Difference between revisions of "PC-BSD® Wiki:Template QuickRef"

From PC-BSD Wiki
Jump to: navigation, search
 
(92 intermediate revisions by one user not shown)
Line 1: Line 1:
{{swapTitle|custompagename=PC-BSD{{r}} Wiki:Template QuickRef|custompagecategory=PC-BSD{{RM}} Wiki:Template QuickRef}}
+
{{swapTitle|title=PC-BSD{{r}} Wiki:Template QuickRef}}
 +
<div class="mw-collapsible mw-collapsed rinlineblock floatright txtsm supertop">'''[Key]'''<div class="mw-collapsible-content txtlg supertop">{{key|code|align=right|width=auto|icon64={{b|Bold Roman}} - required{{br
 +
}}Roman - required variable value{{br
 +
}}{{i|Italic}} - optional variable value{{br
 +
}}{{bi|Bold Italic}} - optional variable{{br
 +
}}{{greytxt|Grey Text}} - Not part of result{{br 
 +
}}1 - specific symbol{{br
 +
}}2 - two-part template{{br
 +
}}3 - prevents wiki parser{{br
 +
}}4 - adds specific style{{br
 +
}}5 - helper/modifiers}}</div>
 
__NOTOC__
 
__NOTOC__
 
__NOEDITSECTION__
 
__NOEDITSECTION__
{{key|code|align=right|width=auto|icon64={{b|Bold Roman}} - required<br
+
</div>
/>Roman - required variable value<br
+
<div class="twocolumn extrabottom">
/>{{i|Italic}} - optional variable value<br
+
===[[template:Citelink|CiteLink]]<span class=keysymbol>[[template:Citelink|[2]]]</span>===
/>{{bi|Bold Italic}} - optional variable<br
+
{{b|{{cbL|2}}Citelink{{!}}url{{=}}}}complete URL{{b|{{!}}txt{{=}}}}alternate text for external link{{b|{{cbR|2}}}}{{br}}
/>1 - specific symbol<br
+
{{b|{{cbL|2}}Citelink{{!}}url{{=}}}}shortcut{{bi|{{!}}url{{=}}}}{{i|page URL}}{{b|{{!}}}}{{b|txt{{=}}}}alternate {{local|link=template:OurInterwiki|OurInterwiki}} link text{{b|{{cbR|2}}}}{{br}}
/>2 - two-part template<br
+
----
/>3 - prevents wiki parser<br
+
===[[template:Danger|Danger txtbox]]===
/>4 - adds specific style<br
+
{{b|{{cbL|2}}danger{{!}}}}{{bi|icon64{{=}}}}text{{b|{{cbR|2}}}}
/>5 - helper/modifiers}}
+
----
===[[template:Citelink|Cite Link]]{{symbol|2}}===
+
===Figure {{vtag|pageNUM}}{{vtag|letter}}{{symbol|[[template:FigureID|5]]}}===
: {{b|<nowiki>{{Citelink|url=</nowiki>}}complete URL{{b|<nowiki>|txt=</nowiki>}}alternate text for external link{{b|<nowiki>}}</nowiki>}}
+
{{b|{{cbL|2}}figureID{{!}}}}letter{{b|{{cbR|2}}}}{{br}}
: {{b|<nowiki>{{Citelink|</nowiki>}}shortcut{{bi|<nowiki>|url=</nowiki>}}{{i|page URL}}{{b|<nowiki>|</nowiki>}}{{b|<nowiki>txt=</nowiki>}}alternate text for OurInterwiki link{{b|<nowiki>}}</nowiki>}}
+
----
: {{b|<nowiki>{{Citelink|</nowiki>}}shortcut{{b|<nowiki>|txtAb=</nowiki>}}alternate text for abbreviated link{{b|<nowiki>}}</nowiki>}}
+
==={{Ftp}}{{symbol|[[template:Ftp|3]]}}===
 
+
{{b|{{ttag|ftp}}}}
===[[template:Danger|Danger]]===
+
----
: {{b|<nowiki>{{danger|</nowiki>}}{{bi|<nowiki>width=</nowiki>}}{{i|size of box in px or % of page}}{{bi|<nowiki>|align=</nowiki>}}{{i|left or right}}{{bi|<nowiki>|icon64=</nowiki>}}text{{b|<nowiki>}}</nowiki>}}
+
==={{git}}{{symbol|[[template:git|3]]}}===
 
+
{{b|{{ttag|git}}}}
===[[template:Ftp|Ftp]]{{symbol|3}}===
+
----
: '''<nowiki>{{ftp}}</nowiki>'''
+
==={{highlight|Highlight}}{{symbol|[[template:Highlight|4]]}}===
 
+
{{b|{{cbL|2}}highlight{{!}}}}{{bi|text{{=}}text}}{{b|{{cbR|2}}}}
===[[template:GroupListHeading|GroupListHeading]]{{symbol|2}}===
+
----
: {{b|<nowiki>{{GroupListHeading|</nowiki>}}{{b|<nowiki>group=</nowiki>}}{{b|tables}}{{b|<nowiki>}}</nowiki>}}
+
==={{Http}}{{symbol|[[template:Http|3]]}}===
: tables is one [[template:GroupList|grouplist item]] but this template is not yet localization friendly and will be adjusted transparently in the future.
+
{{b|{{ttag|http}}}}
 
+
----
===[[template:Highlight|Highlight]]{{symbol|4}}===
+
==={{Https}}{{symbol|[[template:Https|3]]}}===
: {{b|<nowiki>{{highlight|</nowiki>}}{{bi|<nowiki>text=</nowiki>}}text{{b|<nowiki>}}</nowiki>}}
+
{{b|{{ttag|https}}}}
 
+
----
===[[template:Http|Http]]{{symbol|3}}===
+
: '''<nowiki>{{http}}</nowiki>'''
+
 
+
===[[template:Https|Https]]{{symbol|3}}===
+
: '''<nowiki>{{https}}</nowiki>'''
+
 
+
 
===[[template:Local|Local]]===
 
===[[template:Local|Local]]===
: {{b|<nowiki>{{local|link=</nowiki>}}page name{{bi|<nowiki>|anchor=</nowiki>}}{{i|page sub-heading}}{{b|<nowiki>|</nowiki>}}{{i|alternate text}}{{b|<nowiki>}}</nowiki>}}
+
{{b|{{cbL|2}}local{{!}}link{{=}}}}page name{{bi|{{!}}anchor{{=}}}}{{i|(omit #)sub-heading}}{{b|{{!}}}}{{i|alternate text}}{{b|{{cbR|2}}}}
 
+
----
===[[template:NavHeader|Navigation Header]]===
+
===[[template:UseTOC/{{release}}|Navigation Header]]===
: {{b|<nowiki>{{NavHeader|back=</nowiki>}}name of the previous page{{b|<nowiki>|forward=</nowiki>}}name of the next page{{bi|<nowiki>|custompagename=</nowiki>}}{{i|custom page name}}{{bi|<nowiki>|custompagecategory=</nowiki>}}{{i|custom page category}}{{b|<nowiki>}}</nowiki>}}
+
{{b|<nowiki>{{UseTOC{{putVers}}</nowiki>}}{{bi|<nowiki>|</nowiki>}}{{i|special title such as with {{RM}} via <nowiki>{{r}} or {{pcbsd}}</nowiki>}}{{b|<nowiki>}}</nowiki>}}
 
+
----
 
===[[template:Nbsp|Nbsp]]{{symbol|5}}===
 
===[[template:Nbsp|Nbsp]]{{symbol|5}}===
: {{b|<nowiki>{{nbsp|</nowiki>}}{{i|number of non-breaking spaces or default of 1}}{{b|<nowiki>}}</nowiki>}}
+
{{b|<nowiki>{{nbsp|</nowiki>}}{{i|number of non-breaking spaces or default of 1}}{{b|<nowiki>}}</nowiki>}}
 
+
----
===[[template:Note|Note]]===
+
===[[template:Note|Note txtbox]]===
: {{b|<nowiki>{{note|</nowiki>}}{{bi|<nowiki>width=</nowiki>}}{{i|size of box in px or % of page}}{{bi|<nowiki>|align=</nowiki>}}{{i|left or right}}{{bi|<nowiki>|icon64=</nowiki>}}text{{b|<nowiki>}}</nowiki>}}
+
{{b|<nowiki>{{note|</nowiki>}}{{bi|<nowiki>icon64=</nowiki>}}text{{b|<nowiki>}}</nowiki>}}
 
+
----
===[[template:Orangelight|Orangelight]]{{symbol|4}}===
+
==={{orangelight|Orangelight}}{{symbol|[[template:Orangelight|4]]}}===
: {{b|<nowiki>{{orangelight|</nowiki>}}{{bi|<nowiki>text=</nowiki>}}text{{b|<nowiki>}}</nowiki>}}
+
{{b|<nowiki>{{orangelight|</nowiki>}}{{bi|<nowiki>text=</nowiki>}}text{{b|<nowiki>}}</nowiki>}}
 
+
----
===[[template:Redlight|Redlight]]{{symbol|4}}===
+
===[[template:pageNUM|pageNUM]]{{symbol|5}}===
: {{b|<nowiki>{{redlight|</nowiki>}}{{bi|<nowiki>text=</nowiki>}}text{{b|<nowiki>}}</nowiki>}}
+
{{b|{{ttag|pageNUM}}}}{{br}}
 
+
{{b|{{cbL|2}}pageNUM{{!}}}}{{i|reference page}}{{b|{{cbR|2}}}}{{br}}
===[[template:Refheading|Refheading]]{{symbol|2}}===
+
Display only pageNUM of the current or "reference page".{{br}}
: '''<nowiki>{{refheading}}</nowiki>'''
+
These do not work correctly as the link '''text''' of “local” template.
 
+
----
===[[template:r|Registered (superscript)]]{{symbol|1,4}}===
+
==={{pcbsd}}{{symbol|[[template:pcbsd|5]]}}===
: '''<nowiki>{{r}}</nowiki>'''
+
{{b|<nowiki>{{pcbsd}}</nowiki>}}{{br}}
 
+
Rendered with a non-breaking dash; {{RM}} adjusts for headers and large text.
===[[template:RM|Registered Mark]]{{symbol|1}}===
+
----
: '''<nowiki>{{RM}}</nowiki>'''
+
==={{redlight|Redlight}}{{symbol|[[template:Redlight|4]]}}===
 
+
{{b|<nowiki>{{redlight|</nowiki>}}{{bi|<nowiki>text=</nowiki>}}text{{b|<nowiki>}}</nowiki>}}
===[[template:Svn|Svn]]{{symbol|3}}===
+
----
: '''<nowiki>{{svn}}</nowiki>'''
+
===<span class=grouplist>{{putCommon|14}}</span>{{symbol|[[template:Refheading|2]]}}===
 
+
{{b|{{ttag|refheading}}}}
 +
----
 +
==={{greytxt|H3 Example Text}}{{r}}{{symbol|[[template:r|1,4]]}}===
 +
{{b|{{ttag|r}}}}
 +
----
 +
==={{greytxt|H3 Example Text}}{{RM}}{{symbol|[[template:RM|1]]}}===
 +
{{b|{{ttag|RM}}}}
 +
----
 +
==={{svn}}{{symbol|[[template:Svn|3]]}}===
 +
{{b|{{ttag|svn}}}}
 +
----
 
===[[template:SwapTitle|Swap Title]]===
 
===[[template:SwapTitle|Swap Title]]===
: {{b|<nowiki>{{swapTitle|custompagename=</nowiki>}}custom page name{{bi|<nowiki>|custompagecategory=</nowiki>}}{{i|custom page category}}{{b|<nowiki>}}</nowiki>}}
+
{{b|<nowiki>{{swapTitle|title=</nowiki>}}custom page name{{b|<nowiki>}}</nowiki>}}
 
+
----
 +
===<span class=grouplist>{{putCommon|19}}</span>{{symbol|[[template:GroupRefHeading|2]]}}===
 +
{{b|{{cbL|2}}GroupRefHeading{{!}}{{ttag|putCommon{{!}}19}}{{cbR|2}}}}{{br}}
 +
----
 
===[[template:tbl-init|Tbl-init]]{{symbol|2}}===
 
===[[template:tbl-init|Tbl-init]]{{symbol|2}}===
:'''<nowiki>{{</nowiki>tbl-init{{pipe}}caption='''''The caption in bold above the table and added to grouplist under GroupListHeading'''''<nowiki>}}</nowiki>'''<br
+
'''<nowiki>{{</nowiki>tbl-init{{pipe}}caption='''''Omit ''{{putCommon|28}}''or pageID but describe'''''<nowiki>}}</nowiki>'''{{br
/> '''!'''''column title bold text on manilla''<br
+
}} '''!'''''column title bold text on manilla''{{br
/> '''{{pipe}}-<br
+
}} '''{{!}}-{{br
/> {{pipe}}'''''This odd content row will be white''<br
+
}} {{pipe}}'''''This odd content row will be white''{{br
/> '''{{pipe}}-<br
+
}} '''{{!}}-{{br
/> {{pipe}}'''''This even content row will be grey''<br
+
}} {{!}}'''''This even content row will be grey''{{br
/> '''{{pipe}}<nowiki>}</nowiki>'''
+
}} '''{{!}}<nowiki>}</nowiki>'''
 
+
----
 
===[[template:testLangURL|Test Lang URL]]{{symbol|5}}===
 
===[[template:testLangURL|Test Lang URL]]{{symbol|5}}===
: {{b|<nowiki>{{testLangURL|</nowiki>}}series'''|'''of'''|'''iso'''|'''codes'''|'''for'''|'''localized'''|'''external'''|'''site'''|'''defines'''|'''languages'''|'''it'''|'''has'''|'''available{{b|<nowiki>}}</nowiki>}}
+
{{b|<nowiki>{{testLangURL|</nowiki>}}iso'''|'''codes'''|'''a'''|'''localized'''|'''external'''|'''site'''|'''defines'''|'''languages'''|'''as'''|'''available{{b|<nowiki>}}</nowiki>}}{{nbsp|8}}
 
+
----
 
===[[template:txtbox|Text Box]]===
 
===[[template:txtbox|Text Box]]===
:'''<nowiki>{{</nowiki>txtbox|''width='''value'''''|box='''''text in box'''|txt='''text to right of box'''''}}'''
+
'''<nowiki>{{</nowiki>txtbox|''width='''value'''''|box='''''text in box'''|txt='''text to right of box'''''}}'''
 
+
----
===[[template:Warning|Warning]]===
+
===[[template:Warning|Warning txtbox]]===
: {{b|<nowiki>{{warning|</nowiki>}}{{bi|<nowiki>width=</nowiki>}}{{i|size of box in px or % of page}}{{bi|<nowiki>|align=</nowiki>}}{{i|left or right}}{{bi|<nowiki>|icon64=</nowiki>}}text{{b|<nowiki>}}</nowiki>}}
+
{{b|{{cbL}}warning|</nowiki>}}{{bi|<nowiki>icon64=</nowiki>}}text{{b|<nowiki>}}</nowiki>}}
 +
</div>

Latest revision as of 20:55, 15 March 2015

PC-BSD® Wiki:Template QuickRefProtection (edit): Edited by: Tigersharke
[Key]
Key: Bold Roman - required
Roman - required variable value
Italic - optional variable value
Bold Italic - optional variable
Grey Text - Not part of result
1 - specific symbol
2 - two-part template
3 - prevents wiki parser
4 - adds specific style
5 - helper/modifiers


CiteLink[2]

{{Citelink|url=complete URL|txt=alternate text for external link}}
{{Citelink|url=shortcut|url=page URL|txt=alternate OurInterwiki link text}}


Danger txtbox

{{danger|icon64=text}}


Figure <pageNUM><letter>5

{{figureID|letter}}


ftp://3

{{ftp}}


git://3

{{git}}


Highlight4

{{highlight|text=text}}


http://3

{{http}}


https://3

{{https}}


Local

{{local|link=page name|anchor=(omit #)sub-heading|alternate text}}


Navigation Header

{{UseTOC{{putVers}}|special title such as with ® via {{r}} or {{pcbsd}}}}


Nbsp5

{{nbsp|number of non-breaking spaces or default of 1}}


Note txtbox

{{note|icon64=text}}


 Orangelight 4

{{orangelight|text=text}}


pageNUM5

{{pageNUM}}
{{pageNUM|reference page}}
Display only pageNUM of the current or "reference page".
These do not work correctly as the link text of “local” template.


PC‑BSD®5

{{pcbsd}}
Rendered with a non-breaking dash; ® adjusts for headers and large text.


 Redlight 4

{{redlight|text=text}}


References2

{{refheading}}


H3 Example Text®1,4

{{r}}


H3 Example Text®1

{{RM}}


svn://3

{{svn}}


Swap Title

{{swapTitle|title=custom page name}}


Tables2

{{GroupRefHeading|{{putCommon|19}}}}


Tbl-init2

{{tbl-init|caption=Omit Table  Is there no version? or pageID but describe}}
!column title bold text on manilla
|-
|
This odd content row will be white
|-
|
This even content row will be grey
|}


Test Lang URL5

{{testLangURL|iso|codes|a|localized|external|site|defines|languages|as|available}}        


Text Box

{{txtbox|width=value|box=text in box|txt=text to right of box}}


Warning txtbox

{warningicon64=text}}

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox