Template:Readme file

From FlightGear wiki

Jump to navigation Jump to search

$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
| line   =
| nopath =
}}

All parameters are optional.

file: Readme file name, not including README.. If empty, the link will go to $FG_ROOT/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.

line: Optional line number of the README file to jump to.

nopath: If not empty the path will not be shown.

Examples

* {{readme file|logging}}

$FG_ROOT/Docs/README.logging

* {{readme file|commands|0591afe42cf7d78280f7999657034a6cf15a5649}}

$FG_ROOT/Docs/README.commands

* {{readme file|materials|nopath=1}}

README.materials

* {{readme file|gui|line=16}}

$FG_ROOT/Docs/README.gui#l16

Related templates

The {{repo link}} family of templates

Master template

{{repo link}}

Source link templates

FlightGear repositories	{{flightgear source}} {{simgear source}} {{fgdata source}} {{fgaddon source}} {{fgcom source}} {{fgmeta source}} {{fgrun source}} {{getstart source}} {{openradar source}} {{sceneryweb source}} {{terragear source}} {{terrafs source}} {{windows-3rd-party source}}

Specialized templates	{{fgaddon aircraft source}} {{AircraftHangar}} {{fgdata-old source}}

Open source infrastructure repositories	{{sourceforge source}} {{github source}} {{gitlab source}} {{gitorious source}}

URL templates

FlightGear repositories	{{flightgear url}} {{simgear url}} {{fgdata url}} {{fgaddon url}} {{fgcom url}} {{fgmeta url}} {{fgrun url}} {{getstart url}} {{openradar url}} {{sceneryweb url}} {{terragear url}} {{terrafs url}} {{windows-3rd-party url}}

Specialized templates	{{fgaddon aircraft url}} {{fgdata-old url}} {{github issues url}} {{github wiki url}}

Open source infrastructure repositories	{{sourceforge url}} {{github url}} {{gitlab url}} {{gitorious url}}

Commit link templates

FlightGear repositories	{{flightgear commit}} {{simgear commit}} {{fgdata commit}} {{fgaddon commit}} (was {{fgaddon revision}}) {{fgcom commit}} {{fgmeta commit}} {{openradar commit}} {{sceneryweb commit}} {{terragear commit}} {{terrafs commit}} {{windows-3rd-party commit}}

Specialized templates	{{fgdata-old commit}}

Merge request templates

Open source infrastructure repositories	{{gitorious merge request}}

Obtaining a local copy
of the repository

FlightGear repositories	{{flightgear clone}} {{simgear clone}} {{fgdata clone}} {{fgaddon co}} (also {{fgaddon checkout}}) {{fgcom clone}} {{fgmeta clone}} {{openradar clone}} {{sceneryweb clone}} {{terragear clone}} {{terrafs clone}} {{windows-3rd-party clone}}

Specialized templates	{{fgdata-old clone}}

3rd party	{{openscenegraph co}}

Open source infrastructure repositories	{{sourceforge clone}} {{github clone}} {{gitlab clone}} {{gitorious clone}}

File link templates

Specific FlightGear files	{{readme file}} {{FG1000 file}}

Prefixed variable	{{fg root file}} {{fg src file}} {{sg src file}} {{fg aircraft file}} {{fgdata effect}}

Download templates	{{github zip file}} {{gitlab zip file}}

3rd party	{{OSG example}}

Other templates¹	{{flightgear file}} {{simgear file}} {{fgdata file}}

Documentation

{{repo link/doc}}

{{repo link/doc related}}

¹Note that the newer source link templates provide far greater functionality and these templates are not based on the master {{repo link}} template.

Retrieved from "https://wiki.flightgear.org/w/index.php?title=Template:Readme_file&oldid=95064"

Repository link templates