Template:Gitlab clone: Difference between revisions
(Full support for aliased and numbered parameters, with examples to demonstrate the capabilities.) |
(The 'user' parameter is now active, so document it.) |
||
Line 15: | Line 15: | ||
| label = GitLab | | label = GitLab | ||
| site = gitlab | | site = gitlab | ||
| user = 1 | |||
| examples = | | examples = | ||
===== The extra500 repository ===== | ===== The extra500 repository ===== |
Latest revision as of 16:42, 7 March 2016
git clone https://gitlab.com
Goal
To provide a consistent representation of the command to clone git repositories from the GitLab open source infrastructure. This is a subtemplate of the master {{repo link}} template designed to be specific for the git clone
command and the GitLab infrastructure.
Usage
{{gitlab clone | opt = | user = | proj = | repo = | post = }}
The parameters are:
Parameter | Description | Abbreviated parameter |
Numbered parameter |
Status |
---|---|---|---|---|
opt | Any additional options to show after the command git clone , but before the URL.
|
optional | ||
user | The name of the user page for the 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 open source infrastructure. | p | 1 | mandatory |
repo | The name of the repository. A project registered on one of the open source infrastructures generally allows for multiple repositories under that project name. | r | 2 | mandatory |
post | Text to append. This is forms a set with the parameter opt. For example it can represent any command line options that come after the URL. | optional |
Plain text
To create a URL or link as plain text and avoid external links, simply use the {{#tag:tagname|content}}
magic word construct:
{{#tag:nowiki| {{repo link | full = 1 }} }}
https://sourceforge.net/p/flightgear/flightgear/ci/next/tree/
To use the <code> tags:
{{#tag:code|{{#tag:nowiki| {{repo link | full = 1 }} }}}}
https://sourceforge.net/p/flightgear/flightgear/ci/next/tree/
Examples
The extra500 repository
This should produce the text git clone -v https://gitlab.com/extra500/extra500.git
.
{{#tag:code|{{gitlab clone | opt = -v | proj = extra500 | repo = extra500 }}}}.
git clone -v https://gitlab.com/extra500/extra500.git
.
Aliased parameters
This is for git clone -v https://gitlab.com/extra500/extra500.git
.
{{#tag:code|{{gitlab clone | p = extra500 | r = extra500 }}}}.
git clone https://gitlab.com/extra500/extra500.git
.
Numbered parameters
This is for git clone -v https://gitlab.com/extra500/extra500.git
.
{{#tag:code|{{gitlab clone | extra500 | extra500 }}}}.
git clone https://gitlab.com/extra500/extra500.git
.
Related templates
|