Template:Gitlab zip file
Jump to navigation
Jump to search
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
Usage
{{gitlab 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 GitLab 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 GitLab open source infrastructure. | p | 1 | mandatory |
| repo | The name of the repository. A project registered on the GitLab 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.
|
optional | ||
| full | If set to 1, the full URL will be shown rather than any text label. | optional |
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
Parameter alias
This is for https://gitlab.com/extra500/extra500/repository/archive.zip?ref=FG/2016.1.
{{gitlab zip file
| p = extra500
| r = extra500
| b = FG/2016.1
| full = 1
}}
https://gitlab.com/extra500/extra500/repository/archive.zip?ref=FG/2016.1
Zip file with tag
This is for https://gitlab.com/emilianh/IAR80/repository/archive.zip?ref=latest
{{gitlab zip file
| u = emilianh
| r = IAR80
| tag = latest
| full = 1
}}
https://gitlab.com/emilianh/IAR80/repository/archive.zip?ref=latest
Numbered parameters
This is for https://gitlab.com/extra500/extra500/repository/archive.zip?ref=FG/2016.1.
{{gitlab zip file | extra500 | extra500 | FG/2016.1 | full = 1 }}
https://gitlab.com/extra500/extra500/repository/archive.zip?ref=FG/2016.1
Related templates
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Related templates
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||