Editing Template:Markup
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
| Latest revision | Your text | ||
| Line 1: | Line 1: | ||
| − | < | + | {{Documentation subpage}} |
| − | + | <!-- Categories where indicated at the bottom of this page, please. --> | |
| − | + | {{TOC right |limit=2}} | |
| − | + | ||
| − | + | This template is used to present markup or code side by side with the output it renders. | |
| − | + | ||
| − | + | <templatedata> | |
| − | + | { | |
| − | + | "description": " ", | |
| − | + | "paramOrder": [ | |
| − | + | "margin-left", | |
| − | + | "width", | |
| − | + | "style", | |
| − | + | "noheaders", | |
| − | + | "title", | |
| − | + | "colheaderstyle", | |
| − | + | "col1headerstyle", | |
| − | + | "col1", | |
| − | + | "col2headerstyle", | |
| − | + | "col2", | |
| − | + | "codestyle", | |
| − | + | "outputstyle", | |
| − | + | "1", | |
| − | + | "2", | |
| − | + | "3", | |
| − | + | "4", | |
| − | |- | + | "39", |
| − | + | "40" | |
| − | + | ], | |
| − | + | "params": { | |
| − | + | "1": { | |
| − | + | "description": "row 1, first column (markup/code)'s content.", | |
| + | "type": "string" | ||
| + | }, | ||
| + | "2": { | ||
| + | "description": "row 1, second column (output)'s content.", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "3": { | ||
| + | "description": "row 2, first column's content (etc).", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "4": { | ||
| + | "description": "row 2, second column's content (etc).", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "39": { | ||
| + | "description": "First column's content in last possible row.", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "40": { | ||
| + | "description": "Second column's content in last possible row.", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "width": { | ||
| + | "description": "To set the table's overall width.", | ||
| + | "type": "string", | ||
| + | "default": "100%" | ||
| + | }, | ||
| + | "margin-left": { | ||
| + | "description": "To set a margin on the table's lefthand side.", | ||
| + | "type": "string", | ||
| + | "default": "0" | ||
| + | }, | ||
| + | "style": { | ||
| + | "description": "For CSS styles amending the table's overall appearance.", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "title": { | ||
| + | "description": "Title above table.", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "noheaders": { | ||
| + | "description": "Set (as e.g. noheaders=on) to suppress the columns' headings and table's title.", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "col1": { | ||
| + | "description": "First column (markup/code)'s heading.", | ||
| + | "type": "string", | ||
| + | "default": "\"Markup\"" | ||
| + | }, | ||
| + | "col2": { | ||
| + | "description": "Second column (output)'s heading.", | ||
| + | "type": "string", | ||
| + | "default": "\"Renders as\"" | ||
| + | }, | ||
| + | "codestyle": { | ||
| + | "description": "For CSS styles amending the presentation of the first column (markup/code)'s content (e.g. a smaller font-size).", | ||
| + | "type": "string", | ||
| + | "aliases": [ | ||
| + | "markupstyle" | ||
| + | ] | ||
| + | }, | ||
| + | "outputstyle": { | ||
| + | "description": "For CSS styles amending the presentation of the second column (output)'s content.", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "col1headerstyle": { | ||
| + | "description": "For CSS styling to amend the appearance of the first column's heading. Overrides (but does not replace) colheaderstyle.", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "col2headerstyle": { | ||
| + | "description": "For CSS styling to amend the appearance of the second column's heading. Overrides (but does not replace) colheaderstyle.", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "colheaderstyle": { | ||
| + | "description": "For CSS styling to amend the appearance of each column's heading.", | ||
| + | "type": "string" | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | </templatedata> | ||
| + | |||
| + | ===Usage=== | ||
| + | Each cell in the first ("Markup") column uses {{tag|pre|o}} 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 {{xtag|nowiki}}. 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 {{tag|nowiki|s}} 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}}. | ||
| + | * Some templates will place the page in a maintenance category, which is usually undesired: | ||
| + | ** Instead of {{tlx|citation needed}}, use {{tlx|fake citation needed}}. | ||
| + | * Some templates 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=== | ||
| + | ===={{xtag|nowiki}}==== | ||
| + | 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==== | ||
| + | HTML entities are parsed in the markup cell: | ||
| + | {{Markup | ||
| + | |t1=Nowikied markup shows as |t2=Expected markup | ||
| + | | <nowiki> –</nowiki> | &nbsp;&ndash; | ||
| + | }} | ||
| + | |||
| + | To work around this, replace the <code>&</code> with <code>&amp;</code> thus <code>&amp;nbsp;</code> will show as <code>&nbsp;</code> | ||
| + | |||
| + | ====List and indent markup==== | ||
| + | If the first line includes wikimarkup that must start on a new line such as #, * or ; then use {{tag|nowiki|s}}: | ||
| + | |||
| + | {{Markup |title=Without {{tag|nowiki|s}} | ||
| + | | <nowiki># Item 1 | ||
| + | # Item 2 | ||
| + | # Item 3 | ||
| + | # Item 4</nowiki> | ||
| + | | | ||
| + | # Item 1 | ||
| + | # Item 2 | ||
| + | # Item 3 | ||
| + | # Item 4 | ||
| + | }} | ||
| + | |||
| + | {{Markup |title=With {{tag|nowiki|s}} | ||
| + | | <nowiki /> | ||
| + | <nowiki># Item 1 | ||
| + | # Item 2 | ||
| + | # Item 3 | ||
| + | # Item 4</nowiki> | ||
| + | | <nowiki /> | ||
| + | # Item 1 | ||
| + | # Item 2 | ||
| + | # Item 3 | ||
| + | # Item 4 | ||
| + | }} | ||
| + | |||
| + | ===Examples=== | ||
| + | |||
| + | ====Simple==== | ||
| + | {{Markup | ||
| + | | <nowiki>'''Bold text'''</nowiki> | '''Bold text''' | ||
| + | | <nowiki>''Italic text''</nowiki> | ''Italic text'' | ||
| + | }} | ||
| + | |||
| + | ====More complex==== | ||
| + | Note that {{tl2|Markup}}'s second argument here uses {{tl2|fake heading}} and {{tl2|fake citation needed}}. | ||
| + | {{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 citation needed}} | ||
| + | |||
| + | {{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. | ||
| + | }} | ||
| + | |||
| + | ====Showing rendered HTML==== | ||
| + | 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}}}} | ||
| + | }} | ||
| + | |||
| + | ===See also=== | ||
| + | * {{tl|Markup2}} for bulleted and indented markup. | ||
| + | * {{tl|Markupv}} for the vertical presentation (above/below) of markup/code and its output. | ||
| + | |||
| + | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | ||
| + | | <!-- Categories below this line, please: --> | ||
| + | [[Category:Documentation assistance templates]] | ||
| + | [[Category:Template namespace templates]] | ||
| + | [[Category:Template test cases| ]] | ||
| + | }}</includeonly> | ||
