Difference between revisions of "Module:Su/doc"
Jump to navigation
Jump to search
blackwiki>Mr. Stradivarius (→Usage from Lua modules: add) |
blackwiki>Mr. Stradivarius (add some examples) |
||
| Line 24: | Line 24: | ||
All arguments are optional. | All arguments are optional. | ||
| + | |||
| + | === Examples === | ||
| + | |||
| + | {| class="wikitable" | ||
| + | ! Code | ||
| + | ! Result | ||
| + | |- | ||
| + | | {{code|mSu.luaMain('top-line text', 'bottom-line text')|lua}} | ||
| + | | {{su|p=top-line text|b=bottom-line text}} | ||
| + | |- | ||
| + | | {{code|1=mSu.luaMain('top-line text', 'bottom-line text', {fontSize = '100%'})|2=lua}} | ||
| + | | {{su|p=top-line text|b=bottom-line text|w=100%}} | ||
| + | |- | ||
| + | | {{code|1=mSu.luaMain('top-line text', 'bottom-line text', {fontSize = 'f'})|2=lua}} | ||
| + | | {{su|p=top-line text|b=bottom-line text|w=f}} | ||
| + | |- | ||
| + | | {{code|1=mSu.luaMain('top-line text', 'bottom-line text', {align = 'r'})|2=lua}} | ||
| + | | {{su|p=top-line text|b=bottom-line text|a=r}} | ||
| + | |- | ||
| + | | {{code|1=mSu.luaMain('top-line text', 'bottom-line text', {align = 'c'})|2=lua}} | ||
| + | | {{su|p=top-line text|b=bottom-line text|a=c}} | ||
| + | |- | ||
| + | | {{code|mSu.luaMain('top-line text')|lua}} | ||
| + | | {{su|p=top-line text}} | ||
| + | |- | ||
| + | | {{code|mSu.luaMain(nil, 'bottom-line text')|lua}} | ||
| + | | {{su|b=bottom-line text}} | ||
| + | |} | ||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| | ||
Revision as of 09:57, 17 June 2014
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 luaMain function.
mSu.luaMain(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.luaMain('top-line text', 'bottom-line text')
|
top-line text bottom-line text |
mSu.luaMain('top-line text', 'bottom-line text', {fontSize = '100%'})
|
top-line text bottom-line text |
mSu.luaMain('top-line text', 'bottom-line text', {fontSize = 'f'})
|
top-line text bottom-line text |
mSu.luaMain('top-line text', 'bottom-line text', {align = 'r'})
|
top-line text bottom-line text |
mSu.luaMain('top-line text', 'bottom-line text', {align = 'c'})
|
top-line text bottom-line text |
mSu.luaMain('top-line text')
|
top-line text |
mSu.luaMain(nil, 'bottom-line text')
|
bottom-line text |