Template:Readme file: Difference between revisions
Jump to navigation
Jump to search
m (+-cat) |
(Independence of the template from SourceForge. The URL is now being generated by the {{fgdata source}} template, and the name SourceForge has been removed from the documentation.) |
||
| Line 8: | Line 8: | ||
-->}}<!-- | -->}}<!-- | ||
-->}}<!-- | -->}}<!-- | ||
-->[ | -->[{{fgdata source|branch={{{2|next}}}|path=Docs|full=1}}/<!-- | ||
-->{{#ifeq: {{{1}}} | model-combined.eff <!-- Is the file to link to README.model-combined.eff? --> | -->{{#ifeq: {{{1}}} | model-combined.eff <!-- Is the file to link to README.model-combined.eff? --> | ||
| <!-- Yes, add the extra path --><!-- | | <!-- Yes, add the extra path --><!-- | ||
| Line 22: | Line 22: | ||
__NOTOC__ | __NOTOC__ | ||
== Goal == | == Goal == | ||
This template can be used to link to the readme files in [[$FG_ROOT]]/Docs in the | This template can be used to link to the readme files in [[$FG_ROOT]]/Docs in the FGData repository. | ||
== Usage == | == Usage == | ||
Revision as of 19:25, 29 February 2016
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 |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}}