Template:Readme file: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
(Initial behavior of second parameter; Proper label for README.model-combined.eff; +doc: How to link to README.model-combined.eff)
m (Typo)
Line 17: Line 17:
-->README.{{{1}}} README.{{{1}}}
-->README.{{{1}}} README.{{{1}}}
  | <!-- No, go to the deafult --><!--
  | <!-- No, go to the deafult --><!--
-->README README]<!--
-->README README<!--
-->}}<noinclude>
-->}}]<noinclude>
{{Informative template|1=
{{Informative template|1=
__NOTOC__
__NOTOC__

Revision as of 15:09, 2 July 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.
For $FG_ROOT/Docs/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.
nopath
If not empty the path will not be shown.

Examples

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