Template:T/doc: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Documentation/Header}} | |||
{{Lua|Formatting}} | |||
{{Main|Template:F}} | |||
This template creates a fake template call in the form of how it would look in wikitext in source editor. | |||
; | ==Syntax== | ||
See [[#Template Data|Template Data]] for extra functions.<br> | |||
{{T|T|v1=Template Name|v2=v((#))=Variable Input|v3=p((#))=Fixed Input|v4=P((#))=Fixed Input with "let_parse" functionality|v5=Fixed Input|p6=_Y_=1}} | |||
* Direct usage of named parameters is allowed but they will be displayed at a random order and always after any and all parameters with specified order, to specify an order please use {{F|p((#))}}, {{F|P((#))}} or {{F|v((#))}} | |||
* Add <code>(())</code> around any string to give it variable formatting | |||
* {{F|block}} — display the template code in block formatting | |||
* {{F|NC}} — display the template code outside <<nowiki/>code> formatting | |||
* {{F|let_parse}} — allow parsing of input as to allow for custom placed {{F|<nowiki><nowiki></nowiki>}} tags | |||
* {{F|_Y_}} — include to automatically display the expected input with the parameters given | |||
** {{F|no_joint}} — remove the '''yield:''' text from the string that joins the fake template call and the yield (removed by default on [[:Category:Infobox Templates|Infobox Templates]]) | |||
** {{F|_Ybr_}} — same functionality but adds a forced line break after the ''yields:'' for those templates that require to be on a line of their own. | |||
** {{F|_Yn_}} — same functionality but adds a line break after the ''yields:'' for those templates that require to be on a line of their own but do not allow for artificial line break. | |||
** {{F|_infobox}} — places template text after ''yields:'' instead of before. Also applies if template name includes the {{F|Infobox}} text. | |||
==Examples== | |||
''(to be added)'' | |||
==Template Data== | |||
:{{ | <templatedata> | ||
{ | |||
"params": { | |||
< | "text": { | ||
"aliases": [ | |||
"1" | |||
], | |||
"label": "Template", | |||
"description": "Name of the template to make a fake call to", | |||
"type": "string", | |||
"required": true | |||
}, | |||
"v#": { | |||
"label": "Variable Input", | |||
"description": "To be used to indicate that the true template call is expected to replace the given value by appropriate text, replace \"#\" by the number of the parameter to be represented", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"p#": { | |||
"label": "Fixed Input", | |||
"description": "To be used to indicate that the true template call should use the value indicated as-is, replace \"#\" by the number of the parameter to be represented", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"p#": { | |||
"label": "Fixed Input with let_parse", | |||
"description": "To be used to indicate that the true template call should use the value indicated as-is, while allowing the input text to be parsed as wikitext before being passed into the module, replace \"#\" by the number of the parameter to be represented", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"bold": { | |||
"aliases": [ | |||
"b" | |||
], | |||
"label": "Bold", | |||
"description": "Option for bold formatting.", | |||
"type": "boolean" | |||
}, | |||
"italic": { | |||
"aliases": [ | |||
"i" | |||
], | |||
"label": "Italic", | |||
"description": "Option for italic formatting.", | |||
"type": "boolean" | |||
}, | |||
"underline": { | |||
"aliases": [ | |||
"u" | |||
], | |||
"label": "Underline", | |||
"description": "Option for underline formatting.", | |||
"type": "boolean" | |||
}, | |||
"ref": { | |||
"aliases": [ | |||
"r" | |||
], | |||
"label": "Ref Tag", | |||
"description": "Option for adding <ref></ref> tags.", | |||
"type": "boolean" | |||
}, | |||
"P#": { | |||
"label": "Fixed Input (Parsed)", | |||
"description": "To be used to indicate that the true template call should use the value indicated as-is while parsing the input to allow for the usage of html tags inside it, like <nowiki>, replace \"#\" by the number of the parameter to be represented", | |||
"type": "string", | |||
"suggested": true | |||
} | |||
}, | |||
"description": "Template for displaying fake template calls as they would show in source editor mode.", | |||
"paramOrder": [ | |||
"text", | |||
"v#", | |||
"p#", | |||
"P#", | |||
"bold", | |||
"italic", | |||
"underline", | |||
"ref" | |||
] | |||
} | |||
</templatedata> | |||