Template:Tlxb/doc - Revision history

TeraS at 17:06, 1 July 2013

2013-07-01T17:06:13Z

← Older revision		Revision as of 10:06, 1 July 2013
Line 32:		Line 32:
	* 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.		* 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 [[Help:Substitution]]~~. This is useful to indicate when a template should be substituted.		* {{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. This is useful to indicate when a template should be substituted.

	* 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.		* 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.

TeraS at 17:05, 1 July 2013

2013-07-01T17:05:03Z

← Older revision		Revision as of 10:05, 1 July 2013
Line 18:		Line 18:

	== Purpose and naming ==		== Purpose and naming ==
	~~[[Wikt:mnemonic\|~~Mnemonically]] ''''T'''emplate '''l'''ink e'''x'''panded'. After <tt>{{tlx\|Tl}}</tt> ''''T'''emplate '''l'''ink'.		Mnemonically ''''T'''emplate '''l'''ink e'''x'''panded'. After <tt>{{tlx\|Tl}}</tt> ''''T'''emplate '''l'''ink'.

	* This template takes another ''template-name'' and some associated pipe-tricked (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.		* This template takes another ''template-name'' and some associated pipe-tricked (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: "{{tag\|nowiki\|content=size=10}}" or all parameters as a string in "{{tag\|nowiki\|o}}" tags; see ''[[#Examples\|Examples]]'' at bottom. For more details, see ~~[[{{TALKPAGENAME}}\|~~this talk]] page.		* '''''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: "{{tag\|nowiki\|content=size=10}}" or all parameters as a string in "{{tag\|nowiki\|o}}" tags; see ''[[#Examples\|Examples]]'' at bottom. For more details, see this talk page.
	* '''''Exceptions:''''' If the intended template lists numerous parameters, then perhaps this template should really ''not'' be used, and just hardcode the usage with {{tag\|code\|o}}{{tag\|nowiki\|o}}, for example: {{tag\|code\|content={{tag\|nowiki\|content=<nowiki>{{Anytemplate\|arg1=23\|size=250px\|</nowiki><var>other parameters...</var><nowiki>}}</nowiki>}}}}. 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 {{tag\|pre}}.		* '''''Exceptions:''''' If the intended template lists numerous parameters, then perhaps this template should really ''not'' be used, and just hardcode the usage with {{tag\|code\|o}}{{tag\|nowiki\|o}}, for example: {{tag\|code\|content={{tag\|nowiki\|content=<nowiki>{{Anytemplate\|arg1=23\|size=250px\|</nowiki><var>other parameters...</var><nowiki>}}</nowiki>}}}}. 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 {{tag\|pre}}.

	----		----

	* If given no additional parameters except ''<code> 'template name' (<nowiki>{{{1}}}</nowiki>), </code>'' it presents the same as the similar {{tl\|Tl}} ~~[[Macro (computer science)\|~~macro]] template -- a blue link nested in curly-braces-- the same as a user would apply the template without parameters, but with a noticably clearer font and spacing on most modern browsers.		* If given no additional parameters except ''<code> 'template name' (<nowiki>{{{1}}}</nowiki>), </code>'' it presents the same as the similar {{tl\|Tl}} macro template -- a blue link nested in curly-braces-- the same as a user would apply the template without parameters, but with a noticably clearer font and spacing on most modern browsers.

	:* {{Tlx\|Tl\|Tl}} display compared to {{Tlx\|Tlx\|Tl}}: (Tl: {{Tl\|Tl}} versus Tlx: {{Tlx\|Tl}})		:* {{Tlx\|Tl\|Tl}} display compared to {{Tlx\|Tlx\|Tl}}: (Tl: {{Tl\|Tl}} versus Tlx: {{Tlx\|Tl}})

TeraS: Created page with " ''This '{{Tlx|Tlx}}' template documentation is transcluded for all ''Tlx family templates..."

2013-07-01T17:03:58Z

Created page with "<includeonly> ''This '{{Tlx|Tlx}}' template documentation is transcluded for all ''Tlx family templates..."

New page

<includeonly>
''This '{{Tlx|Tlx}}' template documentation is transcluded for all ''Tlx family templates (Tlx, Tlxc, Tlxw, Tlxb)'' [[{{fullurl:Template:Tlx/doc |action=edit}} edit]].{{#ifeq:{{SITENAME}}|Meta| |[[M:template:{{PAGENAMEE}}|Masterpage]]
 }}</includeonly><noinclude>
{{Documentation subpage}}
{{-}}
</noinclude>



Basically:
: {{Tlx|Tlx|Template|first parameter|second|third|...|tenth}} → {{Tlx|Template|first parameter|second|third|...|tenth}}
Where parameters might contain "=" characters, use {{Tlx|{{=}}}} instead
: {{Tlx|Tlx|Template|<nowiki>first parameter{{=}}anything|second|third{{=}}something|...|tenth</nowiki>}} → {{Tlx|Template|first parameter{{=}}anything|second|third{{=}}something|...|tenth}}
For more than 10 parameters, possibly also containing "=", use
: {{Tlx|Tlx|Template|<nowiki><nowiki>first|second|third=something|...|999th</nowiki></nowiki>}} → {{Tlx|Template|<nowiki>first|second|third=something|...|999th</nowiki>}}

The three dots in the examples represent a number of arguments that have been omitted and are not an actual argument.

== Purpose and naming ==
[[Wikt:mnemonic|Mnemonically]] ''''T'''emplate '''l'''ink e'''x'''panded'. After <tt>{{tlx|Tl}}</tt> ''''T'''emplate '''l'''ink'.

* This template takes another ''template-name'' and some associated pipe-tricked (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 "&#124;''...''"). A keyword parameter can be used with equals code &#61; or <nowiki>{{=}}</nowiki> or in nowiki-text: "{{tag|nowiki|content=size=10}}" or all parameters as a string in "{{tag|nowiki|o}}" tags; see ''[[#Examples|Examples]]'' at bottom. For more details, see [[{{TALKPAGENAME}}|this talk]] page.
* '''''Exceptions:''''' If the intended template lists numerous parameters, then perhaps this template should really ''not'' be used, and just hardcode the usage with {{tag|code|o}}{{tag|nowiki|o}}, for example: {{tag|code|content={{tag|nowiki|content=<nowiki>{{Anytemplate|arg1=23|size=250px|</nowiki><var>other parameters...</var><nowiki>}}</nowiki>}}}}. 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 {{tag|pre}}.

----

* If given no additional parameters except ''<code> 'template name' (<nowiki>{{{1}}}</nowiki>), </code>'' it presents the same as the similar {{tl|Tl}} [[Macro (computer science)|macro]] template -- a blue link nested in curly-braces-- the same as a user would apply the template without parameters, but with a noticably clearer font and spacing on most modern browsers.

:* {{Tlx|Tl|Tl}} display compared to {{Tlx|Tlx|Tl}}: (Tl: {{Tl|Tl}} versus Tlx: {{Tlx|Tl}})

* 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 [[Help:Substitution]]. This is useful to indicate when a template should be substituted.

* 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.

== Documentation ==

{{[[Template:{{BASEPAGENAME}}|{{BASEPAGENAME}}]]}}
is a generalization 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''

== See also ==
* [[Template:Tlxb]] – same as {{tl|Tlx}}, but gives the template name in boldface type (this can be useful when stressing the difference between two similarly named templates). [[Template:Tlb]] is the same, except it uses regular text instead of a monospaced non-proportional font.
* [[Template:Para]] – for giving examples of template parameters and values only, instead of entire templates with parameters.
{{tl-nav}}





<includeonly>

[[Category:Typing-aid templates |{{PAGENAME}}]]
[[Category:Internal link templates |{{PAGENAME}}]]
[[Category:Interwiki link templates |{{PAGENAME}}]]


</includeonly>

<includeonly>
</includeonly>