Template:Github zip file: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
m (Documentation fix.)
(Switch to {{repo link/doc zip file}} to simplify the template documentation.)
Line 14: Line 14:
}}<noinclude>
}}<noinclude>


{{Informative template|1=
{{repo link/doc zip file
== Goal ==
| label              = GitHub
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 {{tl|repo link}} template designed to simplify the interface.
| site              = github
 
| default_branch_git = master
== Usage ==
| gh                = 1
{{obr}}'''github zip file'''
| git                = 1
{{!}} ''user''      =
| examples          =
{{!}} ''proj''      =
{{!}} ''repo''      =
{{!}} ''branch''    =
{{!}} ''commit''    =
{{!}} ''text''      =
{{!}} ''pre''        =
{{!}} ''simplepath'' =
{{!}} ''full''      =
{{cbr}}
 
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 <code>/~</code> 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.
: {{inote|The ''text'' parameter will override this.}}
 
; full: If set, the full URL will be shown rather than any text label.
 
== Examples ==
 
=== Default ===
=== Default ===
This is for https://github.com/Juanvvc/c172p-detailed/archive/master.zip.
This is for https://github.com/Juanvvc/c172p-detailed/archive/master.zip.
Line 104: Line 70:
| full  = 1
| full  = 1
}}.
}}.
== Related templates ==
{{repo link/doc related}}


}}
}}


[[Category:Repository link templates]]
</noinclude>
</noinclude>

Revision as of 17:52, 5 March 2016

GitHub website


The following template description is not displayed when the template is inserted in an article.

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 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

The {{repo link}} family of templates
Master template
Source link templates
FlightGear repositories
Specialized templates
Open source infrastructure repositories
URL templates
FlightGear repositories
Specialized templates
Open source infrastructure repositories
Commit link templates
FlightGear repositories
Specialized templates
Merge request templates
Open source infrastructure repositories
Obtaining a local copy
of the repository
FlightGear repositories
Specialized templates
3rd party
Open source infrastructure repositories
File link templates
Specific FlightGear files
Prefixed variable
Download templates
3rd party
Other templates1
Documentation
1Note that the newer source link templates provide far greater functionality and these templates are not based on the master {{repo link}} template.


Retrieved from "https://wiki.flightgear.org/w/index.php?title=Template:Github_zip_file&oldid=94736"