Template:Fgcom commit

From FlightGear wiki
Jump to: navigation, search

{{fgcom commit}}: 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 FGCom git repository at SourceForge. It is a subtemplate of the master {{repo link}} template designed to link to specific version control commits.

Usage

{{fgcom commit
| commit
| text       =
}}

The parameters are:

Parameter Description Abbreviated
parameter
Numbered
parameter
Status
commit The commit identifier (git hash). This defaults to HEAD. 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/fgcom/

SourceForge git <URL>

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

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

SourceForge URL <TEXT>

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

FGCom 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

{{fgcom commit | 3febe70}}

FGCom commit 3febe70

User supplied text

The version number is now {{fgcom commit | 3febe70 | text = 2.12}}.

The version number is now 2.12 .

Parameter alias

The version number is now {{fgcom commit | 3febe70 | t = 2.12}}.

The version number is now 2.12 .

Numbered parameters

The version number is now {{fgcom commit | 3febe70 | 2.12}}.

The version number is now 2.12 .

Related templates