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

From PC-BSD Wiki
Jump to: navigation, search
(18 intermediate revisions by one user not shown)
Line 13: Line 13:
 
===[[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>}}
: {{b|{{Citelink{{!}}}}shortcut{{!}}{{bi|url=}}{{i|page URL}}|{{bi|<nowiki>txt=</nowiki>}}{{i|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 OurInterwiki link{{b|<nowiki>}}</nowiki>}}
: {{b|<nowiki>{{Citelink|</nowiki>}}shortcut'''|txtAb='''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]]===
 +
: {{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>}}
  
 
===[[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>}}
 +
: tables is one [[template:GroupList|grouplist item]] but this template is not yet localization friendly and will be adjusted transparently in the future.
  
 
===[[template:Highlight|Highlight]]{{symbol|4}}===
 
===[[template:Highlight|Highlight]]{{symbol|4}}===
: '''<nowiki>{{</nowiki>highlight{{pipe}}text='''''text'''''<nowiki>}}</nowiki>'''
+
: {{b|<nowiki>{{highlight|</nowiki>}}{{bi|<nowiki>text=</nowiki>}}text{{b|<nowiki>}}</nowiki>}}
{{highlight|blah}} -- {{highlight|text=foo}}
+
  
 
===[[template:Http|Http]]{{symbol|3}}===
 
===[[template:Http|Http]]{{symbol|3}}===
Line 30: Line 36:
  
 
===[[template:Local|Local]]===
 
===[[template:Local|Local]]===
: '''<nowiki>{{local|link=</nowiki>'''''page name'''|anchor='''page sub-heading'''''|'''''alternate text'''''<nowiki>}}</nowiki>'''
+
: {{b|<nowiki>{{local|link=</nowiki>}}page name{{bi|<nowiki>|anchor=</nowiki>}}{{i|page sub-heading}}{{b|<nowiki>|</nowiki>}}{{i|alternate text}}{{b|<nowiki>}}</nowiki>}}
  
 
===[[template:NavHeader|Navigation Header]]===
 
===[[template:NavHeader|Navigation Header]]===
: '''<nowiki>{{</nowiki>NavHeader|back='''''name of the previous page'''''|forward='''''name of the next page'''|custompagename='''custom page name'''|custompagecategory='''custom page category'''''}}'''
+
: {{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:r|Registered (superscript)]]{{symbol|1,4}}===
+
===[[template:Nbsp|Nbsp]]{{symbol|5}}===
: '''<nowiki>{{r}}</nowiki>'''
+
: {{b|<nowiki>{{nbsp|</nowiki>}}{{i|number of non-breaking spaces or default of 1}}{{b|<nowiki>}}</nowiki>}}
 +
 
 +
===[[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>}}
 +
 
 +
===[[template:Orangelight|Orangelight]]{{symbol|4}}===
 +
: {{b|<nowiki>{{orangelight|</nowiki>}}{{bi|<nowiki>text=</nowiki>}}text{{b|<nowiki>}}</nowiki>}}
 +
 
 +
===[[template:Redlight|Redlight]]{{symbol|4}}===
 +
: {{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}}===
 +
: '''<nowiki>{{r}}</nowiki>'''
  
 
===[[template:RM|Registered Mark]]{{symbol|1}}===
 
===[[template:RM|Registered Mark]]{{symbol|1}}===
Line 48: Line 66:
  
 
===[[template:SwapTitle|Swap Title]]===
 
===[[template:SwapTitle|Swap Title]]===
: '''<nowiki>{{</nowiki>swapTitle{{pipe}}custompagename='''''custom page name'''''|custompagecategory='''''custom page category'''<nowiki>}}</nowiki>'''
+
: {{b|<nowiki>{{swapTitle|custompagename=</nowiki>}}custom page name{{bi|<nowiki>|custompagecategory=</nowiki>}}{{i|custom page category}}{{b|<nowiki>}}</nowiki>}}
 +
 
 +
===[[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
 +
/> '''!'''''column title bold text on manilla''<br
 +
/> '''{{pipe}}-<br
 +
/> {{pipe}}'''''This odd content row will be white''<br
 +
/> '''{{pipe}}-<br
 +
/> {{pipe}}'''''This even content row will be grey''<br
 +
/> '''{{pipe}}<nowiki>}</nowiki>'''
  
 
===[[template:testLangURL|Test Lang URL]]{{symbol|5}}===
 
===[[template:testLangURL|Test Lang URL]]{{symbol|5}}===
: '''<nowiki>{{testLangURL|</nowiki>'''es|es_ES|ca|de|eo|fr|id|it|hu|no|nl|pl|pt|pt_BR|fi|sv|is|el|ru|uk|zh|zh_TW|ko'''<nowiki>}}</nowiki>'''
+
: {{b|<nowiki>{{testLangURL|</nowiki>}}series'''|'''of'''|'''iso'''|'''codes'''|'''for'''|'''localized'''|'''external'''|'''site'''|'''defines'''|'''languages'''|'''it'''|'''has'''|'''available{{b|<nowiki>}}</nowiki>}}
  
 
===[[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]]===
 +
: {{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>}}

Revision as of 21:51, 3 October 2013

PC-BSD® Wiki:Template QuickRefProtection (edit): Edited by: Tigersharke
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|width=size of box in px or % of page|align=left or right|icon64=text}}

Ftp3

{{ftp}}

GroupListHeading2

{{GroupListHeading|group=tables}}
tables is one grouplist item but this template is not yet localization friendly and will be adjusted transparently in the future.

Highlight4

{{highlight|text=text}}

Http3

{{http}}

Https3

{{https}}

Local

{{local|link=page name|anchor=page sub-heading|alternate text}}

Navigation Header

{{NavHeader|back=name of the previous page|forward=name of the next page|custompagename=custom page name|custompagecategory=custom page category}}

Nbsp5

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

Note

{{note|width=size of box in px or % of page|align=left or right|icon64=text}}

Orangelight4

{{orangelight|text=text}}

Redlight4

{{redlight|text=text}}

Refheading2

{{refheading}}

Registered (superscript)1,4

{{r}}

Registered Mark1

{{RM}}

Svn3

{{svn}}

Swap Title

{{swapTitle|custompagename=custom page name|custompagecategory=custom page category}}

Tbl-init2

{{tbl-init|caption=The caption in bold above the table and added to grouplist under GroupListHeading}}
!column title bold text on manilla
|-
|
This odd content row will be white
|-
|
This even content row will be grey
|}

Test Lang URL5

{{testLangURL|series|of|iso|codes|for|localized|external|site|defines|languages|it|has|available}}

Text Box

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

Warning

{{warning|width=size of box in px or % of page|align=left or right|icon64=text}}