Template:Github zip file: Difference between revisions
m (Typo.) |
m (Documentation fix.) |
||
Line 40: | Line 40: | ||
; repo: The name of the repository. A GitHub project allows for multiple repositories under that project name. | ; repo: The name of the repository. A GitHub project allows for multiple repositories under that project name. | ||
; branch: The git branch or tag name. For git tags, simply append <code>/~</code> to the tag name. | ; branch: The git branch or tag name. For git tags, simply append <code>/~</code> to the tag name. This defaults to ''master'''. | ||
; commit: The commit identifier (git hash) | ; commit: The commit identifier (git hash). | ||
; text: Text to display as the link label. Overrides '''pre'''. | ; text: Text to display as the link label. Overrides '''pre'''. |
Revision as of 23:30, 1 March 2016
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
{{github zip file | user = | proj = | repo = | branch = | commit = | text = | pre = | simplepath = | full = }}
All parameters are optional.
- user
- The GitHub user name. This will have precedence over the proj parameter. The user page is treated in the same way as a project name.
- proj
- The name of the project, consisting of a grouping of repositories on the GitHub open source infrastructure.
- repo
- The name of the repository. A GitHub project allows for multiple repositories under that project name.
- branch
- The git branch or tag name. For git tags, simply append
/~
to the tag name. This defaults to master'.
- commit
- The commit identifier (git hash).
- text
- Text to display as the link label. Overrides pre.
- pre
- Prefix to a link label.
- 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.
- full
- If set, the full URL will be shown rather than any text label.
Examples
Default
This is for https://github.com/Juanvvc/c172p-detailed/archive/master.zip.
{{github zip file | proj = Juanvvc | repo = c172p-detailed | type = zip | full = 1 }}.
https://github.com/Juanvvc/c172p-detailed/archive/master.zip.
Branch
This is for https://github.com/Juanvvc/c172p-detailed/archive/release/2016.1.zip.
{{github zip file | proj = Juanvvc | repo = c172p-detailed | branch = release/2016.1 | full = 1 }}.
https://github.com/Juanvvc/c172p-detailed/archive/release/2016.1.zip.
Commit
This is for https://github.com/Juanvvc/c172p-detailed/archive/c9cef81a899201802b32109c43ca686bbeffdb42.zip.
{{github zip file | proj = Juanvvc | repo = c172p-detailed | commit = c9cef81a899201802b32109c43ca686bbeffdb42 | full = 1 }}.
https://github.com/Juanvvc/c172p-detailed/archive/c9cef81a899201802b32109c43ca686bbeffdb42.zip.
Related templates
|