Template:Flightgear file: Difference between revisions
Jump to navigation
Jump to search
Red Leader (talk | contribs) m (Minor text changes) |
Red Leader (talk | contribs) (Add line parameter; slightly shorten abbreviated commit IDs to match the SF abbreviation; add link to {{fgaddon url}}) |
||
| Line 6: | Line 6: | ||
| <!-- Yes. Add a trailing slash and tilde after the reference (needed for the SourceForge URL). --><!-- | | <!-- Yes. Add a trailing slash and tilde after the reference (needed for the SourceForge URL). --><!-- | ||
-->/~ | -->/~ | ||
}}/tree/{{{1|}}} flightgear/{{{1|}}}] ({{{2}}}) | }}/tree/{{{1|}}}<!-- | ||
-->{{#if: {{{3|}}} <!-- Is a line defined? --> | |||
| #l{{{3}}} | |||
}} flightgear/{{{1|}}}] ({{{2}}}{{#if: {{{3|}}} | , line {{{3}}} }}) | |||
| <!-- No, a commit reference is not defined. Fall back on "next" and do not display commit reference. --><!-- | | <!-- No, a commit reference is not defined. Fall back on "next" and do not display commit reference. --><!-- | ||
-->next/tree/{{{1|}}} flightgear/{{{1|}}}] | -->next/tree/{{{1|}}}<!-- | ||
-->{{#if: {{{3|}}} <!-- Is a line defined? --> | |||
| #l{{{3}}} | |||
}} flightgear/{{{1|}}}]{{#if: {{{3|}}} | (line {{{3}}}) }} | |||
}}<noinclude> | }}<noinclude> | ||
{{Informative template|1= | {{Informative template|1= | ||
| Line 16: | Line 22: | ||
== Usage == | == Usage == | ||
{{obr}}'''flightgear file'''{{!}}''path''{{!}}''reference''{{cbr}} | {{obr}}'''flightgear file'''{{!}}''path''{{!}}''reference''{{!}}''line''{{cbr}} | ||
Both parameters are optional. | Both parameters are optional. | ||
| Line 23: | Line 29: | ||
; 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. | ; 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. | |||
: {{inote|This parameter will not work if the linked file is of a certain file type, such as <code>.nas</code>. However, this is to do with SourceForge, not the template.}} | |||
== Examples == | == Examples == | ||
| Line 37: | Line 46: | ||
{{flightgear file|src/Main/main.cxx|release/3.6.0}} | {{flightgear file|src/Main/main.cxx|release/3.6.0}} | ||
{{obr}}flightgear file{{!}}src/Main/main.cxx{{!}} | {{obr}}flightgear file{{!}}src/Main/main.cxx{{!}}0a822f{{cbr}} | ||
{{flightgear file|src/Main/main.cxx| | {{flightgear file|src/Main/main.cxx|0a822f}} | ||
{{obr}}flightgear file{{!}}src/Main/main.cxx{{!}}0a822fb412e2fcc44028bf5412710e2fb32dc96b{{cbr}} | {{obr}}flightgear file{{!}}src/Main/main.cxx{{!}}0a822fb412e2fcc44028bf5412710e2fb32dc96b{{cbr}} | ||
{{flightgear file|src/Main/main.cxx|0a822fb412e2fcc44028bf5412710e2fb32dc96b}} | {{flightgear file|src/Main/main.cxx|0a822fb412e2fcc44028bf5412710e2fb32dc96b}} | ||
=== Line parameter given === | |||
{{obr}}flightgear file{{!}}src/Main/main.cxx{{!}}{{!}}7{{cbr}} | |||
{{flightgear file|src/Main/main.cxx||7}} | |||
{{obr}}flightgear file{{!}}src/Main/main.cxx{{!}}0a822f{{!}}7{{cbr}} | |||
{{flightgear file|src/Main/main.cxx|0a822f|7}} | |||
== Related templates == | == Related templates == | ||
| Line 47: | Line 63: | ||
* {{tl|simgear file}} | * {{tl|simgear file}} | ||
* {{tl|fgdata file}} | * {{tl|fgdata file}} | ||
* {{tl|fgaddon url}} | |||
}} | }} | ||
Revision as of 10:37, 25 September 2015
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}}
Path given
{{flightgear file|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
- {{repo link}}
- {{simgear file}}
- {{fgdata file}}
- {{fgaddon url}}