Template:Markup

From Foundry Wiki

{{| style="table-layout: fixed; width: 100%; border-width: medium; margin-left: 0em;"

! style="width:50%" scope="col" | Markup ! style="width:50%" scope="col" | Renders as |- | style="width:50%; border-width: 1px; padding: 5px; border-style: solid none none none; border-color: #ddd; vertical-align:text-top;" | | style="width:50%; border-width: 1px; padding: 5px; border-style: solid none none none; border-color: #ddd; vertical-align:text-top;" | |}}

Template-info.png Documentation

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>...‎</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.

Limitations

====‎<nowiki>...‎</nowiki>

==

If you don't wrap the content of the markup cell in ‎<nowiki>...‎</nowiki> , then any template markup will not be escaped, it will be expanded.

This example shows the markup for {{tl|tag}}: {{| style="table-layout: fixed; width: 100%; border-width: medium; margin-left: 0em;"

! style="width:50%" scope="col" | Renders as ! style="width:50%" scope="col" | Expected rendering
|-

| style="width:50%; background-color: #f9f9f9; border-width: 1px; padding: 5px; border-style: solid none none solid; border-color: #ddd; vertical-align:text-top;" |
<code>{{[[Template:tag|tag]]}}</code>

| style="width:50%; background-color: #f9f9f9; border-width: 1px; padding: 5px; border-style: solid solid none solid; border-color: #ddd; vertical-align:text-top;" | {{tl|tag}} |- | style="width:50%; border-width: 1px; padding: 5px; border-style: solid none none none; border-color: #ddd; vertical-align:text-top;" | | style="width:50%; border-width: 1px; padding: 5px; border-style: solid none none none; border-color: #ddd; vertical-align:text-top;" | |}}


HTML entities

HTML entities are parsed in the markup cell: {{| style="table-layout: fixed; width: 100%; border-width: medium; margin-left: 0em;"

! style="width:50%" scope="col" | Nowikied markup shows as ! style="width:50%" scope="col" | Expected markup
|-

| style="width:50%; background-color: #f9f9f9; border-width: 1px; padding: 5px; border-style: solid none none solid; border-color: #ddd; vertical-align:text-top;" |
 –

| style="width:50%; background-color: #f9f9f9; border-width: 1px; padding: 5px; border-style: solid solid none solid; border-color: #ddd; vertical-align:text-top;" | &nbsp;&ndash; |- | style="width:50%; border-width: 1px; padding: 5px; border-style: solid none none none; border-color: #ddd; vertical-align:text-top;" | | style="width:50%; border-width: 1px; padding: 5px; border-style: solid none none none; border-color: #ddd; vertical-align:text-top;" | |}}


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

Example

Simple

{{| style="table-layout: fixed; width: 100%; border-width: medium; margin-left: 0em;"

! style="width:50%" scope="col" | Markup ! style="width:50%" scope="col" | Renders as
|-

| style="width:50%; background-color: #f9f9f9; border-width: 1px; padding: 5px; border-style: solid none none solid; border-color: #ddd; vertical-align:text-top;" |
'''Bold text'''

| style="width:50%; background-color: #f9f9f9; border-width: 1px; padding: 5px; border-style: solid solid none solid; border-color: #ddd; vertical-align:text-top;" | Bold text
|-

| style="width:50%; background-color: #f9f9f9; border-width: 1px; padding: 5px; border-style: solid none none solid; border-color: #ddd; vertical-align:text-top;" |
''Italic text''

| style="width:50%; background-color: #f9f9f9; border-width: 1px; padding: 5px; border-style: solid solid none solid; border-color: #ddd; vertical-align:text-top;" | Italic text |- | style="width:50%; border-width: 1px; padding: 5px; border-style: solid none none none; border-color: #ddd; vertical-align:text-top;" | | style="width:50%; border-width: 1px; padding: 5px; border-style: solid none none none; border-color: #ddd; vertical-align:text-top;" | |}}


Multiple rows

{{| style="table-layout: fixed; width: 100%; border-width: medium; margin-left: 0em;"

! style="width:50%" scope="col" | Markup ! style="width:50%" scope="col" | Renders as
|-

| style="width:50%; background-color: #f9f9f9; border-width: 1px; padding: 5px; border-style: solid none none solid; border-color: #ddd; vertical-align:text-top;" |
The quick brown fox jumps over the lazy dog.

| style="width:50%; background-color: #f9f9f9; border-width: 1px; padding: 5px; border-style: solid solid none solid; border-color: #ddd; vertical-align:text-top;" | The quick brown fox jumps over the lazy dog.
|-

| style="width:50%; background-color: #f9f9f9; border-width: 1px; padding: 5px; border-style: solid none none solid; border-color: #ddd; vertical-align:text-top;" |
The quick brown fox jumps over the lazy dog.

| style="width:50%; background-color: #f9f9f9; border-width: 1px; padding: 5px; border-style: solid solid none solid; border-color: #ddd; vertical-align:text-top;" | The quick brown fox jumps over the lazy dog.
|-

| style="width:50%; background-color: #f9f9f9; border-width: 1px; padding: 5px; border-style: solid none none solid; border-color: #ddd; vertical-align:text-top;" |
The quick brown fox jumps over the lazy dog.

| style="width:50%; background-color: #f9f9f9; border-width: 1px; padding: 5px; border-style: solid solid none solid; border-color: #ddd; vertical-align:text-top;" | The quick brown fox jumps over the lazy dog.
|-

| style="width:50%; background-color: #f9f9f9; border-width: 1px; padding: 5px; border-style: solid none none solid; border-color: #ddd; vertical-align:text-top;" |
The quick brown fox jumps over the lazy dog.

| style="width:50%; background-color: #f9f9f9; border-width: 1px; padding: 5px; border-style: solid solid none solid; border-color: #ddd; vertical-align:text-top;" | The quick brown fox jumps over the lazy dog.
|-

| style="width:50%; background-color: #f9f9f9; border-width: 1px; padding: 5px; border-style: solid none none solid; border-color: #ddd; vertical-align:text-top;" |
The quick brown fox jumps over the lazy dog.

| style="width:50%; background-color: #f9f9f9; border-width: 1px; padding: 5px; border-style: solid solid none solid; border-color: #ddd; vertical-align:text-top;" | The quick brown fox jumps over the lazy dog. |- | style="width:50%; border-width: 1px; padding: 5px; border-style: solid none none none; border-color: #ddd; vertical-align:text-top;" | | style="width:50%; border-width: 1px; padding: 5px; border-style: solid none none none; border-color: #ddd; vertical-align:text-top;" | |}}


With title

{{| style="table-layout: fixed; width: 100%; border-width: medium; margin-left: 0em;" |+ Foxes and dogs ! style="width:50%" scope="col" | Markup ! style="width:50%" scope="col" | Renders as
|-

| style="width:50%; background-color: #f9f9f9; border-width: 1px; padding: 5px; border-style: solid none none solid; border-color: #ddd; vertical-align:text-top;" |
The quick brown fox jumps over the lazy dog.

| style="width:50%; background-color: #f9f9f9; border-width: 1px; padding: 5px; border-style: solid solid none solid; border-color: #ddd; vertical-align:text-top;" | The quick brown fox jumps over the lazy dog. |- | style="width:50%; border-width: 1px; padding: 5px; border-style: solid none none none; border-color: #ddd; vertical-align:text-top;" | | style="width:50%; border-width: 1px; padding: 5px; border-style: solid none none none; border-color: #ddd; vertical-align:text-top;" | |}}


TemplateData

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
100%
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