View source for Template:Su/doc

{{Documentation subpage}}
{{High-use}}
{{COinS safe|n}}
{{lua|Module:Su}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->

== Purpose ==

Template for creating two smaller lines of text on one actual line, this can be used for [[Template:val|scientific notations of uncertainty]] and [[Template:PhysicsParticle|physics]] symbols, such as [[:Category:Nuclide templates|nuclides]] and [[Template:SubatomicParticle|particles]].

It was named after the <code><nowiki><sup></nowiki></code> and <code><nowiki><sub></nowiki></code> HTML tags, which share the first two letters of their name with this template. This template uses the third letter of the name of these tags, <code><nowiki>p</nowiki></code> and <code><nowiki>b</nowiki></code>, as the name of the argument that drives the output of the top and bottom line, respectively.

[[File:Nuvola apps important.svg|left|48px]] '''Editors beware''': ''these templates use all kinds of hacky tricks to make the output render correctly in a wide variety of browsers. If you plan to make changes to this template, please make sure you verify that this template renders correctly after those changes in all major browsers. This list includes the latest version(s) of Chrome, Firefox, and Safari.''
{{clear left}}

== Arguments ==
{|
|-
| {{nowrap|{{para|p}}}} || The contents of the top line.
|-
| {{nowrap|{{para|b}}}} || The contents of the bottom line.
|-
| {{nowrap|{{para|a}}}} || The alignment of both lines ({{nowrap|{{para|a|r}}}}: right-aligned; {{nowrap|{{para|a|c}}}}: center-aligned; default is left-aligned).
|-
| {{nowrap|{{para|w}}}} || The size of the characters ({{nowrap|{{para|w|f}}}}: fixed-width (monospace), otherwise template inherits the current font and context by default).
|-
| {{nowrap|{{para|lh}}}} || The line height or distance from top to bottom (including top character). Default is 1.2em.
|}

== Note on fractions ==
Usually, when using vulgar fractions it is MOS habit to use &amp;frasl; (<code>&frasl;</code>) ([[MOS:FRAC]]) and {{tl|frac}}.
However, in &lt;sub> or &lt;sup> tags, best use the keyboard slash <code>/</code> for readability in most browsers:
: X{{su|p=1&frasl;2|b=7&frasl;8}} (fraction slash) {{nay}}
and
: X{{su|p=1/2|b=7/8}} (keyboard slash) {{aye}}

== Examples ==

=== Simple ===
: <code><nowiki>X{{su|p=a}} X{{su|b=b}} X{{su|p=a|b=b}} {{su|p=a|b=b}}X {{su|p=a|b=b}}X{{su|p=c|b=d}}</nowiki></code>
: X{{su|p=a}} X{{su|b=b}} X{{su|p=a|b=b}} {{su|p=a|b=b}}X {{su|p=a|b=b}}X{{su|p=c|b=d}}

=== Left-aligned {{nobold|(default)}} ===
: <code><nowiki>X{{su|p=aaaaa|b=b}} X{{su|p=aaaaa|b=b}}Y X{{su|p=a|b=bbbbb}} {{su|p=a|b=bbbbb}}X</nowiki></code>
: X{{su|p=aaaaa|b=b}} X{{su|p=aaaaa|b=b}}Y X{{su|p=a|b=bbbbb}} {{su|p=a|b=bbbbb}}X

=== Right-aligned ===
: <code><nowiki>X{{su|a=r|p=aaaaa|b=b}}X{{su|a=r|p=a|b=bbbbb}}X</nowiki></code>
: X{{su|a=r|p=aaaaa|b=b}}X{{su|a=r|p=a|b=bbbbb}}X

=== Center-aligned ===
: <code><nowiki>X{{su|a=c|p=aaaaa|b=b}}X{{su|a=c|p=a|b=bbbbb}}X</nowiki></code>
: X{{su|a=c|p=aaaaa|b=b}}X{{su|a=c|p=a|b=bbbbb}}X

=== Smaller font ===
: <code><nowiki>{{small|X{{su|p=a}}X{{su|b=b}}X{{su|p=a|b=b}}X}}</nowiki></code>
: {{small|X{{su|p=a}}X{{su|b=b}}X{{su|p=a|b=b}}X}}

=== Larger font ===
: <code><nowiki>{{big|X{{su|p=a}}X{{su|b=b}}X{{su|p=a|b=b}}X}}</nowiki></code>
: {{large|X{{su|p=a}}X{{su|b=b}}X{{su|p=a|b=b}}X}}

=== Fixed-width ===
: <code><nowiki>X{{su|p=...|b=www}}X{{su|w=f|p=...|b=www}}X</nowiki></code>
: X{{su|p=...|b=www}}X{{su|w=f|p=...|b=www}}X

=== Close-spacing ===
: <code><nowiki>{{su|p=4|b=4}} {{su|lh=0.8em|p=4|b=4}}</nowiki></code>
: {{su|p=4|b=4}} {{su|lh=0.8em|p=4|b=4}}

== Line breaks ==

Unlike the <code><nowiki><sup></nowiki></code> and <code><nowiki><sub></nowiki></code> tags, this template does not always prevent line breaks between the two small lines and the text preceding or following it. Thus, if this template is used to supply a subscript and superscript over a base symbol, the whole structure has to be enclosed in a {{tl|nowrap}}, or this template should be invoked through another template that takes care of the wrapping in an appropriate way.

''Note'': Without the suggested {{tl|nowrap}}, this is not consistent across all browsers: in Chrome, this is true, whereas in Firefox and Safari line breaks will generally be suppressed after preceding text.

'''Example''': <code><nowiki>{{nowrap|X{{su|p=a|b=b}}}}</nowiki></code>&nbsp;{{large|→}} {{nowrap|X{{su|p=a|b=b}}}}

== See also ==
{{Sup and sub-related templates}}
{{Math templates |notation}}

<includeonly>{{Sandbox other|
| <!--Categories below this line, please; interwikis to Wikidata.-->
[[Category:Superscript and subscript templates]]
[[Category:Mathematical formatting templates]]
}}</includeonly>