 | This template uses TemplateStyles: |
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{{Template:Citation needed}}.
- Instead of
- 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.
- Citation Style 1 templates can suppress the maintenance category by setting
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:
| Markup | <score>\relative c' { c( b~ c b c b c b c~ c)}</score> |
|---|---|
| Renders as | <score>\relative c' { c( b~ c b c b c b c~ c)}</score>
|
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 {{Template:Citation needed}}.
| Markup |
|
|---|---|
| Renders as | The quick brown fox jumps over the lazy dog.[nb 1] The cow jumped over the moon.[citation needed]
Notes
References
|
With title:
| 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 |
|
|---|---|
| Renders as | Script error: No such module "citation/CS1".
|
| Markup |
|
|---|---|
| Renders as | <strong class="error"><span class="scribunto-error mw-scribunto-error-15fb7b48">Script error: No such module "citation/CS1".</span></strong> |