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 (Usage: typo)
m (+-comments; indentation)
Line 1: Line 1:
 
{{#if: {{{nopath|}}} <!-- Should the path be removed? -->
 
{{#if: {{{nopath|}}} <!-- Should the path be removed? -->
| <!-- Yes, remove the path -->
+
| <!-- Yes, remove the path -->
| <!-- No, keep the path --><!--
+
| <!-- No, keep the path --><!--
--><span style="font-size: 80%;">[[$FG_ROOT]]/Docs/</span>}}[http://sourceforge.net/p/flightgear/fgdata/ci/{{{2|next}}}/tree/Docs/<!--
+
--><span style="font-size: 80%;">[[$FG_ROOT]]/Docs/</span><!--
-->{{#if: {{{1|}}} <!-- Should the default file be linked to? -->
+
-->}}<!--
| <!-- No, go to file path --><!--
+
-->[http://sourceforge.net/p/flightgear/fgdata/ci/{{{2|next}}}/tree/Docs/<!--
 +
-->{{#if: {{{1|}}} <!-- Is the file defined? -->
 +
| <!-- Yes, go to file path --><!--
 
-->README.{{{1}}} README.{{{1}}}]
 
-->README.{{{1}}} README.{{{1}}}]
| <!-- Yes, go to the deafult --><!--
+
| <!-- No, go to the deafult --><!--
 
-->README README]<!--
 
-->README README]<!--
 
-->}}<noinclude>
 
-->}}<noinclude>

Revision as of 10:12, 29 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}}