Template:Para: Difference between revisions
Module>JJMC89 clean subst |
m 1 revision imported |
(No difference)
|
Latest revision as of 17:32, 13 July 2018
|
This template is used on 1,400,000+ pages. To avoid large-scale disruption and unnecessary server load, any changes to it should first be tested in its /sandbox or /testcases subpages or in your own user subpage. The tested changes can then be added to this page in a single edit. Please consider discussing any changes on the talk page before implementing them. |
Usage
This template is for giving examples of template parameter source code (useful in template documentation and talk page discussions of template code). It must have one or two parameters itself. The first parameter is the name of the example parameter to display (this may be empty, but it must be present), and the second (optional) parameter is a value for the first example parameter or, if the first {{para}}
parameter is empty, an unnamed example parameter.
Examples
Code | Result | Notes |
---|---|---|
{{para|name}}
|
|name=
|
|
{{para|title|<var>book title</var>}}
|
|title=book title
|
|
{{para| |section}}
|
|section
|
For unnamed parameters; note empty first parameter in the code |
{{para|<var>parameter</var>|<var>value</var>}}
|
|parameter=value
|
When using literal, pre-specified values, simply provide the value (as in the third example above). When illustrating hypothetical, variable, or user-definable values, use <var>value</var>
(as in the second example above). The same should be done for non-literal, example parameters (fourth example above).
See also
See also the three tables below; they describe the family of approximately forty templates built for talking about templates.
Here are some related templates or subjects not found in the tables:
- , for providing a similar service, but for HTML tags
General-purpose formatting
Link style → | Linked | Unlinked | Linked with subst | Linked including braces | Linked with alternative text | |
---|---|---|---|---|---|---|
Text style ↓ | ↓ {{tlg}} options1 →
|
N/A | nolink=yes
|
subst=yes
|
braceinside=yes
|
alttext=Foo 2=Foo
|
normal | DEFAULT | {{tlg}} 1{{tl}} {{tlp}} 2{{tlu}} 3
|
{{tlf}} 2
|
{{tls}} {{tlsp}}
|
{{tn}}
|
{{tla}}
|
code
|
code=yes
|
{{tl2}} {{tlx}} {{tlxu}} 3
|
{{tlc}} 2{{tld}} 2{{tnull}}
|
{{tlxs}}
|
N/A | |
monospace kbd |
plaincode=yes 4kbd=yes 5
|
{{tltt}} 5{{tltt2}} 5
|
N/A | {{tltts}} 5{{tltts3}} 5{{tltss}} 6
|
N/A | |
bold | bold=yes
|
{{tlb}}
|
N/A | |||
bold+code
|
bold=yes|code=yes
|
{{tlxb}}
| ||||
italic+code
|
italic=yes|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:transparent;">...</code>
. - 5 Displays monospaced font using
<kbd>...</kbd>
tags (changed from<tt>...</tt>
for HTML5 compliance). - 6 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}} |
Shows code and example |
{{xpd|Hatnote|Some hatnote text}} |
"{{hatnote|Some hatnote text}}" gives " " [1] |
Shows code, example and a link to expand the template code |
{{para|title|<var>book title</var>}} |
|title=book title |
Formats template parameters for display, with or without values |
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}} |
[[Template:Hatnote]] [[Template:Hatnote|Hatnote]] |
Formats wikilink, with optional piped link text and blended suffix |
{{tag|ref}} {{xtag|templatedata}} |
<ref>...</ref> <templatedata> |
Formats [X]HTML tags; can add content, choose opening, closing, or self-closing |
{{mli|Bananas|hello}} {{mlix|BananasArgs|hello|Fred}} |
{{#invoke:Bananas|hello}}{{#invoke:BananasArgs|hello|Fred}} |
Counterparts to and for linking to Lua modules |
With utility links
Code example | Effect |
---|---|
{{lts|Hatnote}} |
Template:Hatnote(edit talk links history) |
{{t links|Hatnote}} |
Hatnote (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test) · Module:hatnote |
{{tfd links|Hatnote}} |
Template:Hatnote (edit · talk · history · links · logs · subpages · delete) |
{{tiw|Hatnote}} |
Template:hatnote (backlinks edit) |
{{tltt|Hatnote}} |
{{Hatnote}} |
{{tetl|Hatnote}} |
{{Hatnote}} |
{{tsetl|Hatnote}} |
{{subst:Hatnote}} |
{{ti|Hatnote}} |
Template:Hatnote (talk⧼dot-separator⧽links⧼dot-separator⧽edit) |
{{tic|Hatnote}} |
Template:Hatnote (talk links edit) |
{{tiw|Hatnote}} |
Template:Hatnote (backlinks edit) |
{{tlt|Hatnote}} |
{{Hatnote}} (talk) |
{{ttl|Hatnote}} |
{{Hatnote}} (t/l) |
{{twlh|Hatnote}} |
Template:Hatnote (links, talk) |
The above documentation is transcluded from Template:Para/doc. (edit | history) Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Please add categories to the /doc subpage. Subpages of this template. |