Template:Repo link/doc infrastructure commit
Goal
This template can be used when linking to summaries of commits for the MISSING git repository at MISSING. It is a subtemplate of the master {{repo link}} template designed to link to specific version control commits.
Usage
{{MISSING commit
| proj =
| repo =
| commit =
| text =
}}
The parameters are:
| Parameter | Description | Abbreviated parameter |
Numbered parameter |
Status |
|---|---|---|---|---|
| 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 |
| commit | The commit identifier. | c | 3 | mandatory |
| text | Text to display as the link label. | t | 4 | 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> <TEXT>] <post>
Here the square brackets do not denote optional text, but will instead produce a Mediawiki link. This can be modified by setting full = 1 to produce:
<cmd> <opt> <URL> <post>
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://gitlab.com
To use the <code> tags:
{{#tag:code|{{#tag:nowiki|
{{repo link
| full = 1
}}
}}}}
https://gitlab.com
Examples
Auto-generated text
{{MISSING commit | MISSING}}
User supplied text
MISSING {{MISSING commit | MISSING | text = MISSING}}.
MISSING Template:MISSING commit .
Parameter alias
MISSING {{MISSING commit | MISSING | t = MISSING}}.
MISSING Template:MISSING commit .
Numbered parameters
MISSING {{MISSING commit | MISSING | MISSING}}.
MISSING Template:MISSING commit .
Related templates
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||