Plantilla:Markup/doc

This template is used to present markup or code side by side with the output it renders.

Usage

Each cell in the first ("Markup") column uses <pre> to retain newlines and spaces but styled to allow content to wrap within it. It is usually desirable to escape the content of these cells so that the markup is displayed by wrapping the markup in <nowiki>. It is technically not possible to add this feature to the template.

Each cell in the second ("Renders as") column is usually the unescaped markup copied from the corresponding "Markup" cell before it. There are instances where this may differ:

• If the first line includes wikimarkup that must start on a new line such as #, * or ; then use <nowiki /> before the first line; see examples below.
• Header markup such as == will show in the page table of contents; use {{fake heading}}.
• Some templates will place the page in a maintenance category, which is usually undesired:
  • Instead of {{citation needed}}, use {{fake citation needed}}.
• Some templates may have error checking that places the page in a maintenance category. Suppress the category as possible:
  • Citation Style 1 templates can suppress the maintenance category by setting |template doc demo=true.

Limitations

<nowiki>

If you don't wrap the content of the markup cell in <nowiki>, then any template markup will not be escaped, it will be expanded.

This example shows the markup for {{tl|tag}}:

Renders as	Expected rendering
<tt>{{[[Plantilla:tag|tag]]}}</tt>	{{tl|tag}}

HTML entities

HTML entities are parsed in the markup cell:

Nowikied markup shows as	Expected markup
–	 –

To work around this, replace the & with & thus   will show as  

Examples

Simple

Markup	Renders as
'''Bold text'''	Bold text
''Italic text''	Italic text

Short cut

See Template:Mra.

Enter this:

{{subst:mra|'''Bold text'''|''Italic text''}}

To make this:

{{markup|
<nowiki>'''Bold text'''</nowiki>|'''Bold text'''|
<nowiki>''Italic text''</nowiki>|''Italic text''}}

Which renders as:

Markup	Renders as
'''Bold text'''	Bold text
''Italic text''	Italic text

More complex

Note that {{Markup}}'s second argument here uses {{fake heading}} and {{fake citation needed}}.

Markup	Renders as
The quick brown fox jumps over the lazy dog.{{#tag:ref|A footnote.<ref>A reference for the footnote.</ref>|group=nb}} The cow jumped over the moon.{{fact}} == Notes == {{reflist|group=nb}} == References == {{reflist}}	The quick brown fox jumps over the lazy dog. The cow jumped over the moon.Plantilla:Fake citation needed Notes References

Multiple rows

Markup	Renders as
The quick brown fox jumps over the lazy dog.	The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.	The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.	The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.	The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.	The quick brown fox jumps over the lazy dog.

With title

Foxes and dogs

Markup	Renders as
The quick brown fox jumps over the lazy dog.	The quick brown fox jumps over the lazy dog.

Showing rendered HTML

When a template is enclosed within {{code}}, it shows the rendered HTML:

Markup	Renders as
{{cite book |last=White |first=T. H. |title=The Book of Merlyn |year=1977}}	The Book of Merlyn. 1977.
{{code|lang=html|{{cite book |last=White |first=T. H. |title=The Book of Merlyn |year=1977}}}}	<span class="citation cita-libro" >&#32;''The Book of Merlyn''. 1977.</span><span class="Z3988" title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=The+Book+of+Merlyn&rft.date=1977&rfr_id=info:sid/es.wikipedia.org:Plantilla:Markup/doc"><span style="display: none;">&nbsp;</span></span>

See also

• {{Markup2}} for bulleted and indented markup.
• {{Markupv}} for the vertical presentation (above/below) of markup/code and its output.
• {{Automarkup}} does not require to write the code samples twice.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Markup

Parámetros de la plantilla

Parámetro		Descripción	Tipo	Estado
margin-left	margin-left	To set a margin on the table's lefthand side. Predeterminado 0	Cadena	opcional
width	width	To set the table's overall width. Predeterminado 100%	Cadena	opcional
style	style	For CSS styles amending the table's overall appearance.	Cadena	opcional
noheaders	noheaders	Set (as e.g. noheaders=on) to suppress the columns' headings and table's title.	Cadena	opcional
title	title	Title above table.	Cadena	opcional
colheaderstyle	colheaderstyle	For CSS styling to amend the appearance of each column's heading.	Cadena	opcional
col1headerstyle	col1headerstyle	For CSS styling to amend the appearance of the first column's heading. Overrides (but does not replace) colheaderstyle.	Cadena	opcional
col1	col1	First column (markup/code)'s heading. Predeterminado "Markup"	Cadena	opcional
col2headerstyle	col2headerstyle	For CSS styling to amend the appearance of the second column's heading. Overrides (but does not replace) colheaderstyle.	Cadena	opcional
col2	col2	Second column (output)'s heading. Predeterminado "Renders as"	Cadena	opcional
codestyle	codestyle markupstyle	For CSS styles amending the presentation of the first column (markup/code)'s content (e.g. a smaller font-size).	Cadena	opcional
outputstyle	outputstyle	For CSS styles amending the presentation of the second column (output)'s content.	Cadena	opcional
1	1	row 1, first column (markup/code)'s content.	Cadena	opcional
2	2	row 1, second column (output)'s content.	Cadena	opcional
3	3	row 2, first column's content (etc).	Cadena	opcional
4	4	row 2, second column's content (etc).	Cadena	opcional
39	39	First column's content in last possible row.	Cadena	opcional
40	40	Second column's content in last possible row.	Cadena	opcional