Module:Su/doc: Difference between revisions
Content deleted Content added
use _main instead of luaMain |
Mscuthbert (talk | contribs) added line height doc |
||
| Line 22: | Line 22: | ||
* <code>align</code> - 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. |
* <code>align</code> - 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. |
||
* <code>fontSize</code> - 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. |
* <code>fontSize</code> - 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. |
||
* <code>lineHeight</code> - the distance from top to bottom (including top character). Default is 1.2em. Must be a string value. |
|||
All arguments are optional. |
All arguments are optional. |
||
| Line 45: | Line 46: | ||
| {{code|1=mSu._main('top-line text', 'bottom-line text', {align = 'c'})|2=lua}} |
| {{code|1=mSu._main('top-line text', 'bottom-line text', {align = 'c'})|2=lua}} |
||
| {{su|p=top-line text|b=bottom-line text|a=c}} |
| {{su|p=top-line text|b=bottom-line text|a=c}} |
||
|- |
|||
| {{code|1=mSu._main('12', '8', {align = 'c', lineHeight = '0.8em'})|2=lua}} |
|||
| {{su|p=12|b=8|a=c|lh=0.9em}} |
|||
|- |
|- |
||
| {{code|mSu._main('top-line text')|lua}} |
| {{code|mSu._main('top-line text')|lua}} |
||
Revision as of 19:00, 29 January 2015
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.lineHeight- the distance from top to bottom (including top character). Default is 1.2em. 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'})
|
12 8 |
mSu._main('top-line text')
|
top-line text |
mSu._main(nil, 'bottom-line text')
|
bottom-line text |