Template:Readme file: Difference between revisions
Jump to navigation
Jump to search
(Removing unnecessary README. prefix; clarification) |
m (→Usage: typo) |
||
Line 17: | Line 17: | ||
{{obr}}'''readme file'''{{!}}''file''{{!}}''commit'' {{!}}''nopath''={{cbr}} | {{obr}}'''readme file'''{{!}}''file''{{!}}''commit'' {{!}}''nopath''={{cbr}} | ||
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> |
Revision as of 13:02, 23 May 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|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}}
- $FG_ROOT/Docs/README.logging
* {{readme file|commands|0591afe42cf7d78280f7999657034a6cf15a5649}}
- $FG_ROOT/Docs/README.commands
* {{readme file|materials|nopath=1}}