Difference between revisions of "Template:Repo link/doc usage"
Jump to navigation
Jump to search
(Updated the instructions for explaining the SourceForge git repository workaround of appending '/~' to the branch or tag name, if the '/' character is present.) |
Bugman admin (talk | contribs) m (Switch from the imported {{informative template}} to the relax {{template info}} template) |
||
(2 intermediate revisions by the same user not shown) | |||
Line 278: | Line 278: | ||
! Status | ! Status | ||
{{#ifeq: {{{site|}}} | 1 | | {{#ifeq: {{{site|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{param|site}} | {{!}} {{param|site}} | ||
{{!}} Points the template to a repository host: | {{!}} Points the template to a repository host: | ||
Line 289: | Line 289: | ||
{{!}} 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}}} | ||
− | + | {{!}}- | |
}}{{#ifeq: {{{param1|}}} | 1 | | }}{{#ifeq: {{{param1|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{param|{{{name1}}}}} | {{!}} {{param|{{{name1}}}}} | ||
{{!}} {{{desc1}}} | {{!}} {{{desc1}}} | ||
Line 297: | Line 297: | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos1|}}} | {{param|{{{pos1}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos1|}}} | {{param|{{{pos1}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat1|optional}}} | {{!}} style="text-align: center" {{!}} {{{stat1|optional}}} | ||
− | + | {{!}}- | |
}}{{#ifeq: {{{param2|}}} | 1 | | }}{{#ifeq: {{{param2|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{param|{{{name2}}}}} | {{!}} {{param|{{{name2}}}}} | ||
{{!}} {{{desc2}}} | {{!}} {{{desc2}}} | ||
Line 305: | Line 305: | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos2|}}} | {{param|{{{pos2}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos2|}}} | {{param|{{{pos2}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat2|optional}}} | {{!}} style="text-align: center" {{!}} {{{stat2|optional}}} | ||
− | + | {{!}}- | |
}}{{#ifeq: {{{param3|}}} | 1 | | }}{{#ifeq: {{{param3|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{param|{{{name3}}}}} | {{!}} {{param|{{{name3}}}}} | ||
{{!}} {{{desc3}}} | {{!}} {{{desc3}}} | ||
Line 313: | Line 313: | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos3|}}} | {{param|{{{pos3}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos3|}}} | {{param|{{{pos3}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat3|optional}}} | {{!}} style="text-align: center" {{!}} {{{stat3|optional}}} | ||
− | + | {{!}}- | |
}}{{#ifeq: {{{cmd|}}} | 1 | | }}{{#ifeq: {{{cmd|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{param|cmd}} | {{!}} {{param|cmd}} | ||
{{!}} An optional command line tool name + options to prepend to the URL. For example {{param||{{{eg_cmd|git clone}}}}}. | {{!}} An optional command line tool name + options to prepend to the URL. For example {{param||{{{eg_cmd|git clone}}}}}. | ||
Line 321: | Line 321: | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_cmd|}}} | {{param|{{{pos_cmd}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_cmd|}}} | {{param|{{{pos_cmd}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat_cmd|optional}}} | {{!}} style="text-align: center" {{!}} {{{stat_cmd|optional}}} | ||
− | + | {{!}}- | |
}}{{#ifeq: {{{opt|}}} | 1 | | }}{{#ifeq: {{{opt|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{param|opt}} | {{!}} {{param|opt}} | ||
{{!}} Any additional options to show after {{#if: {{{value_cmd|}}} | the command {{#tag:code|{{{value_cmd}}}}} | {{param|cmd}}}}, but before the URL.{{#ifeq: {{{cmd|}}} | 1 | | {{!}} Any additional options to show after {{#if: {{{value_cmd|}}} | the command {{#tag:code|{{{value_cmd}}}}} | {{param|cmd}}}}, but before the URL.{{#ifeq: {{{cmd|}}} | 1 | | ||
Line 331: | Line 331: | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_opt|}}} | {{param|{{{pos_opt}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_opt|}}} | {{param|{{{pos_opt}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat_opt|optional}}} | {{!}} style="text-align: center" {{!}} {{{stat_opt|optional}}} | ||
− | + | {{!}}- | |
}}{{#ifeq: {{{protocol|}}} | 1 | | }}{{#ifeq: {{{protocol|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{param|protocol}} | {{!}} {{param|protocol}} | ||
{{!}} 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}}}}}. | {{!}} 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}}}}}. | ||
Line 339: | Line 339: | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_protocol|}}} | {{param|{{{pos_protocol}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_protocol|}}} | {{param|{{{pos_protocol}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat_protocol|optional}}} | {{!}} style="text-align: center" {{!}} {{{stat_protocol|optional}}} | ||
− | + | {{!}}- | |
}}{{#ifeq: {{{login|}}} | 1 | | }}{{#ifeq: {{{login|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{param|login}} | {{!}} {{param|login}} | ||
{{!}} The optional user login. {{#ifeq:{{{user|}}}|1|This should not to be confused with the {{param|user}} parameter.}} | {{!}} The optional user login. {{#ifeq:{{{user|}}}|1|This should not to be confused with the {{param|user}} parameter.}} | ||
Line 347: | Line 347: | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_login|}}} | {{param|{{{pos_login}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_login|}}} | {{param|{{{pos_login}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat_login|optional}}} | {{!}} style="text-align: center" {{!}} {{{stat_login|optional}}} | ||
− | + | {{!}}- | |
}}{{#ifeq: {{{type|}}} | 1 | | }}{{#ifeq: {{{type|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{param|type}} | {{!}} {{param|type}} | ||
{{!}} {{#ifeq: {{{gh|{{{gl|}}}}}} | 1 | {{!}} {{#ifeq: {{{gh|{{{gl|}}}}}} | 1 | ||
Line 379: | Line 379: | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_type|}}} | {{param|{{{pos_type}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_type|}}} | {{param|{{{pos_type}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat_type|optional}}} | {{!}} style="text-align: center" {{!}} {{{stat_type|optional}}} | ||
− | + | {{!}}- | |
}}{{#ifeq: {{{user|}}} | 1 | | }}{{#ifeq: {{{user|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{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 {{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. | {{!}} 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. | ||
Line 387: | Line 387: | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_user|}}} | {{param|{{{pos_user}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_user|}}} | {{param|{{{pos_user}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat_user|optional}}} | {{!}} style="text-align: center" {{!}} {{{stat_user|optional}}} | ||
− | + | {{!}}- | |
}}{{#ifeq: {{{proj|}}} | 1 | | }}{{#ifeq: {{{proj|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{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.{{#if: {{{default_proj|}}} | This defaults to {{param||{{{default_proj}}}}}.}} | {{!}} 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}}}}}.}} | ||
Line 395: | Line 395: | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_proj|}}} | {{param|{{{pos_proj}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_proj|}}} | {{param|{{{pos_proj}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat_proj|optional}}} | {{!}} style="text-align: center" {{!}} {{{stat_proj|optional}}} | ||
− | + | {{!}}- | |
}}{{#ifeq: {{{repo|}}} | 1 | | }}{{#ifeq: {{{repo|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{param|repo}} | {{!}} {{param|repo}} | ||
{{!}} 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}}}}}.}} | {{!}} 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}}}}}.}} | ||
Line 403: | Line 403: | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_repo|}}} | {{param|{{{pos_repo}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_repo|}}} | {{param|{{{pos_repo}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat_repo|optional}}} | {{!}} style="text-align: center" {{!}} {{{stat_repo|optional}}} | ||
− | + | {{!}}- | |
}}{{#ifeq: {{{branch|}}} | 1 | | }}{{#ifeq: {{{branch|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{param|branch}} | {{!}} {{param|branch}} | ||
{{!}} The branch name. <!-- | {{!}} The branch name. <!-- | ||
Line 426: | Line 426: | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_branch|}}} | {{param|{{{pos_branch}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_branch|}}} | {{param|{{{pos_branch}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat_branch|optional}}} | {{!}} style="text-align: center" {{!}} {{{stat_branch|optional}}} | ||
− | + | {{!}}- | |
}}{{#ifeq: {{{tag|}}} | 1 | | }}{{#ifeq: {{{tag|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{param|tag}} | {{!}} {{param|tag}} | ||
{{!}} The repository tag name. <!-- | {{!}} The repository tag name. <!-- | ||
Line 439: | Line 439: | ||
{{!}} 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}}} | ||
− | + | {{!}}- | |
}}{{#ifeq: {{{commit|}}} | 1 | | }}{{#ifeq: {{{commit|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{param|commit}} | {{!}} {{param|commit}} | ||
{{!}} The commit identifier<!-- | {{!}} The commit identifier<!-- | ||
Line 457: | Line 457: | ||
{{!}} 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}}} | ||
− | + | {{!}}- | |
}}{{#ifeq: {{{mr|}}} | 1 | | }}{{#ifeq: {{{mr|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{param|mr}} | {{!}} {{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. | {{!}} 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. | ||
Line 465: | Line 465: | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_mr|}}} | {{param|{{{pos_mr}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_mr|}}} | {{param|{{{pos_mr}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat_mr|optional}}} | {{!}} style="text-align: center" {{!}} {{{stat_mr|optional}}} | ||
− | + | {{!}}- | |
}}{{#ifeq: {{{path|}}} | 1 | | }}{{#ifeq: {{{path|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{param|path}} | {{!}} {{param|path}} | ||
{{!}} The file or directory path. | {{!}} The file or directory path. | ||
Line 473: | Line 473: | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_path|}}} | {{param|{{{pos_path}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_path|}}} | {{param|{{{pos_path}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat_path|optional}}} | {{!}} style="text-align: center" {{!}} {{{stat_path|optional}}} | ||
− | + | {{!}}- | |
}}{{#ifeq: {{{line|}}} | 1 | | }}{{#ifeq: {{{line|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{param|line}} | {{!}} {{param|line}} | ||
{{!}} The line number(s) of the file to display. | {{!}} The line number(s) of the file to display. | ||
Line 493: | Line 493: | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_line|}}} | {{param|{{{pos_line}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_line|}}} | {{param|{{{pos_line}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat_line|optional}}} | {{!}} style="text-align: center" {{!}} {{{stat_line|optional}}} | ||
− | + | {{!}}- | |
}}{{#ifeq: {{{post|}}} | 1 | | }}{{#ifeq: {{{post|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{param|post}} | {{!}} {{param|post}} | ||
{{!}} 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}}}}}.}} | {{!}} 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}}}}}.}} | ||
Line 501: | Line 501: | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_post|}}} | {{param|{{{pos_post}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_post|}}} | {{param|{{{pos_post}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat_post|optional}}} | {{!}} style="text-align: center" {{!}} {{{stat_post|optional}}} | ||
− | + | {{!}}- | |
}}{{#ifeq: {{{view|}}} | 1 | | }}{{#ifeq: {{{view|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{param|view}} | {{!}} {{param|view}} | ||
{{!}} View to display: | {{!}} View to display: | ||
Line 518: | Line 518: | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_view|}}} | {{param|{{{pos_view}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_view|}}} | {{param|{{{pos_view}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat_view|optional}}} | {{!}} style="text-align: center" {{!}} {{{stat_view|optional}}} | ||
− | + | {{!}}- | |
}}{{#ifeq: {{{text|}}} | 1 | | }}{{#ifeq: {{{text|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{param|text}} | {{!}} {{param|text}} | ||
{{!}} Text to display as the link label. {{#if: {{{pre|}}} | Overrides {{param|pre}}.}} | {{!}} Text to display as the link label. {{#if: {{{pre|}}} | Overrides {{param|pre}}.}} | ||
Line 526: | Line 526: | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_text|}}} | {{param|{{{pos_text}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_text|}}} | {{param|{{{pos_text}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat_text|optional}}} | {{!}} style="text-align: center" {{!}} {{{stat_text|optional}}} | ||
− | + | {{!}}- | |
}}{{#ifeq: {{{pre|}}} | 1 | | }}{{#ifeq: {{{pre|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{param|pre}} | {{!}} {{param|pre}} | ||
{{!}} Prefix to a link label. | {{!}} Prefix to a link label. | ||
Line 534: | Line 534: | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_pre|}}} | {{param|{{{pos_pre}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_pre|}}} | {{param|{{{pos_pre}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat_pre|optional}}} | {{!}} style="text-align: center" {{!}} {{{stat_pre|optional}}} | ||
− | + | {{!}}- | |
}}{{#ifeq: {{{simplepath|}}} | 1 | | }}{{#ifeq: {{{simplepath|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{param|simplepath}} | {{!}} {{param|simplepath}} | ||
{{!}} If set, this strips off the repository name from the URL label, leaving just the contents of the {{param|path}} parameter. | {{!}} If set, this strips off the repository name from the URL label, leaving just the contents of the {{param|path}} parameter. | ||
Line 543: | Line 543: | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_simplepath|}}} | {{{pos_simplepath|}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_simplepath|}}} | {{{pos_simplepath|}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat_simplepath|optional}}} | {{!}} style="text-align: center" {{!}} {{{stat_simplepath|optional}}} | ||
− | + | {{!}}- | |
}}{{#ifeq: {{{full|}}} | 1 | | }}{{#ifeq: {{{full|}}} | 1 | | ||
− | + | {{!}}- | |
{{!}} {{param|full}} | {{!}} {{param|full}} | ||
{{!}} If set to {{param||1}}, 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. | ||
Line 551: | Line 551: | ||
{{!}} style="text-align: center" {{!}} {{#if: {{{pos_full|}}} | {{param|{{{pos_full}}}}}}} | {{!}} style="text-align: center" {{!}} {{#if: {{{pos_full|}}} | {{param|{{{pos_full}}}}}}} | ||
{{!}} style="text-align: center" {{!}} {{{stat_full|optional}}} | {{!}} style="text-align: center" {{!}} {{{stat_full|optional}}} | ||
− | + | {{!}}- | |
}} | }} | ||
|}<noinclude> | |}<noinclude> | ||
Line 557: | Line 557: | ||
{{inote|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.}} | {{inote|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.}} | ||
− | {{ | + | {{template info|1= |
__NOTOC__ | __NOTOC__ | ||
== Goal == | == Goal == |
Latest revision as of 13:33, 23 October 2020
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.
Template documentation
Contents
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 = | 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 | 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 = | 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 | ||
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 | 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 = | 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 |
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
|