Template:Relax url

From relax wiki
Jump to: navigation, search


The following template description is not displayed when the template is inserted in an article.


This template is for creating direct URLs for the relax git version control repository. This is equivalent to the {{relax source}} template with the full parameter set to 1. It is a subtemplate of the master {{repo link}} template designed to be specific for the relax repository.


{{relax url
| cmd        =
| opt        =
| protocol   =
| login      =
| type       =
| branch     =
| tag        =
| commit     =
| path       =
| line       =
| post       =
| view       =

All parameters are optional.

Parameter Description Abbreviated
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
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.
  • 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


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.


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:


For the type parameter value of git, a login is allowed:


SourceForge <URL> for 'type=git'

For this parameter value, the complete <URL> value will be:


SourceForge <URL> for 'type=git web'

For this parameter value, the <URL> value will be:


The <VIEW> value for different values of view is:


If the parameter setting view=rss is used, a different <URL> value is produced:


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:

log view.
commit view.
RSS feed.

The text parameter trumps all, and <TEXT> is simply:


Plain text

To create a URL or link as plain text and avoid external links, simply use the {{#tag:tagname|content}} magic word construct:

  {{repo link
  | full = 1


To use the <code> tags:

  {{repo link
  | full = 1



No parameters

This is a link to https://sourceforge.net/p/nmr-relax/code/ci/master/tree/.

{{relax url}}.



This is a link to https://sourceforge.net/p/nmr-relax/code/ci/master/tree/pipe_control/diffusion_tensor.py.

{{relax url
| path = pipe_control/diffusion_tensor.py


File and a branch

This is a link to https://sourceforge.net/p/nmr-relax/code/ci/j_couplings/tree/generic_fns/align_tensor.py.

{{relax url
| path   = generic_fns/align_tensor.py
| branch = j_couplings


File and a tag

This is a link to https://sourceforge.net/p/nmr-relax/code/ci/4.0.3/tree/pipe_control/diffusion_tensor.py.

{{relax url
| path = pipe_control/diffusion_tensor.py
| tag  = 4.0.3


File and a commit

This is a link to https://sourceforge.net/p/nmr-relax/code/ci/bb91d6/tree/data_store/exp_info.py.

{{relax url
| path   = data_store/exp_info.py
| commit = bb91d6


{{relax url
| path   = data_store/exp_info.py
| commit = bb91d693f4102f81735e2a965cc1eed610211753



This is a link to https://sourceforge.net/p/nmr-relax/code/ci/6105c8/.

{{relax url
| commit = 6105c8
| view   = commit


File and line number

This is a link to https://sourceforge.net/p/nmr-relax/code/ci/master/tree/gui/spin_viewer/tree.py#l68.

{{relax url
| path = gui/spin_viewer/tree.py
| line = 68


File, line number, and commit

This is a link to https://sourceforge.net/p/nmr-relax/code/ci/21462188d194d28ee6bd0523ebcc13a00a73c4ba/tree/gui/spin_viewer/tree.py#l546.

{{relax url
| path   = gui/spin_viewer/tree.py
| commit = 21462188d194d28ee6bd0523ebcc13a00a73c4ba
| line   = 546


Git clone

Note  For a simpler interface for this specific example, see {{relax clone}}.

This is for git clone git://git.code.sf.net/p/nmr-relax/code.

{{#tag:code|{{#tag:nowiki|{{relax url
  | cmd      = git clone
  | protocol = git
  | type     = git

git clone git://git.code.sf.net/p/nmr-relax/code/.

Aliased parameters

This is a link to https://sourceforge.net/p/nmr-relax/code/ci/j_couplings/tree/generic_fns/align_tensor.py#l227.

{{relax url
| f    = generic_fns/align_tensor.py
| b    = j_couplings
| l    = 227


Numbered parameters

This is a link to https://sourceforge.net/p/nmr-relax/code/ci/j_couplings/tree/generic_fns/align_tensor.py.

{{relax url | generic_fns/align_tensor.py | b = j_couplings }}.


Related templates