Template:Readme file: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
m (Change (single case only))
(Initial behavior of second parameter; Proper label for README.model-combined.eff; +doc: How to link to README.model-combined.eff)
Line 3: Line 3:
  | <!-- No, keep the path --><!--
  | <!-- No, keep the path --><!--
-->[[$FG_ROOT]]/Docs/<!--
-->[[$FG_ROOT]]/Docs/<!--
-->{{#ifeq: {{{1}}} | model-combined.eff <!-- Is the file to link to README.model-combined.eff? -->
    | <!-- Yes, add the extra path --><!--
    -->model-combined.eff/<!--
-->}}<!--
-->}}<!--
-->}}<!--
-->[http://sourceforge.net/p/flightgear/fgdata/ci/{{{3|next}}}/tree/Docs/{{#ifeq: {{{1}}} | model-combined.eff | model-combined.eff/ }}<!--
-->[http://sourceforge.net/p/flightgear/fgdata/ci/{{{2|next}}}/tree/Docs/<!--
-->{{#ifeq: {{{1}}} | model-combined.eff <!-- Is the file to link to README.model-combined.eff? -->
    | <!-- Yes, add the extra path --><!--
    -->model-combined.eff/<!--
-->}}<!--
-->{{#if: {{{1|}}} <!-- Is the file defined? -->
-->{{#if: {{{1|}}} <!-- Is the file defined? -->
  | <!-- Yes, go to file path --><!--
  | <!-- Yes, go to file path --><!--
-->README.{{{1}}} README.{{{1}}}]
-->README.{{{1}}} README.{{{1}}}
  | <!-- No, go to the deafult --><!--
  | <!-- No, go to the deafult --><!--
-->README README]<!--
-->README README]<!--
Line 22: Line 30:


; 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>.
:          For <code>[[$FG_ROOT]]/Docs/model-combined.eff/README.model-combined.eff</code> you only have to specify '''model-combined.eff'''.


; commit:  Optional SHA-1 commit reference to use instead of the latest commit.
; commit:  Optional SHA-1 commit reference to use instead of the latest commit.
Line 31: Line 41:
* {{readme file|logging}}
* {{readme file|logging}}


  <nowiki>* {{readme file|commands|3=0591afe42cf7d78280f7999657034a6cf15a5649}}</nowiki>
  <nowiki>* {{readme file|commands|0591afe42cf7d78280f7999657034a6cf15a5649}}</nowiki>
* {{readme file|commands|3=0591afe42cf7d78280f7999657034a6cf15a5649}}
* {{readme file|commands|0591afe42cf7d78280f7999657034a6cf15a5649}}


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

Revision as of 15:08, 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}}