Template:Fgdata effect

From FlightGear wiki
Revision as of 12:29, 21 August 2016 by Hooray (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

$FG_ROOT/Effects/model-combined-deferred.eff


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

Goal

This template is for creating links to FGData effects files prefixed with $FG_ROOT/Effects/. It is a subtemplate of the master {{repo link}} template, via the {{fg root file}} template. It is intended to help protect articles/documentation from file/path changes in the base package, so that the corresponding documentation can be more easily updated and maintained, without having to manually edit possibly dozens of articles to reflect such refactorings (moving/renaming files/folders and introducing new ones).

Usage

{{fgdata effect
| path       =
}}

The parameters are:

Parameter Description Abbreviated
parameter
Numbered
parameter
Status
path The file or directory path. f 1 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

{{fgdata effect}}

$FG_ROOT/Effects/model-combined-deferred.eff

File

{{fgdata effect
| path = model-combined-deferred.eff
}}

$FG_ROOT/Effects/model-combined-deferred.eff

Aliased parameters

{{fgdata effect
| f = model-combined-deferred.eff
}}.

$FG_ROOT/Effects/model-combined-deferred.eff.

Numbered parameters

{{fgdata effect | model-combined-deferred.eff}}.

$FG_ROOT/Effects/model-combined-deferred.eff.

Related templates