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
m (Catar for sub-folders (e.g., http://sourceforge.net/p/flightgear/fgdata/ci/next/tree/Docs/model-combined.eff/README.model-combined.eff))
m (Change (single case only))
Line 4: Line 4:
 
-->[[$FG_ROOT]]/Docs/<!--
 
-->[[$FG_ROOT]]/Docs/<!--
 
-->}}<!--
 
-->}}<!--
-->[http://sourceforge.net/p/flightgear/fgdata/ci/{{{3|next}}}/tree/Docs/{{{2|}}}<!--
+
-->[http://sourceforge.net/p/flightgear/fgdata/ci/{{{3|next}}}/tree/Docs/{{#ifeq: {{{1}}} | model-combined.eff | 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 --><!--
Line 17: Line 17:
  
 
== Usage ==
 
== Usage ==
  {{obr}}'''readme file'''{{!}}''file''{{!}}''folder''{{!}}''commit'' {{!}}''nopath''={{cbr}}
+
  {{obr}}'''readme file'''{{!}}''file''{{!}}''commit'' {{!}}''nopath''={{cbr}}
  
 
All 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>.
 
; folder:  Sub-folder containing the readme file, see example below.
 
  
 
; 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 32: Line 30:
 
  <nowiki>* {{readme file|logging}}</nowiki>
 
  <nowiki>* {{readme file|logging}}</nowiki>
 
* {{readme file|logging}}
 
* {{readme file|logging}}
 
<nowiki>* {{readme file|model-combined.eff|folder=model-combined.eff}}</nowiki>
 
* {{readme file|model-combined.eff|model-combined.eff}}
 
  
 
  <nowiki>* {{readme file|commands|3=0591afe42cf7d78280f7999657034a6cf15a5649}}</nowiki>
 
  <nowiki>* {{readme file|commands|3=0591afe42cf7d78280f7999657034a6cf15a5649}}</nowiki>

Revision as of 07:25, 30 June 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|3=0591afe42cf7d78280f7999657034a6cf15a5649}}
* {{readme file|materials|nopath=1}}