Template:Readme file: Difference between revisions
Jump to navigation
Jump to search
m (Typo) |
(-doc: Simplifying a bit) |
||
| Line 31: | Line 31: | ||
; 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>. | ||
: For <code> | : For <code>model-combined.eff/README.model-combined.eff</code> you only have to specify '''model-combined.eff'''. | ||
; 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. | ||
Revision as of 15:11, 2 July 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.
- For
model-combined.eff/README.model-combined.effyou 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}}
- $FG_ROOT/Docs/README.logging
* {{readme file|commands|0591afe42cf7d78280f7999657034a6cf15a5649}}
- $FG_ROOT/Docs/README.commands
* {{readme file|materials|nopath=1}}