Template:Markupv/doc

This template is used to present wiki markup or code in a vertical format with the rendered output beneath it.

Usage

Parameters

|markup= |m=	The code/markup ("wikitext"), wrapped in <nowiki>...</nowiki> tags so it will be displayed as-is
|renders= |r=	The same code markup, but without the <nowiki>...</nowiki> tags, so that it will be parsed
|title= |t=	A title to display above the example pair (optional)
|tag=	The name of a HTML tag (such as <syntaxhighlight>, <pre>, or <div>) to wrap the markup with (optional)
|margin=	Size of the indentation from the left margin, in em units; numeric values only, do not include em unit suffix (optional)
|style=	Additional CSS declarations for the whole table (optional) CSS style declarations for the title (|tstyle=), markup (|mstyle=), and render (|rstyle=) can also be specified separately (all optional)

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>. It is not technically possible to build this feature into 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:

• If the first line includes wikimarkup that must start on a new line such as #, * or ; then use <nowiki /> before the first line.
  • Use |tag=pre or |tag=syntaxhighlight to prevent an empty line before the list in the Markup cell.
• Header markup such as == will show in the page table of contents; use {{Fake heading}}.
• When using {{Reflist}} with no other parameters, use {{Reflist|close=1}} to ensure that the reference list is closed.
• 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

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

Markup	{{tl|Tag}}
Renders as	{{Tag}}

Without <nowiki> the previous example would instead display:

Markup	<span class="nowrap">&#123;&#123;</span>[[Template:Tag|Tag]]<span class="nowrap">&#125;&#125;</span>
Renders as	{{Tag}}

Examples

Simple

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

Markup	''Italic text''
Renders as	Italic text

Meta

The following meta-example uses {{Markupv}} to create an example of using <score>...</score>:

{{Markupv|tag=syntaxhighlight|title=Example:
 | markup  = <nowiki><score>\relative c' { c( b~ c b c b c b c~ c)}</score></nowiki>
 | renders = <score>\relative c' { c( b~ c b c b c b c~ c)}</score>
}}

…it generates:

Example:

Markup	<score>\relative c' { c( b~ c b c b c b c~ c)}</score>
Renders as

Complex

▶ Note that the second argument to {{Markupv}} uses {{Fake heading}}.

Markup	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.{{Citation needed}} == Notes == {{Reflist|group=nb}} == References == {{Reflist}}
Renders as	The quick brown fox jumps over the lazy dog. The cow jumped over the moon. Notes References

With title

Foxes and dogs

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

Wrapped in "code" tags

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

With "code" tags

Markup	{{Code|{{Cite book|last=White|first=T. H.|title=The Book of Merlyn|year=1977}}}}
Renders as	{{#parsoidfragment:48}}<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%2Fen.wikipedia.org%3ATemplate%3AMarkupv%2Fdoc" class="Z3988"></span>

This can also be achieved by setting |tag=code:

With "tag" parameter

Markup	{{Cite book|last=White|first=T. H.|title=The Book of Merlyn|year=1977}}
Renders as	{{#parsoidfragment:53}}<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%2Fen.wikipedia.org%3ATemplate%3AMarkupv%2Fdoc" class="Z3988"></span>

For comparison:

With "syntaxhighlight", not "code"

Markup	{{Cite book|last=White|first=T. H.|title=The Book of Merlyn|year=1977}}
Renders as	White, T. H. (1977). The Book of Merlyn.

See also

• {{Automarkup}}
• {{Markup}} – provides a side-by-side presentation of markup and renderer output
• {{Markup2}} – organizes examples vertically using bulleted lists/sublists