Jspoelstra (talk | contribs) No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
| + | == Licensing == |
||
| − | {{tlx|tlx}} — an acronym for '''template link expanded''' — is a sort of more useful sister to {{tlx|tl}}. It allows you do demonstrate templates more fully, by letting you show not just the template name, but ''also the parameters''. It's almost always preferable to use {{tlx|tlx}} than {{tlx|tl}} — even when you're ''not'' demonstrating parameters — because it automatically converts to a highly readable monospaced font. |
||
| + | {{Copyright fairuse}} |
||
| − | |||
| − | Although our template pages automatically display mono-spaced fonts, no other commonly-used namespace does. Look at the difference in display: |
||
| − | |||
| − | <div style=font-family:sans-serif> |
||
| − | * This uses {{tlx|tl}}: {{Tl|Tl}} |
||
| − | * This uses {{tlx|tlx}}: {{Tlx|Tl}} |
||
| − | </div> |
||
| − | |||
| − | Clearly, {{tlx|tlx}} is much more readable. That's not to say there are no uses for {{tlx|tl}}, but {{tlx|tlx}} is often the clearest thing. And, perhaps more importantly, it's the only one of the two that will allow the demonstration of parameters. |
||
| − | == Details == |
||
| − | * This template takes another ''template-name'' and some associated [[m:Parameter#Parameters|(numbered) parameters]] (or 'pass parameters'), and displays them as an 'example demonstration' of how the ''template-name'' template could be coded, literally. Its primary use is in instruction and documentation. |
||
| − | * '''''Specifics:''''' Up to 10 pass parameters (numbered or nowiki-keywords) for the specified template are displayed as 'placeholders', and over 10 parameters can be displayed using a coded vertical-bar (as in "<small>&#124;</small>''...''"). A keyword parameter can be used with equals code &#61; or <nowiki>{{=}}</nowiki> or in nowiki-text: "<nowiki>size=10</nowiki>" or all parameters as a string in <nowiki>"<nowiki>"</nowiki> tags; see ''[[#Examples|Examples]]'' at bottom. For more details, see <nowiki>[[{{TALKPAGENAME}}|this talk]]</nowiki> page. |
||
| − | * '''''Exceptions:''''' If the intended template lists numerous parameters, then perhaps this template should really ''not'' be used, and just hardcode the usage with {{nowrap|<code><nowiki><code><nowiki></nowiki></code>}}, for example: {{nowrap|<code><nowiki><code><nowiki>{{Anytemplate|arg1=23|size=250px|</nowiki><var>other parameters...</var><nowiki>}}</nowiki></code></nowiki></code>}}. If a vertical display, with parameters on their own lines, is desired, this can also be laid out manually in this manner, or more rapidly done with {{nowrap|<code><nowiki><pre>...</pre></nowiki></code>}}. |
||
| − | * Comparatively, {{Tlx|Tl}} will not take or display additional parameters, and for minor technical reasons, may be preferred for mere listing and referencing in long pages involving a lot of template expansions. |
||
| − | * {{tlx|Tlx}} has a named parameter ''subst''. Setting this parameter to any string of length 1 or greater will place the string "subst:" before the template name, linked to {{w|Help:Substitution}}. This is useful to indicate when a template should be substituted. For example {{tlx|Tlx|Welcome|<nowiki>subst=Y</nowiki>}} will display {{Tlx|Welcome|subst=Y}}. |
||
| − | * Additionally, Tlx will take a 'named' parameter 'SISTER' to link interwiki to other sister projects such as one of these examples: '|SISTER=W:', 'Tlx|SISTER=M:', 'Tlx|SISTER=Q:', 'Tlx|SISTER=S:', allowing documentation or discourse about a template across interwiki boundaries. |
||
| − | * {{[[Template:{{BASEPAGENAME}}|{{BASEPAGENAME}}]]}} is a generalisation of {{Tl|Tl|x}}, {{Tl|Tlp|x|y}}, etcetera with arguably better readable output. This depends on the browser, but too narrow uses of "'''{'''", "'''|'''", "'''}'''" in conjunction with links can be hard to read. |
||
| − | |||
| − | === Usage === |
||
| − | |||
| − | :<tt>{{{{BASEPAGENAME}}{{!}}template name}}</tt> |
||
| − | :<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}param}}</tt> |
||
| − | :<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10}}</tt> |
||
| − | :<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10&#124;more}}</tt> |
||
| − | :<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}param&#61;value}}</tt> |
||
| − | ''Up to 10 placeholders for parameters of the specified template'' |
||
| − | |||
| − | === Examples === |
||
| − | {{#ifeq:{{SITENAME}}|Wikipedia|<!-- Skip message--->| |
||
| − | {{#ifeq:{{SITENAME}}|Meta|<!-- No note needed --->|<!-- Other Sisters Note: ---> |
||
| − | ;Note: On the source sister projects, en.wikipedia and Meta, '''X0, X1, X2,..., X9 are sandbox templates''' for experimentation on involved templates that need be in template space. An auto-cleansing software facility exists that might be used to duplicate the facility on other Sister projects. |
||
| − | }}}} |
||
| − | |||
| − | <!--{| border="1" cellpadding="4" class="wikitable" |
||
| − | ! Code |
||
| − | ! Result |
||
| − | ! Remark |
||
| − | |- |
||
| − | |{{Tlx|Tlx|x0}} |
||
| − | |{{Tlx|x0}} |
||
| − | ||  |
||
| − | |- |
||
| − | |{{Tlx|Tlx|Abc}} |
||
| − | |{{Tlx|Abc}} |
||
| − | ||  |
||
| − | |- |
||
| − | |{{Tlx|Tlx|ABC}} |
||
| − | |{{Tlx|ABC}} |
||
| − | ||  |
||
| − | |- |
||
| − | |{{Tlx|Tlx|AbC}} |
||
| − | |{{Tlx|AbC}} |
||
| − | ||  |
||
| − | |- |
||
| − | |{{Tlx|Tlx|x1|one}} |
||
| − | |{{Tlx|x1|one}} |
||
| − | ||  |
||
| − | |- |
||
| − | |{{Tlx|Tlx|x2|one|two}} |
||
| − | |{{Tlx|x2|one|two}} |
||
| − | ||  |
||
| − | |- |
||
| − | |{{Tlx|Tlx|x3|1|2|3|4|5|6|7|8|9|10}} |
||
| − | |{{Tlx|x3|1|2|3|4|5|6|7|8|9|10}} |
||
| − | ||  |
||
| − | |- |
||
| − | |{{Tlx|Tlx|x4|1|2|3|4|5|6|7|8|9|10|11}} |
||
| − | |{{Tlx|x4|1|2|3|4|5|6|7|8|9|10|11}} |
||
| − | |up to 10 parameters, then ... |
||
| − | |- |
||
| − | |{{Tlx|Tlx|x5|1|2|3|4|5|6|7|8|9|10&#124;11}} |
||
| − | |{{Tlx|x5|1|2|3|4|5|6|7|8|9|10|11}} |
||
| − | |align="right"|<tt>&#124;</tt> for more |
||
| − | |- |
||
| − | |colspan=2| {{Tlx|Tlx|convert|<nowiki><nowiki>14|m|ftin|abbr=out|sp=us</nowiki></nowiki>}} |
||
| − | |unlimited parameters as one nowiki string |
||
| − | |- |
||
| − | |{{Tlx|Tlx|x1|x=u}} |
||
| − | |{{Tlx|x1|x=u}} |
||
| − | |'''=''' won't work |
||
| − | |- |
||
| − | |{{Tlx|Tlx|x1|x&#61;u}} |
||
| − | |{{Tlx|x1|x=u}} |
||
| − | |align="right"|<tt>&#61;</tt> is okay |
||
| − | |- |
||
| − | |{{Tlx|Tlx|x1|x<nowiki>{{=}}</nowiki>u}} |
||
| − | |{{Tlx|x1|x{{=}}u}} |
||
| − | |align="right"|<tt><nowiki>{{=}}</nowiki></tt> is okay |
||
| − | |- |
||
| − | |{{Tlx|Tlx|x1|<nowiki>x=u</nowiki>}} |
||
| − | |{{Tlx|x1|<nowiki>x=u</nowiki>}} |
||
| − | |align="right"|sticky nowiki is okay |
||
| − | |- |
||
| − | |{{Tlx|Tlx|x2| |two}} |
||
| − | |{{Tlx|x2| |two}} |
||
| − | |empty won't work |
||
| − | |- |
||
| − | |{{Tlx|Tlx|x2|&#32;|two}} |
||
| − | |{{Tlx|x2| |two}} |
||
| − | |align="right"|<tt>&#32;</tt> is okay |
||
| − | |- |
||
| − | |{{Tlx|Tlx|x2|&nbsp;|two}} |
||
| − | |{{Tlx|x2| |two}} |
||
| − | |align="right"|<tt>&nbsp;</tt> is okay |
||
| − | |- |
||
| − | |{{Tlx|Tlx|x2| &#124; two}} |
||
| − | |{{Tlx|x2| | two}} |
||
| − | |align="right"|<tt>&#124;</tt> is okay |
||
| − | |- |
||
| − | || {{Tlx|Tlx|x2| {{!}} two}} |
||
| − | || {{Tlx|x2| {{!}} two}} |
||
| − | |align="right"|{{Tlx|!}} is dubious |
||
| − | |- |
||
| − | || {{Tlx|Tlx|x2|<nowiki>2=</nowiki>|<nowiki>3=two</nowiki>}} |
||
| − | || {{Tlx|x2|2=|3=two}} |
||
| − | |empty really doesn't work |
||
| − | |- |
||
| − | || {{Tlx|Tlx|x2|<nowiki>2=one</nowiki>|two}} |
||
| − | || {{Tlx|x2|2=one|two}} |
||
| − | |'''two''' clobbers '''2=one''' |
||
| − | |- |
||
| − | || {{Tlx|Tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}} |
||
| − | || {{Tlx|x2|3=two|2=one}} |
||
| − | |align="right"|right to left okay |
||
| − | |}--> |
||
| − | <noinclude>[[category:template documentation|{{PAGENAME}}]]</noinclude> |
||
Revision as of 14:09, 18 May 2014
Licensing
 | This file is copyrighted. The individual who uploaded this work and first used it in an article, and subsequent persons who place it into articles, assert that this qualifies as fair use of the material under United States copyright law. |
|---|