Module:Su/doc

This is the documentation page for Module:Su

This module implements the {{su}} template. It is used to create two smaller lines of text on one actual line.

Usage from wikitext

This module cannot be used directly from wikitext. It can only be used through a template, usually the {{su}} template. Please see the template page for documentation.

Usage from Lua modules

To use this module from other Lua modules, first load the module.

local mSu = require('Module:Su')

You can then generate the su links by using the _main function.

mSu._main(sup, sub, options)

sup is the contents of the top line, and sub is the contents of the bottom line. options is a table that can contain the following fields:

align - this can be set to "r" or "right" for right-alignment, and "c" or "center" for center-alignment. Anything else will make the output left-aligned. Must be a string value.
fontSize - the font size of the text, e.g. "90%". If set to "f" or "fixed", the module will output a fixed-width font at 80%. Must be a string value.
lineHeight - the distance from top to bottom (including top character). Default is 1.2em. Must be a string value.
verticalAlign - The base alignment from the bottom. Default depends on presence of sub; -0.4em if present, 0.8em if not. Must be a string value.

All arguments are optional.

Examples

Code	Result
`mSu._main('top-line text', 'bottom-line text')`	^{top-line text} _{bottom-line text}
`mSu._main('top-line text', 'bottom-line text', {fontSize = '100%'})`	^{top-line text} _{bottom-line text}
`mSu._main('top-line text', 'bottom-line text', {fontSize = 'f'})`	^{top-line text} _{bottom-line text}
`mSu._main('top-line text', 'bottom-line text', {align = 'r'})`	^{top-line text} _{bottom-line text}
`mSu._main('top-line text', 'bottom-line text', {align = 'c'})`	^{top-line text} _{bottom-line text}
`mSu._main('12', '8', {align = 'c', lineHeight = '0.8em'})`	¹² ₈
`mSu._main('top-line text')`	^{top-line text}
`mSu._main(nil, 'bottom-line text')`	_{bottom-line text}