Template:Fgaddon co: Difference between revisions
Jump to navigation
Jump to search
(Switch to {{repo link/doc usage}} for consistent subtemplate usage documentation, and added {{repo link/doc plain text}}.) |
(Full support for aliased and numbered parameters, with examples to demonstrate the capabilities.) |
||
| Line 1: | Line 1: | ||
{{#tag:nowiki|{{repo link | {{#tag:nowiki|{{repo link | ||
| site | | site = {{project infrastructure|abbrev}} | ||
| cmd | | cmd = svn co {{{opt|}}} | ||
| protocol | | protocol = {{#if: {{{login|}}} | svn+ssh | https}} | ||
| login{{#if:{{{login|}}}||NULL}} | | login{{#if:{{{login|}}}||NULL}} = {{{login}}} | ||
| type | | type = svn | ||
| repo | | repo = fgaddon | ||
| branch{{#if:{{{branch|}}}||NULL}} = {{{branch}}} | | branch{{#if:{{{branch|{{{b|{{{1|}}}}}}}}}||NULL}} = {{{branch|{{{b|{{{1}}}}}}}}} | ||
| path{{#if:{{{path|}}}||NULL}} = {{{path}}} | | path{{#if:{{{path|{{{f|{{{2|}}}}}}}}}||NULL}} = {{{path|{{{f|{{{2}}}}}}}}} | ||
| post | | post = {{{post|fgaddon}}} | ||
| full | | full = 1 | ||
}} }}<noinclude> | }} }}<noinclude> | ||
{{Informative template|1= | {{Informative template|1= | ||
| Line 20: | Line 20: | ||
| opt = 1 | | opt = 1 | ||
| login = 1 | | login = 1 | ||
| branch = 1 | | branch = 1 | short_branch = b | pos_branch = 1 | ||
| path = 1 | | path = 1 | short_path = f | pos_path = 2 | ||
| post = 1 | default_post = fgaddon | | post = 1 | default_post = fgaddon | ||
| sf = 1 | | sf = 1 | ||
| Line 67: | Line 67: | ||
| post = | | post = | ||
}} | }} | ||
=== Aliased parameters === | |||
{{obr}}fgaddon co | |||
{{!}} b = branches/release-3.2.0 | |||
{{!}} f = Aircraft/V22-Osprey | |||
{{cbr}}. | |||
{{fgaddon co | |||
| b = branches/release-3.2.0 | |||
| f = Aircraft/V22-Osprey | |||
}}. | |||
=== Numbered parameters === | |||
{{obr}}fgaddon co {{!}} branches/release-3.2.0 {{!}} Aircraft/V22-Osprey {{cbr}}. | |||
{{fgaddon co | branches/release-3.2.0 | Aircraft/V22-Osprey }}. | |||
== Related templates == | == Related templates == | ||
Revision as of 21:54, 6 March 2016
svn co https://svn.code.sf.net/p/flightgear/fgaddon/trunk fgaddon
The following template description is not displayed when the template is inserted in an article.
Goal
To provide a consistent representation of the command to checkout the FGAddon subversion repository.
Usage
{{fgaddon co
| opt =
| login =
| branch =
| path =
| post =
}}
The parameters are:
| Parameter | Description | Abbreviated parameter |
Numbered parameter |
Status |
|---|---|---|---|---|
| opt | Any additional options to show after cmd, but before the URL. | optional | ||
| login | The optional user login. | 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 trunk. | b | 1 | optional |
| path | The file or directory path. | f | 2 | optional |
| post | Text to append. This is forms a set with the parameter opt. For example it can represent any command line options that come after the URL. The default value is fgaddon. | optional |
Plain text
To create a URL or link as plain text and avoid external links, simply use the {{#tag:tagname|content}} magic word construct:
{{#tag:nowiki|
{{repo link
| full = 1
}}
}}
https://sourceforge.net/p/flightgear/flightgear/ci/next/tree/
To use the <code> tags:
{{#tag:code|{{#tag:nowiki|
{{repo link
| full = 1
}}
}}}}
https://sourceforge.net/p/flightgear/flightgear/ci/next/tree/
Examples
Checkout of trunk with user name
{{fgaddon co
| opt = --username <username>
| post = fgaddon
}}
svn co --username <username> https://svn.code.sf.net/p/flightgear/fgaddon/trunk fgaddon
Checkout of aircraft from a branch
{{fgaddon co
| branch = branches/release-3.4.0
| path = Aircraft/V22-Osprey
| post =
}}
svn co https://svn.code.sf.net/p/flightgear/fgaddon/branches/release-3.4.0/Aircraft/V22-Osprey
Checkout of aircraft as a user
{{fgaddon co
| login = <username>
| path = Aircraft/wrightFlyer1903
| post =
}}
svn co svn+ssh://<username>@svn.code.sf.net/p/flightgear/fgaddon/trunk/Aircraft/wrightFlyer1903
Aliased parameters
{{fgaddon co
| b = branches/release-3.2.0
| f = Aircraft/V22-Osprey
}}.
svn co https://svn.code.sf.net/p/flightgear/fgaddon/branches/release-3.2.0/Aircraft/V22-Osprey fgaddon .
Numbered parameters
{{fgaddon co | branches/release-3.2.0 | Aircraft/V22-Osprey }}.
svn co https://svn.code.sf.net/p/flightgear/fgaddon/branches/release-3.2.0/Aircraft/V22-Osprey fgaddon .
Related templates
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||