Template:Tnull/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>Davidgothberg
Adding "See also" to other similar templates. And modernising doc page header and footer.
Ookami (talk | contribs)
m 42 revisions imported
 
(31 intermediate revisions by 23 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->
==Usage==
'''Tnull''' is used to nullify templates in the monospaced font. It is similar to {{tlx|tlx}} in the way that it has support for many parameters, but it does not link the template name. It is similar to {{tl|tlc}}, but does not prevent text wrapping.


'''Tnull''' is used to nullify templates in the monospaced font. It is similar to {{tl2|tlx}}&nbsp;in the way that it has support for many parameters.
==Example==
Typing <code>&#123;&#123;tnull|foo|bar|baz|boo&#125;&#125;</code> in the edit window would yield <code>&#123;&#123;foo|bar|baz|boo&#125;&#125;</code> in the rendered page.


=== Example ===
===Special character handling===
===="=" (equality sign)====
If there is a "=" character (equality/equals sign) in ''any'' parameter, it must be replaced with <code>&amp;#61;</code> [or {{tl|{{=}}}}?]:
:<code>&#123;&#123;tnull|click|image&amp;#61;<var>image name</var>|width&amp;#61;<var>width</var>|height&amp;#61;<var>height</var>|link&amp;#61;<var>page name</var>&#125;&#125;</code>


Typing <tt><code>&#123;&#123;tnull|foo|bar|baz|boo&#125;&#125;</code></tt> in the edit-form would yield <tt>&#123;&#123;foo|bar|baz|boo&#125;&#125;</tt> in the "read-mode".
Or you can use <code><var>parameter-number</var>=<var>value</var></code> as in:
:<code>&#123;&#123;tnull|click|2=image=<var>image name</var>|3=width=<var>width</var>|4=height=<var>height</var>|5=link=<var>page name</var>&#125;&#125;</code>


=== Note ===
Either method would yield the following output:
:{{tnull|click|2=image=<var>image name</var>|3=width=<var>width</var>|4=height=<var>height</var>|5=link=<var>page name</var>}}


If there is an "=" in ''any'' parameter, you must use <tt>parameter_number=text</tt>. So to nullify something like {{tl2|click}}, use the syntax <tt><code>&#123;&#123;tnull|click|2=image=IMAGE NAME|3=width=WIDTH|4=height=HEIGHT|5=link=PAGE TO WHICH TO LINK&#125;&#125;</code></tt>, which would yield {{tnull|click|2=image=IMAGE NAME|3=width=WIDTH|4=height=HEIGHT|5=link=PAGE TO LINK TO}}
===="|" (vertical bar, pipe)====
If a second consecutive pipe (|) is used to denote that a parameter has been skipped, you must replace it with <code>&amp;#124;</code> as in:
:<code>&#123;&#123;tnull|look from|Alan|&amp;#124;all the Alans&#125;&#125;</code>


=== See also ===
That would yield the following displayed output:
:{{tnull|look from|Alan|&#124;all the Alans}}


* {{tl|tlc}} – No link, several parameters and text in <code>&lt;code>&lt;/code></code> style.
==TemplateData==
* {{tl|tld}} – No link, several parameters and <tt>teletype</tt> text style.
{{collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
* {{tl|tlf}} – No link, several parameters and normal text style.
{{TemplateData header|noheader=1}}
<templatedata>
{
"params": {
"1": {
"label": "Template name",
"description": "Name of the template to link",
"example": "Tlx",
"type": "wiki-template-name",
"required": true
},
"2": {
"label": "1st parameter",
"type": "string"
},
"3": {
"label": "2nd parameter",
"type": "string"
},
"4": {
"label": "3rd parameter",
"type": "string"
},
"5": {
"label": "4th parameter",
"type": "string"
},
"6": {
"label": "5th parameter",
"type": "string"
},
"7": {
"label": "6th parameter",
"type": "string"
},
"8": {
"label": "7th parameter",
"type": "string"
},
"9": {
"label": "8th parameter",
"type": "string"
},
"10": {
"label": "9th parameter",
"type": "string"
},
"11": {
"label": "10th parameter",
"type": "string"
}
},
"description": "Show example template usage without expanding the template itself. Unlike {{tlx}}, does not link the template.",
"format": "inline"
}
</templatedata>
{{collapse bottom}}


* {{tl|tl}} –  Template link, no parameters and normal text style.
==See also==
* {{tl|tlx}} – Template link, several parameters and interwiki links, <tt>teletype</tt> text style.
{{Template-linking templates}}
* {{tl|tn}} – Same as {{tlf|tl}}, but shows the braces as part of the link.


<includeonly>
<includeonly>{{Sandbox other|
<!-- ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE -->
| <!-- ADD CATEGORIES BELOW THIS LINE, PLEASE: -->
[[Category:Typing-aid templates|{{PAGENAME}}]]
[[Category:Template namespace templates]]
 
[[Category:Typing-aid templates]]
</includeonly>
}}</includeonly>

Latest revision as of 05:18, 3 September 2020

Usage

Tnull is used to nullify templates in the monospaced font. It is similar to {{tlx}} in the way that it has support for many parameters, but it does not link the template name. It is similar to {{tlc}}, but does not prevent text wrapping.

Example

Typing {{tnull|foo|bar|baz|boo}} in the edit window would yield {{foo|bar|baz|boo}} in the rendered page.

Special character handling

"=" (equality sign)

If there is a "=" character (equality/equals sign) in any parameter, it must be replaced with &#61; [or {{=}}?]:

{{tnull|click|image&#61;image name|width&#61;width|height&#61;height|link&#61;page name}}

Or you can use parameter-number=value as in:

{{tnull|click|2=image=image name|3=width=width|4=height=height|5=link=page name}}

Either method would yield the following output:

{{click|image=image name|width=width|height=height|link=page name}}

"|" (vertical bar, pipe)

If a second consecutive pipe (|) is used to denote that a parameter has been skipped, you must replace it with &#124; as in:

{{tnull|look from|Alan|&#124;all the Alans}}

That would yield the following displayed output:

{{look from|Alan||all the Alans}}

TemplateData

TemplateData documentation used by VisualEditor and other tools
See a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Tnull

Show example template usage without expanding the template itself. Unlike {{tlx}}, does not link the template.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Template name1

Name of the template to link

Example
Tlx
Templaterequired
1st parameter2

no description

Stringoptional
2nd parameter3

no description

Stringoptional
3rd parameter4

no description

Stringoptional
4th parameter5

no description

Stringoptional
5th parameter6

no description

Stringoptional
6th parameter7

no description

Stringoptional
7th parameter8

no description

Stringoptional
8th parameter9

no description

Stringoptional
9th parameter10

no description

Stringoptional
10th parameter11

no description

Stringoptional

See also

General-purpose formatting

Comparison of template-linking templates according to their style
Link style → Linked Unlinked Linked with subst Linked including braces Linked with alternative text
Text style ↓ {{tlg}} options1 DEFAULT nolink=yes subst=yes braceinside=yes alttext=Foo
2=Foo
normal DEFAULT {{tlg}}1
{{tl}}
{{tlp|1|2|...}}2
{{Template:tlu}}3
{{tlf}}2 {{subst:tls}}
{{subst:tlsp|1|2|...}}
{{subst:Template:tlsu}}3
{{tn}} {{tla}}
code code=yes {{tl2}}
{{tlx}}
{{Template:tlxu}}3
{{tlc}}2
{{tld}}2
{{tnull}}
{{subst:tlxs}} N/A
monospace
kbd
plaincode=yes4
kbd=yes5
N/A {{subst:tltss}}5
bold bold=yes {{tlb}} N/A
bold+code code=yes {{tlxb}}
italic+code code=yes {{tlxi}}
  • 1  {{tlg}} is the most general, allowing any combination of text style and/or link style options.
  • 2  Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.
  • 3  Allows links to templates in any namespace.
  • 4  {{tlg|plaincode=yes}} uses <code style="border:none; background-color:transparent;">...</code>.
  • 5  Displays monospaced font using <span style="font-family:monospace;">...</span>.

Other formatting templates

Code example Effect Notes
{{tl2|Hatnote|lang=fr}} {{hatnote}} Supports linking to sister projects (e.g., fr:Hatnote)
{{tlu|User:Ahunt/SSHFS}} {{User:Ahunt/SSHFS}} Supports linking to any namespace
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}
{{hatnote|lang=fr|Some text}}

Some text
Shows code and example
{{xpd|Hatnote|Some hatnote text}} "{{hatnote|Some hatnote text}}" gives "
Some hatnote text
" [1]
Shows code, example and a link to expand the template code
{{tln|Hatnote}} Template:Hatnote Produces a normal link to the template
{{elc|Template:Hatnote}}
{{elc|Template:Hatnote|Hatnote}}
[[Template:Hatnote]]
[[Template:Hatnote|Hatnote]]
Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}} {{#invoke:Example|hello}} Counterpart to {{tl}} for linking to Lua modules
{{mlx|Example|hello}} {{#invoke:Example|hello}} Counterpart to {{tlx}} for linking to Lua modules
{{para|title|<var>book title</var>}} |title=book title Formats template parameters for display, with or without values
{{sclx|LASTING}} [[WP:LASTING]] Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a <code>...</code> tag.
{{tag|ref}}
{{xtag|templatedata}}
<ref>...</ref>
<templatedata>
Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}} {{d:Ping project}} Wikidata counterpart to {{tl}}
{{pf|if}}
{{pf|if|{{{1}}}|true|false}}
{{#if}}
{{#if:{{{1}}}|true|false}}
Parser function equivalent to {{tl}}

With utility links

Code example Effect
{{lt|Hatnote}} Template:Hatnote (edit | talk | history | links | watch | logs)
{{lts|Hatnote}} Template:Hatnote(edit talk links history)
{{t links|Hatnote}} Hatnote (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test)
{{tfd links|Hatnote}} Template:Hatnote (edit · talk · history · links · transclusions · logs · subpages · delete)
{{tltt|Hatnote}} {{Hatnote}}
{{tetl|Hatnote}} {{Hatnote}}
links talk edit
{{tsetl|Hatnote}} {{subst:Hatnote}}
 links talk edit
{{ti|Hatnote}} Template:Hatnote (talk⧼dot-separator⧽links⧼dot-separator⧽edit)
{{tic|Hatnote}} Template:Hatnote (talk links edit)
{{tim|Hatnote}} m:Template:Hatnote (backlinks edit)
{{tiw|Hatnote}} Template:Hatnote (backlinks edit)
{{tlt|Hatnote}} {{Hatnote}} (talk)
{{ttl|Hatnote}} {{Hatnote}} (t/l)
{{twlh|Hatnote}} Template:Hatnote (links, talk)