Difference between revisions of "Template:Markup/doc"
imported>Sardanaphalus (→See also: removed self-entry, formatting) |
imported>Sardanaphalus (Parameter descriptions) |
||
| Line 5: | Line 5: | ||
This template is used to present markup or code side by side with the rendered output. | This template is used to present markup or code side by side with the rendered output. | ||
| − | + | {{Parameter descriptions/with defaults | |
| − | {{ | + | |col1style=width:8.0em; |
| − | | | + | | <span style{{=}}"font-size:125%;font-family:sans-serif;"> '''Parameters''' </span> | | {{resize|115%|'''Default'''}} |
| − | | | + | | margin-left | To set a margin on the table's lefthand side. | – |
| − | + | | noheaders | Set (as e.g. {{mono|100%|noheaders=on}}) to suppress the columns' headings and table's title. | – | |
| − | + | | title | Title above table. | none | |
| − | + | | col1 | First column's heading. | "Markup" | |
| − | | margin-left | To set a margin on the table's lefthand side | | + | | col2 | Second column's heading. | "Renders as" |
| − | | noheaders | Set (as e.g. {{mono|100%|noheaders=on}}) to suppress the columns' headings and table's title | | + | | codestyle | For CSS styles amending the presentation of markup/code in the first column (e.g. a smaller font-size). | – |
| − | | title | Title above table | + | | outputstyle | Ditto output in second column. | – |
| − | | col1 | First column's heading | + | }} |
| − | | col2 | Second column's heading | "Renders as" | + | {{Parameter descriptions |
| − | | codestyle | For CSS styles amending the presentation of markup/code in the first column (e.g. a smaller font-size) | | + | |style=margin-top:0.3em; |
| − | | outputstyle | Ditto output in second column | | + | |col1style=width:8.0em; |
| − | + | | | {{big|'''Content for'''}} | |
| − | | | + | | {{{1}}} | row 1, first column (markup/code) |
| − | | {{{1}}} | row 1, first column (markup/code) | + | | {{{2}}} | row 1, second column (output) |
| − | | {{{2}}} | row 1, second column (output) | + | | {{{3}}} | row 2, first column |
| − | | {{{3}}} | row 2, first column | + | | {{{4}}} | row 2, second column |
| − | | {{{4}}} | row 2, second column | + | | ... | |
| − | | ... | + | | {{{39}}} | row 20, first column |
| − | | {{{39}}} | row 20, first column | + | | {{{40}}} | row 20, second column |
| − | | {{{40}}} | row 20, second column | ||
}} | }} | ||
| − | ==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. | ||
| Line 42: | Line 40: | ||
** {{cs1}} templates can suppress the maintenance category by setting {{para|template doc demo|true}}. | ** {{cs1}} templates can suppress the maintenance category by setting {{para|template doc demo|true}}. | ||
| − | ==Limitations== | + | ===Limitations=== |
| − | + | ===={{xtag|nowiki}}==== | |
| − | ==={{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. | 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. | ||
| Line 53: | Line 50: | ||
}} | }} | ||
| − | ===HTML entities=== | + | ====HTML entities==== |
HTML entities are parsed in the markup cell: | HTML entities are parsed in the markup cell: | ||
{{Markup | {{Markup | ||
| Line 62: | Line 59: | ||
To work around this, replace the <code>&</code> with <code>&amp;</code> thus <code>&amp;nbsp;</code> will show as <code>&nbsp;</code> | 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=== | + | ====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}}: | 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 | + | | <nowiki># Item 1 |
# Item 2 | # Item 2 | ||
# Item 3 | # Item 3 | ||
| Line 77: | Line 74: | ||
}} | }} | ||
| − | {{ | + | {{Markup |title=With {{tag|nowiki|s}} |
| − | |<nowiki /> | + | | <nowiki /> |
<nowiki># Item 1 | <nowiki># Item 1 | ||
# Item 2 | # Item 2 | ||
# Item 3 | # Item 3 | ||
# Item 4</nowiki> | # Item 4</nowiki> | ||
| − | |<nowiki /> | + | | <nowiki /> |
# Item 1 | # Item 1 | ||
# Item 2 | # Item 2 | ||
| Line 90: | Line 87: | ||
}} | }} | ||
| − | ==Examples== | + | ===Examples=== |
| − | ===Simple=== | + | ====Simple==== |
{{Markup | {{Markup | ||
| <nowiki>'''Bold text'''</nowiki> | '''Bold text''' | | <nowiki>'''Bold text'''</nowiki> | '''Bold text''' | ||
| Line 98: | Line 95: | ||
}} | }} | ||
| − | ===More complex=== | + | ====More complex==== |
Note that {{tl2|Markup}}'s second argument here uses {{tl2|fake heading}} and {{tl2|fake citation needed}}. | Note that {{tl2|Markup}}'s second argument here uses {{tl2|fake heading}} and {{tl2|fake citation needed}}. | ||
{{Markup | {{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}} | | <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== | + | == Notes == |
| − | {{reflist|group=nb}} | + | {{reflist|group=nb}} |
| − | ==References== | + | == References == |
| − | {{reflist}} | + | {{reflist}} |
| − | </nowiki> | + | </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 118: | Line 115: | ||
}} | }} | ||
| − | ===Multiple rows=== | + | ====Multiple rows==== |
{{Markup | {{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. | ||
| Line 127: | Line 124: | ||
}} | }} | ||
| − | ===With title=== | + | ====With title==== |
| − | {{Markup | + | {{Markup |title=Foxes and dogs |
| − | |title=Foxes and dogs | ||
| 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. | ||
}} | }} | ||
| − | ===Showing rendered HTML=== | + | ====Showing rendered HTML==== |
When a template is enclosed within {{tl|code}}, it shows the rendered HTML: | When a template is enclosed within {{tl|code}}, it shows the rendered HTML: | ||
{{Markup | {{Markup | ||
| − | | <nowiki>{{cite book |last=White |first=T. H. |title=The Book of Merlyn |year=1977}}</nowiki> | + | | <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}} | + | | {{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> | + | | <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}}}} | + | | {{code|{{cite book |last=White |first=T. H. |title=The Book of Merlyn |year=1977}}}} |
}} | }} | ||
| − | == 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. | ||
Revision as of 17:08, 14 December 2014
| This is a documentation subpage for Template:Markup. It contains usage information, categories and other content that is not part of the original template page. |
This template is used to present markup or code side by side with the rendered output.
Template:Parameter descriptions/with defaults Template:Parameter descriptions
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:
- Instead of
{{citation needed}}, use{{fake citation needed}}.
- Instead of
- 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.
- Citation Style 1 templates can suppress the maintenance category by setting
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 |
|---|---|
– |
– |
To work around this, replace the & with & thus &nbsp; will show as
List and indent markup
If the first line includes wikimarkup that must start on a new line such as #, * or ; then use <nowiki />:
| Markup | Renders as |
|---|---|
# Item 1 # Item 2 # Item 3 # Item 4 |
|
| Markup | Renders as |
|---|---|
<nowiki /> # Item 1 # Item 2 # Item 3 # Item 4 |
|
Examples
Simple
| 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]
|
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
| 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|{{cite book |last=White |first=T. H. |title=The Book of Merlyn |year=1977}}}}
|
|
See also
- {{Markup2}} for bulleted and indented markup.
- {{Markupv}} for the vertical presentation (above/below) of markup/code and its output.