Template:Readme file: Difference between revisions

Jump to navigation Jump to search
Added {{repo link/doc related}} to the documentation.
(+ 'nopath' example)
(Added {{repo link/doc related}} to the documentation.)
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{#if: {{{nopath|}}} | | <span style="font-size: 80%;">[[$FG_ROOT]]/Docs/</span>}}[http://sourceforge.net/p/flightgear/fgdata/ci/{{{2|next}}}/tree/Docs/{{{1|README}}} {{{1|README}}}]<noinclude>
{{#if: {{{nopath|}}} <!-- Should the path be removed? -->
| <!-- Yes, remove the path -->
| <!-- No, keep the path --><!--
-->[[$FG_ROOT]]/Docs/<!--
-->{{#ifeq: {{{1}}} | model-combined.eff <!-- Is the file to link to README.model-combined.eff? -->
    | <!-- Yes, add the extra path --><!--
    -->model-combined.eff/<!--
-->}}<!--
-->}}<!--
-->[{{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? -->
| <!-- 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=
{{Informative template|1=
__NOTOC__
__NOTOC__
== Goal ==
== Goal ==
This template can be used to link to the readme files in [[$FG_ROOT]]/Docs.
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 path''{{!}}''commit'' {{!}}''nopath''={{cbr}}
  {{obr}}'''readme file'''
{{!}} ''file''
{{!}} ''commit''
{{!}} ''line''  =
{{!}} ''nopath'' =
{{cbr}}


Both parameters are optional.
All parameters are optional.


; file path: Path and filename starting from but not including <code>/data/</code>. Defaults to '''README'''.
; file:   Readme file name, not including <code>README.</code>. If empty, the link will go to <code>$FG_ROOT/Docs/README</code>.


; commit:     Optional SHA-1 commit reference to use instead of the latest commit.
:         For <code>model-combined.eff/README.model-combined.eff</code> you only have to specify '''model-combined.eff'''.


; nopath:     If not empty the path will not be shown.
; 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 ==
== Examples ==
  <nowiki>* {{readme file|README.logging}}</nowiki>
  <nowiki>* {{readme file|logging}}</nowiki>
* {{readme file|README.logging}}
* {{readme file|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.commands|0591afe42cf7d78280f7999657034a6cf15a5649}}</nowiki>
  <nowiki>* {{readme file|gui|line=16}}</nowiki>
* {{readme file|README.commands|0591afe42cf7d78280f7999657034a6cf15a5649}}
* {{readme file|gui|line=16}}


<nowiki>* {{readme file|README.materials|nopath=1}}</nowiki>
== Related templates ==
* {{readme file|README.materials|nopath=1}}
{{repo link/doc related}}


}}
}}


[[Category:Link templates]]
[[Category:Repository link templates‎]]
</noinclude>
</noinclude>

Navigation menu