Template:Repo link/doc usage: Difference between revisions
Jump to navigation
Jump to search
(Expanded the 'path' parameter description.) |
(Added a 'number' parameter for links to trackers.) |
||
(26 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
== Usage == | |||
{{obr}}'''{{{template|MISSING}}}'''<!-- | {{obr}}'''{{{template|MISSING}}}'''<!-- | ||
-->{{#ifeq: {{{site|}}} | 1 | <nowiki></nowiki> | -->{{#ifeq: {{{site|}}} | 1 | <nowiki></nowiki> | ||
Line 9: | Line 10: | ||
| site = | | site = | ||
| ''site'' = | | ''site'' = | ||
}} | |||
}} | |||
}}{{#ifeq: {{{param1|}}} | 1 | <nowiki></nowiki> | |||
{{!}} {{#ifeq: {{{type1|}}} | num | |||
| {{#ifeq: {{{stat1|}}} | mandatory | |||
| {{{name1}}} | |||
| ''{{{name1}}}'' | |||
}} | |||
| {{#ifeq: {{{stat1|}}} | mandatory | |||
| {{{name1}}} = | |||
| ''{{{name1}}}'' = | |||
}} | |||
}} | |||
}}{{#ifeq: {{{param2|}}} | 1 | <nowiki></nowiki> | |||
{{!}} {{#ifeq: {{{type2|}}} | num | |||
| {{#ifeq: {{{stat2|}}} | mandatory | |||
| {{{name2}}} | |||
| ''{{{name2}}}'' | |||
}} | |||
| {{#ifeq: {{{stat2|}}} | mandatory | |||
| {{{name2}}} = | |||
| ''{{{name2}}}'' = | |||
}} | |||
}} | |||
}}{{#ifeq: {{{param3|}}} | 1 | <nowiki></nowiki> | |||
{{!}} {{#ifeq: {{{type3|}}} | num | |||
| {{#ifeq: {{{stat3|}}} | mandatory | |||
| {{{name3}}} | |||
| ''{{{name3}}}'' | |||
}} | |||
| {{#ifeq: {{{stat3|}}} | mandatory | |||
| {{{name3}}} = | |||
| ''{{{name3}}}'' = | |||
}} | }} | ||
}} | }} | ||
Line 119: | Line 153: | ||
| tag = | | tag = | ||
| ''tag'' = | | ''tag'' = | ||
}} | |||
}} | |||
}}{{#ifeq: {{{commit|}}} | 1 | <nowiki></nowiki> | |||
{{!}} {{#ifeq: {{{type_commit|}}} | num | |||
| {{#ifeq: {{{stat_commit|}}} | mandatory | |||
| commit | |||
| ''commit'' | |||
}} | |||
| {{#ifeq: {{{stat_commit|}}} | mandatory | |||
| commit = | |||
| ''commit'' = | |||
}} | |||
}} | |||
}}{{#ifeq: {{{mr|}}} | 1 | <nowiki></nowiki> | |||
{{!}} {{#ifeq: {{{type_mr|}}} | num | |||
| {{#ifeq: {{{stat_mr|}}} | mandatory | |||
| mr | |||
| ''mr'' | |||
}} | |||
| {{#ifeq: {{{stat_mr|}}} | mandatory | |||
| mr = | |||
| ''mr'' = | |||
}} | |||
}} | |||
}}{{#ifeq: {{{number|}}} | 1 | <nowiki></nowiki> | |||
{{!}} {{#ifeq: {{{type_number|}}} | num | |||
| {{#ifeq: {{{stat_number|}}} | mandatory | |||
| number | |||
| ''number'' | |||
}} | |||
| {{#ifeq: {{{stat_number|}}} | mandatory | |||
| number = | |||
| ''number'' = | |||
}} | }} | ||
}} | }} | ||
Line 130: | Line 197: | ||
| path = | | path = | ||
| ''path'' = | | ''path'' = | ||
}} | }} | ||
}} | }} | ||
Line 225: | Line 281: | ||
{{cbr}} | {{cbr}} | ||
{{{intro|}}} | {{{intro|The parameters are:}}} | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
! Parameter | ! Parameter | ||
Line 236: | Line 292: | ||
{{!}} {{param|site}} | {{!}} {{param|site}} | ||
{{!}} Points the template to a repository host: | {{!}} Points the template to a repository host: | ||
:* For [[SourceForge]] use either | :* For [[SourceForge]] use either {{param||s}}, {{param||sf}} or {{param||sourceforge}}. | ||
:* For [[GitHub]] use either | :* For [[GitHub]] use either {{param||gh}}, {{param||gith}} or {{param||github}}. | ||
:* For [[GitLab]] use either | :* For [[GitLab]] use either {{param||gl}}, {{param||gitl}} or {{param||gitlab}}. | ||
:* For the [[Gitorious]] archive use either | :* For the [[Gitorious]] archive use either {{param||g}}, {{param||go}}, {{param||gito}} or {{param||gitorious}}. | ||
:* For generic repositories, the | :* For generic repositories, the {{param|site}} parameter will be interpreted as the domain name. | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{short_site|}}} | {{param|{{{short_site}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{short_site|}}} | {{param|{{{short_site}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_site|}}} | {{param|{{{pos_site}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_site|}}} | {{param|{{{pos_site}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat_site|mandatory}}} | {{!}} style="text-align: center" {{!}} {{{stat_site|mandatory}}} | ||
</tr> | |||
}}{{#ifeq: {{{param1|}}} | 1 | | |||
<tr> | |||
{{!}} {{param|{{{name1}}}}} | |||
{{!}} {{{desc1}}} | |||
{{!}} style="text-align: center" {{!}} {{#if: {{{short1|}}} | {{param|{{{short1}}}}}}} | |||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos1|}}} | {{param|{{{pos1}}}}}}} | |||
{{!}} style="text-align: center" {{!}} {{{stat1|optional}}} | |||
</tr> | |||
}}{{#ifeq: {{{param2|}}} | 1 | | |||
<tr> | |||
{{!}} {{param|{{{name2}}}}} | |||
{{!}} {{{desc2}}} | |||
{{!}} style="text-align: center" {{!}} {{#if: {{{short2|}}} | {{param|{{{short2}}}}}}} | |||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos2|}}} | {{param|{{{pos2}}}}}}} | |||
{{!}} style="text-align: center" {{!}} {{{stat2|optional}}} | |||
</tr> | |||
}}{{#ifeq: {{{param3|}}} | 1 | | |||
<tr> | |||
{{!}} {{param|{{{name3}}}}} | |||
{{!}} {{{desc3}}} | |||
{{!}} style="text-align: center" {{!}} {{#if: {{{short3|}}} | {{param|{{{short3}}}}}}} | |||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos3|}}} | {{param|{{{pos3}}}}}}} | |||
{{!}} style="text-align: center" {{!}} {{{stat3|optional}}} | |||
</tr> | </tr> | ||
}}{{#ifeq: {{{cmd|}}} | 1 | | }}{{#ifeq: {{{cmd|}}} | 1 | | ||
<tr> | <tr> | ||
{{!}} {{param|cmd}} | {{!}} {{param|cmd}} | ||
{{!}} An optional command line tool name + options to prepend to the URL. For example | {{!}} An optional command line tool name + options to prepend to the URL. For example {{param||{{{eg_cmd|git clone}}}}}. | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{short_cmd|}}} | {{param|{{{short_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" {{!}} {{#if: {{{pos_cmd|}}} | {{param|{{{pos_cmd}}}}}}} | ||
Line 256: | Line 336: | ||
<tr> | <tr> | ||
{{!}} {{param|opt}} | {{!}} {{param|opt}} | ||
{{!}} Any additional options to show after | {{!}} Any additional options to show after {{#if: {{{value_cmd|}}} | the command {{#tag:code|{{{value_cmd}}}}} | {{param|cmd}}}}, but before the URL.{{#ifeq: {{{cmd|}}} | 1 | | ||
: {{inote| | : {{inote|The separation of {{param|cmd}} and {{param|opt}} is for future non-CLI handling of a standardised set of {{param|cmd}} parameter values}} | ||
}} | |||
{{!}} style="text-align: center" {{!}} {{#if: {{{short_opt|}}} | {{param|{{{short_opt}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{short_opt|}}} | {{param|{{{short_opt}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_opt|}}} | {{param|{{{pos_opt}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_opt|}}} | {{param|{{{pos_opt}}}}}}} | ||
Line 265: | Line 346: | ||
<tr> | <tr> | ||
{{!}} {{param|protocol}} | {{!}} {{param|protocol}} | ||
{{!}} The URL protocol, for example | {{!}} The URL protocol, for example {{param||https}}, {{param||http}}, {{param||ssh}}{{#ifeq:{{{git|}}}|1|, {{param||git}}}}{{#ifeq:{{{svn|}}}|1|, {{param||svn}}}}. This defaults to {{param||{{{default_protocol|https}}}}}. | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{short_protocol|}}} | {{param|{{{short_protocol}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{short_protocol|}}} | {{param|{{{short_protocol}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_protocol|}}} | {{param|{{{pos_protocol}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_protocol|}}} | {{param|{{{pos_protocol}}}}}}} | ||
Line 273: | Line 354: | ||
<tr> | <tr> | ||
{{!}} {{param|login}} | {{!}} {{param|login}} | ||
{{!}} The optional user login. | {{!}} The optional user login. {{#ifeq:{{{user|}}}|1|This should not to be confused with the {{param|user}} parameter.}} | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{short_login|}}} | {{param|{{{short_login}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{short_login|}}} | {{param|{{{short_login}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_login|}}} | {{param|{{{pos_login}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_login|}}} | {{param|{{{pos_login}}}}}}} | ||
Line 287: | Line 368: | ||
-->This can be one of<!-- | -->This can be one of<!-- | ||
-->{{#ifeq: {{{git|}}} | 1 | -->{{#ifeq: {{{git|}}} | 1 | ||
|<nowiki></nowiki> | |<nowiki></nowiki> {{param||git}}, {{param||git web}}<!-- | ||
-->{{#ifeq: {{{svn|{{{gh|{{{gl|}}}}}}}}} | 1 |, <nowiki></nowiki>}} | -->{{#ifeq: {{{svn|{{{gh|{{{gl|}}}}}}}}} | 1 |, <nowiki></nowiki>}} | ||
}}<!-- | }}<!-- | ||
-->{{#ifeq: {{{svn|}}} | 1 | -->{{#ifeq: {{{svn|}}} | 1 | ||
|<nowiki></nowiki> | |<nowiki></nowiki> {{param||svn}}, {{param||svn web}}<!-- | ||
-->{{#ifeq: {{{gh|{{{gl|}}}}}} | 1 |, <nowiki></nowiki>}} | -->{{#ifeq: {{{gh|{{{gl|}}}}}} | 1 |, <nowiki></nowiki>}} | ||
}}<!-- | }}<!-- | ||
-->{{#ifeq: {{{gh|{{{gl|}}}}}} | 1 |<nowiki></nowiki> | -->{{#ifeq: {{{gh|{{{gl|}}}}}} | 1 |<nowiki></nowiki>{{param||zip}}<!-- | ||
-->. See the [[#Download templates|<nowiki>{{* zip file}}</nowiki> templates]] for a simplified interface for the zip files | -->. See the [[#Download templates|<nowiki>{{* zip file}}</nowiki> templates]] for a simplified interface for the zip files | ||
}}. <!-- | }}. <!-- | ||
-->The default is | -->The default is {{param||{{{default_type|{{#ifeq:{{{git|}}}|1|git web|svn web}}}}}}}. | ||
{{#ifeq: {{{sf|{{{go|}}}}}} | 1 | {{#ifeq: {{{sf|{{{go|}}}}}} | 1 | ||
| {{#ifeq: {{{gh|{{{gl|}}}}}} | 1 | | {{#ifeq: {{{gh|{{{gl|}}}}}} | 1 | ||
Line 313: | Line 394: | ||
<tr> | <tr> | ||
{{!}} {{param|user}} | {{!}} {{param|user}} | ||
{{!}} The name of the user page for the {{#if: {{{site_name|}}} | [[{{{site_name}}}]]}} open source infrastructure. This is notably different to the | {{!}} The name of the user page for the {{#if: {{{site_name|}}} | [[{{{site_name}}}]]}} open source infrastructure. This is notably different to the {{param|login}} parameter. This will have precedence over the {{param|proj}} parameter. The user page is treated in the same way as a project name. | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{short_user|}}} | {{param|{{{short_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" {{!}} {{#if: {{{pos_user|}}} | {{param|{{{pos_user}}}}}}} | ||
Line 321: | Line 402: | ||
<tr> | <tr> | ||
{{!}} {{param|proj}} | {{!}} {{param|proj}} | ||
{{!}} The name of the project, consisting of a grouping of repositories on the {{#if: {{{site_name|}}} | [[{{{site_name}}}]]}} open source infrastructure. | {{!}} The name of the project, consisting of a grouping of repositories on the {{#if: {{{site_name|}}} | [[{{{site_name}}}]]}} open source infrastructure.{{#if: {{{default_proj|}}} | This defaults to {{param||{{{default_proj}}}}}.}} | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{short_proj|}}} | {{param|{{{short_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" {{!}} {{#if: {{{pos_proj|}}} | {{param|{{{pos_proj}}}}}}} | ||
Line 329: | Line 410: | ||
<tr> | <tr> | ||
{{!}} {{param|repo}} | {{!}} {{param|repo}} | ||
{{!}} The name of the repository{{#if: {{{eg_repo|}}}, for example | {{!}} The name of the repository{{#if: {{{eg_repo|}}}, for example {{param||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.{{#if: {{{default_repo|}}} | This defaults to {{param||{{{default_repo}}}}}.}} | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{short_repo|}}} | {{param|{{{short_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" {{!}} {{#if: {{{pos_repo|}}} | {{param|{{{pos_repo}}}}}}} | ||
Line 338: | Line 419: | ||
{{!}} {{param|branch}} | {{!}} {{param|branch}} | ||
{{!}} The branch name. <!-- | {{!}} The branch name. <!-- | ||
-->{{# | -->{{#ifeq: {{{svn|}}} | 1 | As tags are simply branches in SVN repositories, this parameter can also be used for svn tags. <nowiki></nowiki>}}<!-- | ||
-->{{# | -->{{#ifeq: {{{git|}}} | 1 | ||
| {{#ifeq: {{{svn|}}} | 1 | |||
| {{# | | This defaults to {{param||{{{default_branch_git|next}}}}} or {{param||{{{default_branch_svn|trunk}}}}} for git and svn respectively. <nowiki></nowiki> | ||
| This defaults to | | This defaults to {{param||{{{default_branch_git|next}}}}}. <nowiki></nowiki> | ||
| This defaults to | }} | ||
| {{#ifeq: {{{svn|}}} | 1 | |||
| This defaults to {{param||{{{default_branch_svn|trunk}}}}}. <nowiki></nowiki> | |||
}} | }} | ||
}}<!-- | |||
-->{{#ifeq: {{{sf|}}} | 1 | |||
| {{#ifeq: {{{git|}}} | 1 | |||
| For SourceForge git repositories, if the character <code>/</code> is present in the branch name, the text <code>/~</code> must be appended to the branch. <nowiki></nowiki> | |||
}} | }} | ||
}} | }} | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{short_branch|}}} | {{param|{{{short_branch}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{short_branch|}}} | {{param|{{{short_branch}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_branch|}}} | {{param|{{{pos_branch}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_branch|}}} | {{param|{{{pos_branch}}}}}}} | ||
Line 357: | Line 441: | ||
<tr> | <tr> | ||
{{!}} {{param|tag}} | {{!}} {{param|tag}} | ||
{{!}} | {{!}} The repository tag name. <!-- | ||
-->{{#ifeq: {{{sf|}}} | 1 | |||
| {{#ifeq: {{{git|}}} | 1 | |||
| For SourceForge git repositories, if the character <code>/</code> is present in the tag name, the text <code>/~</code> must be appended to the tag. <nowiki></nowiki> | |||
}} | |||
}} | |||
{{!}} style="text-align: center" {{!}} {{#if: {{{short_tag|}}} | {{param|{{{short_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" {{!}} {{#if: {{{pos_tag|}}} | {{param|{{{pos_tag}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat_tag|optional}}} | {{!}} style="text-align: center" {{!}} {{{stat_tag|optional}}} | ||
</tr> | </tr> | ||
}}{{#ifeq: {{{commit|}}} | 1 | | }}{{#ifeq: {{{commit|}}} | 1 | | ||
Line 374: | Line 455: | ||
{{!}} {{param|commit}} | {{!}} {{param|commit}} | ||
{{!}} The commit identifier<!-- | {{!}} The commit identifier<!-- | ||
-->{{# | -->{{#ifeq: {{{git|}}} | 1 | ||
| {{# | | {{#ifeq: {{{svn|}}} | 1 | ||
|<nowiki></nowiki> (git hash or svn revision number). This defaults to | |<nowiki></nowiki> (git hash or svn revision number). This defaults to {{param||HEAD}}. | ||
|<nowiki></nowiki> (git hash). This defaults to | |<nowiki></nowiki> (git hash). This defaults to {{param||HEAD}}. | ||
}} | }} | ||
| {{# | | {{#ifeq: {{{svn|}}} | 1 | ||
|<nowiki></nowiki> (svn revision number). This defaults to | |<nowiki></nowiki> (svn revision number). This defaults to {{param||HEAD}}. | ||
|. | |. | ||
}} | }} | ||
Line 387: | Line 468: | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_commit|}}} | {{param|{{{pos_commit}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_commit|}}} | {{param|{{{pos_commit}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat_commit|optional}}} | {{!}} style="text-align: center" {{!}} {{{stat_commit|optional}}} | ||
</tr> | |||
}}{{#ifeq: {{{mr|}}} | 1 | | |||
<tr> | |||
{{!}} {{param|mr}} | |||
{{!}} The merge request number. If provided and if the other parameters are present, this overrides any {{param|commit}}, {{param|tag}}, or {{param|branch}} parameter values. | |||
{{!}} style="text-align: center" {{!}} {{#if: {{{short_mr|}}} | {{param|{{{short_mr}}}}}}} | |||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_mr|}}} | {{param|{{{pos_mr}}}}}}} | |||
{{!}} style="text-align: center" {{!}} {{{stat_mr|optional}}} | |||
</tr> | |||
}}{{#ifeq: {{{number|}}} | 1 | | |||
<tr> | |||
{{!}} {{param|number}} | |||
{{!}} The bug/issue/support request/etc. tracker number. If provided and if the other parameters are present, this overrides any {{param|commit}}, {{param|tag}}, {{param|branch}}, or {{param|mr}} parameter values. | |||
{{!}} style="text-align: center" {{!}} {{#if: {{{short_number|}}} | {{param|{{{short_number}}}}}}} | |||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_number|}}} | {{param|{{{pos_number}}}}}}} | |||
{{!}} style="text-align: center" {{!}} {{{stat_number|optional}}} | |||
</tr> | |||
}}{{#ifeq: {{{path|}}} | 1 | | |||
<tr> | |||
{{!}} {{param|path}} | |||
{{!}} The file or directory 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: {{{line|}}} | 1 | | }}{{#ifeq: {{{line|}}} | 1 | | ||
Line 401: | Line 506: | ||
}}{{#ifeq: {{{gh|}}} | 1 | | }}{{#ifeq: {{{gh|}}} | 1 | | ||
:* For GitHub either use: | :* For GitHub either use: | ||
:** A single line number, for example | :** A single line number, for example {{param||2}}. | ||
:** Two line numbers separated with a hyphen ( | :** Two line numbers separated with a hyphen ({{param||-}}), for example {{param||3-10}}. | ||
}} | }} | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{short_line|}}} | {{param|{{{short_line}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{short_line|}}} | {{param|{{{short_line}}}}}}} | ||
Line 411: | Line 516: | ||
<tr> | <tr> | ||
{{!}} {{param|post}} | {{!}} {{param|post}} | ||
{{!}} Text to append. This is forms a set with | {{!}} 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 {{param||{{{default_post}}}}}.}} | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{short_post|}}} | {{param|{{{short_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" {{!}} {{#if: {{{pos_post|}}} | {{param|{{{pos_post}}}}}}} | ||
Line 421: | Line 526: | ||
{{!}} View to display: | {{!}} View to display: | ||
{{#ifeq: {{{sf|}}} | 1 | | {{#ifeq: {{{sf|}}} | 1 | | ||
:* For SourceForge use one of | :* For SourceForge use one of {{param||tree}}, {{param||log}}, {{param||commit}}, or {{param||rss}}. If a commit is specified (the {{param|commit}} parameter is set and {{param|path}} is not), the default is {{param||commit}}. Otherwise the default is {{param||tree}}. | ||
}}{{#ifeq: {{{gh|}}} | 1 | | }}{{#ifeq: {{{gh|}}} | 1 | | ||
:* For GitHub use one of | :* For GitHub use one of {{param||blob}}, {{param||blame}}, {{param||commit}}, {{param||commits}} or {{param||raw}}. The default is {{param||tree}}. | ||
}}{{#ifeq: {{{gl|}}} | 1 | | }}{{#ifeq: {{{gl|}}} | 1 | | ||
:* The GitLab interface for | :* The GitLab interface for {{param|type|git web}} is not yet implemented in the master {{tl|repo link}} template, so the {{param|view}} parameter currently does nothing. | ||
}}{{#ifeq: {{{go|}}} | 1 | | }}{{#ifeq: {{{go|}}} | 1 | | ||
:* For the Gitorious archive use one of | :* For the Gitorious archive use one of {{param||summary}}, {{param||shortlog}}, {{param||log}}, {{param||blob}}, {{param||commit}}, {{param||commitdiff}}, {{param||patch}}, {{param||tree}}, {{param||history}}, or {{param||raw}}. The default is {{param||commit}} if a merge request is supplied, {{param||blob}} if a path is given, {{param||commit}} if a commit is given, {{param||shortlog}} if a branch is given, or {{param||summary}} otherwise. | ||
}} | }} | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{short_view|}}} | {{param|{{{short_view}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{short_view|}}} | {{param|{{{short_view}}}}}}} | ||
Line 436: | Line 541: | ||
<tr> | <tr> | ||
{{!}} {{param|text}} | {{!}} {{param|text}} | ||
{{!}} Text to display as the link label. | {{!}} Text to display as the link label. {{#if: {{{pre|}}} | Overrides {{param|pre}}.}} | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{short_text|}}} | {{param|{{{short_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" {{!}} {{#if: {{{pos_text|}}} | {{param|{{{pos_text}}}}}}} | ||
Line 452: | Line 557: | ||
<tr> | <tr> | ||
{{!}} {{param|simplepath}} | {{!}} {{param|simplepath}} | ||
{{!}} If set, this strips off the repository name from the URL label, leaving just the contents of the | {{!}} If set, this strips off the repository name from the URL label, leaving just the contents of the {{param|path}} parameter. | ||
: {{inote|The ''text'' parameter will override this.}} | : {{inote|The ''text'' parameter will override this.}} | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{short_simplepath|}}} | {{{short_simplepath|}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{short_simplepath|}}} | {{{short_simplepath|}}}}} | ||
Line 461: | Line 566: | ||
<tr> | <tr> | ||
{{!}} {{param|full}} | {{!}} {{param|full}} | ||
{{!}} If set, the full URL will be shown rather than any text label. | {{!}} If set to {{param||1}}, the full URL will be shown rather than any text label. | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{short_full|}}} | {{param|{{{short_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" {{!}} {{#if: {{{pos_full|}}} | {{param|{{{pos_full}}}}}}} | ||
Line 483: | Line 588: | ||
{{!}} site_name = | {{!}} site_name = | ||
{{!}} site = {{!}} type_site = {{!}} short_site = {{!}} pos_site = {{!}} stat_site = | {{!}} site = {{!}} type_site = {{!}} short_site = {{!}} pos_site = {{!}} stat_site = | ||
{{!}} cmd = {{!}} type_cmd = {{!}} short_cmd = {{!}} pos_cmd = {{!}} stat_cmd = | {{!}} param1 = {{!}} type1 = {{!}} short1 = {{!}} pos1 = {{!}} stat1 = {{!}} name1 = {{!}} desc1 = | ||
{{!}} param2 = {{!}} type2 = {{!}} short2 = {{!}} pos2 = {{!}} stat2 = {{!}} name2 = {{!}} desc2 = | |||
{{!}} param3 = {{!}} type3 = {{!}} short3 = {{!}} pos3 = {{!}} stat3 = {{!}} name3 = {{!}} desc3 = | |||
{{!}} cmd = {{!}} type_cmd = {{!}} short_cmd = {{!}} pos_cmd = {{!}} stat_cmd = {{!}} value_cmd = {{!}} eg_cmd = | |||
{{!}} opt = {{!}} type_opt = {{!}} short_opt = {{!}} pos_opt = {{!}} stat_opt = | {{!}} opt = {{!}} type_opt = {{!}} short_opt = {{!}} pos_opt = {{!}} stat_opt = | ||
{{!}} protocol = {{!}} type_protocol = {{!}} short_protocol = {{!}} pos_protocol = {{!}} stat_protocol = {{!}} default_protocol = | {{!}} protocol = {{!}} type_protocol = {{!}} short_protocol = {{!}} pos_protocol = {{!}} stat_protocol = {{!}} default_protocol = | ||
Line 493: | Line 601: | ||
{{!}} branch = {{!}} type_branch = {{!}} short_branch = {{!}} pos_branch = {{!}} stat_branch = {{!}} default_branch_git = {{!}} default_branch_svn = | {{!}} branch = {{!}} type_branch = {{!}} short_branch = {{!}} pos_branch = {{!}} stat_branch = {{!}} default_branch_git = {{!}} default_branch_svn = | ||
{{!}} tag = {{!}} type_tag = {{!}} short_tag = {{!}} pos_tag = {{!}} stat_tag = | {{!}} tag = {{!}} type_tag = {{!}} short_tag = {{!}} pos_tag = {{!}} stat_tag = | ||
{{!}} commit = {{!}} type_commit = {{!}} short_commit = {{!}} pos_commit = {{!}} stat_commit = | |||
{{!}} mr = {{!}} type_mr = {{!}} short_mr = {{!}} pos_mr = {{!}} stat_mr = | |||
{{!}} number = {{!}} type_number = {{!}} short_number = {{!}} pos_number = {{!}} stat_number = | |||
{{!}} path = {{!}} type_path = {{!}} short_path = {{!}} pos_path = {{!}} stat_path = | {{!}} path = {{!}} type_path = {{!}} short_path = {{!}} pos_path = {{!}} stat_path = | ||
{{!}} line = {{!}} type_line = {{!}} short_line = {{!}} pos_line = {{!}} stat_line = | {{!}} line = {{!}} type_line = {{!}} short_line = {{!}} pos_line = {{!}} stat_line = | ||
{{!}} post = {{!}} type_post = {{!}} short_post = {{!}} pos_post = {{!}} stat_post = | {{!}} post = {{!}} type_post = {{!}} short_post = {{!}} pos_post = {{!}} stat_post = {{!}} default_post = | ||
{{!}} view = {{!}} type_view = {{!}} short_view = {{!}} pos_view = {{!}} stat_view = | {{!}} view = {{!}} type_view = {{!}} short_view = {{!}} pos_view = {{!}} stat_view = | ||
{{!}} text = {{!}} type_text = {{!}} short_text = {{!}} pos_text = {{!}} stat_text = | {{!}} text = {{!}} type_text = {{!}} short_text = {{!}} pos_text = {{!}} stat_text = | ||
Line 514: | Line 624: | ||
; site_name: The optional name for the open source infrastructure, for use in some of the parameter descriptions. | ; site_name: The optional name for the open source infrastructure, for use in some of the parameter descriptions. | ||
; type_*: The parameter type. This defaults to | ; type_*: The parameter type. This defaults to {{param||name}} to define this as a named parameter. For an anonymous or numbered parameter, set this to {{param||num}}. | ||
; short_*: The optional abbreviated parameter name used as an alias for the full parameter name. | ; short_*: The optional abbreviated parameter name used as an alias for the full parameter name. | ||
Line 520: | Line 630: | ||
; pos_*: The parameter position for anonymous or numbered parameters. | ; pos_*: The parameter position for anonymous or numbered parameters. | ||
; stat_*: The parameter status, for example | ; stat_*: The parameter status, for example {{param||mandatory}}. This defaults to {{param||optional}}. | ||
; eg_*: An example for the parameter. | ; eg_*: An example for the parameter. | ||
Line 526: | Line 636: | ||
; default_*: The default parameter value. | ; default_*: The default parameter value. | ||
; break: If set to | ; value_*: The value of the parameter, if it is hardcoded. | ||
; intro: Introductory text before the parameter table. This defaults to ''The parameters are:''. | |||
; break: If set to {{param||1}}, an empty line between the URL and text formatting will be added. | |||
== Examples == | == Examples == | ||
Line 543: | Line 657: | ||
{{!}} branch = 1 | {{!}} branch = 1 | ||
{{!}} tag = 1 | {{!}} tag = 1 | ||
{{!}} commit = 1 | |||
{{!}} mr = 1 | |||
{{!}} number = 1 | |||
{{!}} path = 1 | {{!}} path = 1 | ||
{{!}} line = 1 | {{!}} line = 1 | ||
{{!}} post = 1 | {{!}} post = 1 | ||
Line 574: | Line 690: | ||
| branch = 1 | | branch = 1 | ||
| tag = 1 | | tag = 1 | ||
| commit = 1 | |||
| mr = 1 | |||
| number = 1 | |||
| path = 1 | | path = 1 | ||
| line = 1 | | line = 1 | ||
| post = 1 | | post = 1 | ||
Line 606: | Line 724: | ||
{{!}} branch = 1 {{!}} short_branch = b {{!}} pos_branch = 3 | {{!}} branch = 1 {{!}} short_branch = b {{!}} pos_branch = 3 | ||
{{!}} tag = 1 | {{!}} tag = 1 | ||
{{!}} commit = 1 {{!}} short_commit = c {{!}} pos_commit = 5 | |||
{{!}} mr = 1 {{!}} short_mr = m {{!}} pos_mr = 6 | |||
{{!}} number = 1 {{!}} short_number = n {{!}} pos_number = 5 | |||
{{!}} path = 1 {{!}} short_path = f {{!}} pos_path = 4 | {{!}} path = 1 {{!}} short_path = f {{!}} pos_path = 4 | ||
{{!}} line = 1 {{!}} short_line = l | {{!}} line = 1 {{!}} short_line = l | ||
{{!}} post = 1 | {{!}} post = 1 | ||
Line 637: | Line 757: | ||
| branch = 1 | short_branch = b | pos_branch = 3 | | branch = 1 | short_branch = b | pos_branch = 3 | ||
| tag = 1 | | tag = 1 | ||
| commit = 1 | short_commit = c | pos_commit = 5 | |||
| mr = 1 | short_mr = m | pos_mr = 6 | |||
| number = 1 | short_number = m | pos_number = 5 | |||
| path = 1 | short_path = p | pos_path = 4 | | path = 1 | short_path = p | pos_path = 4 | ||
| line = 1 | short_line = l | | line = 1 | short_line = l | ||
| post = 1 | | post = 1 | ||
Line 830: | Line 952: | ||
| gl = 1 | | gl = 1 | ||
| git = 1 | | git = 1 | ||
| break = 0 | |||
}} | |||
==== Custom parameters ==== | |||
{{obr}}repo link/doc usage | |||
{{!}} template = fgaddon file | |||
{{!}} param1 = 1 {{!}} name1 = aircraft {{!}} type1 = num {{!}} pos1 = 1 {{!}} stat1 = mandatory {{!}} desc1 = The aircraft directory name. If empty, the URL of <code><branch>/Aircraft/</code> will be returned. | |||
{{!}} param2 = 1 {{!}} name2 = path {{!}} type2 = num {{!}} pos2 = 2 {{!}} stat2 = mandatory {{!}} desc2 = The file path following from the aircraft directory name. The full file path will be constructed as <code><nowiki><branch>/Aircraft/<path></nowiki></code>. | |||
{{!}} param3 = 1 {{!}} name3 = file {{!}} type3 = named {{!}} stat3 = optional {{!}} desc3 = If set, then a link to the file rather than the full URL will be shown. | |||
{{!}} simplepath = 1 | |||
{{!}} sf = 1 | |||
{{!}} svn = 1 | |||
{{!}} break = 0 | |||
{{cbr}} | |||
{{repo link/doc usage | |||
| template = fgaddon file | |||
| param1 = 1 | name1 = aircraft | type1 = num | pos1 = 1 | stat1 = mandatory | desc1 = The aircraft directory name. If empty, the URL of <code><branch>/Aircraft/</code> will be returned. | |||
| param2 = 1 | name2 = path | type2 = num | pos2 = 2 | stat2 = mandatory | desc2 = The file path following from the aircraft directory name. The full file path will be constructed as <code><nowiki><branch>/Aircraft/<path></nowiki></code>. | |||
| param3 = 1 | name3 = file | type3 = named | stat3 = optional | desc3 = If set, then a link to the file rather than the full URL will be shown. | |||
| simplepath = 1 | |||
| sf = 1 | |||
| svn = 1 | |||
| break = 0 | | break = 0 | ||
}} | }} |
Latest revision as of 08:29, 8 July 2019
Usage
{{MISSING }}
The parameters are:
Parameter | Description | Abbreviated parameter |
Numbered parameter |
Status |
---|
Note If a full parameter name is aliased via an abbreviation or numbered parameter and multiple values are supplied, the order of precedence from highest to lowest priority is: Full parameter; abbreviated parameter; numbered parameter.
The following template description is not displayed when the template is inserted in an article.
Goal
This is a master documentation template for use in all of the {{repo link}} subtemplates. It documents the usage of the templates.
Usage
{{repo link/doc usage | template = | site_name = | site = | type_site = | short_site = | pos_site = | stat_site = | param1 = | type1 = | short1 = | pos1 = | stat1 = | name1 = | desc1 = | param2 = | type2 = | short2 = | pos2 = | stat2 = | name2 = | desc2 = | param3 = | type3 = | short3 = | pos3 = | stat3 = | name3 = | desc3 = | cmd = | type_cmd = | short_cmd = | pos_cmd = | stat_cmd = | value_cmd = | eg_cmd = | opt = | type_opt = | short_opt = | pos_opt = | stat_opt = | protocol = | type_protocol = | short_protocol = | pos_protocol = | stat_protocol = | default_protocol = | login = | type_login = | short_login = | pos_login = | stat_login = | type = | type_type = | short_type = | pos_type = | stat_type = | default_type = | user = | type_user = | short_user = | pos_user = | stat_user = | proj = | type_proj = | short_proj = | pos_proj = | stat_proj = | default_proj = | repo = | type_repo = | short_repo = | pos_repo = | stat_repo = | default_repo = | eg_repo = | branch = | type_branch = | short_branch = | pos_branch = | stat_branch = | default_branch_git = | default_branch_svn = | tag = | type_tag = | short_tag = | pos_tag = | stat_tag = | commit = | type_commit = | short_commit = | pos_commit = | stat_commit = | mr = | type_mr = | short_mr = | pos_mr = | stat_mr = | number = | type_number = | short_number = | pos_number = | stat_number = | path = | type_path = | short_path = | pos_path = | stat_path = | line = | type_line = | short_line = | pos_line = | stat_line = | post = | type_post = | short_post = | pos_post = | stat_post = | default_post = | view = | type_view = | short_view = | pos_view = | stat_view = | text = | type_text = | short_text = | pos_text = | stat_text = | pre = | type_pre = | short_pre = | pos_pre = | stat_pre = | simplepath = | type_simplepath = | short_simplepath = | pos_simplepath = | stat_simplepath = | full = | type_full = | short_full = | pos_full = | stat_full = | intro = | sf = | gh = | gl = | go = | svn = | git = | break = }}
- site_name
- The optional name for the open source infrastructure, for use in some of the parameter descriptions.
- 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.
- value_*
- The value of the parameter, if it is hardcoded.
- intro
- Introductory text before the parameter table. This defaults to The parameters are:.
- break
- If set to 1, an empty line between the URL and text formatting will be added.
Examples
All options
{{repo link/doc usage | template = repo link | site = 1 | cmd = 1 | opt = 1 | protocol = 1 | login = 1 | type = 1 | user = 1 | proj = 1 | repo = 1 | branch = 1 | tag = 1 | commit = 1 | mr = 1 | number = 1 | path = 1 | line = 1 | post = 1 | view = 1 | text = 1 | pre = 1 | simplepath = 1 | full = 1 | intro = All parameters except site are optional. | sf = 1 | gh = 1 | gl = 1 | go = 1 | svn = 1 | git = 1 }}
Usage
{{repo link | site = | cmd = | opt = | protocol = | login = | type = | user = | proj = | repo = | branch = | tag = | commit = | mr = | number = | path = | line = | post = | view = | text = | pre = | simplepath = | full = }}
All parameters except site are optional.
Parameter | Description | Abbreviated parameter |
Numbered parameter |
Status |
---|---|---|---|---|
site | Points the template to a repository host:
|
mandatory | ||
cmd | An optional command line tool name + options to prepend to the URL. For example git clone. | optional | ||
opt | Any additional options to show after cmd, but before the URL.
|
optional | ||
protocol | The URL protocol, for example https, http, ssh, git, svn. This defaults to https. | optional | ||
login | The optional user login. This should not to be confused with the user parameter. | optional | ||
type | Choose between the web interface, a direct repository link, or a zip file download. This can be one of git, git web, svn, svn web, zip. See the {{* zip file}} templates for a simplified interface for the zip files. The default is git web.
|
optional | ||
user | The name of the user page for the 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. | optional | ||
proj | The name of the project, consisting of a grouping of repositories on the open source infrastructure. | optional | ||
repo | The name of the repository. A project registered on one of the open source infrastructures generally allows for multiple repositories under that project name. | optional | ||
branch | The branch name. As tags are simply branches in SVN repositories, this parameter can also be used for svn tags. This defaults to next or trunk for git and svn respectively. For SourceForge git repositories, if the character / is present in the branch name, the text /~ must be appended to the branch.
|
optional | ||
tag | The repository tag name. For SourceForge git repositories, if the character / is present in the tag name, the text /~ must be appended to the tag.
|
optional | ||
commit | The commit identifier (git hash or svn revision number). This defaults to HEAD. | optional | ||
mr | The merge request number. If provided and if the other parameters are present, this overrides any commit, tag, or branch parameter values. | optional | ||
number | The bug/issue/support request/etc. tracker number. If provided and if the other parameters are present, this overrides any commit, tag, branch, or mr parameter values. | optional | ||
path | The file or directory path. | optional | ||
line | The line number(s) of the file to display.
|
optional | ||
post | Text to append. This is forms a set with the parameter cmd and opt. For example it can represent any command line options that come after the URL. | optional | ||
view | View to display:
|
optional | ||
text | Text to display as the link label. Overrides pre. | optional | ||
pre | Prefix to a link label. | optional | ||
simplepath | If set, this strips off the repository name from the URL label, leaving just the contents of the path parameter.
|
optional | ||
full | If set to 1, the full URL will be shown rather than any text label. | optional |
Shortcuts enabled
{{repo link/doc usage | template = repo link | site = 1 | cmd = 1 | opt = 1 | protocol = 1 | login = 1 | type = 1 | short_type = y | user = 1 | short_user = u | pos_user = 1 | proj = 1 | short_proj = p | pos_proj = 1 | repo = 1 | short_repo = r | pos_repo = 2 | branch = 1 | short_branch = b | pos_branch = 3 | tag = 1 | commit = 1 | short_commit = c | pos_commit = 5 | mr = 1 | short_mr = m | pos_mr = 6 | number = 1 | short_number = n | pos_number = 5 | path = 1 | short_path = f | pos_path = 4 | line = 1 | short_line = l | post = 1 | view = 1 | short_view = v | text = 1 | short_text = t | pre = 1 | simplepath = 1 | full = 1 | short_full = f | intro = All parameters except site are optional. | sf = 1 | gh = 1 | gl = 1 | go = 1 | svn = 1 | git = 1 }}
Usage
{{repo link | site = | cmd = | opt = | protocol = | login = | type = | user = | proj = | repo = | branch = | tag = | commit = | mr = | number = | path = | line = | post = | view = | text = | pre = | simplepath = | full = }}
All parameters except site are optional.
Parameter | Description | Abbreviated parameter |
Numbered parameter |
Status |
---|---|---|---|---|
site | Points the template to a repository host:
|
mandatory | ||
cmd | An optional command line tool name + options to prepend to the URL. For example git clone. | optional | ||
opt | Any additional options to show after cmd, but before the URL.
|
optional | ||
protocol | The URL protocol, for example https, http, ssh, git, svn. This defaults to https. | optional | ||
login | The optional user login. This should not to be confused with the user parameter. | optional | ||
type | Choose between the web interface, a direct repository link, or a zip file download. This can be one of git, git web, svn, svn web, zip. See the {{* zip file}} templates for a simplified interface for the zip files. The default is git web.
|
y | optional | |
user | The name of the user page for the 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. | u | 1 | optional |
proj | The name of the project, consisting of a grouping of repositories on the open source infrastructure. | j | 1 | optional |
repo | The name of the repository. A project registered on one of the open source infrastructures generally allows for multiple repositories under that project name. | r | 2 | optional |
branch | The branch name. As tags are simply branches in SVN repositories, this parameter can also be used for svn tags. This defaults to next or trunk for git and svn respectively. For SourceForge git repositories, if the character / is present in the branch name, the text /~ must be appended to the branch.
|
b | 3 | optional |
tag | The repository tag name. For SourceForge git repositories, if the character / is present in the tag name, the text /~ must be appended to the tag.
|
optional | ||
commit | The commit identifier (git hash or svn revision number). This defaults to HEAD. | c | 5 | optional |
mr | The merge request number. If provided and if the other parameters are present, this overrides any commit, tag, or branch parameter values. | m | 6 | optional |
number | The bug/issue/support request/etc. tracker number. If provided and if the other parameters are present, this overrides any commit, tag, branch, or mr parameter values. | m | 5 | optional |
path | The file or directory path. | p | 4 | optional |
line | The line number(s) of the file to display.
|
l | optional | |
post | Text to append. This is forms a set with the parameter cmd and opt. For example it can represent any command line options that come after the URL. | optional | ||
view | View to display:
|
v | optional | |
text | Text to display as the link label. Overrides pre. | t | optional | |
pre | Prefix to a link label. | optional | ||
simplepath | If set, this strips off the repository name from the URL label, leaving just the contents of the path parameter.
|
optional | ||
full | If set to 1, the full URL will be shown rather than any text label. | f | optional |
Parameter: type
Everything
{{repo link/doc usage | template = repo link | type = 1 | sf = 1 | gh = 1 | gl = 1 | go = 1 | svn = 1 | git = 1 | break = 0 }}
Usage
{{repo link | type = }}
The parameters are:
Parameter | Description | Abbreviated parameter |
Numbered parameter |
Status |
---|---|---|---|---|
type | Choose between the web interface, a direct repository link, or a zip file download. This can be one of git, git web, svn, svn web, zip. See the {{* zip file}} templates for a simplified interface for the zip files. The default is git web.
|
optional |
Everything svn
{{repo link/doc usage | template = repo link | type = 1 | sf = 1 | gh = 1 | gl = 1 | go = 1 | svn = 1 | break = 0 }}
Usage
{{repo link | type = }}
The parameters are:
Parameter | Description | Abbreviated parameter |
Numbered parameter |
Status |
---|---|---|---|---|
type | Choose between the web interface, a direct repository link, or a zip file download. This can be one of svn, svn web, zip. See the {{* zip file}} templates for a simplified interface for the zip files. The default is svn web.
|
optional |
Everything git
{{repo link/doc usage | template = repo link | type = 1 | sf = 1 | gh = 1 | gl = 1 | go = 1 | git = 1 | break = 0 }}
Usage
{{repo link | type = }}
The parameters are:
Parameter | Description | Abbreviated parameter |
Numbered parameter |
Status |
---|---|---|---|---|
type | Choose between the web interface, a direct repository link, or a zip file download. This can be one of git, git web, zip. See the {{* zip file}} templates for a simplified interface for the zip files. The default is git web.
|
optional |
SourceForge
{{repo link/doc usage | template = repo link | type = 1 | sf = 1 | svn = 1 | git = 1 | break = 0 }}
Usage
{{repo link | type = }}
The parameters are:
Parameter | Description | Abbreviated parameter |
Numbered parameter |
Status |
---|---|---|---|---|
type | Choose between the web interface or a direct repository link. This can be one of git, git web, svn, svn web. The default is git web. | optional |
SourceForge svn
{{repo link/doc usage | template = repo link | type = 1 | sf = 1 | svn = 1 | break = 0 }}
Usage
{{repo link | type = }}
The parameters are:
Parameter | Description | Abbreviated parameter |
Numbered parameter |
Status |
---|---|---|---|---|
type | Choose between the web interface or a direct repository link. This can be one of svn, svn web. The default is svn web. | optional |
SourceForge git
{{repo link/doc usage | template = repo link | type = 1 | sf = 1 | git = 1 | break = 0 }}
Usage
{{repo link | type = }}
The parameters are:
Parameter | Description | Abbreviated parameter |
Numbered parameter |
Status |
---|---|---|---|---|
type | Choose between the web interface or a direct repository link. This can be one of git, git web. The default is git web. | optional |
GitHub and GitLab
{{repo link/doc usage | template = repo link | type = 1 | gh = 1 | gl = 1 | git = 1 | break = 0 }}
Usage
{{repo link | type = }}
The parameters are:
Parameter | Description | Abbreviated parameter |
Numbered parameter |
Status |
---|---|---|---|---|
type | Choose between the web interface, a direct repository link, or a zip file download. This can be one of git, git web, zip. See the {{* zip file}} templates for a simplified interface for the zip files. The default is git web. | optional |
GitHub
{{repo link/doc usage | template = repo link | type = 1 | gh = 1 | git = 1 | break = 0 }}
Usage
{{repo link | type = }}
The parameters are:
Parameter | Description | Abbreviated parameter |
Numbered parameter |
Status |
---|---|---|---|---|
type | Choose between the web interface, a direct repository link, or a zip file download. This can be one of git, git web, zip. See the {{* zip file}} templates for a simplified interface for the zip files. The default is git web. | optional |
GitLab
{{repo link/doc usage | template = repo link | type = 1 | gl = 1 | git = 1 | break = 0 }}
Usage
{{repo link | type = }}
The parameters are:
Parameter | Description | Abbreviated parameter |
Numbered parameter |
Status |
---|---|---|---|---|
type | Choose between the web interface, a direct repository link, or a zip file download. This can be one of git, git web, zip. See the {{* zip file}} templates for a simplified interface for the zip files. The default is git web. | optional |
Custom parameters
{{repo link/doc usage | template = fgaddon file | param1 = 1 | name1 = aircraft | type1 = num | pos1 = 1 | stat1 = mandatory | desc1 = The aircraft directory name. If empty, the URL of<branch>/Aircraft/
will be returned. | param2 = 1 | name2 = path | type2 = num | pos2 = 2 | stat2 = mandatory | desc2 = The file path following from the aircraft directory name. The full file path will be constructed as<branch>/Aircraft/<path>
. | param3 = 1 | name3 = file | type3 = named | stat3 = optional | desc3 = If set, then a link to the file rather than the full URL will be shown. | simplepath = 1 | sf = 1 | svn = 1 | break = 0 }}
Usage
{{fgaddon file | aircraft | path | file = | simplepath = }}
The parameters are:
Parameter | Description | Abbreviated parameter |
Numbered parameter |
Status |
---|---|---|---|---|
aircraft | The aircraft directory name. If empty, the URL of <branch>/Aircraft/ will be returned.
|
1 | mandatory | |
path | The file path following from the aircraft directory name. The full file path will be constructed as <branch>/Aircraft/<path> .
|
2 | mandatory | |
file | If set, then a link to the file rather than the full URL will be shown. | optional | ||
simplepath | If set, this strips off the repository name from the URL label, leaving just the contents of the path parameter.
|
optional |
Related templates
|