Hi fellow wiki editors!

To help newly registered users get more familiar with the wiki (and maybe older users too) there is now a {{Welcome to the wiki}} template. Have a look at it and feel free to add it to new users discussion pages (and perhaps your own).

I have tried to keep the template short, but meaningful. /Johan G

Template:Readme file

From FlightGear wiki
Revision as of 11:59, 19 May 2015 by Johan G (Talk | contribs) (+ 'nopath' example)

Jump to: navigation, 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.

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}}