Template:Repo link/doc svn source: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
(Documentation of the abbreviated and numbered parameters.)
(Removal of the 'Usage' section title, as this is provided by the {{repo link/doc usage}} template.)
Line 4: Line 4:
This template is for creating links or URLs for the [[{{{label|MISSING}}}]] svn version control repository.  It is a subtemplate of the master {{tl|repo link}} template designed to be specific for the {{{label|MISSING}}} repository.
This template is for creating links or URLs for the [[{{{label|MISSING}}}]] svn version control repository.  It is a subtemplate of the master {{tl|repo link}} template designed to be specific for the {{{label|MISSING}}} repository.


== Usage ==
{{repo link/doc usage
{{repo link/doc usage
| template  = {{{repo|MISSING}}} source
| template  = {{{repo|MISSING}}} source

Revision as of 13:12, 6 March 2016

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 MISSING svn version control repository. It is a subtemplate of the master {{repo link}} template designed to be specific for the MISSING repository.

Usage

{{MISSING source
| cmd        =
| opt        =
| protocol   =
| login      =
| type       =
| branch     =
| commit     =
| path       =
| line       =
| post       =

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

All 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 svn co. 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
protocol The URL protocol, for example https, http, ssh, svn. This defaults to https. optional
login The optional user login. optional
type Choose between the web interface or a direct repository link. This can be one of svn, svn web. The default is svn web. optional
branch The branch name. As tags are simply branches in SVN repositories, this parameter can also be used for svn tags. This defaults to trunk. b optional
commit The commit identifier (svn revision number). This defaults to HEAD. c optional
path The file or directory path. f 1 optional
line The line number(s) of the file to display.
  • For SourceForge: Use a single line number.
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:
  • For SourceForge use one of tree, log, commit, or rss. If a commit is specified (the commit parameter is set and path is not), the default is commit. Otherwise the default is tree.
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

Examples

MISSING

Related templates