Movatterモバイル変換


[0]ホーム

URL:


Jump to content
WikipediaThe Free Encyclopedia
Search

Template:Para

Permanently protected template
From Wikipedia, the free encyclopedia

|

Template documentation[view] [edit] [history] [purge]
Not to be confused withTemplate:Paragraph break orTemplate:Param.
WarningThis template is used onapproximately 2,830,000 pages, or roughly 4% of all pages.
To avoid major disruption and server load, any changes should be tested in the template's/sandbox or/testcases subpages, or in your ownuser subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on thetalk page before implementing them.

Usage

This template is for giving examples oftemplate parameter source code (useful in template documentation and talk page discussions of template code).

It must have at least one or two parameters itself. The first parameter is the name of the example parameter to display (this may beempty, but it must bepresent). The second (optional) parameter is a value for the first example parameter; or, if the first parameter is empty, the second illustrates an exampleunnamed parameter (which in some cases may serve as a pre-defined parameter that takes no|=value after it, e.g. the|section in{{More citations needed|section}}).

Examples

CodeResultNotes
{{para|name}}|name=
{{para|title|The Oxford English Dictionary}}|title=The Oxford English Dictionary
{{para||section}}|sectionForunnamed parameters;
note empty first
parameter in
the code
{{para|{{var|parameter}}|{{var|value}}}}|parameter=value

When using literal, pre-specified parameter names and values, simply provide them (as in the first through third examples above). When illustrating hypothetical/example parameter names, or variable or user-definable values, use something like{{var|parameter}} and/or{{var|value}} (as in the last example above).

Parameters

  • |1= or first unnamed parameter – the parameter name. Give this parameter as explicitly blank and just fill in parameter 2 when you want to show anunnamed parameter (which, depending on the context, may serve as a valueless parameter name); e.g.,{{para|section}}|section=
  • |2= or second unnamed parameter – the value name; e.g.,{{para|section|about}}|section=about.
    • When the first parameter is given but is blank, the second represents an unnamed parameter's value (or a valueless parameter name), and only the parameter is shown with no equal’s sign; e.g.,{{para||section}}|section
  • |plain=y (or any other value besidesy) – removes the faint border and light-grey background, which may be useful in various situations. The border and text color are set toinherit, to use the colors of the surrounding text. This parameter cooperates with the two below, in that if either are used, the text will be colorized while the border and background will still be removed.
  • |mxt=y or|green=y – to apply the style (green monospaced text) that would be applied by{{mxt}}. Since{{para}} contains<code> markup inside its source which would override the color of{{mxt}}, these parameters can be used when{{para}} is used for text inside a passage of{{mxt}} content. This parameter cooperates with|plain= in applying the color but respecting the removal of border and background.
  • |!mxt=y or|red=y – same as above, but applies the red of{{!mxt}}, the “bad monospaced example text" template.
  • |style= – to apply arbitraryCSS style, for some specialized contextual purpose. Example:|style=background-color: Yellow;. Anycolor,background-color, orborder specified here willoverride those provided by any of the above parameters, regardless of the order in which the parameters are given in the template. As this template uses a<span> element, only CSS that can apply to inline elements (not block elements) will work. Like the above parameters, it applies to the entire output.
    • Light bulb iconB To specifically style the parameter name and/or the value:
      e.g.,{{para|page|{{var|'''single''' page number}}}},{{para|page'''''<u>s</u>'''''|{{var|page'''range''', or'''multiple''' individual pages, or both}}}}
      gives:|page=single page number,|pages=pagerange, ormultiple individual pages, or both

TemplateData

See a monthly parameter usage report forTemplate:Para in articles based on its TemplateData.

TemplateData for Para

Gives examples of template parameter source code

Template parameters[Edit template data]

ParameterDescriptionTypeStatus
Parameter name1

The parameter name. Give this parameter as explicitly blank and just fill in parameter 2 when you want to show an unnamed parameter.

Stringsuggested
Value name2

The value name. When the first parameter is given but is blank, the second represents an unnamed parameter's value (or a valueless parameter name).

Stringsuggested
Plainplain

Removes the faint border and light-grey background.

Default
y
Booleanoptional
Green textmxtgreen

Colors the text in green.

Default
y
Booleanoptional
Red text!mxtred

Colors the text in red.

Default
y
Booleanoptional
Stylestyle

Apply arbitrary CSS style, for some specialized contextual purpose.

Example
background-color: Yellow;
Contentoptional

See also

The three tables below describe the family of approximately forty templates built for talking about templates.

There are also some related templates or subjects not found in those tables:

  • {{Param}}, for markup of examples of parameter names as they would appear in MediaWiki source code of templates, e.g.{{param|foo}} gives:{{{foo}}}
  • {{Template journal parameter}}, for markup of examples of parameter names as they would appear in the{{tj}} and{{tji}} templates.
  • {{Tag|...|attribs}}, for markup of examples of HTML elements' attributes and values; e.g.{{tag|a|attribs=href=/demo.php|o}} gives:<a href=/demo.php>
These tables:

General-purpose formatting

Comparison of template-linking templates according to the styles of generated text and link produced
Text style ↓{{tlg}} options[note 1]
to achieve text style
Link style
LinkedUnlinkedLinked with substUnlinked with substLinked including bracesLinked with alternative text
{{tlg}} options[note 1]
to achieve link style
DEFAULTnolink=yessubst=yesnolink=yes|subst=yesbraceinside=yesalttext=Foo
2=Foo
normalDEFAULT{{tlg}}[note 1]
{{tl}}
{{tlp|1|2|...}}[note 2]
{{Template:tlu}}[note 3]
{{tlf}}[note 2]
<template link>
{{subst:tls}}
{{subst:Template:tlsu}}[note 3]
{{subst:tlsf}}[note 2]
<template link>
{{tn}}{{tla}}
codecode=yes{{tl2}}
{{tlx}}
{{Template:tlxu}}[note 3]
{{tlc}}[note 2]
<template link>
{{tnull}}<template link>
{{subst:tlxs}}{{subst:tlsc}}[note 2]
<template link>
monospaceplaincode=yes[note 4]{{subst:tltss}}[note 5]
kbdkbd=yes[note 5]
boldbold=yes{{tlb}}
bold+codebold=yes|code=yes{{tlxb}}
italic+codeitalic=yes|code=yes{{tlxi}}
  1. ^abc{{tlg}} is the most general template, allowing any combination of text style and/or link style options.
  2. ^abcdePrevents wrapping of text by placing it inside<span class="nowrap">...</span> tags.
  3. ^abcAllows links to templates in any namespace.
  4. ^{{tlg|plaincode=yes}} uses<code style="border:none; background-color:transparent;">...</code>.
  5. ^abDisplays monospaced font using<span style="font-family:monospace;">...</span>.

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters
Code exampleEffectNotes
{{Tj|Hatnote|Some text|selfref: yes|category: no|lang: fr}}
{{Hatnote
|Some text
|selfref =yes
|category =no
|lang =fr
}}
Supports colors, placeholder texts, named and unnamed parameters
<syntaxhighlightlang="wikitext">{{Hatnote| Some text| selfref= yes| category= no| lang= fr}}</syntaxhighlight>
{{Hatnote| Some text| selfref= yes| category= no| lang= fr}}
Same as above
{{Tji|Hatnote|Some text|selfref: yes|category: no|lang: fr}}{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}Supports colors, placeholder texts, named and unnamed parameters
<syntaxhighlight lang="wikitext" inline>{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}</syntaxhighlight>{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}Same as above
{{tl2|Hatnote|lang=fr}}{{hatnote}}Supports linking to sister projects (e.g., fr:Hatnote)
{{demo|<nowiki>{{Hatnote|Some text}}</nowiki>}}
{{hatnote|Some text}}
Some text
Shows code and example
{{tln|Hatnote}}Template:HatnoteProduces a normal link to the template
{{elc|Template:Example}}
{{elc|Template:Example|Text|suffix}}
[[Template:Example]]
[[Template:Example|Text]]suffix
Shows how wikilink would be entered in wiki markup, with optional link text and suffix
{{ml|Example|hello}}{{#invoke:Example|hello}}Counterpart to{{tl}} for linking to Lua modules
{{mfl|Example|hello}}{{#invoke:Example|hello}}Similar to{{ml}}, but expects the function to be documented and creates a link to the corresponding section
{{mlx|Example|hello}}{{#invoke:Example|hello}}Counterpart to{{tlx}} for linking to Lua modules
{{ml-lua|Module:Example}}require('Module:Example')Link to Lua modules and built-in libraries, showing Lua code.
{{para|title|<var>book title</var>}}|title=book titleFormats 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 theWP: 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}}
{{mwl|#if}}
{{mwl|#if|{{{1}}}|true|false}}
{{#if}}
{{#if:{{{1}}}|true|false}}
Magic word links
{{pf|if}}
{{pf|if|{{{1}}}|true|false}}
{{#if}}
{{#if:{{{1}}}|true|false}}
Parser function equivalent to{{tl}}
{{magic word|uc:}}{{uc:}}Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)
Code exampleEffect
{{lt|Hatnote}}Template:Hatnote (edit |talk |history |links |watch |logs)
{{lts|Hatnote}}Template:Hatnote(edit talk links history)
{{t links|Hatnote}}{{Hatnote}} (edittalkhistorylinks #/subpages/doc /doc edit/sbox /sbox diff/test)
{{tfd links|Hatnote}}Template:Hatnote (talk ·history ·transclusions ·logs ·subpages)
{{tetl|Hatnote}}{{Hatnote}}
links talk edit
{{tsetl|Hatnote}}{{subst:Hatnote}}
 links talk edit
{{ti|Hatnote}}Template:Hatnote (talk ·links ·edit)
{{tic|Hatnote}}Template:Hatnote (talklinksedit)
{{tim|Hatnote}}m:Template:Hatnote (backlinksedit)
{{tiw|Hatnote}}Template:Hatnote (backlinksedit)
{{tlt|Hatnote}}{{Hatnote}} (talk)
{{ttl|Hatnote}}Template:Hatnote (links,talk)
{{twlh|Hatnote}}Template:Hatnote (links,talk)
Template  Example output  Use 
{{strong}}Important! To indicate<strong> importance, seriousness, or urgency instead of just simple typographical boldfacing
{{strongbad}} "Never use ..." Same as {{strong}} but in red
{{stronggood}} "Only use ..." Same as {{strong}} but in green
{{em}} "Anemphatic phrase" To indicate<em> stress emphasis (not just purely typographical italicization like for book titles or foreign terms)
{{var}}strPrefix To indicate text is a variable name. Use for any variable names except those including "I" (uppercase i) and/or "l" (lowercase L); for these, {{var serif}} should be used to ensure a noticeable distinction
{{var serif}}strIllustratePrefix (see {{var}} above)
{{tld}}{{DEFAULTSORT:Y, X}} To display wikicode variables andmagic words as they would appear in code
{{para}}|year=2008 To display template parameters with or without values
{{param}}{{{title|alt}}} To display parameters as used in code (i.e. with triple braces), especially to indicate relationships between them. May be combined with {{para}} above
{{tjp}}
‹ Thetemplate below (Template journal parameter) is being considered for deletion. Seetemplates for discussion to help reach a consensus. ›
|selfref=yes
To display template parameters with colors (as they would appear in the{{tj}} and{{tji}} templates)
{{param value}}··2·blanks·fore·and·aft·· To display parameter values lightly bordered; replaces <code>...</code>, especially when value contains embedded or leading/trailing blanks; visualized here withmiddot (·) but can use ␠, ▯, or any character.
{{tlx}} etc.{{Template|1|2|...|10}} To display a template call (with or without parameters and values) as code
{{tji}}{{hatnote|Hello|selfref=yes|category=no}} To showcase with colors in horizontal format the syntax of any template, while providing an easy way to display placeholder texts using colons as separators
{{tag}}"The<img>...</img> tags ..." To renderHTML elements ("tags") in prose
{{code}}/{{codett}}"Ensure thealt= parameter ..." To indicate text is source code. To nest other templates within {{code}}, use<code>...</code>.{{codett}} differs only in styling:someMethod becomessomeMethod
{{PreCode}}"FORTH has keyword?BRANCH." Like {{code}}, but prevents line breaks inside the code. Only for very short code parts.
{{subst:codenowiki}}{{small|small text example}} To wrap example code in<code><nowiki>...</nowiki></code>
{{subst:kbdnowiki}}{{large|large text example}} To wrap example code in<kbd><nowiki>...</nowiki></kbd>
{{syntaxhighlight}}    [this is a block template] ( or{{sxhl}})  Wrapper for<syntaxhighlight>...</syntaxhighlight>, but will wrap overflowing text
{{deprecated code}} "Do not use<blink>." ( or{{dc}})  To indicatedeprecated source code in template documentation, articles on HTML specs, etc. The{{dc2}} variant uses strike-through (<blink>) while{{dcr}} uses red (<blink>).
{{pre}}    [this is a block template] For larger blocks of source code and other pre-formatted text
{{tj}}    [this is a block template] To showcase with colors and multiple lines (vertical format) the syntax of any template, while providing an easy way to display placeholder texts using colons as separators
{{quote}}    [this is a block template] For block quotations (only – never for non-quotations)
{{block indent}}    [this is a block template] For indented blocks of material; visually identical to{{quote}} but without quote markup
{{kbd}}user input To indicate user input
{{key press}}Ctrl+x To indicate specific-keystroke input, including combinations
{{key top}}Left shift Similar; includes more symbols, but does not directly support combinations
{{button}}Don't save To indicate a button in a user interface
{{samp}}example output To indicate sample or example output
The abovedocumentation istranscluded fromTemplate:Para/doc.(edit |history)
Editors can experiment in this template'ssandbox(edit |diff) andtestcases(edit) pages.
Add categories to the/doc subpage.Subpages of this template.
Retrieved from "https://en.wikipedia.org/w/index.php?title=Template:Para&oldid=1099725938"
Category:
Hidden categories:

[8]ページ先頭

©2009-2025 Movatter.jp