Template:Gitlab clone
git clone https://gitlab.com
Template documentation
Contents
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/nmr-relax/code/ci/master/tree/
To use the <code> tags:
{{#tag:code|{{#tag:nowiki| {{repo link | full = 1 }} }}}}
https://sourceforge.net/p/nmr-relax/code/ci/master/tree/
Examples
Git clone
This is for the main relax source code repository: git clone https://gitlab.com/nmr-relax/relax.git relax
. Though in this case, the simpler {{relax clone}} should be used.
{{#tag:code|{{gitlab clone | proj = nmr-relax | repo = relax | post = relax }}}}.
git clone https://gitlab.com/nmr-relax/relax.git relax
.
Aliased parameters
This is for git clone https://gitlab.com/nmr-relax/website.git
.
{{#tag:code|{{gitlab clone | p = nmr-relax | r = website }}}}.
git clone https://gitlab.com/nmr-relax/website.git
.
Numbered parameters
This is for git clone https://gitlab.com/nmr-relax/website.git
.
{{#tag:code|{{gitlab clone | nmr-relax | website }}}}.
git clone https://gitlab.com/nmr-relax/website.git
.
Related templates
|