Template:Repo link/doc usage: Difference between revisions

Jump to navigation Jump to search

Template:Repo link/doc usage (view source)

Revision as of 15:05, 5 March 2016

4,826 bytes added ,  5 March 2016
For a large simplification of the output, the descriptions have been merged into the parameter table, a column for the parameter status has been added, and the usage of this template is better documented.
(Switched to a sortable wikitable for the parameter shortcuts.)
(For a large simplification of the output, the descriptions have been merged into the parameter table, a column for the parameter status has been added, and the usage of this template is better documented.)
Line 44: Line 44:
  }}
  }}
  {{cbr}}
  {{cbr}}
{{#if: {{{intro|}}} |
{{{intro}}}


}}{{#ifeq: {{{site|}}} | 1 |
{{{intro|}}}
; site: Points the template to a repository host:
 
{| class="wikitable sortable"
! Parameter
! Description
! Abbreviated<br/>parameter
! Numbered<br/>parameter
! Status
{{#ifeq: {{{site|}}} | 1 |
<tr>
{{!}} {{param|site}}
{{!}} Points the template to a repository host:
:* For [[SourceForge]] use either '''s''', '''sf''' or '''sourceforge'''.
:* For [[SourceForge]] use either '''s''', '''sf''' or '''sourceforge'''.
:* For [[GitHub]] use either '''gh''', '''gith''' or '''github'''.
:* For [[GitHub]] use either '''gh''', '''gith''' or '''github'''.
Line 54: Line 62:
:* For the [[Gitorious]] archive use either '''g''', '''gito''' or '''gitorious'''.
:* For the [[Gitorious]] archive use either '''g''', '''gito''' or '''gitorious'''.
:* For generic repositories, the '''site''' parameter will be interpreted as the domain name.
:* For generic repositories, the '''site''' parameter will be interpreted as the domain name.
 
  {{!}} style="text-align: center" {{!}} {{#if: {{{short_site|}}} | {{param|{{{short_site}}}}}}}
}}{{#ifeq: {{{cmd|}}} | 1 |
  {{!}} style="text-align: center" {{!}} {{#if: {{{pos_site|}}} | {{param|{{{pos_site}}}}}}}
; cmd: An optional command line tool name + options to prepend to the URL.  For example '''{{{eg_cmd|git clone}}}'''.
  {{!}} style="text-align: center" {{!}} {{{stat_site|mandatory}}}
 
}}{{#ifeq: {{{opt|}}} | 1 |
; opt: Any additional options to show after '''cmd''', if supplied.
: {{inote|Developer note: This is for future non-CLI handling of a standardised set of '''cmd''' parameter values}}
 
}}{{#ifeq: {{{protocol|}}} | 1 |
; protocol: The URL protocol, for example '''https''', '''http''', '''ssh'''{{#if:{{{git|}}}|, '''git'''}}{{#if:{{{svn|}}}|, '''svn'''}}.  This defaults to '''{{{default_protocol|https}}}'''.
 
}}{{#ifeq: {{{login|}}} | 1 |
; login: The optional user login. This should not to be confused with the '''user''' parameter.
 
}}{{#ifeq: {{{type|}}} | 1 |
; type: <!--
-->{{#ifeq: {{{gh|{{{gl|}}}}}} | 1
    | Choose between the web interface, a direct repository link, or a zip file download.
    | Choose between the web interface or a direct repository link.
  }} <!--
-->This can be one of<!--
-->{{#ifeq: {{{git|}}} | 1
    |<nowiki></nowiki> '''git''', '''git web'''<!--
  -->{{#ifeq: {{{svn|{{{gh|{{{gl|}}}}}}}}} | 1 |, <nowiki></nowiki>}}
  }}<!--
-->{{#ifeq: {{{svn|}}} | 1
    |<nowiki></nowiki> '''svn''', '''svn web'''<!--
  -->{{#ifeq: {{{gh|{{{gl|}}}}}} | 1 |, <nowiki></nowiki>}}
  }}<!--
-->{{#ifeq: {{{gh|{{{gl|}}}}}} | 1 |<nowiki></nowiki>'''zip'''<!--
  -->. See the [[#Download templates|<nowiki>{{* zip file}}</nowiki> templates]] for a simplified interface for the zip files
  }}. <!--
-->The default is '''{{{default_type|{{#ifeq:{{{git|}}}|1|git web|svn web}}}}}'''.
{{#ifeq: {{{sf|{{{go|}}}}}} | 1
  | {{#ifeq: {{{gh|{{{gl|}}}}}} | 1
      |: {{inote|Zip archive downloads are currently only supported for <!--
  -->{{#ifeq: {{{gh|}}}          | 1 |GitHub}}<!--
  -->{{#ifeq: {{{gh|{{{gl|}}}}}} | 1 |<nowiki></nowiki> and <nowiki></nowiki>}}<!--
  -->{{#ifeq: {{{gl|}}}          | 1 |GitLab}} repositories.}}
    }}
}}
 
}}{{#ifeq: {{{user|}}} | 1 |
; user: The name of the user page for the open source infrastructure.  This is notably different to the '''login''' parameter.  This will generally have precedence over the '''proj''' parameter.  The user page is treated in the same way as a project name.
 
}}{{#ifeq: {{{proj|}}} | 1 |
; proj: The name of the project, consisting of a grouping of repositories on the open source infrastructure.  This defaults to '''{{{default_proj|flightgear}}}'''.
 
}}{{#ifeq: {{{repo|}}} | 1 |
; repo: The name of the repository, for example '''fgdata'''.  A project registered on one of the open source infrastructures generally allows for multiple repositories under that project name. This defaults to '''{{{default_repo|flightgear}}}'''.
 
}}{{#ifeq: {{{branch|}}} | 1 |
; branch: The branch name. <!--
-->{{#if: {{{svn|}}} | As tags are simply branches in SVN repositories, this parameter can also be used for svn tags. <nowiki></nowiki>}}<!--
-->{{#if: {{{git|}}} | For git tags, simply append <code>/~</code> to the tag name. <nowiki></nowiki>}}<!--
-->{{#if: {{{git|}}}
    | {{#if: {{{svn|}}}
        | This defaults to '''next''' or '''trunk''' for git and svn respectively. <nowiki></nowiki>
        | This defaults to '''next'''. <nowiki></nowiki>
      }}
    | {{#if: {{{svn|}}}
        | This defaults to '''trunk'''. <nowiki></nowiki>
      }}
  }}
 
}}{{#ifeq: {{{tag|}}} | 1 |
; tag: Reserved for future use.  This will be used for a situation in which tags and branches are treated differently by an open source infrastructure site.
 
}}{{#ifeq: {{{path|}}} | 1 |
; path: The file path.
 
}}{{#ifeq: {{{commit|}}} | 1 |
; commit: The commit identifier<!--
-->{{#if: {{{git|}}}
    | {{#if: {{{svn|}}}
        |<nowiki></nowiki> (git hash or svn revision number).  This defaults to '''next''' and '''HEAD''' for git and svn respectively.
        |<nowiki></nowiki> (git hash).  This defaults to '''next'''.
      }}
    | {{#if: {{{svn|}}}
        |<nowiki></nowiki> (svn revision number).  This defaults to '''HEAD'''.
        |.
      }}
  }}
 
}}{{#ifeq: {{{line|}}} | 1 |
; line: The line number(s) of the file to display.
{{#ifeq: {{{sf|{{{go|}}}}}} | 1 |
:* For {{#ifeq: {{{sf|}}} | 1
        | SourceForge<!--
      -->{{#ifeq: {{{go|}}} | 1 |<nowiki></nowiki> and <nowiki></nowiki>}}
      }}<!--
    -->{{#ifeq: {{{go|}}} | 1 | the Gitorious archive}}<!--
    -->:  Use a single line number.
}}{{#ifeq: {{{gh|}}} | 1 |
:* For GitHub either use:
:** A single line number, for example '''2'''.
:** Two line numbers separated with a hyphen ('''-'''), for example '''3-10'''.
}}
 
}}{{#ifeq: {{{post|}}} | 1 |
; post: Text to append.  This is forms a set with to the '''cmd''' and '''opt''' parameters.  For example it can represent any command line options that come after the URL.
 
}}{{#ifeq: {{{view|}}} | 1 |
; view:  View to display:
{{#ifeq: {{{sf|}}} | 1 |
:* For SourceForge use one of '''tree''', '''log''', '''commit''', or '''rss'''.  The default is '''tree'''.
}}{{#ifeq: {{{gh|}}} | 1 |
:* For GitHub use one of '''blob''', '''blame''', '''commit''', '''commits''' or '''raw'''.  The default is '''tree'''.
}}{{#ifeq: {{{gl|}}} | 1 |
:* The GitLab interface for '''type=git web''' is not yet implemented in the master {{tl|repo link}} template, so the '''view''' parameter currently does nothing.
}}{{#ifeq: {{{go|}}} | 1 |
:* For the Gitorious archive use one of '''summary''', '''shortlog''', '''log''', '''blob''', '''commit''', '''commitdiff''', '''tree''', '''history''', or '''raw'''. The default is '''blob''' if a path is given, '''commit''' if a commit is given, or '''summary''' otherwise.
}}
 
}}{{#ifeq: {{{text|}}} | 1 |
; text: Text to display as the link label.  Overrides '''pre'''.
 
}}{{#ifeq: {{{pre|}}} | 1 |
; pre: Prefix to a link label.
 
}}{{#ifeq: {{{simplepath|}}} | 1 |
; simplepath:  If set, this strips off the repository name from the URL label, leaving just the contents of the '''path''' parameter.
: {{inote|The ''text'' parameter will override this.}}
 
}}{{#ifeq: {{{full|}}} | 1 |
; full: If set, the full URL will be shown rather than any text label.
}}<!--
 
 
-->
{{#if: {{{shortcut|}}} |=== The Parameter shortcuts ===}}
{| class="wikitable sortable" style="text-align: center; {{#if: {{{shortcut|}}} | | display: none;}}"
! style="width: 33%" | Parameter
! style="width: 33%" | Abbreviated parameter
! style="width: 33%" | Numbered/positional parameter
{{#ifeq: {{{site|}}} | 1 |
<tr>
{{!}} {{param|site}}
{{!}} {{#if: {{{short_site|}}} | {{param|{{{short_site}}}}}}}
{{!}} {{#if: {{{pos_site|}}} | {{param|{{{pos_site}}}}}}}
  </tr>
  </tr>
}}{{#ifeq: {{{cmd|}}} | 1 |
}}{{#ifeq: {{{cmd|}}} | 1 |
  <tr>
  <tr>
  {{!}} {{param|cmd}}
  {{!}} {{param|cmd}}
  {{!}} {{#if: {{{short_cmd|}}} | {{param|{{{short_cmd}}}}}}}
  {{!}} An optional command line tool name + options to prepend to the URL.  For example '''{{{eg_cmd|git clone}}}'''.
  {{!}} {{#if: {{{pos_cmd|}}} | {{param|{{{pos_cmd}}}}}}}
{{!}} style="text-align: center" {{!}} {{#if: {{{short_cmd|}}} | {{param|{{{short_cmd}}}}}}}
  {{!}} style="text-align: center" {{!}} {{#if: {{{pos_cmd|}}} | {{param|{{{pos_cmd}}}}}}}
{{!}} style="text-align: center" {{!}} {{{stat_cmd|optional}}}
  </tr>
  </tr>
}}{{#ifeq: {{{opt|}}} | 1 |
}}{{#ifeq: {{{opt|}}} | 1 |
  <tr>
  <tr>
  {{!}} {{param|opt}}
  {{!}} {{param|opt}}
  {{!}} {{#if: {{{short_opt|}}} | {{param|{{{short_opt}}}}}}}
  {{!}} Any additional options to show after '''cmd''', if supplied.
  {{!}} {{#if: {{{pos_opt|}}} | {{param|{{{pos_opt}}}}}}}
: {{inote|Developer note: This is for future non-CLI handling of a standardised set of '''cmd''' parameter values}}
{{!}} style="text-align: center" {{!}} {{#if: {{{short_opt|}}} | {{param|{{{short_opt}}}}}}}
  {{!}} style="text-align: center" {{!}} {{#if: {{{pos_opt|}}} | {{param|{{{pos_opt}}}}}}}
{{!}} style="text-align: center" {{!}} {{{stat_opt|optional}}}
</tr>
}}{{#ifeq: {{{protocol|}}} | 1 |
<tr>
{{!}} {{param|protocol}}
{{!}} The URL protocol, for example '''https''', '''http''', '''ssh'''{{#if:{{{git|}}}|, '''git'''}}{{#if:{{{svn|}}}|, '''svn'''}}.  This defaults to '''{{{default_protocol|https}}}'''.
{{!}} style="text-align: center" {{!}} {{#if: {{{short_protocol|}}} | {{param|{{{short_protocol}}}}}}}
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_protocol|}}} | {{param|{{{pos_protocol}}}}}}}
{{!}} style="text-align: center" {{!}} {{{stat_protocol|optional}}}
</tr>
}}{{#ifeq: {{{login|}}} | 1 |
<tr>
{{!}} {{param|login}}
{{!}} The optional user login.  This should not to be confused with the '''user''' parameter.
{{!}} style="text-align: center" {{!}} {{#if: {{{short_login|}}} | {{param|{{{short_login}}}}}}}
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_login|}}} | {{param|{{{pos_login}}}}}}}
{{!}} style="text-align: center" {{!}} {{{stat_login|optional}}}
  </tr>
  </tr>
}}{{#ifeq: {{{type|}}} | 1 |
}}{{#ifeq: {{{type|}}} | 1 |
  <tr>
  <tr>
  {{!}} {{param|type}}
  {{!}} {{param|type}}
  {{!}} {{#if: {{{short_type|}}} | {{param|{{{short_type}}}}}}}
  {{!}} {{#ifeq: {{{gh|{{{gl|}}}}}} | 1
  {{!}} {{#if: {{{pos_type|}}} | {{param|{{{pos_type}}}}}}}
        | Choose between the web interface, a direct repository link, or a zip file download.
        | Choose between the web interface or a direct repository link.
      }} <!--
    -->This can be one of<!--
    -->{{#ifeq: {{{git|}}} | 1
        |<nowiki></nowiki> '''git''', '''git web'''<!--
      -->{{#ifeq: {{{svn|{{{gh|{{{gl|}}}}}}}}} | 1 |, <nowiki></nowiki>}}
      }}<!--
    -->{{#ifeq: {{{svn|}}} | 1
        |<nowiki></nowiki> '''svn''', '''svn web'''<!--
      -->{{#ifeq: {{{gh|{{{gl|}}}}}} | 1 |, <nowiki></nowiki>}}
      }}<!--
    -->{{#ifeq: {{{gh|{{{gl|}}}}}} | 1 |<nowiki></nowiki>'''zip'''<!--
      -->. See the [[#Download templates|<nowiki>{{* zip file}}</nowiki> templates]] for a simplified interface for the zip files
      }}. <!--
    -->The default is '''{{{default_type|{{#ifeq:{{{git|}}}|1|git web|svn web}}}}}'''.
      {{#ifeq: {{{sf|{{{go|}}}}}} | 1
        | {{#ifeq: {{{gh|{{{gl|}}}}}} | 1
            |: {{inote|Zip archive downloads are currently only supported for <!--
          -->{{#ifeq: {{{gh|}}}          | 1 |GitHub}}<!--
          -->{{#ifeq: {{{gh|{{{gl|}}}}}} | 1 |<nowiki></nowiki> and <nowiki></nowiki>}}<!--
          -->{{#ifeq: {{{gl|}}}          | 1 |GitLab}} repositories.}}
          }}
      }}
{{!}} style="text-align: center" {{!}} {{#if: {{{short_type|}}} | {{param|{{{short_type}}}}}}}
  {{!}} style="text-align: center" {{!}} {{#if: {{{pos_type|}}} | {{param|{{{pos_type}}}}}}}
{{!}} style="text-align: center" {{!}} {{{stat_type|optional}}}
  </tr>
  </tr>
}}{{#ifeq: {{{user|}}} | 1 |
}}{{#ifeq: {{{user|}}} | 1 |
  <tr>
  <tr>
  {{!}} {{param|user}}
  {{!}} {{param|user}}
  {{!}} {{#if: {{{short_user|}}} | {{param|{{{short_user}}}}}}}
  {{!}} The name of the user page for the open source infrastructure.  This is notably different to the '''login''' parameter.  This will generally have precedence over the '''proj''' parameter.  The user page is treated in the same way as a project name.
  {{!}} {{#if: {{{pos_user|}}} | {{param|{{{pos_user}}}}}}}
{{!}} style="text-align: center" {{!}} {{#if: {{{short_user|}}} | {{param|{{{short_user}}}}}}}
  {{!}} style="text-align: center" {{!}} {{#if: {{{pos_user|}}} | {{param|{{{pos_user}}}}}}}
{{!}} style="text-align: center" {{!}} {{{stat_user|optional}}}
  </tr>
  </tr>
}}{{#ifeq: {{{proj|}}} | 1 |
}}{{#ifeq: {{{proj|}}} | 1 |
  <tr>
  <tr>
  {{!}} {{param|proj}}
  {{!}} {{param|proj}}
  {{!}} {{#if: {{{short_proj|}}} | {{param|{{{short_proj}}}}}}}
  {{!}} The name of the project, consisting of a grouping of repositories on the open source infrastructure.  This defaults to '''{{{default_proj|flightgear}}}'''.
  {{!}} {{#if: {{{pos_proj|}}} | {{param|{{{pos_proj}}}}}}}
{{!}} style="text-align: center" {{!}} {{#if: {{{short_proj|}}} | {{param|{{{short_proj}}}}}}}
  {{!}} style="text-align: center" {{!}} {{#if: {{{pos_proj|}}} | {{param|{{{pos_proj}}}}}}}
{{!}} style="text-align: center" {{!}} {{{stat_proj|optional}}}
  </tr>
  </tr>
}}{{#ifeq: {{{repo|}}} | 1 |
}}{{#ifeq: {{{repo|}}} | 1 |
  <tr>
  <tr>
  {{!}} {{param|repo}}
  {{!}} {{param|repo}}
  {{!}} {{#if: {{{short_repo|}}} | {{param|{{{short_repo}}}}}}}
  {{!}} The name of the repository, for example '''fgdata'''.  A project registered on one of the open source infrastructures generally allows for multiple repositories under that project name.  This defaults to '''{{{default_repo|flightgear}}}'''.
  {{!}} {{#if: {{{pos_repo|}}} | {{param|{{{pos_repo}}}}}}}
{{!}} style="text-align: center" {{!}} {{#if: {{{short_repo|}}} | {{param|{{{short_repo}}}}}}}
  {{!}} style="text-align: center" {{!}} {{#if: {{{pos_repo|}}} | {{param|{{{pos_repo}}}}}}}
{{!}} style="text-align: center" {{!}} {{{stat_repo|optional}}}
  </tr>
  </tr>
}}{{#ifeq: {{{branch|}}} | 1 |
}}{{#ifeq: {{{branch|}}} | 1 |
  <tr>
  <tr>
  {{!}} {{param|branch}}
  {{!}} {{param|branch}}
  {{!}} {{#if: {{{short_branch|}}} | {{param|{{{short_branch}}}}}}}
  {{!}} The branch name. <!--
  {{!}} {{#if: {{{pos_branch|}}} | {{param|{{{pos_branch}}}}}}}
    -->{{#if: {{{svn|}}} | As tags are simply branches in SVN repositories, this parameter can also be used for svn tags. <nowiki></nowiki>}}<!--
    -->{{#if: {{{git|}}} | For git tags, simply append <code>/~</code> to the tag name. <nowiki></nowiki>}}<!--
    -->{{#if: {{{git|}}}
        | {{#if: {{{svn|}}}
            | This defaults to '''next''' or '''trunk''' for git and svn respectively. <nowiki></nowiki>
            | This defaults to '''next'''. <nowiki></nowiki>
          }}
        | {{#if: {{{svn|}}}
            | This defaults to '''trunk'''. <nowiki></nowiki>
          }}
      }}
 
{{!}} style="text-align: center" {{!}} {{#if: {{{short_branch|}}} | {{param|{{{short_branch}}}}}}}
  {{!}} style="text-align: center" {{!}} {{#if: {{{pos_branch|}}} | {{param|{{{pos_branch}}}}}}}
{{!}} style="text-align: center" {{!}} {{{stat_branch|optional}}}
  </tr>
  </tr>
}}{{#ifeq: {{{tag|}}} | 1 |
}}{{#ifeq: {{{tag|}}} | 1 |
  <tr>
  <tr>
  {{!}} {{param|tag}}
  {{!}} {{param|tag}}
  {{!}} {{#if: {{{short_tag|}}} | {{param|{{{short_tag}}}}}}}
  {{!}} Reserved for future use.  This will be used for a situation in which tags and branches are treated differently by an open source infrastructure site.
  {{!}} {{#if: {{{pos_tag|}}} | {{param|{{{pos_tag}}}}}}}
{{!}} style="text-align: center" {{!}} {{#if: {{{short_tag|}}} | {{param|{{{short_tag}}}}}}}
  {{!}} style="text-align: center" {{!}} {{#if: {{{pos_tag|}}} | {{param|{{{pos_tag}}}}}}}
{{!}} style="text-align: center" {{!}} {{{stat_tag|optional}}}
  </tr>
  </tr>
}}{{#ifeq: {{{path|}}} | 1 |
}}{{#ifeq: {{{path|}}} | 1 |
  <tr>
  <tr>
  {{!}} {{param|path}}
  {{!}} {{param|path}}
  {{!}} {{#if: {{{short_path|}}} | {{param|{{{short_path}}}}}}}
  {{!}} The file path.
  {{!}} {{#if: {{{pos_path|}}} | {{param|{{{pos_path}}}}}}}
{{!}} style="text-align: center" {{!}} {{#if: {{{short_path|}}} | {{param|{{{short_path}}}}}}}
  {{!}} style="text-align: center" {{!}} {{#if: {{{pos_path|}}} | {{param|{{{pos_path}}}}}}}
{{!}} style="text-align: center" {{!}} {{{stat_path|optional}}}
  </tr>
  </tr>
}}{{#ifeq: {{{commit|}}} | 1 |
}}{{#ifeq: {{{commit|}}} | 1 |
  <tr>
  <tr>
  {{!}} {{param|commit}}
  {{!}} {{param|commit}}
  {{!}} {{#if: {{{short_commit|}}} | {{param|{{{short_commit}}}}}}}
  {{!}} The commit identifier<!--
  {{!}} {{#if: {{{pos_commit|}}} | {{param|{{{pos_commit}}}}}}}
    -->{{#if: {{{git|}}}
        | {{#if: {{{svn|}}}
            |<nowiki></nowiki> (git hash or svn revision number).  This defaults to '''next''' and '''HEAD''' for git and svn respectively.
            |<nowiki></nowiki> (git hash).  This defaults to '''next'''.
          }}
        | {{#if: {{{svn|}}}
            |<nowiki></nowiki> (svn revision number).  This defaults to '''HEAD'''.
            |.
          }}
      }}
{{!}} style="text-align: center" {{!}} {{#if: {{{short_commit|}}} | {{param|{{{short_commit}}}}}}}
  {{!}} style="text-align: center" {{!}} {{#if: {{{pos_commit|}}} | {{param|{{{pos_commit}}}}}}}
{{!}} style="text-align: center" {{!}} {{{stat_commit|optional}}}
  </tr>
  </tr>
}}{{#ifeq: {{{line|}}} | 1 |
}}{{#ifeq: {{{line|}}} | 1 |
  <tr>
  <tr>
  {{!}} {{param|line}}
  {{!}} {{param|line}}
  {{!}} {{#if: {{{short_line|}}} | {{param|{{{short_line}}}}}}}
  {{!}} The line number(s) of the file to display.
  {{!}} {{#if: {{{pos_line|}}} | {{param|{{{pos_line}}}}}}}
      {{#ifeq: {{{sf|{{{go|}}}}}} | 1 |
:* For {{#ifeq: {{{sf|}}} | 1
        | SourceForge<!--
      -->{{#ifeq: {{{go|}}} | 1 |<nowiki></nowiki> and <nowiki></nowiki>}}
      }}<!--
    -->{{#ifeq: {{{go|}}} | 1 | the Gitorious archive}}<!--
    -->:  Use a single line number.
      }}{{#ifeq: {{{gh|}}} | 1 |
:* For GitHub either use:
:** A single line number, for example '''2'''.
:** Two line numbers separated with a hyphen ('''-'''), for example '''3-10'''.
      }}
{{!}} style="text-align: center" {{!}} {{#if: {{{short_line|}}} | {{param|{{{short_line}}}}}}}
  {{!}} style="text-align: center" {{!}} {{#if: {{{pos_line|}}} | {{param|{{{pos_line}}}}}}}
{{!}} style="text-align: center" {{!}} {{{stat_line|optional}}}
  </tr>
  </tr>
}}{{#ifeq: {{{post|}}} | 1 |
}}{{#ifeq: {{{post|}}} | 1 |
  <tr>
  <tr>
  {{!}} {{param|post}}
  {{!}} {{param|post}}
  {{!}} {{#if: {{{short_post|}}} | {{param|{{{short_post}}}}}}}
  {{!}} Text to append.  This is forms a set with to the '''cmd''' and '''opt''' parameters.  For example it can represent any command line options that come after the URL.
  {{!}} {{#if: {{{pos_post|}}} | {{param|{{{pos_post}}}}}}}
{{!}} style="text-align: center" {{!}} {{#if: {{{short_post|}}} | {{param|{{{short_post}}}}}}}
  {{!}} style="text-align: center" {{!}} {{#if: {{{pos_post|}}} | {{param|{{{pos_post}}}}}}}
{{!}} style="text-align: center" {{!}} {{{stat_post|optional}}}
  </tr>
  </tr>
}}{{#ifeq: {{{view|}}} | 1 |
}}{{#ifeq: {{{view|}}} | 1 |
  <tr>
  <tr>
  {{!}} {{param|view}}
  {{!}} {{param|view}}
  {{!}} {{#if: {{{short_view|}}} | {{param|{{{short_view}}}}}}}
  {{!}} View to display:
  {{!}} {{#if: {{{pos_view|}}} | {{param|{{{pos_view}}}}}}}
      {{#ifeq: {{{sf|}}} | 1 |
:* For SourceForge use one of '''tree''', '''log''', '''commit''', or '''rss'''.  The default is '''tree'''.
      }}{{#ifeq: {{{gh|}}} | 1 |
:* For GitHub use one of '''blob''', '''blame''', '''commit''', '''commits''' or '''raw'''.  The default is '''tree'''.
      }}{{#ifeq: {{{gl|}}} | 1 |
:* The GitLab interface for '''type=git web''' is not yet implemented in the master {{tl|repo link}} template, so the '''view''' parameter currently does nothing.
      }}{{#ifeq: {{{go|}}} | 1 |
:* For the Gitorious archive use one of '''summary''', '''shortlog''', '''log''', '''blob''', '''commit''', '''commitdiff''', '''tree''', '''history''', or '''raw'''.  The default is '''blob''' if a path is given, '''commit''' if a commit is given, or '''summary''' otherwise.
      }}
{{!}} style="text-align: center" {{!}} {{#if: {{{short_view|}}} | {{param|{{{short_view}}}}}}}
  {{!}} style="text-align: center" {{!}} {{#if: {{{pos_view|}}} | {{param|{{{pos_view}}}}}}}
{{!}} style="text-align: center" {{!}} {{{stat_view|optional}}}
  </tr>
  </tr>
}}{{#ifeq: {{{text|}}} | 1 |
}}{{#ifeq: {{{text|}}} | 1 |
  <tr>
  <tr>
  {{!}} {{param|text}}
  {{!}} {{param|text}}
  {{!}} {{#if: {{{short_text|}}} | {{param|{{{short_text}}}}}}}
  {{!}} Text to display as the link label.  Overrides '''pre'''.
  {{!}} {{#if: {{{pos_text|}}} | {{param|{{{pos_text}}}}}}}
{{!}} style="text-align: center" {{!}} {{#if: {{{short_text|}}} | {{param|{{{short_text}}}}}}}
  {{!}} style="text-align: center" {{!}} {{#if: {{{pos_text|}}} | {{param|{{{pos_text}}}}}}}
{{!}} style="text-align: center" {{!}} {{{stat_text|optional}}}
  </tr>
  </tr>
}}{{#ifeq: {{{pre|}}} | 1 |
}}{{#ifeq: {{{pre|}}} | 1 |
  <tr>
  <tr>
  {{!}} {{param|pre}}
  {{!}} {{param|pre}}
  {{!}} {{#if: {{{short_pre|}}} | {{param|{{{short_pre}}}}}}}
  {{!}} Prefix to a link label.
  {{!}} {{#if: {{{pos_pre|}}} | {{param|{{{pos_pre}}}}}}}
{{!}} style="text-align: center" {{!}} {{#if: {{{short_pre|}}} | {{param|{{{short_pre}}}}}}}
  {{!}} style="text-align: center" {{!}} {{#if: {{{pos_pre|}}} | {{param|{{{pos_pre}}}}}}}
{{!}} style="text-align: center" {{!}} {{{stat_pre|optional}}}
  </tr>
  </tr>
}}{{#ifeq: {{{simplepath|}}} | 1 |
}}{{#ifeq: {{{simplepath|}}} | 1 |
  <tr>
  <tr>
  {{!}} {{param|simplepath}}
  {{!}} {{param|simplepath}}
  {{!}} {{#if: {{{short_simplepath|}}} | {{{short_simplepath|}}}}}
  {{!}} If set, this strips off the repository name from the URL label, leaving just the contents of the '''path''' parameter.
  {{!}} {{#if: {{{pos_simplepath|}}} | {{{pos_simplepath|}}}}}
: {{inote|The ''text'' parameter will override this.}}
{{!}} style="text-align: center" {{!}} {{#if: {{{short_simplepath|}}} | {{{short_simplepath|}}}}}
  {{!}} style="text-align: center" {{!}} {{#if: {{{pos_simplepath|}}} | {{{pos_simplepath|}}}}}
{{!}} style="text-align: center" {{!}} {{{stat_simplepath|optional}}}
  </tr>
  </tr>
}}{{#ifeq: {{{full|}}} | 1 |
}}{{#ifeq: {{{full|}}} | 1 |
  <tr>
  <tr>
  {{!}} {{param|full}}
  {{!}} {{param|full}}
  {{!}} {{#if: {{{short_full|}}} | {{param|{{{short_full}}}}}}}
  {{!}} If set, the full URL will be shown rather than any text label.
  {{!}} {{#if: {{{pos_full|}}} | {{param|{{{pos_full}}}}}}}
{{!}} style="text-align: center" {{!}} {{#if: {{{short_full|}}} | {{param|{{{short_full}}}}}}}
  {{!}} style="text-align: center" {{!}} {{#if: {{{pos_full|}}} | {{param|{{{pos_full}}}}}}}
{{!}} style="text-align: center" {{!}} {{{stat_full|optional}}}
  </tr>
  </tr>
}}
}}
Line 309: Line 299:


  {{obr}}repo link/doc usage
  {{obr}}repo link/doc usage
  {{!}} template         =  
  {{!}} template   = {{!}} type_template  = {{!}} short_template  = {{!}} pos_template  = {{!}} stat_template  =  
  {{!}} site             =  
  {{!}} site       = {{!}} type_site      = {{!}} short_site      = {{!}} pos_site      = {{!}} stat_site      =  
  {{!}} cmd             =  
  {{!}} cmd       = {{!}} type_cmd        = {{!}} short_cmd        = {{!}} pos_cmd        = {{!}} stat_cmd        = {{!}} eg_cmd          =
  {{!}} opt             =  
  {{!}} opt       = {{!}} type_opt        = {{!}} short_opt        = {{!}} pos_opt        = {{!}} stat_opt        =  
  {{!}} protocol         =  
  {{!}} protocol   = {{!}} type_protocol  = {{!}} short_protocol  = {{!}} pos_protocol  = {{!}} stat_protocol  = {{!}} default_protocol =
  {{!}} login           =  
  {{!}} login     = {{!}} type_login      = {{!}} short_login      = {{!}} pos_login      = {{!}} stat_login      =  
  {{!}} type             =  
  {{!}} type       = {{!}} type_type      = {{!}} short_type      = {{!}} pos_type      = {{!}} stat_type      = {{!}} default_type    =
  {{!}} user             =  
  {{!}} user       = {{!}} type_user      = {{!}} short_user      = {{!}} pos_user      = {{!}} stat_user      =  
  {{!}} proj             =  
  {{!}} proj       = {{!}} type_proj      = {{!}} short_proj      = {{!}} pos_proj      = {{!}} stat_proj      = {{!}} default_proj    =
  {{!}} repo             =  
  {{!}} repo       = {{!}} type_repo      = {{!}} short_repo      = {{!}} pos_repo      = {{!}} stat_repo      = {{!}} default_repo    =
  {{!}} branch           =  
  {{!}} branch     = {{!}} type_branch    = {{!}} short_branch    = {{!}} pos_branch    = {{!}} stat_branch    =  
  {{!}} tag             =  
  {{!}} tag       = {{!}} type_tag        = {{!}} short_tag        = {{!}} pos_tag        = {{!}} stat_tag        =  
  {{!}} path             =  
  {{!}} path       = {{!}} type_path      = {{!}} short_path      = {{!}} pos_path      = {{!}} stat_path      =  
  {{!}} commit           =  
  {{!}} commit     = {{!}} type_commit    = {{!}} short_commit    = {{!}} pos_commit    = {{!}} stat_commit    =  
  {{!}} line             =  
  {{!}} line       = {{!}} type_line      = {{!}} short_line      = {{!}} pos_line      = {{!}} stat_line      =  
  {{!}} post             =  
  {{!}} post       = {{!}} type_post      = {{!}} short_post      = {{!}} pos_post      = {{!}} stat_post      =  
  {{!}} view             =  
  {{!}} view       = {{!}} type_view      = {{!}} short_view      = {{!}} pos_view      = {{!}} stat_view      =  
  {{!}} text             =  
  {{!}} text       = {{!}} type_text      = {{!}} short_text      = {{!}} pos_text      = {{!}} stat_text      =  
  {{!}} pre             =  
  {{!}} pre       = {{!}} type_pre        = {{!}} short_pre        = {{!}} pos_pre        = {{!}} stat_pre        =  
  {{!}} simplepath       =  
  {{!}} simplepath = {{!}} type_simplepath = {{!}} short_simplepath = {{!}} pos_simplepath = {{!}} stat_simplepath =  
{{!}} full            =  
  {{!}} full      = {{!}} type_full      = {{!}} short_full      = {{!}} pos_full      = {{!}} stat_full      =  
  {{!}} intro            =  
  {{!}} intro      =  
{{!}} sf              =  
  {{!}} sf        =  
{{!}} gh              =  
  {{!}} gh        =  
{{!}} gl              =  
  {{!}} gl        =  
{{!}} go              =  
  {{!}} go        =  
  {{!}} svn              =  
  {{!}} svn        =  
  {{!}} git              =  
  {{!}} git        =  
  {{!}} eg_cmd          =
  {{!}} default_protocol =
  {{!}} default_type    =
  {{!}} default_proj    =
  {{!}} default_repo    =
  {{cbr}}
  {{cbr}}
; '''type_*''':  The parameter type.  This defaults to '''name''' to define this as a named parameter.  For an anonymous or numbered parameter, set this to '''num'''.
; '''short_*''':  The optional abbreviated parameter name used as an alias for the full parameter name.
; '''pos_*''':  The parameter position for anonymous or numbered parameters.
; '''stat_*''':  The parameter status, for example '''mandatory'''.  This defaults to '''optional'''.
; '''eg_*''':  An example for the parameter.
; '''default_*''':  The default parameter value.


== Examples ==
== Examples ==
Retrieved from "https://wiki.flightgear.org/Special:MobileDiff/94710"

Navigation menu