RogueScholar: Create template documentation

2022-09-13T17:27:32Z

Create template documentation

New page

__NOTOC__
{{Notice|It contains usage information, categories and other content that is not part of the original template page.|''NOTICE:'' This is a documentation subpage for [[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}<br />

The <kbd style="font-size: 1.15em; font-weight: 800;"><nowiki>{{</nowiki>[[Template:Beta|Beta]]<nowiki>}}</nowiki></kbd> template creates a table cell with a light blue background and black, larger heavy text which defaults to the word 'Beta', as seen above. It is designed to generate a uniform appearance for common cell values in feature and comparison tables with minimal effort, alongside similar templates like these (each a link to its own template page):
<div style="margin: 1.5em auto; width: fit-content;">
{| class="wikitable" style="display: inline-table; margin: 1em; vertical-align: middle;"
| class="table-yes" style="background-color: #90ff90; font-size: 1.08em; font-weight: 700; padding: 0.2em 0.67em; text-align: center; vertical-align: middle;" | [[Template:Yes|Yes]]
|}
{| class="wikitable" style="display: inline-table; margin: 1em; vertical-align: middle;"
| class="table-no" style="background-color: #ff9090; font-size: 1.08em; font-weight: 700; padding: 0.2em 0.67em; text-align: center; vertical-align: middle;" | [[Template:No|No]]
|}
{| class="wikitable" style="display: inline-table; margin: 1em; vertical-align: middle;"
| class="table-partial" style="background-color: #ff0; font-size: 1.08em; font-weight: 700; padding: 0.2em 0.67em; text-align: center; vertical-align: middle;" | [[Template:Partial|Partial]]
|}
{| class="wikitable" style="display: inline-table; margin: 1em; vertical-align: middle;"
| class="table-unknown" style="background-color: #d3d3d3; font-size: 1.08em; font-weight: 700; padding: 0.2em 0.67em; text-align: center; vertical-align: middle;" | [[Template:Unknown|Unknown]]
|}
{| class="wikitable" style="display: inline-table; margin: 1em; vertical-align: middle;"
| class="table-wip" style="background-color: #c9e0ff; font-size: 1.08em; font-weight: 700; padding: 0.2em 0.67em; text-align: center; vertical-align: middle;" | [[Template:Wip|W.I.P.]]
|}
{| class="wikitable" style="display: inline-table; margin: 1em; vertical-align: middle;"
| class="table-na" style="background-color: #ffc890; font-size: 1.08em; font-weight: 700; padding: 0.2em 0.67em; text-align: center; vertical-align: middle;" | [[Template:NA|N/A]]
|}
{| class="wikitable" style="display: inline-table; margin: 1em; vertical-align: middle;"
| class="table-disabled" style="background-color: #ff9090; font-size: 1.08em; font-weight: 700; padding: 0.2em 0.67em; text-align: center; vertical-align: middle;" | [[Template:Disabled|Disabled]]
|}
{| class="wikitable" style="display: inline-table; margin: 1em; vertical-align: middle;"
| class="table-enabled" style="background-color: #90ff90; color: #000; font-size: 1.08em; font-weight: 700; padding: 0.2em 0.67em; text-align: center; vertical-align: middle;" | [[Template:Enabled|Enabled]]
|}
</div>

== Usage ==
The template will only function properly when used inside of the standard wikicode for tables, following the pipe character(s) which indicate the start of a new table cell. In practice, it looks like this when editing and then when parsed:
<div style="margin: 1.5em 0 1.5em 6em; vertical-align: middle;">
<poem style="background-color: cornsilk; border: 2px solid #c7c8c9; color: #000; display: inline-block; font: 500 0.92rem/1.4 monospace; margin: 0 2.5em 0 0; min-width: 25vmax; padding: 0.5em 1em; vertical-align: middle;">
{| class="wikitable"
! scope="col" | Feature development stage
! scope="col" | Targeted for next major release?
|-
| '''<nowiki>{{Beta}}</nowiki>'''
| <nowiki>{{Yes}}</nowiki>
|}
</poem> <span style="font-size: 1.5rem; font-weight: 900; margin: 0 1em;">⇒</span>
{| class="wikitable" style="display: inline-table; margin: 0 0 0 2.5em;"
! scope="col" | Feature development stage
! scope="col" | Targeted for next major release?
|-
| {{Beta}}
| {{Yes|'''Yes'''}}
|}
</div>

=== Custom text ===
The word 'Beta' that is the cell's default contents can be replaced with any text desired, simply by assigning it as the value of the {{Para|1}} parameter or passing it as the only unnamed parameter.

For example, calling this template as either '''{{Tlx|Beta|Testing}}''' or '''{{Tlx|Beta|2=1=Testing}}''' both produce the following table cell:
{| class="wikitable" style="margin-left: 3em;"
| {{Beta|Testing}}
|}

=== Parameters ===
Changes to the template's appearance when parsed are accomplished by adding parameters to the template call in the form of '''{{Tlx|Beta|2=<var>name</var>=<var>value</var>}}'''. Use as many or as few as needed to accomplish the desired appearance.
{| class="wikitable" style="margin-left: 3em;"
|+ All available template parameters
! scope="col" | Name
! scope="col" | Value
|-
! scope="row" | {{Para|1|<var>Text</var>}}<br />''or''<br /><span style="background-color: #f9f9f9; padding: 1px 4px;">{{Tlx|Beta|<var>Text</var>}}</span>
| Text that replaces the default <span style="font-size: 1.08em; font-weight: 700;">Beta</span> cell contents, and can include wiki markup syntax (may also be provided as the only unnamed parameter)
|-
! scope="row" | {{Para|align}}
| Aligns the cell contents to either of the horizontal margins, rather than the default center alignment; valid values are '''<kbd>left</kbd>''' or '''<kbd>right</kbd>'''
|-
! scope="row" | {{Para|bgcolor}}
| Override the default background color (<code style="background-color: #33fcff; color: #000;">#33fcff</code>) — values shound not be terminated with a semicolon.
:Valid color formats are:
::* CSS3 keywords like '''<kbd style="border: 1px solid #c7c8c9;">transparent</kbd>''' or '''<kbd style="background-color: #fff; border: 1px solid #c7c8c9;">none</kbd>''' (inheriting the surrounding background color or becoming white, respectively)
::* Named CSS3 colors like '''<kbd style="background-color: moccasin; border: 1px solid #c7c8c9;">moccasin</kbd>''' or '''<kbd style="background-color: gainsboro; border: 1px solid #c7c8c9;">gainsboro</kbd>'''
::* RGB or RGBA hexadecimal values, in either the short ('''<kbd style="background-color: #ccc; border: 1px solid #c7c8c9;">#ccc</kbd>''') or long ('''<kbd style="background-color: #ffe228; border: 1px solid #c7c8c9;">#ffe228</kbd>''') forms (lowercase letters are preferred due to superior gzip compression)
|-
! scope="row" | {{Para|style}}
| Any other CSS3 inline style elements desired, in addition to or instead of, the default formatting (each one terminated with a semicolon)
|}

=== Default style ===
This template uses the following CSS elements as its defaults. Those without an explicit override parameter above can still be changed, if necessary, by adding them as a value for the {{Para|style}} parameter and affixing them with a space and <kbd>!important</kbd> placed before the terminating semicolon.

::<syntaxhighlight lang="html" inline><td style="background-color: #33fcff; color: black; font-size: 1.08em; font-weight: 700; padding: 0.2em 0.67em; text-align: center; vertical-align: middle;"></syntaxhighlight><br />

An example of such overrides, should we wish to change the font-size and font-weight values (which control the typeface height and boldness, respectively) to the default text size and normal weight, would look like:
<div style="margin-left: 3em;">'''{{Tlx|Beta|2=style=font-size: 1em !important; font-weight: 400 !important;}}'''  which then appears as  
{| class="wikitable" style="display: inline-table; vertical-align: middle;"
| {{Beta|style=font-size: 1em !important; font-weight: 400 !important;}}
|}
</div>

== See also ==
<div style="width: fit-content;"><ul style="display: inline-block; margin: 0 12em 0 1.6em; padding: 0;">
<li>{{Tl|Yes}}</li>
<li>{{Tl|Enabled}}</li>
<li>{{Tl|Partial}}</li>
<li>{{Tl|NA}}</li>
<li>[[:Category:Formatting templates]]</li></ul>
<ul style="display: inline-block; margin: 0 0 0 1.6em; padding: 0;">
<li>{{Tl|No}}</li>
<li>{{Tl|Disabled}}</li>
<li>{{Tl|Wip}}</li>
<li>{{Tl|Unknown}}</li>
<li>[[:Category:Table cell templates]]</li></ul>
</div><includeonly>


[[Category:Table cell templates]]</includeonly><noinclude>

[[Category:Template documentation pages]]</noinclude>

Template:Beta/doc - Revision history

RogueScholar: Create template documentation