Difference between revisions of "Template:Markupv/doc"

From blackwiki
Jump to navigation Jump to search
imported>Lemondoge
imported>Milker
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- Categories and interwikis go at the bottom of this page. -->
+
<!-- Please add categories at the bottom of this page, and interwikis at Wikidata (see Wikipedia:Wikidata) -->
  
==Usage==
+
== Usage ==
 
This template is used to present markup or code in a vertical format above the rendered output.
 
This template is used to present markup or code in a vertical format above the rendered output.
  
Line 24: Line 24:
 
** {{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}}.
  
==Example==
+
== Examples ==
 
The following meta-example uses {{tlf|markupv}} to create an example of using {{tag|score}}:
 
The following meta-example uses {{tlf|markupv}} to create an example of using {{tag|score}}:
 
<pre>
 
<pre>
Line 39: Line 39:
 
}}
 
}}
  
==Limitations==
+
== Limitations ==
 
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 45: Line 45:
  
 
{{markupv|t1=Renders as|t2=Expected rendering
 
{{markupv|t1=Renders as|t2=Expected rendering
|{{tl|tag}}
+
|m={{tl|tag}}
|<nowiki>{{tl|tag}}</nowiki>
+
|r=<nowiki>{{tl|tag}}</nowiki>
 
}}
 
}}
  
 
HTML entities are parsed in the markup cell
 
HTML entities are parsed in the markup cell
 
{{markupv|t1=Nowikied markup shows as |t2=Expected markup
 
{{markupv|t1=Nowikied markup shows as |t2=Expected markup
|<nowiki>&nbsp;&ndash;</nowiki>
+
|m=<nowiki>&nbsp;&ndash;</nowiki>
|&amp;nbsp;&amp;ndash;
+
|r=&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>
 
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 ==
  
 
'''Simple examples:'''
 
'''Simple examples:'''
 
{{markupv
 
{{markupv
|<nowiki>'''Bold text'''</nowiki>|'''Bold text'''
+
|m=<nowiki>'''Bold text'''</nowiki>|r='''Bold text'''
|<nowiki>''Italic text''</nowiki>|''Italic text''
+
}}{{markupv
 +
|m=<nowiki>''Italic text''</nowiki>|r=''Italic text''
 
}}
 
}}
  
Line 68: Line 69:
 
Note that the second argument to {{tl2|markupv}} uses {{tl2|fake heading}} and {{tl2|fake citation needed}}.
 
Note that the second argument to {{tl2|markupv}} uses {{tl2|fake heading}} and {{tl2|fake citation needed}}.
 
{{markupv
 
{{markupv
|<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}}
+
|m=<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}}
+
|r=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}}
 
{{fake heading|sub=3|Notes}}
Line 87: Line 88:
 
'''With title:'''
 
'''With title:'''
 
{{markupv|title=Foxes and dogs
 
{{markupv|title=Foxes and dogs
|The quick brown fox jumps over the lazy dog.
+
|m=The quick brown fox jumps over the lazy dog.
|The quick brown fox jumps over the lazy dog.
+
|r=The quick brown fox jumps over the lazy dog.
 
}}
 
}}
  
Line 94: Line 95:
  
 
{{markupv
 
{{markupv
|<nowiki>{{cite book |last=White |first=T. H. |title=The Book of Merlyn |year=1977}}</nowiki>
+
|m=<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}}
+
|r={{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>
+
}}{{markupv
|{{code|{{cite book |last=White |first=T. H. |title=The Book of Merlyn |year=1977}}}}
+
|m=<nowiki>{{code|{{cite book |last=White |first=T. H. |title=The Book of Merlyn |year=1977}}}}</nowiki>
 +
|r={{code|{{cite book |last=White |first=T. H. |title=The Book of Merlyn |year=1977}}}}
 
}}
 
}}
  
Line 105: Line 107:
 
* {{tl|markupv}}: above and below markup
 
* {{tl|markupv}}: above and below markup
  
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
+
<includeonly>{{Sandbox other||
<!-- Categories go here and interwikis go in Wikidata. -->
+
<!-- Add categories below this line, and interwikis at Wikidata -->
 
[[Category:Template test cases| ]]
 
[[Category:Template test cases| ]]
 
[[Category:Template namespace templates]]
 
[[Category:Template namespace templates]]
 
[[Category:Documentation assistance templates]]
 
[[Category:Documentation assistance templates]]
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 16:19, 28 April 2020

Usage

This template is used to present markup or code in a vertical format above the rendered output.

Parameters:

  • markup or m: Content of Markup cell
  • renders or r: Content of Renders as cell
  • title or t: Title of table; defaults to none
  • margin: Set table left margin in em
  • width: Table width; defaults to 90%
  • style: Additional CSS for the table

The Markup cell is pre-formatted with <pre> to retain newlines and spaces, but styled to allow content to wrap within the cell. It is usually desirable to escape the content of the Markup cell so that the markup is displayed by wrapping the markup in <nowiki>. It is technically not possible to add this feature to the template.

In the Renders as cell, the content is usually the unescaped markup copied from the Markup cell. 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.
  • Header markup such as == will show in the page table of contents; use {{fake heading}}.
  • When using {{reflist}} with no other parameters, use {{reflist|close=1}} to ensure that the reference list is closed.
  • 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.

Examples

The following meta-example uses {{markupv}} to create an example of using <score>...</score>:

{{markupv|title=Example:
|markup=<nowiki><score>\relative c' { c( b~ c b c b c b c~ c)}</score></nowiki>
|renders=<score>\relative c' { c( b~ c b c b c b c~ c)}</score>
}}

It generates:

Example:
Markup
<score>\relative c' { c( b~ c b c b c b c~ c)}</score>
Renders as <score>\relative c' { c( b~ c b c b c b c~ c)}</score>

Limitations

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

Markup
{{[[Template:tag|tag]]}}
Renders as {{tl|tag}}

HTML entities are parsed in the markup cell

Markup
 –
Renders as &nbsp;&ndash;

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

Examples

Simple examples:

Markup
'''Bold text'''
Renders as Bold text
Markup
''Italic text''
Renders as Italic text

Complex example: Note that the second argument to {{markupv}} uses {{fake heading}} and {{fake citation needed}}.

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

With title:

Foxes and dogs
Markup
The quick brown fox jumps over the lazy dog.
Renders as The quick brown fox jumps over the lazy dog.

When a template is enclosed within {{code}}, it shows the rendered HTML:

Markup
{{cite book |last=White |first=T. H. |title=The Book of Merlyn |year=1977}}
Renders as White, T. H. (1977). The Book of Merlyn.
Markup
{{code|{{cite book |last=White |first=T. H. |title=The Book of Merlyn |year=1977}}}}
Renders as <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%3AMarkupv%2Fdoc" class="Z3988"></span>'"`UNIQ--templatestyles-0000002A-QINU`"'

See also

  • {{markup}}: side by side markup
  • {{markup2}}: bulleted and indented markup
  • {{markupv}}: above and below markup