Template:Fgcom source
Goal
This template is for creating links or URLs for the FGCom git version control repository. It is a subtemplate of the master {{repo link}} template designed to be specific for the FGCom repository.
Usage
{{fgcom source
| cmd =
| opt =
| protocol =
| login =
| type =
| branch =
| tag =
| 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 git clone. | optional | ||
| opt | Any additional options to show after cmd, but before the URL.
|
optional | ||
| protocol | The URL protocol, for example https, http, ssh, git. 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 git, git web. The default is git web. | optional | ||
| branch | The branch name. This defaults to next. For SourceForge git repositories, if the character / is present in the branch name, the text /~ must be appended to the branch.
|
b | optional | |
| tag | The repository tag name. For SourceForge git repositories, if the character / is present in the tag name, the text /~ must be appended to the tag.
|
optional | ||
| commit | The commit identifier (git hash). 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.
|
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.
|
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>
Site: SourceForge
Project page
For a normal SourceForge project page, the base URL is respectively constructed as:
<protocol>://<DOMAIN>/p/<proj>/<repo>/
For the type parameter value of git, a login is allowed:
<protocol>://[<login>@]<DOMAIN>/p/<proj>/<repo>/
SourceForge <URL> for 'type=git'
For this parameter value, the complete <URL> value will be:
<protocol>://[<login>@]git.code.sf.net/p/<proj>/<repo>/
SourceForge <URL> for 'type=git web'
For this parameter value, the <URL> value will be:
<protocol>://sourceforge.net/p/<proj>/<repo>/ci/<commit|branch>/<VIEW>/<path>[#l<line>]
The <VIEW> value for different values of view is:
- tree
tree/.- log
log/?path=.- commit
- nothing.
If the parameter setting view=rss is used, a different <URL> value is produced:
<protocol>://sourceforge.net/p/<proj>/<repo>/feed/
SourceForge URL <TEXT> for 'type=git' and 'type=git web'
The link text <TEXT>, if the full parameter is not set, will be:
<proj>/<repo>/<commit|branch>[/<path>][#l<line>] <DESC>
If the simplepath parameter is set, this changes to:
[/<path>][#l<line>] <DESC>
If the pre parameter is supplied, this changes to:
<pre>[/<path>][#l<line>] <DESC>
The RSS feed is a special case in that <TEXT> will be one of:
<proj>/<repo> <DESC>
<pre> <DESC>
The description <DESC> is dependent on the view parameter:
- tree
- Nothing.
- log
log view.- commit
commit view.- rss
RSS feed.
The text parameter trumps all, and <TEXT> is simply:
<text>
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
{{fgcom source}}
The repository
{{fgcom source
| text = The fgcom version controlled repository
}}
The fgcom version controlled repository
File
{{fgcom source
| path = src/fgcom.cpp
}}
flightgear/fgcom/next/src/fgcom.cpp
File and a branch
{{fgcom source
| path = fgcom/fgcom.c
| branch = fgcom4
}}
flightgear/fgcom/fgcom4/fgcom/fgcom.c
File and a tag
{{fgcom source
| path = src/fgcom.cpp
| tag = version/2.10/~
}}
flightgear/fgcom/version/2.10/~/src/fgcom.cpp
File and a commit
{{fgcom source
| path = src/utils.cpp
| commit = 437c09
}}
flightgear/fgcom/437c09/src/utils.cpp
{{fgcom source
| path = src/utils.cpp
| commit = 437c09629aeec6da40c8dca322ed1e80383a06b7
}}
flightgear/fgcom/437c09629aeec6da40c8dca322ed1e80383a06b7/src/utils.cpp
Commit
{{fgcom source
| commit = 59b80a
| view = commit
}}
flightgear/fgcom/59b80a commit view
File and line number
{{fgcom source
| path = server/fg-config-builder.pl
| line = 65
}}
flightgear/fgcom/next/server/fg-config-builder.pl#l65
File, line number, and commit
{{fgcom source
| path = data/phonebook.txt
| commit = 59d797
| line = 20
}}
flightgear/fgcom/59d797/data/phonebook.txt#l20
Custom label given
{{fgcom source
| path = src/fgcom_init.cpp
| text = FGCom initialization
}}
Prefix of $FG_COM
{{fgcom source
| path = src/fgcom_init.cpp
| pre = $FG_COM
}}
Full path
{{fgcom source
| path = src/fgcom.cpp
| commit = 7dcc6f0f5640dfc8419f862d426da7054c3d3217
| line = 65
| full = 1
}}
Command
{{#tag:syntaxhighlight|
{{fgcom source
| cmd = git pull
| protocol = git
| type = git
| post = next
| full = 1
}}
| lang = "sh"
}}
git pull git://git.code.sf.net/p/flightgear/fgcom/ next
Aliased parameters
This is for https://sourceforge.net/p/flightgear/fgcom/ci/version/2.10/~/tree/iaxclient/lib/audio_alsa.c.
{{fgcom source
| f = iaxclient/lib/audio_alsa.c
| tag = version/2.10/~
| full = 1
}}.
https://sourceforge.net/p/flightgear/fgcom/ci/version/2.10/~/tree/iaxclient/lib/audio_alsa.c.
Numbered parameters
This is for https://sourceforge.net/p/flightgear/fgcom/ci/version/2.10/~/tree/iaxclient/lib/audio_alsa.c.
{{fgcom source | iaxclient/lib/audio_alsa.c | tag = version/2.10/~ | full = 1 }}.
https://sourceforge.net/p/flightgear/fgcom/ci/version/2.10/~/tree/iaxclient/lib/audio_alsa.c.
Related templates
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||