Hi fellow wiki editors!

To help newly registered users get more familiar with the wiki (and maybe older users too) there is now a {{Welcome to the wiki}} template. Have a look at it and feel free to add it to new users discussion pages (and perhaps your own).

I have tried to keep the template short, but meaningful. /Johan G

Template:Terragear commit

From FlightGear wiki
Revision as of 14:46, 25 February 2016 by Bugman (Talk | contribs) (Creation of the {{terragear commit}} template.)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Missing parameter commit


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

Goal

This template can be used when linking to summaries of commits for the TerraGear git repository at SourceForge. It is a subtemplate of the master {{repo link}} template designed to link to specific version control commits.

Usage

{{terragear commit
| commit
| text       =
}}

The parameters are:

Parameter Description Abbreviated
parameter
Numbered
parameter
Status
commit The commit identifier. 1 mandatory
text Text to display as the link label. t 2 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:

https://sourceforge.net/p/flightgear/terragear/

SourceForge git <URL>

For the svn repository type, the <URL> value will be:

https://sourceforge.net/p/flightgear/terragear/ci/<commit>

SourceForge svn <URL>

For the svn repository type, the <URL> value will be:

https://sourceforge.net/p/flightgear/terragear/<commit|HEAD>

SourceForge URL <TEXT>

The link text <TEXT>, if the text parameter is not set, will simply be:

TerraGear commit <commit>

Or if the text parameter is supplied, the <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

Auto-generated text

{{terragear commit | 86aa92}}

TerraGear commit 86aa92

User supplied text

We now have {{terragear commit | 5e8137 | text = robust reading of untrusted input}}.

We now have robust reading of untrusted input .

Parameter alias

We now have {{terragear commit | 5e8137 | t = robust reading of untrusted input}}.

We now have robust reading of untrusted input .

Numbered parameters

We now have {{terragear commit | 5e8137 | robust reading of untrusted input}}.

We now have robust reading of untrusted input .

Related templates