Template:Gitlab zip file

From FlightGear wiki
Revision as of 21:17, 1 March 2016 by Bugman (talk | contribs) (Improvements to the documentation.)
Jump to navigation Jump to search

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

{{gitlab zip file
| proj       =
| repo       =
| branch     =
| commit     =

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

All parameters are optional.

proj
The name of the project, consisting of a grouping of repositories on the GitLab open source infrastructure.
repo
The name of the repository. A GitLab 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.
commit
The commit identifier (git hash). This defaults to next.
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

Branch

This is for https://gitlab.com/extra500/extra500/repository/archive.zip?ref=FG/2016.1.

{{gitlab zip file
| proj   = extra500
| repo   = extra500
| branch = FG/2016.1
}}

gitlab/extra500/extra500/FG/2016.1 zip file

Or as a full download link:

{{gitlab zip file
| proj   = extra500
| repo   = extra500
| branch = FG/2016.1
| full   = 1
}}

https://gitlab.com/extra500/extra500/repository/archive.zip?ref=FG/2016.1

Related templates