Vorlage:Markup/doc

Usage

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

Parameters:

• unnamed 1: Content of row 1, column 1
• unnamed 2: Content of row 1, column 2

through

• unnamed 39: Content of row 20, column 1
• unnamed 40: Content of row 20, column 2

• t1: Title of column one; defaults to Markup
• t2: Title of column two; defaults to Renders as
• title: Title of table; defaults to none
• notitle: When set, suppresses table and column titles
• margin: set table left margin in em

The Markup cell is pre-formatted with <pre> to retain newlines and spaces, but styled to allow content to wrap within the cell. It is usually desirable to escape the content of the Markup cell so that the markup is displayed by wrapping the markup in <nowiki>...</nowiki>. It is technically not possible to add this feature to the template.

In the Renders as cell, the content is usually the unescaped markup copied from the Markup cell. There are instances where this may differ:

• When using {{reflist}} with no other parameters, use {{reflist|close}} to ensure that the reference list is closed.
• Some templates will place the page in a maintenance category, which is usually undesired:
• Some template may have error checking that places the page in a maintenance category. Suppress the category as possible:
  • some templates can suppress the maintenance category by setting |template doc demo=true.

Limitations

If you don't wrap the content of the markup cell in <nowiki>...</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
{{[[Template:tag|tag]]}}	{{tl|tag}}

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 examples:

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

Complex example: Note that the second argument to {{markup}} uses {{<TEMPLATENAME>}} and {{<TEMPLATENAME2>}}.

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.{{<TEMPLATENAME2>}} {{<TEMPLATENAME>}} {{<TEMPLATENAME>}}

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.

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

Markup	Renders as
{{<TEMPLATENAME>}}	{{<TEMPLATENAME>}}
{{code snippet|{{<TEMPLATENAME>}}}}	sample text