Open main menu

Template:Readme file

Revision as of 08:37, 1 March 2016 by Bugman (Talk | contribs) (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.)

Revision as of 08:37, 1 March 2016 by Bugman (Talk | contribs) (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.)

$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
| line   =
| nopath =
}}

All parameters are optional.

file
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.
commit
Optional SHA-1 commit reference to use instead of the latest commit.
line
Optional line number of the README file to jump to.
nopath
If not empty the path will not be shown.

Examples

* {{readme file|logging}}

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

* {{readme file|materials|nopath=1}}

* {{readme file|gui|line=16}}
Last modified on 7 March 2016, at 12:09