Difference between revisions of "Template:Readme file"

From FlightGear wiki
Jump to: navigation, search
(Added the 'line' parameter as this is used by some wiki pages with broken Gitorious links. This is passed into {{fgdata source}}, but required a small redesign to have the full path handed by template.)
(Added {{repo link/doc related}} to the documentation.)
Line 65: Line 65:
  <nowiki>* {{readme file|gui|line=16}}</nowiki>
  <nowiki>* {{readme file|gui|line=16}}</nowiki>
* {{readme file|gui|line=16}}
* {{readme file|gui|line=16}}
== Related templates ==
{{repo link/doc related}}

Latest revision as of 12:09, 7 March 2016


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


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


{{readme file
| file
| commit
| line   =
| nopath =

All parameters are optional.

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


* {{readme file|logging}}
* {{readme file|commands|0591afe42cf7d78280f7999657034a6cf15a5649}}
* {{readme file|materials|nopath=1}}
* {{readme file|gui|line=16}}

Related templates