Template:Markup
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>
. 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 {{crlf2}} before the first line; see the template for examples.
- 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}} to ensure that the reference list is closed.
- Some templates will place the page in a maintenance category, which is usually undesired:
- Instead of {{fact}} use {{fake fact}}.
- Instead of {{citation needed}}, use {{fake citation needed}}.
- Some template 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
.
- Citation Style 1 templates can suppress the maintenance category by setting
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}}:
Renders as | Expected rendering |
---|---|
{{[[:Template:tag|tag]]}} |
{{tl|tag}} |
HTML entities are parsed in the markup cell
Mowikied markup shows as | Expected markup |
---|---|
– |
– |
To work around this, replace the &
with &
thus &nbsp;
will show as
Examples
Simple examples:
Markup | Renders as |
---|---|
'''Bold text''' |
Bold text |
''Italic text'' |
Italic text |
<s>Struck text</s> |
|
Complex example: Note that the second argument to {{markup}} uses {{fake heading}} and {{fake fact}}.
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.[citation needed]
|
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:
Markup | Renders as |
---|---|
The quick brown fox jumps over the lazy dog. |
The quick brown fox jumps over the lazy dog. |