Template:F/doc
This is the documentation page for F. It contains usage information, categories, and other content not part of the original template page. | ||
|---|---|---|
| Main | Documentation | Usage |
This template allows to display formatting methods without them being actually applied to the text for examples and guides.
Examples
- Default
{{F|Xiao}} yields: Xiao
- Link with label and bolding
{{F|Xiao|Alatus|l = 1|b = 1}} yields: '''[[Xiao|Alatus]]'''
- External Link with italic, underline, in ref tags and variable link label
{{F|https://youtu.be/mpD8bIM1FLU|element|el = 1|i = 1|u = 1|r = 1|vl = 1}} yields: <ref>''<u>[https://youtu.be/mpD8bIM1FLU element]</u>''</ref>
- Link with variable Input indication and bolding
{{F|Potato|Apple|l = 1|b = 1|v = 1}} yields: '''[[Potato|Apple]]'''
- Template formatting with direct input and variable input with named and unnamed params
{{F|Icon|p1 = potato=blue|v2 = season=winter|p3 = azure|v4 = aple|t = 1}} yields: {{Icon|potato = blue|season = winter|azure|aple}}
Template Data
Template for displaying formatting methods as they would show in source editor mode.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Text | text 1 | Main input to display, represents the page to link in link format and the url to link to in external link format. | String | required |
| Link | link l | Option for internal link formatting. | String | optional |
| External Link | external-link el | Option for external link formatting. | String | optional |
| Label | label 2 | Functional only with link or external link formatting active, text to add as label. | String | optional |
| Variable Input | variable v | Display text as variable input (i.e. expected to be replaced by appropiate text). | String | optional |
| Variable Input | variable-label vl | Functional only with link or external link formatting active, display the link lable as variable input (i.e. expected to be replaced by appropiate text). | String | optional |
| Variable Input | v# | Functional only with template call formatting active, parameter to display as variable input (i.e. expected to be replaced by appropiate text). | String | optional |
| Template | template t | Option for template call formatting. | String | optional |
| Fixed Input | p# | Functional only with template call formatting active, parameter to display as fixed input (i.e. expected to be used as-is). | String | optional |
| Bold | bold b | Option for bold formatting. | Boolean | optional |
| Italic | italic i | Option for italic formatting. | Boolean | optional |
| Underline | underline u | Option for underline formatting. | Boolean | optional |
| Ref Tag | ref r | Option for adding <ref></ref> tags. | Boolean | optional |
| NoWiki | nowiki nw | Option for adding <nowiki></nowiki> tags. | Boolean | optional |