Template:Simgear file: Difference between revisions
Jump to navigation
Jump to search
Red Leader (talk | contribs) m (typo) |
Red Leader (talk | contribs) m (Minor text changes) |
||
Line 25: | Line 25: | ||
Both parameters are optional. | Both parameters are optional. | ||
; path: What follows after <code>/tree/</code> in the URL. Can be the path to a file or a directory. If empty the link will point to the root of the SimGear repository. | ; path: What follows after <code>/tree/</code> in the URL. Can be the path to a file or a directory. If empty, the link will point to the root of the SimGear repository. | ||
; reference: A commit reference. Usually the SHA-1 commit | ; 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. | ||
== Examples == | == Examples == | ||
Line 54: | Line 54: | ||
== Related templates == | == Related templates == | ||
* {{tl|repo link}} | * {{tl|repo link}} | ||
* {{tl|flightgear file}} | |||
* {{tl|fgdata file}} | |||
}} | }} |
Revision as of 13:11, 14 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 SimGear repository.
Usage
{{simgear file|path|reference}}
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 SimGear 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.
Examples
No parameters given
{{simgear file}}
Path given
{{simgear file|simgear/canvas/Canvas.cxx}}
simgear/simgear/canvas/Canvas.cxx
Path and a commit reference given
{{simgear file|simgear/canvas/Canvas.cxx|release/2.12.0}}
simgear/simgear/canvas/Canvas.cxx (release/2.12.0)
{{simgear file|simgear/canvas/Canvas.cxx|4f94c222}}
simgear/simgear/canvas/Canvas.cxx (4f94c222)
{{simgear file|simgear/canvas/Canvas.cxx|4f94c22241e5ef90026fd087168b24a13ee5ef9b}}
simgear/simgear/canvas/Canvas.cxx (4f94c22241e5ef90026fd087168b24a13ee5ef9b)
Files not in simgear/
{{simgear file|version}}
Related templates
- {{repo link}}
- {{flightgear file}}
- {{fgdata file}}