Template:Readme file: Difference between revisions
Jump to navigation
Jump to search
(Making all of the path the same size) |
Red Leader (talk | contribs) m (Catar for sub-folders (e.g., http://sourceforge.net/p/flightgear/fgdata/ci/next/tree/Docs/model-combined.eff/README.model-combined.eff)) |
||
| Line 4: | Line 4: | ||
-->[[$FG_ROOT]]/Docs/<!-- | -->[[$FG_ROOT]]/Docs/<!-- | ||
-->}}<!-- | -->}}<!-- | ||
-->[http://sourceforge.net/p/flightgear/fgdata/ci/{{{ | -->[http://sourceforge.net/p/flightgear/fgdata/ci/{{{3|next}}}/tree/Docs/{{{2|}}}<!-- | ||
-->{{#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''{{!}}''commit'' {{!}}''nopath''={{cbr}} | {{obr}}'''readme file'''{{!}}''file''{{!}}''folder''{{!}}''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 31: | Line 33: | ||
* {{readme file|logging}} | * {{readme file|logging}} | ||
<nowiki>* {{readme file|commands|0591afe42cf7d78280f7999657034a6cf15a5649}}</nowiki> | <nowiki>* {{readme file|model-combined.eff|folder=model-combined.eff}}</nowiki> | ||
* {{readme file|commands|0591afe42cf7d78280f7999657034a6cf15a5649}} | * {{readme file|model-combined.eff|model-combined.eff}} | ||
<nowiki>* {{readme file|commands|3=0591afe42cf7d78280f7999657034a6cf15a5649}}</nowiki> | |||
* {{readme file|commands|3=0591afe42cf7d78280f7999657034a6cf15a5649}} | |||
<nowiki>* {{readme file|materials|nopath=1}}</nowiki> | <nowiki>* {{readme file|materials|nopath=1}}</nowiki> | ||
Revision as of 12:23, 30 June 2015
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|folder|commit |nopath=}}
All parameters are optional.
- file
- Readme file name, not including
README.. If empty, the link will go to$FG_DATA/Docs/README.
- folder
- Sub-folder containing the readme file, see example below.
- 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}}
- $FG_ROOT/Docs/README.logging
* {{readme file|model-combined.eff|folder=model-combined.eff}}
* {{readme file|commands|3=0591afe42cf7d78280f7999657034a6cf15a5649}}
- $FG_ROOT/Docs/README.commands
* {{readme file|materials|nopath=1}}