Template:Gitlab zip file: Difference between revisions

Jump to navigation Jump to search
Switch to {{repo link/doc zip file}} to simplify the template documentation.
(Documentation improvements.)
(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              = GitLab
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 {{tl|repo link}} template designed to simplify the interface.
| site              = gitlab
 
| default_branch_git = master
== Usage ==
| gl                = 1
{{obr}}'''gitlab zip file'''
| git                = 1
{{!}} proj      =
| examples          =
{{!}} repo      =
{{!}} ''branch''    =
{{!}} ''commit''    =
{{!}} ''text''      =  
{{!}} ''pre''        =
{{!}} ''simplepath'' =
{{!}} ''full''      =
{{cbr}}
 
The parameters '''proj''' and '''repo''' are mandatory, all others 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 <code>/~</code> to the tag name.
 
; 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 ==
 
=== Branch ===
=== Branch ===
This is for https://gitlab.com/extra500/extra500/repository/archive.zip?ref=FG/2016.1.
This is for https://gitlab.com/extra500/extra500/repository/archive.zip?ref=FG/2016.1.

Navigation menu