Template:Readme file: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
(Created page with "{{#if: {{{nopath|}}} | | <span style="font-size: 80%;">$FG_ROOT/Docs/</span>}}[http://sourceforge.net/p/flightgear/fgdata/ci/{{{2|next}}}/tree/Docs/{{{1|README}}} {{{1|REA...")
 
(+ 'nopath' example)
Line 23: Line 23:
* {{readme file|README.commands|0591afe42cf7d78280f7999657034a6cf15a5649}}
* {{readme file|README.commands|0591afe42cf7d78280f7999657034a6cf15a5649}}


<nowiki>* {{readme file|README.materials|nopath=1}}</nowiki>
* {{readme file|README.materials|nopath=1}}


}}
}}

Revision as of 16:59, 19 May 2015

$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.

Usage

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

Both parameters are optional.

file path
Path and filename starting from but not including /data/. Defaults to README.
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|README.logging}}
* {{readme file|README.commands|0591afe42cf7d78280f7999657034a6cf15a5649}}
* {{readme file|README.materials|nopath=1}}