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

From PC-BSD Wiki
Jump to: navigation, search
 
(55 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}}
 
__NOTOC__
 
__NOTOC__
 
__NOEDITSECTION__
 
__NOEDITSECTION__
{{key|code|align=right|width=auto|icon64={{b|Bold Roman}} - required<br
+
<div class="mw-collapsible mw-collapsed rinlineblock floatright txtsm">'''[Key]'''<div class="mw-collapsible-content txtlg">{{key|code|align=right|width=auto|icon64={{b|Bold Roman}} - required{{br
/>Roman - required variable value<br
+
}}Roman - required variable value{{br
/>{{i|Italic}} - optional variable value<br  
+
}}{{i|Italic}} - optional variable value{{br  
/>{{bi|Bold Italic}} - optional variable<br  
+
}}{{bi|Bold Italic}} - optional variable{{br  
/>1 - specific symbol<br  
+
}}1 - specific symbol{{br  
/>2 - two-part template<br  
+
}}2 - two-part template{{br  
/>3 - prevents wiki parser<br  
+
}}3 - prevents wiki parser{{br  
/>4 - adds specific style<br
+
}}4 - adds specific style{{br
/>5 - helper/modifiers}}
+
}}5 - helper/modifiers}}</div></div>
 +
{|
 +
!
 +
!
 +
|-
 +
|
 
===[[template:Citelink|Cite Link]]{{symbol|2}}===
 
===[[template:Citelink|Cite Link]]{{symbol|2}}===
: {{b|<nowiki>{{Citelink|url=</nowiki>}}complete URL{{b|<nowiki>|txt=</nowiki>}}alternate text for external link{{b|<nowiki>}}</nowiki>}}
+
{{b|<nowiki>{{Citelink|url=</nowiki>}}complete URL{{b|<nowiki>|txt=</nowiki>}}alternate text for external link{{b|<nowiki>}}</nowiki>}}{{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{{bi|<nowiki>|url=</nowiki>}}{{i|page URL}}{{b|<nowiki>|</nowiki>}}{{b|<nowiki>txt=</nowiki>}}alternate text for {{local|link=template:OurInterwiki|OurInterwiki}} link{{b|<nowiki>}}</nowiki>}}{{br}}
: {{b|<nowiki>{{Citelink|</nowiki>}}shortcut{{b|<nowiki>|txtAb=</nowiki>}}alternate text for abbreviated link{{b|<nowiki>}}</nowiki>}}
+
{{b|<nowiki>{{Citelink|</nowiki>}}shortcut{{b|<nowiki>|txtAb=</nowiki>}}alternate text for abbreviated link{{b|<nowiki>}}</nowiki>}}
 
+
|
 
===[[template:Danger|Danger]]===
 
===[[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>}}
+
{{b|<nowiki>{{danger|</nowiki>}}{{bi|<nowiki>icon64=</nowiki>}}text{{b|<nowiki>}}</nowiki>}}
 
+
|-
 +
|
 +
===[[template:FigureID|FigureID]]{{symbol|5}}===
 +
'''<nowiki>{{figureID|</nowiki>'''letter'''<nowiki>}}</nowiki>'''{{br}}
 +
"{{putCommon|27}} <pageNUM>letter" such as "Figure 8.20a" is localized.
 +
|
 
===[[template:Ftp|Ftp]]{{symbol|3}}===
 
===[[template:Ftp|Ftp]]{{symbol|3}}===
: '''<nowiki>{{ftp}}</nowiki>'''
+
'''<nowiki>{{ftp}}</nowiki>'''
 
+
|-
===[[template:GroupListHeading|GroupListHeading]]{{symbol|2}}===
+
|
: {{b|<nowiki>{{GroupListHeading|</nowiki>}}{{b|<nowiki>group=</nowiki>}}{{b|tables}}{{b|<nowiki>}}</nowiki>}}
+
===[[template:pageNUM|pageNUM]]{{symbol|5}}===
: tables is one [[template:GroupList|grouplist item]] but this template is not yet localization friendly and will be adjusted transparently in the future.  
+
'''<nowiki>{{pageNUM}}</nowiki>'''{{br}}
 
+
'''<nowiki>{{pageNUM|</nowiki>'''''reference page'''''<nowiki>}}</nowiki>'''{{br}}
 +
Display only pageNUM of the current or "reference page", similar to FigureID.
 +
|
 +
===[[template:GroupRefHeading|GroupRefHeading]]{{symbol|2}}===
 +
{{b|<nowiki>{{GroupRefHeading|{{putCommon|19}}}}</nowiki>}}{{br}}
 +
{{putCommon|19}} is one [[template:GroupRef|groupRef item]] and is localization friendly.
 +
|-
 +
|
 
===[[template:Highlight|Highlight]]{{symbol|4}}===
 
===[[template:Highlight|Highlight]]{{symbol|4}}===
: {{b|<nowiki>{{highlight|</nowiki>}}{{bi|<nowiki>text=</nowiki>}}text{{b|<nowiki>}}</nowiki>}}
+
{{b|<nowiki>{{highlight|</nowiki>}}{{bi|<nowiki>text=</nowiki>}}text{{b|<nowiki>}}</nowiki>}}
 
+
|
 
===[[template:Http|Http]]{{symbol|3}}===
 
===[[template:Http|Http]]{{symbol|3}}===
: '''<nowiki>{{http}}</nowiki>'''
+
'''<nowiki>{{http}}</nowiki>'''
 
+
|-
 +
|
 
===[[template:Https|Https]]{{symbol|3}}===
 
===[[template:Https|Https]]{{symbol|3}}===
: '''<nowiki>{{https}}</nowiki>'''
+
'''<nowiki>{{https}}</nowiki>'''
 
+
|
 
===[[template:Local|Local]]===
 
===[[template:Local|Local]]===
: {{b|<nowiki>{{local|link=</nowiki>}}page name{{bi|<nowiki>|anchor=</nowiki>}}{{i|<nowiki>page sub-heading|alternate text</nowiki>}}{{b|<nowiki>}}</nowiki>}}
+
{{b|<nowiki>{{local|link=</nowiki>}}page name{{bi|<nowiki>|anchor=</nowiki>}}{{i|(omit #)sub-heading}}{{b|<nowiki>|</nowiki>}}{{i|alternate text}}{{b|<nowiki>}}</nowiki>}}
 
+
|-
===[[template:NavHeader|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>}}
+
===[[template:UseTOC/{{release}}|Navigation Header]]===
 
+
{{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}}===
 +
{{b|<nowiki>{{nbsp|</nowiki>}}{{i|number of non-breaking spaces or default of 1}}{{b|<nowiki>}}</nowiki>}}
 +
|-
 +
|
 
===[[template:Note|Note]]===
 
===[[template:Note|Note]]===
: {{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:pcbsd|{{pcbsd}}]]{{symbol|5}}===
 +
{{b|<nowiki>{{pcbsd}}</nowiki>}}{{br}}
 +
Rendered with a non-breaking dash; {{RM}} adjusts for headers and large text.
 +
|-
 +
|
 
===[[template:Orangelight|Orangelight]]{{symbol|4}}===
 
===[[template:Orangelight|Orangelight]]{{symbol|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:Redlight|Redlight]]{{symbol|4}}===
: {{b|<nowiki>{{redlight|</nowiki>}}{{bi|<nowiki>text=</nowiki>}}text{{b|<nowiki>}}</nowiki>}}
+
{{b|<nowiki>{{redlight|</nowiki>}}{{bi|<nowiki>text=</nowiki>}}text{{b|<nowiki>}}</nowiki>}}
 
+
|-
 +
|
 
===[[template:Refheading|Refheading]]{{symbol|2}}===
 
===[[template:Refheading|Refheading]]{{symbol|2}}===
: '''<nowiki>{{refheading}}</nowiki>'''
+
'''<nowiki>{{refheading}}</nowiki>'''
 
+
|
 
===[[template:r|Registered (superscript)]]{{symbol|1,4}}===
 
===[[template:r|Registered (superscript)]]{{symbol|1,4}}===
: '''<nowiki>{{r}}</nowiki>'''
+
'''<nowiki>{{r}}</nowiki>'''
 
+
|-
 +
|
 
===[[template:RM|Registered Mark]]{{symbol|1}}===
 
===[[template:RM|Registered Mark]]{{symbol|1}}===
: '''<nowiki>{{RM}}</nowiki>'''
+
'''<nowiki>{{RM}}</nowiki>'''
 
+
|
 
===[[template:Svn|Svn]]{{symbol|3}}===
 
===[[template:Svn|Svn]]{{symbol|3}}===
: '''<nowiki>{{svn}}</nowiki>'''
+
'''<nowiki>{{svn}}</nowiki>'''
 
+
|-
 +
|
 
===[[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>}}
 
+
|rowspan=3|
 
===[[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}}'''''An odd content line will be white''<br
+
}} {{pipe}}'''''This odd content row will be white''{{br
/> '''{{pipe}}-<br
+
}} '''{{!}}-{{br
/> {{pipe}}'''''An even content line 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]]===
: {{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|<nowiki>{{warning|</nowiki>}}{{bi|<nowiki>icon64=</nowiki>}}text{{b|<nowiki>}}</nowiki>}}
 +
|}

Latest revision as of 03:26, 27 February 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
1 - specific symbol
2 - two-part template
3 - prevents wiki parser
4 - adds specific style
5 - helper/modifiers

Cite Link2

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

Danger

{{danger|icon64=text}}

FigureID5

{{figureID|letter}}
"Figure <pageNUM>letter" such as "Figure 8.20a" is localized.

Ftp3

{{ftp}}

pageNUM5

{{pageNUM}}
{{pageNUM|reference page}}
Display only pageNUM of the current or "reference page", similar to FigureID.

GroupRefHeading2

{{GroupRefHeading|{{putCommon|19}}}}
Tables is one groupRef item and is localization friendly.

Highlight4

{{highlight|text=text}}

Http3

{{http}}

Https3

{{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

{{note|icon64=text}}

PC‑BSD®5

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

Orangelight4

{{orangelight|text=text}}

Redlight4

{{redlight|text=text}}

Refheading2

{{refheading}}

Registered (superscript)1,4

{{r}}

Registered Mark1

{{RM}}

Svn3

{{svn}}

Swap Title

{{swapTitle|title=custom page name}}

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

{{warning|icon64=text}}

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox