Template:Gitlab url: Difference between revisions

Latest revision as of 12:08, 24 May 2016

The following template description is not displayed when the template is inserted in an article.

Goal

This template is for creating direct URLs for the content of the version control repositories of the GitLab open source infrastructure. This is equivalent to the {{gitlab source}} template with the full parameter set to 1. It is a subtemplate of the master {{repo link}} template designed to be specific for the GitLab repositories.

Usage

{{gitlab url
| cmd        =
| opt        =
| type       =
| user       =
| proj       =
| repo       =
| branch     =
| tag        =
| commit     =
| path       =
| line       =
| post       =
| view       =
}}

Either the user or proj parameter, as well as the repo parameter, must be supplied. All other parameters are optional.

Parameter	Description	Abbreviated parameter	Numbered parameter	Status
cmd	An optional command line tool name + options to prepend to the URL. For example git clone.			optional
opt	Any additional options to show after cmd, but before the URL. Note The separation of cmd and opt is for future non-CLI handling of a standardised set of cmd parameter values			optional
type	Choose between the web interface or a direct repository link. This can be one of git, git web. The default is git web.			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
branch	The branch name. This defaults to next.	b	3	optional
tag	The repository tag name.	t		optional
commit	The commit identifier (git hash). This defaults to HEAD.	c	5	optional
path	The file or directory path.	f	4	optional
line	The line number(s) of the file to display.	l		optional
post	Text to append. This is forms a set with the parameter cmd and opt. For example it can represent any command line options that come after the URL.			optional
view	View to display: The GitLab interface for type = git web is not yet implemented in the master {{repo link}} template, so the view parameter currently does nothing.	v		optional

Design

In this section, the following notation will be used:

Angular brackets + lower case text <xyz>: Template parameters.
Angular brackets + upper case text <XYZ>: Template constructed text.
Square brackets [xyz]: Optional text, only added if the parameter is set.
Or symbol |: The value on the left, if present, otherwise the value on the right of the symbol.

Overview

The general design is:

<cmd> <opt> <URL> <post>

Site: GitLab

The base URL for GitLab repositories is:

<protocol>://gitlab.com/<proj>[/<repo>]

GitLab <URL> for 'type=git'

For this parameter value, the complete <URL> value will be:

<protocol>://gitlab.com/<proj>[/<repo>].git

GitLab <URL> for 'type=git web'

This is not implemented yet. Please add new examples to allow this template to be extended.

GitLab <URL> for 'type=zip'

For this parameter value, the base zip file URL will be:

<protocol>://gitlab.com/<proj>/<repo>/repository/archive.zip

If a branch, tag, or commit is specified, this will be added as a query:

<protocol>://gitlab.com/<proj>/<repo>/repository/archive.zip[?ref=<commit|tag|branch>]

GitLab URL <TEXT>

This is not implemented yet. Please add new examples to allow this template to be extended.

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

No parameters

{{gitlab url}}

https://gitlab.com

Project

{{gitlab url|tortoisegit|tortoisegit}}

https://gitlab.com/tortoisegit/tortoisegit

User repository

This is for https://gitlab.com/emilianh/Lockheed-L10-Electra.

{{gitlab url
| user   = emilianh
| repo   = Lockheed-L10-Electra
}}

https://gitlab.com/emilianh/Lockheed-L10-Electra

File

This is for https://gitlab.com/fg-radi/osm2city/blob/master/osm2city.py.

{{gitlab url
| proj = fg-radi
| repo = osm2city
| path = osm2city.py
}}.

https://gitlab.com/fg-radi/osm2city/blob/master/osm2city.py.

File and a branch

This is for https://gitlab.com/tortoisegit/tortoisegit/blob/REL_1.8.16.0_EXTERNAL/release.txt.

{{gitlab url
| proj   = tortoisegit
| repo   = tortoisegit
| branch = REL_1.8.16.0_EXTERNAL
| path   = release.txt
}}.

https://gitlab.com/tortoisegit/tortoisegit/blob/REL_1.8.16.0_EXTERNAL/release.txt.

File and a commit

This is for https://gitlab.com/extra500/extra500/blob/20ac59/extra500-set.xml.

{{gitlab url
| proj   = extra500
| repo   = extra500
| commit = 20ac59ad
| path   = extra500-set.xml
}}.

https://gitlab.com/extra500/extra500/blob/20ac59ad/extra500-set.xml.

File with line number

This is for https://gitlab.com/mdanil/Tu-144/blob/master/Models/Tu-144.xml#L8-14.

{{gitlab url
| user   = mdanil
| repo   = Tu-144
| view   = blob
| branch = master
| path   = Models/Tu-144.xml
| line   = 8-14
}}.

https://gitlab.com/mdanil/Tu-144/blob/master/Models/Tu-144.xml#L8-14.

The FlightGear Multiplayer server software

This is for https://gitlab.com/fgms/fgms-0-x.git.

{{gitlab url
  | proj = fgms
  | repo = fgms-0-x
  | type = git
}}.

https://gitlab.com/fgms/fgms-0-x.git.

Git clone

Note For a simpler interface, see {{gitlab clone}}.

This should produce git clone https://gitlab.com/extra500/extra500.git.

{{#tag:syntaxhighlight|
{{gitlab url
| cmd    = git clone
| proj   = extra500
| repo   = extra500
| branch = FG/2016.1
| type   = git
}}
| lang = "sh"
}}

git clone https://gitlab.com/extra500/extra500.git

Raw view

This is for https://gitlab.com/extra500/extra500/raw/20ac59/extra500-set.xml.

{{gitlab url
| proj   = extra500
| repo   = extra500
| view   = raw
| commit = 20ac59
| path   = extra500-set.xml
}}.

https://gitlab.com/extra500/extra500/raw/20ac59/extra500-set.xml.

Commit

This is for https://gitlab.com/extra500/extra500/commit/20ac59ad.

{{gitlab url
| proj   = extra500
| repo   = extra500
| view   = commit
| commit = 20ac59ad
}}.

https://gitlab.com/extra500/extra500/commit/20ac59ad.

Tree view at a given commit

This is for https://gitlab.com/extra500/extra500/tree/20ac59ad.

{{gitlab url
| proj   = extra500
| repo   = extra500
| view   = tree
| commit = 20ac59ad
}}.

https://gitlab.com/extra500/extra500/tree/20ac59ad.

Main views

History view

This is for https://gitlab.com/mailman/mailman/commits/master.

{{gitlab url
| user   = mailman
| repo   = mailman
| view   = commits
}}.

https://gitlab.com/mailman/mailman/commits/master.

History view from a commit

This is for https://gitlab.com/mailman/mailman/commits/1236a9cf.

{{gitlab url
| user   = mailman
| repo   = mailman
| view   = commits
| commit = 1236a9cf
}}.

https://gitlab.com/mailman/mailman/commits/1236a9cf.

Zip archive download

Note For a simpler interface, see {{gitlab zip file}}.

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

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

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

Aliased parameters

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

{{gitlab url
| p    = extra500
| r    = extra500
| b    = FG/2016.1
| type = zip
}}.

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

Numbered parameters

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

{{gitlab url | extra500 | extra500 | FG/2016.1 | type = zip }}.

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

Related templates

@@ Line 26: / Line 26: @@
 | examples  =
 === No parameters ===
-  {{obr}}gitlab url/sandbox{{cbr}}
+  {{obr}}gitlab url{{cbr}}
-{{gitlab url/sandbox}}
+{{gitlab url}}
 === Project ===
-  {{obr}}gitlab url/sandbox{{!}}tortoisegit{{!}}tortoisegit{{cbr}}
+  {{obr}}gitlab url{{!}}tortoisegit{{!}}tortoisegit{{cbr}}
-{{gitlab url/sandbox|tortoisegit|tortoisegit}}
+{{gitlab url|tortoisegit|tortoisegit}}
 ==== User repository ====
 This is for https://gitlab.com/emilianh/Lockheed-L10-Electra.
-  {{obr}}gitlab url/sandbox
+  {{obr}}gitlab url
   {{!}} user   = emilianh
   {{!}} repo   = Lockheed-L10-Electra
   {{cbr}}
-{{gitlab url/sandbox
+{{gitlab url
 | user   = emilianh
 | repo   = Lockheed-L10-Electra
@@ Line 49: / Line 49: @@
 This is for https://gitlab.com/fg-radi/osm2city/blob/master/osm2city.py.
-  {{obr}}gitlab url/sandbox
+  {{obr}}gitlab url
   {{!}} proj = fg-radi
   {{!}} repo = osm2city
@@ Line 55: / Line 55: @@
   {{cbr}}.
-{{gitlab url/sandbox
+{{gitlab url
 | proj = fg-radi
 | repo = osm2city
@@ Line 64: / Line 64: @@
 This is for https://gitlab.com/tortoisegit/tortoisegit/blob/REL_1.8.16.0_EXTERNAL/release.txt.
-  {{obr}}gitlab url/sandbox
+  {{obr}}gitlab url
   {{!}} proj   = tortoisegit
   {{!}} repo   = tortoisegit
@@ Line 71: / Line 71: @@
   {{cbr}}.
-{{gitlab url/sandbox
+{{gitlab url
 | proj   = tortoisegit
 | repo   = tortoisegit
@@ Line 81: / Line 81: @@
 This is for https://gitlab.com/extra500/extra500/blob/20ac59/extra500-set.xml.
-  {{obr}}gitlab url/sandbox
+  {{obr}}gitlab url
   {{!}} proj   = extra500
   {{!}} repo   = extra500
@@ Line 88: / Line 88: @@
   {{cbr}}.
-{{gitlab url/sandbox
+{{gitlab url
 | proj   = extra500
 | repo   = extra500
@@ Line 98: / Line 98: @@
 This is for https://gitlab.com/mdanil/Tu-144/blob/master/Models/Tu-144.xml#L8-14.
-  {{obr}}gitlab url/sandbox
+  {{obr}}gitlab url
   {{!}} user   = mdanil
   {{!}} repo   = Tu-144
@@ Line 107: / Line 107: @@
   {{cbr}}.
-{{gitlab url/sandbox
+{{gitlab url
 | user   = mdanil
 | repo   = Tu-144
@@ Line 119: / Line 119: @@
 This is for https://gitlab.com/fgms/fgms-0-x.git.
-  {{obr}}gitlab url/sandbox
+  {{obr}}gitlab url
     {{!}} proj = fgms
     {{!}} repo = fgms-0-x
@@ Line 125: / Line 125: @@
   {{cbr}}.
-{{gitlab url/sandbox
+{{gitlab url
    | proj  = fgms
    | repo  = fgms-0-x
@@ Line 136: / Line 136: @@
   {{obr}}#tag:syntaxhighlight{{!}}
-  {{obr}}gitlab url/sandbox
+  {{obr}}gitlab url
   {{!}} cmd    = git clone
   {{!}} proj   = extra500
@@ Line 147: / Line 147: @@
 {{#tag:syntaxhighlight|
-{{gitlab url/sandbox
+{{gitlab url
 | cmd    = git clone
 | proj   = extra500
@@ Line 160: / Line 160: @@
 This is for https://gitlab.com/extra500/extra500/raw/20ac59/extra500-set.xml.
-  {{obr}}gitlab url/sandbox
+  {{obr}}gitlab url
   {{!}} proj   = extra500
   {{!}} repo   = extra500
@@ Line 168: / Line 168: @@
   {{cbr}}.
-{{gitlab url/sandbox
+{{gitlab url
 | proj   = extra500
 | repo   = extra500
@@ Line 179: / Line 179: @@
 This is for https://gitlab.com/extra500/extra500/commit/20ac59ad.
-  {{obr}}gitlab url/sandbox
+  {{obr}}gitlab url
   {{!}} proj   = extra500
   {{!}} repo   = extra500
@@ Line 186: / Line 186: @@
   {{cbr}}.
-{{gitlab url/sandbox
+{{gitlab url
 | proj   = extra500
 | repo   = extra500
@@ Line 196: / Line 196: @@
 This is for https://gitlab.com/extra500/extra500/tree/20ac59ad.
-  {{obr}}gitlab url/sandbox
+  {{obr}}gitlab url
   {{!}} proj   = extra500
   {{!}} repo   = extra500
@@ Line 203: / Line 203: @@
   {{cbr}}.
-{{gitlab url/sandbox
+{{gitlab url
 | proj   = extra500
 | repo   = extra500
@@ Line 214: / Line 214: @@
 This is for https://gitlab.com/mailman/mailman/commits/master.
-  {{obr}}gitlab url/sandbox
+  {{obr}}gitlab url
   {{!}} user   = mailman
   {{!}} repo   = mailman
@@ Line 220: / Line 220: @@
   {{cbr}}.
-{{gitlab url/sandbox
+{{gitlab url
 | user   = mailman
 | repo   = mailman
@@ Line 229: / Line 229: @@
 This is for https://gitlab.com/mailman/mailman/commits/1236a9cf.
-  {{obr}}gitlab url/sandbox
+  {{obr}}gitlab url
   {{!}} user   = mailman
   {{!}} repo   = mailman
@@ Line 236: / Line 236: @@
   {{cbr}}.
-{{gitlab url/sandbox
+{{gitlab url
 | user   = mailman
 | repo   = mailman
@@ Line 247: / Line 247: @@
 This is for https://gitlab.com/extra500/extra500/repository/archive.zip?ref=FG/2016.1.
-  {{obr}}gitlab url/sandbox
+  {{obr}}gitlab url
   {{!}} proj   = extra500
   {{!}} repo   = extra500
@@ Line 254: / Line 254: @@
   {{cbr}}
-{{gitlab url/sandbox
+{{gitlab url
 | proj   = extra500
 | repo   = extra500
@@ Line 263: / Line 263: @@
 This is for https://gitlab.com/extra500/extra500/repository/archive.zip?ref=FG/2016.1.
-  {{obr}}gitlab url/sandbox
+  {{obr}}gitlab url
   {{!}} p    = extra500
   {{!}} r    = extra500
@@ Line 270: / Line 270: @@
   {{cbr}}.
-{{gitlab url/sandbox
+{{gitlab url
 | p    = extra500
 | r    = extra500
@@ Line 280: / Line 280: @@
 This is for https://gitlab.com/extra500/extra500/repository/archive.zip?ref=FG/2016.1.
-  {{obr}}gitlab url/sandbox {{!}} extra500 {{!}} extra500 {{!}} FG/2016.1 {{!}} type = zip {{cbr}}.
+  {{obr}}gitlab url {{!}} extra500 {{!}} extra500 {{!}} FG/2016.1 {{!}} type = zip {{cbr}}.
-{{gitlab url/sandbox | extra500 | extra500 | FG/2016.1 | type = zip }}.
+{{gitlab url | extra500 | extra500 | FG/2016.1 | type = zip }}.
 }}</noinclude>

Template:Gitlab url: Difference between revisions

Latest revision as of 12:08, 24 May 2016

Goal

Usage

Design

Overview

Site: GitLab

GitLab <URL> for 'type=git'

GitLab <URL> for 'type=git web'

GitLab <URL> for 'type=zip'

GitLab URL <TEXT>

Plain text

Examples

No parameters

Project

User repository

File

File and a branch

File and a commit

File with line number

The FlightGear Multiplayer server software

Git clone

Raw view

Commit

Tree view at a given commit

Main views

History view

History view from a commit

Zip archive download

Aliased parameters

Numbered parameters

Related templates

Navigation menu

Search