Template:Template link expanded/doc: Difference between revisions
(Subst {{Interwiki doc page pattern}} + Merge updated usage from Meta (Overwite all here)) |
(Merge Interwiki doc page pattern into merged commons/Meta usage and create /doc pages) |
||
Line 1: | Line 1: | ||
Snippet heading from {{Tl|Interwiki doc page pattern}}:<br> |
|||
;This page will show SIX broken commands in three block forming pairs before or after subst'ing -- all involve the partial (broken) command word 'in clude' ('''note the added space''') -- these are deliberate breakings of those [[w:wikimarkup|wikimarkup language]] keywords to ensure this whole boilerplate template will be subst'ed. Fix these after substing this page in it's destination and delete this heading, as well as the how-to guiding imbedded comments below. |
|||
<in cludeonly><!-----------------Interwiki Doc page pattern-------------------> {{-}} |
<in cludeonly><!-----------------Interwiki Doc page pattern-------------------> {{-}} |
||
<small>''This '{{ |
<small>''This '{{Tlx|Tlx}}' template documentation is [[w:Wikipedia:Template doc page pattern|transcluded]] for all ''Tlx family templates (Tlx, Tlxm, Tlxw)'' [<span class="plainlinks">[{{fullurl:Template:Tlx/doc |action=edit}} edit]</span>].{{#ifeq:{{SITENAME}}|Meta| |[[M:template:{{PAGENAMEE}}|Masterpage]] |
||
}}</small></ |
}}</small></includeonly><noinclude> {{template doc page viewed directly|yes}} |
||
{{-}} |
{{-}} |
||
<!-- Add the Categories for this doc or usage page (only-- not for the calling template) BELOW THIS LINE ---> |
<!-- Add the Categories for this doc or usage page (only-- not for the calling template) BELOW THIS LINE ---> |
||
[[Category:Template documentation|{{PAGENAME}}]] |
[[Category:Template documentation|{{PAGENAME}}]] |
||
⚫ | |||
⚫ | |||
;As of creation of 'Tlx/doc', two interwiki defauted versions also share this usage page: |
|||
# {{Tl|Tlxm}} -- which links to templates on Meta |
|||
# {{Tl|Tlxw}} -- which links to templates on Wikipedia |
|||
Since these are the two repositories of templates for exports to sister projects.<br>// <b>[[User:Fabartus|Fra]]</b><font color="green">[[User talk:Fabartus|nkB]]</font> 16:23, 12 February 2007 (UTC) |
|||
<!-- ----------------------------------------------------------- |
<!-- ----------------------------------------------------------- |
||
---- Self declarations, this page, not the parent template. |
---- Self declarations, this page, not the parent template. |
||
Line 14: | Line 18: | ||
{{interwikitmp-grp|V=D|cats=|inhib=yes|{{PAGENAME}}|{{PAGENAME}}}} <!-- Comment this out if not an tools template of |
{{interwikitmp-grp|V=D|cats=|inhib=yes|{{PAGENAME}}|{{PAGENAME}}}} <!-- Comment this out if not an tools template of |
||
---- ---- interwikitmp-grp interest, use, or scope.--> |
---- ---- interwikitmp-grp interest, use, or scope.--> |
||
</ |
</noinclude><includeonly> |
||
<!-- EDIT IN (calling) TEMPLATE CATEGORIES BELOW THIS LINE --> |
<!-- EDIT IN (calling) TEMPLATE CATEGORIES BELOW THIS LINE --> |
||
[[Category:Typing-aid templates |{{PAGENAME}}]] |
[[Category:Typing-aid templates |{{PAGENAME}}]] |
||
[[Category:Miscellaneous templates |{{PAGENAME}}]] |
|||
[[Category:Internal link templates |{{PAGENAME}}]] |
[[Category:Internal link templates |{{PAGENAME}}]] |
||
[[Category:Interwiki link templates |{{PAGENAME}}]] |
[[Category:Interwiki link templates |{{PAGENAME}}]] |
||
[[Category:Navigational templates |{{PAGENAME}}]] --- END OF BLOCK COMMENT ------------------------- ---> |
|||
<!-- EDIT IN (calling) TEMPLATE CATEGORIES ABOVE THIS LINE --> |
|||
</in cludeonly> <!--- Note: This breakage deliberate... in Six different places. ---- |
|||
Just text search: 'in clude' to Clean it up after subst'ing when building your usage/documentation text. ---> |
|||
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> |
|||
<!-- --------------------------------------------------------------------------- |
|||
---- Calling or parent template declarations, the parent template, not this page. |
|||
---- ----------------------------------------------------------------------- ---> |
|||
{{interwikitmp-grp|V=1|inhib=yes|{{PAGENAME}}|{{PAGENAME}}}} <!--- This is correct placement (inside includeonly block + towards the 'doc/usage' page bottom) and the call is correct for auto-categorization of many tools templates pages' generating internal links. This template call can be located anywhere in the documentation, but |
|||
should be kept inside the includeonly fence. A bottom location like this interferes least with display and formating of comprehensible documentation, but moving it up so text ends about the same point as the template display is a good thing for later edit needs. By keeping template interwiki's inside an includeonly block, this page can be given it's own, which is unimportant when the page is a collected usage page for similar templates, but good for /doc pages. |
|||
Quick Usage on V=## parameter: 1==internal links, 2==interwiki links, 3==Miscellaneous, 4==1+3, 5==2+3, 6==1+2+3 or just (1+2) when 'inhib=yes|' parameter defined as well... such as {{Tl|Commonscat1A}}, where a category link is interwiki, and a link is to main article. Parameter: 'cat=bare cat name ' supplants miscellaneous, and is used for typing-aid or uncategorized types (sub-cats of miscellaneous); 'CATS=must be given full names with square parenthesis, and add on to the V=## auto-categories. <nowiki> {{{1}}}} is pipelink sort name for the auto-cats, in 'CATS=' calls, you must add such to the pass parameter. {{{2}}} is 'universal' override name, otherwise template name defaults to {{PAGENAME}} in links built and displayed. This is primarily used in Name Case Variants, where a naming collision occurs on a sister project. ---> |
|||
<!-- EDIT/ADD TEMPLATE Interwiki's BELOW THIS LINE --> |
<!-- EDIT/ADD TEMPLATE Interwiki's BELOW THIS LINE --> |
||
⚫ | |||
;This usage also applies to interwiki capable template variations: 'Tlxm' and 'Tlxw'<br> |
|||
MERGED Usage from Meta below |
|||
⚫ | |||
{{tlx|tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}} <br>→ (becomes) → <br>{{tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}} |
{{tlx|tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}} <br>→ (becomes) → <br>{{tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}} |
||
;Purpose:Mnemonically 'Template list expanded'... after {{tlx|tl}} 'Template list' {{I2}}This template takes another ''template-name'' and some associated [[w:pipe-trick|pipe-tricked]] [http://meta.wikimedia.org/wiki/Parameter#Parameters (numbered) parameters] (or 'pass parameters'), and aggregates them into an 'example demonstration' of how the ''template-name'' template might be used. It's primary use is in instruction and documentation such as this passage. |
;Purpose:Mnemonically 'Template list expanded'... after {{tlx|tl}} 'Template list' {{I2}}This template takes another ''template-name'' and some associated [[w:pipe-trick|pipe-tricked]] [http://meta.wikimedia.org/wiki/Parameter#Parameters (numbered) parameters] (or 'pass parameters'), and aggregates them into an 'example demonstration' of how the ''template-name'' template might be used. It's primary use is in instruction and documentation such as this passage. |
||
Line 74: | Line 58: | ||
:<tt>{{{{PAGENAME}}|template name|param&#61;value}}</tt> |
:<tt>{{{{PAGENAME}}|template name|param&#61;value}}</tt> |
||
''Up to three placeholders for parameters of the specified template'' |
''Up to three placeholders for parameters of the specified template'' |
||
⚫ | |||
*{{SITENAME}}* |
|||
{{#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 |
;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. |
||
{{#ifeq:{{SITENAME}} |
|||
⚫ | |||
|Meta3||An auto-cleansing software facility exists that might be used to duplicate the facility on other Sister projects. |
|||
⚫ | |||
{| border="1" cellpadding="4" class="wikitable" |
{| border="1" cellpadding="4" class="wikitable" |
Revision as of 16:23, February 12, 2007
<in cludeonly>
This '{{Tlx}}
' template documentation is transcluded for all Tlx family templates (Tlx, Tlxm, Tlxw) [edit].Masterpage
</includeonly> Template:Template doc page viewed directly
- As of creation of 'Tlx/doc', two interwiki defauted versions also share this usage page
Since these are the two repositories of templates for exports to sister projects.
// FrankB 16:23, 12 February 2007 (UTC)
Template:Interwikitmp-grp
- This usage also applies to interwiki capable template variations
- 'Tlxm' and 'Tlxw'
{{tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}}
→ (becomes) → {{template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}}
- Purpose
- Mnemonically 'Template list expanded'... after
{{tl}}
'Template list' Template:I2This template takes another template-name and some associated pipe-tricked (numbered) parameters (or 'pass parameters'), and aggregates them into an 'example demonstration' of how the template-name template might be used. It's primary use is in instruction and documentation such as this passage.
- Up to five pass parameters (numbered) for the specified template are displayed as 'placeholders', and more parameters are shown as "|...", for details see the this talk page.
- If given no additional parameters except
'template name' ({{{1}}}),
it presents the same as the similar {{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.
- Comparatively,
{{Tl}}
will not take or display additional parameters, and for minor technical reasons, may preferred for mere listing and referencing in long pages involving a lot of template expansions1.
- 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. Small 'front end' Shell or convience templates
{{Tlxw}}
and{{Tlxm}}
are typing-aid templates available at Meta for automatic substitution in discussions about templates on Wikipedia or Meta.
Documentation
{{Template link expanded/doc}} is a generalization of Template:Tlxw, Template:Tlxw, 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
- {{Template link expanded/doc|template name}}
- {{Template link expanded/doc|template name|param}}
- {{Template link expanded/doc|template name|1|2|3}}
- {{Template link expanded/doc|template name|1|2|3|more}}
- {{Template link expanded/doc|template name|param=value}}
Up to three placeholders for parameters of the specified template
Examples
- 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.
Code | Result | Remark |
---|---|---|
{{{{Tlx|x0}}
|
{{{{x0}}
|
|
{{{{Tlx|x1|one}}
|
{{{{x1|one}}
|
|
{{{{Tlx|x2|one|two}}
|
{{{{x2|one|two}}
|
|
{{{{Tlx|x3|1|2|3}}
|
{{{{x3|1|2|3}}
|
|
{{{{Tlx|x4|1|2|3|4}}
|
{{{{x4|1|2|3|4}}
|
up to 3 parameters |
{{{{Tlx|x4|1|2|3|4}}
|
{{{{x4|1|2|3|4}}
|
| for more |
{{{{Tlx|x1|x=u}}
|
{{{{x1}}
|
= won't work |
{{{{Tlx|x1|x=u}}
|
{{{{x1|x=u}}
|
= is okay |
{{{{Tlx|x1|<nowiki>x=u</nowiki>}}
|
{{{{x1|x=u}}
|
sticky nowiki is okay |
{{{{Tlx|x2| |two}}
|
{{{{x2|two}}
|
empty won't work |
{{{{Tlx|x2| |two}}
|
{{{{x2| |two}}
|
  is okay |
{{{{Tlx|x2| |two}}
|
{{{{x2| |two}}
|
is okay |
{{{{Tlx|x2|| two}}
|
{{{{x2|| two}}
|
| is okay |
{{{{Tlx|x2|{{!}} two}}
|
{{{{x2|| two}}
|
{{{{!}} is dubious
|
{{{{Tlx|x2|2=|3=two}}
|
{{{{x2|two}}
|
empty really doesn't work |
{{{{Tlx|x2|2=one|two}}
|
{{{{x2|two}}
|
two clobbers 2=one |
{{{{Tlx|x2|3=two|2=one}}
|
{{{{x2|one|two}}
|
right to left okay |