Template:Markupv/sandbox

This is the template sandbox page for Template:Markupv (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

Usage

This template is used to present markup or code in a vertical format above the rendered output.

Parameters:

markup or m: Content of Markup cell
renders or r: Content of Renders as cell
title or t: Title of table; defaults to none
margin: Set table left margin in em
width: Table width; defaults to 90%
style: Additional CSS for the table

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

If the first line includes wikimarkup that must start on a new line such as #, * or ; then use <nowiki /> before the first line.
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.

Examples

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

{{markupv|title=Example:
|markup=<nowiki><nowiki><score>\relative c' { c( b~ c b c b c b c~ c)}</score></nowiki></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	$\relative c' { c( b~ c b c b c b c~ c)}$

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	<span class="nowrap">{{</span>[[Template:Tag\|Tag]]<span class="nowrap">}}</span>
Renders as	{{Tl\|Tag}}

HTML entities are parsed in the markup cell

Markup	–
Renders as	–

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

Examples

Simple examples:

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

Markup	''Italic text''
Renders as	Italic text

Complex example: Note that the second argument to {{Markupv}} uses {{Fake heading}} and {{Fake citation needed}}.

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.{{Fake citation needed}}

== Notes ==
{{Reflist|group=nb}}

== References ==
{{Reflist}}

Renders as

The quick brown fox jumps over the lazy dog.^{[nb 1]} The cow jumped over the moon.‹The template Fake citation needed is being considered for merging.› ^{[citation needed]}

Notes

^ A footnote.^[1]

References

^ A reference for the footnote.

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.

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

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.

Markup	{{code\|{{cite book \|last=White \|first=T. H. \|title=The Book of Merlyn \|year=1977}}}}
Renders as	'"`UNIQ--templatestyles-0000002F-QINU`"'<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%2Fsandbox" class="Z3988"></span>