Template:Readme file

From FlightGear wiki
Revision as of 19:25, 29 February 2016 by Bugman (talk | contribs) (Independence of the template from SourceForge. The URL is now being generated by the {{fgdata source}} template, and the name SourceForge has been removed from the documentation.)
Jump to navigation Jump to search

$FG_ROOT/Docs/README

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

Goal

This template can be used to link to the readme files in $FG_ROOT/Docs in the FGData repository.

Usage

{{readme file|file|commit |nopath=}}

All parameters are optional.

file
Readme file name, not including README.. If empty, the link will go to $FG_DATA/Docs/README.
For model-combined.eff/README.model-combined.eff you only have to specify model-combined.eff.
commit
Optional SHA-1 commit reference to use instead of the latest commit.
nopath
If not empty the path will not be shown.

Examples

* {{readme file|logging}}

* {{readme file|commands|0591afe42cf7d78280f7999657034a6cf15a5649}}

* {{readme file|materials|nopath=1}}
Retrieved from "https://wiki.flightgear.org/w/index.php?title=Template:Readme_file&oldid=94385"