Plantilya:Markup
This template is used to present markup or code side by side with the output it renders.
Usage
[usba ang wikitext]Each cell in the first ("Markup") column uses <pre> to retain newlines and spaces but styled to allow content to wrap within it. It is usually desirable to escape the content of these cells so that the markup is displayed by wrapping the markup in Plantilya:Xtag. It is technically not possible to add this feature to the template.
Each cell in the second ("Renders as") column is usually the unescaped markup copied from the corresponding "Markup" cell before it. 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; see examples below. - Header markup such as
==will show in the page table of contents; use {{fake heading}}. - 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:
- Plantilya:Cs1 templates can suppress the maintenance category by setting
|template doc demo=true.
- Plantilya:Cs1 templates can suppress the maintenance category by setting
Limitations
[usba ang wikitext]If you don't wrap the content of the markup cell in Plantilya:Xtag, then any template markup will not be escaped, it will be expanded.
This example shows the markup for {{tl|tag}}:
| Renders as | Expected renderingProblema sa Lua: expandTemplate: template "format item" does not exist. |
|---|---|
HTML entities
[usba ang wikitext]HTML entities are parsed in the markup cell:
| Nowikied markup shows as | Expected markupProblema sa Lua: expandTemplate: template "format item" does not exist. |
|---|---|
To work around this, replace the & with & thus &nbsp; will show as
Examples
[usba ang wikitext]Simple
[usba ang wikitext]| Markup | Renders asProblema sa Lua: expandTemplate: template "format item" does not exist. |
|---|---|
Short cut
[usba ang wikitext]See Template:Mra.
Enter this:
{{subst:mra|'''Bold text'''|''Italic text''}}
To make this:
{{markup|
<nowiki>'''Bold text'''</nowiki>|'''Bold text'''|
<nowiki>''Italic text''</nowiki>|''Italic text''}}
Which renders as:
| Markup | Renders asProblema sa Lua: expandTemplate: template "format item" does not exist. |
|---|---|
More complex
[usba ang wikitext]Note that Plantilya:Tl2's second argument here uses Plantilya:Tl2 and Plantilya:Tl2.
| Markup | Renders asProblema sa Lua: expandTemplate: template "format item" does not exist. |
|---|---|
Multiple rows
[usba ang wikitext]| Markup | Renders asProblema sa Lua: expandTemplate: template "format item" does not exist. |
|---|---|
With title
[usba ang wikitext]| Markup | Renders asProblema sa Lua: expandTemplate: template "format item" does not exist. |
|---|---|
Showing rendered HTML
[usba ang wikitext]When a template is enclosed within {{code}}, it shows the rendered HTML:
| Markup | Renders asProblema sa Lua: expandTemplate: template "format item" does not exist. |
|---|---|
See also
[usba ang wikitext]- {{Markup2}} for bulleted and indented markup.
- {{Markupv}} for the vertical presentation (above/below) of markup/code and its output.
- {{Automarkup}} does not require to write the code samples twice.
TemplateData
[usba ang wikitext]TemplateData for Markup
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| margin-left | margin-left | To set a margin on the table's lefthand side.
| String | optional |
| width | width | To set the table's overall width.
| String | optional |
| style | style | For CSS styles amending the table's overall appearance. | String | optional |
| noheaders | noheaders | Set (as e.g. noheaders=on) to suppress the columns' headings and table's title. | String | optional |
| title | title | Title above table. | String | optional |
| colheaderstyle | colheaderstyle | For CSS styling to amend the appearance of each column's heading. | String | optional |
| col1headerstyle | col1headerstyle | For CSS styling to amend the appearance of the first column's heading. Overrides (but does not replace) colheaderstyle. | String | optional |
| col1 | col1 | First column (markup/code)'s heading.
| String | optional |
| col2headerstyle | col2headerstyle | For CSS styling to amend the appearance of the second column's heading. Overrides (but does not replace) colheaderstyle. | String | optional |
| col2 | col2 | Second column (output)'s heading.
| String | optional |
| codestyle | codestyle markupstyle | For CSS styles amending the presentation of the first column (markup/code)'s content (e.g. a smaller font-size). | String | optional |
| outputstyle | outputstyle | For CSS styles amending the presentation of the second column (output)'s content. | String | optional |
| 1 | 1 | row 1, first column (markup/code)'s content. | String | optional |
| 2 | 2 | row 1, second column (output)'s content. | String | optional |
| 3 | 3 | row 2, first column's content (etc). | String | optional |
| 4 | 4 | row 2, second column's content (etc). | String | optional |
| 39 | 39 | First column's content in last possible row. | String | optional |
| 40 | 40 | Second column's content in last possible row. | String | optional |