Modul:Su/doc

This is a documentation subpage for Modul:Su.
It contains usage information, categories and other content that is not part of the original modul page.

This module is rated as ready for general use. It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.

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 85%. 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('top-line text')`	top-line text
`mSu._main(nil, 'bottom-line text')`	bottom-line text