Template:Markup/doc

From MicroWiki, the free micronational encyclopædia
Jump to navigation Jump to search

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

Usage

Each pair of {{Markup}}'s arguments should be two copies of some wikitext markup, with the first of the pair enclosed in Template:Xtag 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:

Markup Renders as
[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

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 {{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.
  • Some templates may have error checking that places the page in a maintenance category.
    • Template:Cs1 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 Template:Xtag tags. To work around this, replace the & with &amp; 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

Markup Renders as
[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

With custom title and column headers

How to write about foxes and dogs in Wikipedia.
Write this in wikitext and this will appear in the article.
[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

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).

Markup Renders as
[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

With HTML entities

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

Markup Renders as
[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

More examples

Markup Renders as
[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

Typing aid: template {{mra}}

{{mra}} will duplicate the source text automatically, saving you the trouble of copying the text and adding Template:Xtag 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:

Markup Renders as
[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

See also

  • {{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

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools.

TemplateData for Markup

Template parameters

ParameterDescriptionTypeStatus
margin-leftmargin-left

To set a margin on the table's lefthand side.

Default
0
Stringoptional
widthwidth

To set the table's overall width.

Default
auto
Stringoptional
stylestyle

For CSS styles amending the table's overall appearance.

Stringoptional
noheadersnoheaders

Set (as e.g. noheaders=on) to suppress the columns' headings and table's title.

Stringoptional
titletitle

Title above table.

Stringoptional
colheaderstylecolheaderstyle

For CSS styling to amend the appearance of each column's heading.

Stringoptional
col1headerstylecol1headerstyle

For CSS styling to amend the appearance of the first column's heading. Overrides (but does not replace) colheaderstyle.

Stringoptional
col1col1

First column (markup/code)'s heading.

Default
"Markup"
Stringoptional
col2headerstylecol2headerstyle

For CSS styling to amend the appearance of the second column's heading. Overrides (but does not replace) colheaderstyle.

Stringoptional
col2col2

Second column (output)'s heading.

Default
"Renders as"
Stringoptional
Column 1 stylecodestyle markupstyle

Use CSS style code to change the look of content in the Markup column.

Example
white-space: nowrap
Stringoptional
Column 2 styleoutputstyle

Use CSS style code to change the look of content in the Renders-as column.

Stringoptional
11

row 1, first column (markup/code)'s content.

Stringoptional
22

row 1, second column (output)'s content.

Stringoptional
33

row 2, first column's content (etc).

Stringoptional
44

row 2, second column's content (etc).

Stringoptional
3939

First column's content in last possible row.

Stringoptional
4040

Second column's content in last possible row.

Stringoptional