Template:Repo link/doc infrastructure source

Template documentation

Goal

This template is for creating links or URLs for the content of the version control repositories of the MISSING open source infrastructure. It is a subtemplate of the master {{repo link}} template designed to be specific for the MISSING repositories.

Usage

{{MISSING source
| cmd        =
| opt        =
| type       =
| proj       =
| repo       =
| branch     =
| tag        =
| commit     =
| path       =
| line       =
| post       =

| view       =
| text       =
| pre        =
| simplepath =
| full       =
}}

The 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. The default is svn web.			optional
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.	b	3	optional
tag	The repository tag name.			optional
commit	The commit identifier.	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:	v		optional
text	Text to display as the link label. Overrides pre.	t		optional
pre	Prefix to a link label.			optional
simplepath	If set, this strips off the repository name from the URL label, leaving just the contents of the path parameter. Note The text parameter will override this.			optional
full	If set to 1, the full URL will be shown rather than any text label.			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://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

Related templates