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 (+-cat)
(Independence of the template from SourceForge. The URL is now being generated by the {{fgdata source}} template, and the name SourceForge has been removed from the documentation.)
Line 8: Line 8:
 
  -->}}<!--
 
  -->}}<!--
 
-->}}<!--
 
-->}}<!--
-->[http://sourceforge.net/p/flightgear/fgdata/ci/{{{2|next}}}/tree/Docs/<!--
+
-->[{{fgdata source|branch={{{2|next}}}|path=Docs|full=1}}/<!--
 
  -->{{#ifeq: {{{1}}} | model-combined.eff <!-- Is the file to link to README.model-combined.eff? -->
 
  -->{{#ifeq: {{{1}}} | model-combined.eff <!-- Is the file to link to README.model-combined.eff? -->
 
     | <!-- Yes, add the extra path --><!--
 
     | <!-- Yes, add the extra path --><!--
Line 22: Line 22:
 
__NOTOC__
 
__NOTOC__
 
== Goal ==
 
== Goal ==
This template can be used to link to the readme files in [[$FG_ROOT]]/Docs in the SourceForge repository.
+
This template can be used to link to the readme files in [[$FG_ROOT]]/Docs in the FGData repository.
  
 
== Usage ==
 
== Usage ==

Revision as of 14:25, 29 February 2016

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