Changes

Template:Readme file

1,381 bytes added, 17:09, 7 March 2016
Added {{repo link/doc related}} to the documentation.
{{#if: {{{nopath|}}} <!-- Should the path be removed? --> | <!-- Yes, remove the path --> | <span style="font!-- No, keep the path --><!----size: 80%;">[[$FG_ROOT]]/Docs/</span!-- -->{{#ifeq: {{{1}}[http://sourceforge} | model-combined.net/p/flightgeareff <!-- Is the file to link to README.model-combined.eff? --> | <!-- Yes, add the extra path --><!-- -->model-combined.eff/<!-- -->}}<!---->}}<!---->[{{fgdata/ci/source | branch = {{{2|next}}}/tree/ | 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? --> | <!-- Yes, go to file path --><!---->README.{{{1}}} | <!-- No, go to the deafult --><!---->README<!---->}}<!---->{{#if: {{{line|}}} | &#35;l{{{line}}}}}<!-- Show the line number.-->]<noinclude>
{{Informative template|1=
__NOTOC__
== Goal ==
This template can be used to link to the readme files in [[$FG_ROOT]]/Docsin the FGData repository.
== Usage ==
{{obr}}'''readme file''' {{!}}''file path'' {{!}}''commit'' {{!}} ''line'' = {{!}}''nopath''= {{cbr}}
Both All parameters are optional.
; file path: Path and filename starting from but Readme file name, not including <code>/data/README.</code>. Defaults If empty, the link will go to '''<code>$FG_ROOT/Docs/README'''</code>.
; commit: Optional SHA For <code>model-1 commit reference combined.eff/README.model-combined.eff</code> you only have to use instead of the latest commitspecify '''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 ==
<nowiki>* {{readme file|README.logging}}</nowiki>* {{readme file|README.logging}}  <nowiki>* {{readme file|commands|0591afe42cf7d78280f7999657034a6cf15a5649}}</nowiki>* {{readme file|commands|0591afe42cf7d78280f7999657034a6cf15a5649}}  <nowiki>* {{readme file|materials|nopath=1}}</nowiki>* {{readme file|materials|nopath=1}}
<nowiki>* {{readme file|README.commandsgui|0591afe42cf7d78280f7999657034a6cf15a5649line=16}}</nowiki>* {{readme file|README.commandsgui|0591afe42cf7d78280f7999657034a6cf15a5649line=16}}
== Related templates ==
{{repo link/doc related}}
}}
[[Category:Link templatesRepository link templates‎]]
</noinclude>