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

Difference between revisions of "Template:Readme file"

From FlightGear wiki
Jump to: navigation, search
(Removing unnecessary README. prefix; clarification)
m (Usage: typo)
Line 17: Line 17:
 
  {{obr}}'''readme file'''{{!}}''file''{{!}}''commit'' {{!}}''nopath''={{cbr}}
 
  {{obr}}'''readme file'''{{!}}''file''{{!}}''commit'' {{!}}''nopath''={{cbr}}
  
Both parameters are optional.
+
All parameters are optional.
  
 
; file:    Readme file name, not including <code>README.</code>.  If empty the link will go to <code>$FG_DATA/Docs/README</code>
 
; file:    Readme file name, not including <code>README.</code>.  If empty the link will go to <code>$FG_DATA/Docs/README</code>

Revision as of 08:02, 23 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 in the SourceForge 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
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}}