Template:Flightgear file

From FlightGear wiki
Revision as of 10:37, 25 September 2015 by Red Leader (talk | contribs) (Add line parameter; slightly shorten abbreviated commit IDs to match the SF abbreviation; add link to {{fgaddon url}})
Jump to navigation Jump to search

flightgear/

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

Goal

This template can be used when linking to source files or directories in the FlightGear repository.

Usage

{{flightgear file|path|reference|line}}

Both parameters are optional.

path
What follows after /tree/ in the URL. Can be the path to a file or a directory. If empty, the link will point to the root of the FlightGear repository.
reference
A commit reference. Usually the SHA-1 commit ID (which can be abbreviated), but it can also be a tag or a branch name. If empty, the link will point to the next branch.
line
A line number. This should just be a single number, as SourceForge does not support multiple line numbers.
Note This parameter will not work if the linked file is of a certain file type, such as .nas. However, this is to do with SourceForge, not the template.

Examples

No parameters given

{{flightgear file}}

flightgear/

Path given

{{flightgear file|src/Main/main.cxx}}

flightgear/src/Main/main.cxx

Path and a commit reference given

{{flightgear file|src/Main/main.cxx|release/3.6.0}}

flightgear/src/Main/main.cxx (release/3.6.0)

{{flightgear file|src/Main/main.cxx|0a822f}}

flightgear/src/Main/main.cxx (0a822f)

{{flightgear file|src/Main/main.cxx|0a822fb412e2fcc44028bf5412710e2fb32dc96b}}

flightgear/src/Main/main.cxx (0a822fb412e2fcc44028bf5412710e2fb32dc96b)

Line parameter given

{{flightgear file|src/Main/main.cxx||7}}

flightgear/src/Main/main.cxx (line 7)

{{flightgear file|src/Main/main.cxx|0a822f|7}}

flightgear/src/Main/main.cxx (0a822f, line 7)

Related templates