Template:Github zip file

GitHub website

Template documentation

Goal

This template is for providing direct download links to the automatically generated zip archives of GitHub repositories. The temporary zip file is created on demand when the link is followed. It is a subtemplate of the master {{repo link}} template designed to simplify the interface.

Usage

Usage

{{github zip file
| user       =
| proj       =
| repo       =
| branch     =
| tag        =
| commit     =

| text       =
| pre        =
| simplepath =
| full       =
}}

The parameters are:

Parameter	Description	Abbreviated parameter	Numbered parameter	Status
user	The name of the user page for the GitHub open source infrastructure. This is notably different to the login parameter. This will have precedence over the proj parameter. The user page is treated in the same way as a project name.	u	1	mandatory
proj	The name of the project, consisting of a grouping of repositories on the GitHub open source infrastructure.	p	1	mandatory
repo	The name of the repository. A project registered on the GitHub open source infrastructure generally allows for multiple repositories under that project name.	r	2	mandatory
branch	The branch name. This defaults to master.	b	3	optional
tag	The repository tag name.			optional
commit	The commit identifier (git hash). This defaults to HEAD.	c	4	optional
text	Text to display as the link label. Overrides pre.	t	5	optional
pre	Prefix to a link label.			optional
simplepath	If set, this strips off the repository name from the URL label, leaving just the contents of the path parameter. Note The text parameter will override this.			optional
full	If set to 1, the full URL will be shown rather than any text label.			optional

Examples

Default

This is a link to https://github.com/nmr-relax/relax/archive/master.zip.

{{github zip file
| proj = nmr-relax
| repo = relax
| full = 1
}}.

https://github.com/nmr-relax/relax/archive/master.zip.

Branch

This is a link to https://github.com/nmr-relax/relax/archive/N_state_model.zip.

{{github zip file
| proj   = nmr-relax
| repo   = relax
| branch = N_state_model
| full   = 1
}}.

https://github.com/nmr-relax/relax/archive/N_state_model.zip.

Commit

This is a link to https://github.com/nmr-relax/relax/archive/58d63f8dc7b5a17e97bc260c557b2d16a3782f8a.zip.

{{github zip file
| proj   = nmr-relax
| repo   = relax
| commit = 58d63f8dc7b5a17e97bc260c557b2d16a3782f8a
| full   = 1
}}.

https://github.com/nmr-relax/relax/archive/58d63f8dc7b5a17e97bc260c557b2d16a3782f8a.zip.

Aliased parameters

This is a link to https://github.com/nmr-relax/relax/archive/absolute_rdc.zip.

{{github zip file
| p    = nmr-relax
| r    = relax
| b    = absolute_rdc
| full = 1
}}.

https://github.com/nmr-relax/relax/archive/absolute_rdc.zip.

Numbered parameters

This is a link to https://github.com/nmr-relax/relax/archive/0.3.zip.

{{github zip file | nmr-relax | relax | 0.3 | full = 1 }}.

https://github.com/nmr-relax/relax/archive/0.3.zip.

Related templates