View source for Template:Markup/doc

{{Documentation subpage}}
<!-- Categories and interwikis go at the bottom of this page. -->

==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 {{tag|pre|o}} 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 {{xtag|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 {{tl|crlf2}} before the first line; see examples below.
* Header markup such as {{code|1===}} will show in the page table of contents; use {{tlx|fake heading}}.
* When using {{tlx|reflist}} with no other parameters, use {{tlx|reflist|close}} to ensure that the reference list is closed.
* Some templates will place the page in a maintenance category, which is usually undesired:
** Instead of {{tlx|citation needed}}, use {{tlx|Fake}}.
* Some template may have error checking that places the page in a maintenance category. Suppress the category as possible:
** {{cs1}} templates can suppress the maintenance category by setting {{para|template doc demo|true}}.

==Limitations==
If you don't wrap the content of the markup cell in {{xtag|nowiki}}, then any template markup will not be escaped, it will be expanded.

This example shows the markup for <nowiki>{{tl|tag}}</nowiki>:

{{markup|t1=Renders as|t2=Expected rendering
|{{tl|tag}}
|<nowiki>{{tl|tag}}</nowiki>
}}

HTML entities are parsed in the markup cell
{{markup|t1=Nowikied markup shows as |t2=Expected markup
|<nowiki>&nbsp;&ndash;</nowiki>
|&amp;nbsp;&amp;ndash;
}}

To work around this, replace the <code>&</code> with <code>&amp;amp;</code> thus <code>&amp;amp;nbsp;</code> will show as <code>&amp;nbsp;</code>

==Examples==

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

'''Complex example:'''
Note that the second argument to {{tl2|markup}} uses {{tl2|fake heading}} and {{tl2|Fake}}.
{{markup
|<nowiki>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}}
</nowiki>
|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}}

{{fake heading|sub=3|Notes}}
{{Reflist|group=nb}}

{{fake heading|sub=3|References}}
{{Reflist|close}}
}}

'''Multiple rows:'''
{{markup
|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:'''
{{markup|title=Foxes and dogs
|The quick brown fox jumps over the lazy dog.
|The quick brown fox jumps over the lazy dog.
}}

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

{{markup
|<nowiki>{{cite book |last=White |first=T. H. |title=The Book of Merlyn |year=1977}}</nowiki>
|{{cite book |last=White |first=T. H. |title=The Book of Merlyn |year=1977}}
|<nowiki>{{code|{{cite book |last=White |first=T. H. |title=The Book of Merlyn |year=1977}}}}</nowiki>
|{{code|{{cite book |last=White |first=T. H. |title=The Book of Merlyn |year=1977}}}}
}}

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- Categories and interwikis go here: -->
[[Category:Template test cases| Testcases side by side]]
[[Category:Template namespace templates]]
[[Category:Documentation assistance templates]]

}}</includeonly>