Template:Fgaddon commit: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
(Set the 'git' and 'svn' parameters for {{repo link/doc commit}}.)
(Switch the 'site' parameter to use the {{project infrastructure/code}} subtemplate.)
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{repo link
{{repo link
| site  = {{project infrastructure|abbrev}}
| site  = {{project infrastructure/code}}
| repo  = fgaddon
| repo  = fgaddon
| type  = svn web
| type  = svn web
Line 7: Line 7:
| text  = {{#if: {{{1|}}}
| text  = {{#if: {{{1|}}}
   | {{{text|{{{t|{{{2|FGAddon commit r{{strip whitespace|{{{1}}}}} }}} }}} }}}
   | {{{text|{{{t|{{{2|FGAddon commit r{{strip whitespace|{{{1}}}}} }}} }}} }}}
   | <big style="color:red;">Missing parameter '''commit'''</big>
   | {{error|Missing parameter '''commit'''|fgaddon commit}}
   }}
   }}
}}<noinclude>
}}<noinclude>

Revision as of 11:06, 15 March 2016

[https://Template:Project infrastructure/code//fgaddonGeneric svn web interface is not implemented for {{repo link}}]


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

Usage

{{fgaddon commit
| commit
| text       =
}}

The parameters are:

Parameter Description Abbreviated
parameter
Numbered
parameter
Status
commit The commit identifier (svn revision number). 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/fgaddon/

SourceForge svn <URL>

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

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

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

{{fgaddon commit | 1020}}

[https://Template:Project infrastructure/code//fgaddonGeneric svn web interface is not implemented for {{repo link}}]

User supplied text

Maintenance such as {{fgaddon commit | 1001 | text = removing Windows Thumbs.db files}} should not be needed.

Maintenance such as [https://Template:Project infrastructure/code//fgaddonGeneric svn web interface is not implemented for {{repo link}}]  should not be needed.

Parameter alias

Maintenance such as {{fgaddon commit | 1001 | t = removing Windows Thumbs.db files}} should not be needed.

Maintenance such as [https://Template:Project infrastructure/code//fgaddonGeneric svn web interface is not implemented for {{repo link}}]  should not be needed.

Numbered parameters

Maintenance such as {{fgaddon commit | 1001 | removing Windows Thumbs.db files}} should not be needed.

Maintenance such as [https://Template:Project infrastructure/code//fgaddonGeneric svn web interface is not implemented for {{repo link}}]  should not be needed.

Related templates