Template:Repo link/doc usage: Difference between revisions

:* For [[SourceForge]] use either '''s''', '''sf''' or '''sourceforge'''.

:* For [[GitHub]] use either '''gh''', '''gith''' or '''github'''.

:* For [[GitLab]] use either '''gl''', '''gitl''' or '''gitlab'''.

:* For the [[Gitorious]] archive use either '''g''', '''gito''' or '''gitorious'''.

:* For generic repositories, the '''site''' parameter will be interpreted as the domain name.

  {{!}} An optional command line tool name + options to prepend to the URL.  For example '''{{{eg_cmd|git clone}}}'''.

: {{inote|Developer note: This is for future non-CLI handling of a standardised set of '''cmd''' parameter values}}

  {{!}} The URL protocol, for example '''https''', '''http''', '''ssh'''{{#if:{{{git|}}}|, '''git'''}}{{#if:{{{svn|}}}|, '''svn'''}}.  This defaults to '''{{{default_protocol|https}}}'''.

  {{!}} The optional user login. {{#ifeq:{{{user|}}}|1|This should not to be confused with the '''user''' parameter.}}

         |<nowiki></nowiki> '''git''', '''git web'''<!--

         |<nowiki></nowiki> '''svn''', '''svn web'''<!--

     -->{{#ifeq: {{{gh|{{{gl|}}}}}} | 1 |<nowiki></nowiki>'''zip'''<!--

     -->The default is '''{{{default_type|{{#ifeq:{{{git|}}}|1|git web|svn web}}}}}'''.

  {{!}} The name of the user page for the {{#if: {{{site_name|}}} | [[{{{site_name}}}]]}} open source infrastructure.  This is notably different to the '''login''' parameter.  This will have precedence over the '''proj''' parameter.  The user page is treated in the same way as a project name.

  {{!}} The name of the project, consisting of a grouping of repositories on the {{#if: {{{site_name|}}} | [[{{{site_name}}}]]}} open source infrastructure.  This defaults to '''{{{default_proj|flightgear}}}'''.

  {{!}} The name of the repository{{#if: {{{eg_repo|}}}, for example '''eg_repo'''}}.  A project registered on {{#if: {{{site_name|}}} | the [[{{{site_name}}}]] open source infrastructure | one of the open source infrastructures}} generally allows for multiple repositories under that project name.  This defaults to '''{{{default_repo|flightgear}}}'''.

             | This defaults to '''{{{default_branch_git|next}}}''' or '''{{{default_branch_svn|trunk}}}''' for git and svn respectively. <nowiki></nowiki>

             | This defaults to '''{{{default_branch_git|next}}}'''. <nowiki></nowiki>

             | This defaults to '''{{{default_branch_svn|trunk}}}'''. <nowiki></nowiki>

             |<nowiki></nowiki> (git hash or svn revision number).  This defaults to '''HEAD'''.

             |<nowiki></nowiki> (git hash).  This defaults to '''HEAD'''.

             |<nowiki></nowiki> (svn revision number).  This defaults to '''HEAD'''.

:** A single line number, for example '''2'''.

:** Two line numbers separated with a hyphen ('''-'''), for example '''3-10'''.

  {{!}} Text to append.  This is forms a set with the parameter {{#ifeq:{{{cmd|}}}|1|{{param|cmd}}{{#ifeq:{{{opt|}}}|1|<nowiki></nowiki> and <nowiki></nowiki>}}}}{{#ifeq:{{{opt|}}}|1|{{param|opt}}}}.  For example it can represent any command line options that come after the URL. {{#if:{{{default_post|}}}|The default value is '''{{{default_post}}}'''.}}

:* For SourceForge use one of '''tree''', '''log''', '''commit''', or '''rss'''.  The default is '''tree'''.

:* For GitHub use one of '''blob''', '''blame''', '''commit''', '''commits''' or '''raw'''.  The default is '''tree'''.

:* 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.

:* 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.

  {{!}} Text to display as the link label. {{#if: {{{pre|}}} | Overrides '''pre'''.}}

  {{!}} If set, this strips off the repository name from the URL label, leaving just the contents of the '''path''' parameter.

; 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'''.

; stat_*:  The parameter status, for example '''mandatory'''.  This defaults to '''optional'''.

; break:  If set to '''1''', an empty line between the URL and text formatting will be added.