Template:Repo link/doc infrastructure source

From FlightGear wiki
< Template:Repo link
Revision as of 17:47, 2 March 2016 by Bugman (talk | contribs) (Improved the documentation.)
Jump to navigation Jump to search
The following template description is not displayed when the template is inserted in an article.

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     =
| path       =
| commit     =
| line       =
| post       =

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

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

cmd
An optional command line tool name + options to prepend to the URL. For example git clone.
opt
Any additional options to show after cmd, if supplied.
Note Developer note: This is for future non-CLI handling of a standardised set of cmd parameter values
type
Choose between the web interface or direct repository link. This can be either git, git web, or zip. For zip files however, please see the {{* zip file}} templates. The default is git web.
proj
The name of the project, consisting of a grouping of repositories on the MISSING open source infrastructure.
repo
The name of the repository, for example fgdata. A project registered on one of the open source infrastructures generally allows for multiple repositories under that project name.
branch
The git branch or tag name. For git tags, simply append /~ to the tag name. This defaults to master.
path
The file path.
commit
The commit identifier (git hash).
line
Line number of the file to display.
view
View to display.
text
Text to display as the link label. Overrides pre.
pre
Prefix to a link label.
post
Text to append.
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.
full
If set, the full URL will be shown.

Examples

Related templates