Hi fellow wiki editors!
To help newly registered users get more familiar with the wiki (and maybe older users too) there is now a {{Welcome to the wiki}} template. Have a look at it and feel free to add it to new users discussion pages (and perhaps your own).
I have tried to keep the template short, but meaningful. /Johan G
Difference between revisions of "Template:Readme file"
From FlightGear wiki
(Initial behavior of second parameter; Proper label for README.model-combined.eff; +doc: How to link to README.model-combined.eff) |
(Added {{repo link/doc related}} to the documentation.) |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 8: | Line 8: | ||
-->}}<!-- | -->}}<!-- | ||
-->}}<!-- | -->}}<!-- | ||
| − | -->[ | + | -->[{{fgdata source |
| − | + | | branch = {{{2|next}}} | |
| − | + | | path = Docs/<!-- | |
| − | + | -->{{#ifeq: {{{1}}} | model-combined.eff <!-- Is the file to link to README.model-combined.eff? --> | |
| − | + | | <!-- Yes, add the extra path --><!-- | |
| + | -->model-combined.eff/ | ||
| + | }}<!-- | ||
| + | -->README<!-- | ||
| + | -->{{#if: {{{1|}}} | .{{{1}}}}}<!-- Is the file defined? --> | ||
| + | | line{{#if:{{{line|}}}||NULL}} = {{{line}}} | ||
| + | | full = 1 | ||
| + | }} <!-- | ||
-->{{#if: {{{1|}}} <!-- Is the file defined? --> | -->{{#if: {{{1|}}} <!-- Is the file defined? --> | ||
| <!-- Yes, go to file path --><!-- | | <!-- Yes, go to file path --><!-- | ||
| − | --> | + | -->README.{{{1}}} |
| <!-- No, go to the deafult --><!-- | | <!-- No, go to the deafult --><!-- | ||
| − | -->README | + | -->README<!-- |
| − | -->}}<noinclude> | + | -->}}<!-- |
| + | -->{{#if: {{{line|}}} | #l{{{line}}}}}<!-- Show the line number. | ||
| + | -->]<noinclude> | ||
{{Informative template|1= | {{Informative template|1= | ||
__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 == | ||
| − | {{obr}}'''readme file'''{{!}}''file''{{!}}''commit'' {{!}}''nopath''={{cbr}} | + | {{obr}}'''readme file''' |
| + | {{!}} ''file'' | ||
| + | {{!}} ''commit'' | ||
| + | {{!}} ''line'' = | ||
| + | {{!}} ''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>$ | + | ; file: Readme file name, not including <code>README.</code>. If empty, the link will go to <code>$FG_ROOT/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. | ||
| + | |||
| + | ; line: Optional line number of the README file to jump to. | ||
; nopath: If not empty the path will not be shown. | ; nopath: If not empty the path will not be shown. | ||
| Line 46: | Line 62: | ||
<nowiki>* {{readme file|materials|nopath=1}}</nowiki> | <nowiki>* {{readme file|materials|nopath=1}}</nowiki> | ||
* {{readme file|materials|nopath=1}} | * {{readme file|materials|nopath=1}} | ||
| + | |||
| + | <nowiki>* {{readme file|gui|line=16}}</nowiki> | ||
| + | * {{readme file|gui|line=16}} | ||
| + | |||
| + | == Related templates == | ||
| + | {{repo link/doc related}} | ||
}} | }} | ||
| − | [[Category: | + | [[Category:Repository link templates]] |
</noinclude> | </noinclude> | ||
Latest revision as of 12:09, 7 March 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
| 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.effyou 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 file|gui|line=16}}
- $FG_ROOT/Docs/README.gui#l16
Related templates
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
