Difference between revisions of "Template:Markup/doc"

From blackwiki
Jump to navigation Jump to search
imported>Tholme
 
(8 intermediate revisions by 7 users not shown)
Line 1: Line 1:
the table's overall appearance.",
+
{{Documentation subpage}}
"type": "string"
+
<!-- Categories where indicated at the bottom of this page, please. -->
},
+
{{TOC right |limit=2}}
"title": {
+
 
"description": "Title above table.",
+
This template is used to present markup or code side by side with the output it renders.
"type": "string"
 
},
 
"noheaders": {
 
"description": "Set (as e.g. noheaders=on)
 
]
 
},
 
"outputstyle": {
 
"description": "For CSS styles amending the presentation of the second column (output)'s content.",
 
"type": "string 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===
+
==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 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 theare instances where this may differ:
+
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.
 
* 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 will show  
+
* 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:
 
* Some templates will place the page in a maintenance category, which is usually undesired:
** Instead of {{tlx|citation needed}}, use {{tlx|fake
+
** Instead of {{tlx|citation needed}}, use {{tlx|fake citation needed}}.
* Some templates may
+
* 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}}.
 +
 
 +
The template accepts up to 40 unnamed parameters, resulting in up to 20 rows of examples.
 +
 
 +
===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>&nbsp;&ndash;</nowiki> | &amp;nbsp;&amp;ndash;
 +
}}
 +
 
 +
To work around this, replace the <code>&</code> with <code>&amp;amp;</code> thus <code>&amp;amp;nbsp;</code> will show as <code>&amp;nbsp;</code>
  
 
===Examples===
 
===Examples===
Line 37: Line 41:
 
====Simple====
 
====Simple====
 
{{Markup
 
{{Markup
| <nowiki>'''Bold text'''</ here uses {{tl2|fake heading}}  
+
| <nowiki>'''Bold text'''</nowiki> | '''Bold text'''
 +
| <nowiki>''Italic text''</nowiki> | ''Italic text''
 +
}}
 +
====Short cut====
 +
See [[Template:Mra]].
 +
 
 +
'''Enter this:'''
 +
<pre>{{subst:mra|'''Bold text'''|''Italic text''}}</pre>
 +
'''To make this:'''
 +
<pre>{{markup|
 +
&lt;nowiki>'''Bold text'''</nowiki>|'''Bold text'''|
 +
&lt;nowiki>''Italic text''</nowiki>|''Italic text''}}</pre>
 +
 
 +
'''Which renders as:'''
 +
{{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 ==
 
== References ==
{{reflist}
+
{{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}}
 
| 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}}
  
Line 75: Line 104:
 
}}
 
}}
  
===See also===
+
==See also==
 
* {{tl|Markup2}} for bulleted and indented markup.
 
* {{tl|Markup2}} for bulleted and indented markup.
 
* {{tl|Markupv}} for the vertical presentation (above/below) of markup/code and its output.
 
* {{tl|Markupv}} for the vertical presentation (above/below) of markup/code and its output.
 
* {{tl|Automarkup}} does not require to write the code samples twice.
 
* {{tl|Automarkup}} does not require to write the code samples twice.
 
+
== TemplateData ==
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
+
{{TemplateData header}}
 +
<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": "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>
 +
<includeonly>{{Sandbox other|
 
| <!-- Categories below this line, please: -->
 
| <!-- Categories below this line, please: -->
 
[[Category:Documentation assistance templates]]
 
[[Category:Documentation assistance templates]]

Latest revision as of 15:47, 21 February 2021

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

Usage

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 <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 <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:
  • 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.

The template accepts up to 40 unnamed parameters, resulting in up to 20 rows of examples.

Limitations

<nowiki>

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

Renders as Expected rendering
{{[[Template:tag|tag]]}}

{{tl|tag}}

HTML entities

HTML entities are parsed in the markup cell:

Nowikied markup shows as Expected markup
 –

&nbsp;&ndash;

To work around this, replace the & with &amp; thus &amp;nbsp; will show as &nbsp;

Examples

Simple

Markup Renders as
'''Bold text'''

Bold text

''Italic text''

Italic text

Short cut

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 as
'''Bold text'''

Bold text

''Italic text''

Italic text

More complex

Note that {{Markup}}'s second argument here uses {{fake heading}} and {{fake citation needed}}.

Markup Renders as
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}}

The quick brown fox jumps over the lazy dog.[nb 1] The cow jumped over the moon.[citation needed]

Notes
  1. A footnote.[1]
References
  1. A reference for the footnote.

Multiple rows

Markup Renders as
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

Foxes and dogs
Markup Renders as
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 {{code}}, it shows the rendered HTML:

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

White, T. H. (1977). The Book of Merlyn.

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

<cite id="CITEREFWhite1977" class="citation book cs1">White, T. H. (1977). ''The Book of Merlyn''.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=The+Book+of+Merlyn&rft.date=1977&rft.aulast=White&rft.aufirst=T.+H.&rfr_id=info%3Asid%2Fblackwiki.org%3ATemplate%3AMarkup%2Fdoc" class="Z3988"></span>'"`UNIQ--templatestyles-0000002C-QINU`"'

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 documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

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
Codestylecodestyle markupstyle

For CSS styles amending the presentation of the first column (markup/code)'s content (e.g. a smaller font-size).

Stringoptional
Outputstyleoutputstyle

For CSS styles amending the presentation of the second column (output)'s content.

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