Template:Tag/doc
Similar templates at English sister projects [edit] | |||
---|---|---|---|
![]() |
mta | Meta-wiki | Tag |
![]() |
wpd | Wikipedia | Tag |
![]() |
cms | Commons | Tag |
![]() |
wbk | Wikibooks | Tag |
![]() |
wsp | Wikispecies | Tag |
![]() |
wvy | Wikiversity | Tag |
![]() |
mdw | MediaWiki | Tag |
This template provides a quick way to mention an XML-style tag in a preformatted way. Mainly used in discussion/help pages.
Usage
[edit]- first parameter — (mandatory) the name of the HTML tag
- second parameter — what type of tag to display:
p
orpair
– (default) display a matched pair of open-and-close tags:<font>...</font>
o
oropen
– display only the opening tag of an open-and-close pair:<span>
c
orclose
– display only the closing tag of an open-and-close pair:</span>
s
orsingle
– display a single tag:<br />
- content= — the text content of the tags
- params= — any parameters to be included in the opening tag
Examples
[edit]{{tag|ref}}
→<ref>...</ref>
{{tag|ref|content=hello}}
→<ref>hello</ref>
{{tag|font|content=foo}}
→<font>foo</font>
{{tag|font|open}}
→<font>
{{tag|font|open|content=hello}}
→<font>hello
{{tag|span|close|content=hello}}
→hello</span>
{{tag|span|pair|content=hello}}
→<span>hello</span>
{{tag|ref|open|params=group=note}}
→<ref group=note>
{{tag|references|single}}
→<references />
{{tag|br|single}}
→<br />
TemplateData
[edit]- TemplateData
TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.
Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either useTemplateData=1
or useTemplateData=only
on the /doc
subpage and transcluding it with {{Documentation}} into the template. <nowiki>
-tags can be wrapped around the arguments, if required, to avoid templates being expanded.
Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw <templatedata>
-tags into the Wikitext of the template, as described in various Wikipediae.
Wikipedia's help about TemplateData • Commons-specific information
This template provides a quick way to mention an XML-style tag in a preformatted way. Mainly used in discussion/help pages.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Tag | 1 | The name of the HTML tag.
| Line | required |
Type | 2 | What type of tag to display.
| String | optional |
Parameters | params | Parameters to be included in the opening tag.
| Line | optional |
Content | content | The text content of the tags.
| Content | optional |