Plantilla:Markup/doc

This is a documentation subpage for Plantilla:Markup.
It contains usage information, categories and other content that is not part of the original plantilla page.

This template uses TemplateStyles:

Template:Markup/styles.css

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

Usage

Each pair of {{Markup}}'s arguments should be two copies of some wikitext markup, with the first of the pair enclosed in <nowiki> tags. The template produces output in two columns, the first showing the markup and the second showing how it is rendered. The template accepts up to 40 unnamed parameters, resulting in up to 20 rows of examples.

This:

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

Produces this:

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

In many cases, the markup for both columns are identical, but there are instances where this may need to differ. If none of these issues apply, then you may use {{subst:mra}} to save yourself from copying the code twice.

Header markup such as == will show in the page table of contents; to avoid this, use {{fake heading}} in the markup for the second column (see example below).
Some templates will place the page in a maintenance category, which is usually undesired.
Some templates may have error checking that places the page in a maintenance category.
- ~~Citation Style 1 templates with errors: add |template doc demo=true to the template in the second column.~~
- To avoid this and the associated red error messages make sure that each example on the page uses different sources.
HTML entities are parsed in the first cell, even with <nowiki> tags. To work around this, replace the & with & in the first column (see example below).

It is advisable to begin both copies of the markup with a newline; this is necessary if the first line of the markup must start on a new line (such as #, * or ;).

Examples

Multiple rows

Markup	Renders as
'''Bold text'''	Bold text
''Italic text''	Italic text
[[Internal link]]	Internal link
{{cite book\|ref=none\|last=Smith\|year=2021\|title=Smith's book}}	Smith (2021). Smith's book.
<score>\relative c' { c( b~ c b c b c b c~ c)}</score>	$\relative c' { c( b~ c b c b c b c~ c)}$

With custom title and column headers

How to write about foxes and dogs in Wikipedia.
Write this in wikitext	and this will appear in the article.
The quick brown [[fox]] jumps over the lazy [[dog]].	The quick brown fox jumps over the lazy dog.

A complex example

In this example, Plantilla:Template link interwiki's second argument here uses Plantilla:Template link interwiki (to avoid headings appearing in the table of contents) and Plantilla:Template link interwiki (to avoid adding this page to the maintenance list).

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.^{[nb 1]} The cow jumped over the moon.Plantilla:Fake citation needed

Notes

↑ A footnote.^[1]

References

↑ A reference for the footnote.

With HTML entities

HTML entities are parsed in the markup cell. To work around this, replace the & with & in the first column.

{{Markup| <nowiki>&amp;ndash;</nowiki> | &ndash;}}

renders as:

Markup	Renders as
–	–

With the glyphs "|" and "="

If the markup contains the glyphs | or = they need to be replaced by the magic words {{!}} or {{=}}. If not they are being interpreted for the Template:Markup itself as a separator between the parameters or between the parameter name and value! So as an example use:

{{markup
|<nowiki>use <code>|lang = en</code></nowiki>
|use <code>{{!}}lang {{=}} en</code>
}}

which renders as:

Markup	Renders as
use <code>\|lang = en</code>	use `\|lang = en`

More examples

Markup	Renders as
{{cite book \|last=White \|first=T. H. \|title=The Book of Merlyn \|year=1977}}	White, T. H. (1977). The Book of Merlyn.
{{code\|lang=html\|{{cite book \|last=White \|first=T. H. \|title=The Book of Merlyn \|year=1977}}}}	`{{#parsoidfragment:45}}<cite id="CITEREFWhite1977" class="citation book cs1">White, T. H. (1977). ''The Book of Merlyn''.</cite><span 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&rft.aulast=White&rft.aufirst=T.+H.&rfr_id=info%3Asid%2Fcbk-zam.wikipedia.org%3APlantilla%3AMarkup%2Fdoc" class="Z3988"></span>`

Typing aid: template {{mra}}

{{mra}} will duplicate the source text automatically, saving you the trouble of copying the text and adding <nowiki> tags to the first case.

This:

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

Will produce 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

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. see the monthly parameter usage report for Template:Markup.

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 auto	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. Predeterminado none	Cadena	opcional
tag	`tag`	Tag to use for markup. The default is pre and syntaxhighlight only works with single rows of text. Valores sugeridos `pre` `syntaxhighlight` Predeterminado pre	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
Column 1 Style	`col1style`	For CSS styles to amend the appearance of the markup column (e.g. width of the column). Predeterminado none Ejemplo width:20em;	Cadena	opcional
Column 2 Style	`col2style`	For CSS styles to amend the appearance of the output column (e.g. the background colour). Predeterminado none Ejemplo background-color:#fff;	Cadena	opcional
Markup text style	`codestyle` `markupstyle`	Use CSS style code to change the appearance of content (text) in the Markup column. Ejemplo white-space: nowrap;	Cadena	opcional
Output text style	`outputstyle`	Use CSS style code to change the appearance of content (text) in the Renders-as column. Ejemplo white-space: nowrap;	Cadena	opcional
padding	`padding`	Padding within each cell Predeterminado 5px	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

[2] A footnote.^[1]

[1] A reference for the footnote.

[nb 1]

[1]