Difference between revisions of "Template:Markup/doc"

Revision as of 06:24, 16 September 2022

This is a documentation subpage for Template:Markup.
It contains usage information,

categories and other content or metadata that is not part of the original template.

This template is used to present markup or code side by side with the output it renders.

This template may require cleanup to meet this wiki's Editing Guidelines. No cleanup reason has been specified. Please help improve this template if you can; the talk page may contain suggestions.

Usage

Each pair of {{Markup}}'s arguments should be two copies of some wikitext markup, with the first of the pair enclosed in <nowiki> tags. The template produces output in two columns, the first showing the markup and the second showing how it is rendered. The template accepts up to 40 unnamed parameters, resulting in up to 20 rows of examples.

This:

{{markup|<nowiki>'''Bold text'''</nowiki>|'''Bold text'''}}

Produces this: '''Bold text'''

In many cases, the markup for both columns is identical, but there are instances where this may need to differ. If none of these issues apply, then you may use {{mra}} to save yourself from copying the code twice.

Header markup such as == will show in the page table of contents; to avoid this, use {{fake heading}} in the markup for the second column (see example below).
Some templates will place the page in a maintenance category, which is usually undesired. For example.
- Instead of {{citation needed}}, use {{fake citation needed}} in the second column.
Some templates may have error checking that places the page in a maintenance category.
- ~~Citation Style 1 templates with errors: add |template doc demo = true to the template in the second column.~~
- To avoid this and the associated red error messages make sure that each example on the page uses different sources.
HTML entities are parsed in the first cell, even with <nowiki> tags. To work around this, replace the & with & in the first column (see example below).

It is advisable to begin both copies of the markup with a newline; this is necessary if the first line of the markup must start on a new line (such as #, * or ;).

Examples

Multiple rows

'''Bold text'''

With custom title and column headers

The quick brown fox jumps over the lazy dog.

A complex example

In this example, {{Markup}}'s second argument here uses {{fake heading}} (to avoid headings appearing in the table of contents) and {{fake citation needed}} (to avoid adding this page to the maintenance list).

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}}

With HTML entities

HTML entities are parsed in the markup cell. To work around this, replace the & with & in the first column.

–

More examples

{{cite book |last=White |first=T. H. |title=The Book of Merlyn |year=1977}}

Typing aid: template {{mra}}

{{mra}} will duplicate the source text automatically, saving you the trouble of copying the text and adding <nowiki> tags to the first case.

This:

{{subst:mra|'''Bold text'''|''Italic text''}}

Will produce this:

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

Which renders as: '''Bold text'''

TemplateData

This is the

TemplateData for this template used by TemplateWizard,

VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Markup

<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": "auto" }, "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": "Use CSS style code to change the look of content in the Markup column.", "type": "string", "aliases": [ "markupstyle" ], "label": "Column 1 style", "example": "white-space: nowrap" }, "outputstyle": { "description": "Use CSS style code to change the look of content in the Renders-as column.", "type": "string", "label": "Column 2 style" }, "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>

@@ Line 16: / Line 16: @@
 {{markup|<nowiki>'''Bold text'''</nowiki>|'''Bold text'''}}
-In many cases, the markup for both columns are identical, but there are instances where this may need to differ. If none of these issues apply, then you may use {{tlx|mra}} to save yourself from copying the code twice.
+In many cases, the markup for both columns is identical, but there are instances where this may need to differ. If none of these issues apply, then you may use {{tlx|mra}} to save yourself from copying the code twice.
 * Header markup such as {{code|1===}} will show in the page table of contents; to avoid this, use {{tlx|fake heading}} in the markup for the second column (see example [[#A complex example|below]]).
 * Some templates will place the page in a maintenance category, which is usually undesired. For example.
@@ Line 25: / Line 25: @@
 * HTML entities are parsed in the first cell, even with {{xtag|nowiki}} tags. To work around this, replace the <code>&</code> with <code>&amp;amp;</code> in the first column (see example [[#With HTML entities|below]]).
-It is advisable to begin both copies of the markup with a [[newline]]; this is necessary if the first line of the markup must start on a new line (such as #, *  or ;).
+It is advisable to begin both copies of the markup with a {{Wikipedia|newline}}; this is necessary if the first line of the markup must start on a new line (such as #, *  or ;).
 ==Examples==