Template:Readme file: Difference between revisions

Jump to navigation Jump to search
Added {{repo link/doc related}} to the documentation.
(Making all of the path the same size)
(Added {{repo link/doc related}} to the documentation.)
 
(8 intermediate revisions by 3 users not shown)
Line 3: Line 3:
  | <!-- No, keep the path --><!--
  | <!-- No, keep the path --><!--
-->[[$FG_ROOT]]/Docs/<!--
-->[[$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/<!--
-->}}<!--
-->}}<!--
-->}}<!--
-->[http://sourceforge.net/p/flightgear/fgdata/ci/{{{2|next}}}/tree/Docs/<!--
-->[{{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}}} README.{{{1}}}]
-->README.{{{1}}}
  | <!-- No, go to the deafult --><!--
  | <!-- No, go to the deafult --><!--
-->README README]<!--
-->README<!--
-->}}<noinclude>
-->}}<!--
-->{{#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 in the SourceForge repository.
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>$FG_DATA/Docs/README</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>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 36: 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:Link templates]]
[[Category:Repository link templates‎]]
</noinclude>
</noinclude>

Navigation menu