Module:Su/doc - Revision history

Tom.Reding: /* top */{{High-use}}

2023-12-28T13:00:16Z

top: {{High-use}}

← Previous revision		Revision as of 13:00, 28 December 2023
Line 1:		Line 1:
			{{High-use}}
	This module implements the {{tl\|su}} template. It is used to create two smaller lines of text on one actual line.		This module implements the {{tl\|su}} template. It is used to create two smaller lines of text on one actual line.

WOSlinker: change source to syntaxhighlight

2020-07-07T13:31:21Z

change source to syntaxhighlight

← Previous revision		Revision as of 13:31, 7 July 2020
Line 9:		Line 9:
	To use this module from other Lua modules, first load the module.		To use this module from other Lua modules, first load the module.

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	local mSu = require('Module:Su')		local mSu = require('Module:Su')
			</syntaxhighlight>
	</source>

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

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	mSu._main(sup, sub, options)		mSu._main(sup, sub, options)
			</syntaxhighlight>
	</source>

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

Matt Fitzpatrick: default font-size is 80%

2018-02-17T02:30:13Z

default font-size is 80%

← Previous revision		Revision as of 02:30, 17 February 2018
Line 21:		Line 21:
	<var>sup</var> is the contents of the top line, and <var>sub</var> is the contents of the bottom line. <var>options</var> is a table that can contain the following fields:		<var>sup</var> is the contents of the top line, and <var>sub</var> is the contents of the bottom line. <var>options</var> is a table that can contain the following fields:
	* <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 80%. 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.		* <code>lineHeight</code> - the distance from top to bottom (including top character). Default is 1.2em. Must be a string value.
	* <code>verticalAlign</code> - The base alignment from the bottom. Default depends on presence of <code>sub</code>; -0.4em if present, 0.8em if not. Must be a string value.		* <code>verticalAlign</code> - The base alignment from the bottom. Default depends on presence of <code>sub</code>; -0.4em if present, 0.8em if not. Must be a string value.

Edokter: verticalAlign

2016-03-28T17:31:57Z

verticalAlign

← Previous revision		Revision as of 17:31, 28 March 2016
Line 23:		Line 23:
	* <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.		* <code>lineHeight</code> - the distance from top to bottom (including top character). Default is 1.2em. Must be a string value.
			* <code>verticalAlign</code> - The base alignment from the bottom. Default depends on presence of <code>sub</code>; -0.4em if present, 0.8em if not. Must be a string value.

	All arguments are optional.		All arguments are optional.

Mscuthbert: match code to doc.

2015-01-29T19:00:44Z

match code to doc.

← Previous revision		Revision as of 19:00, 29 January 2015
Line 48:		Line 48:
	\|-		\|-
	\| {{code\|1=mSu._main('12', '8', {align = 'c', lineHeight = '0.8em'})\|2=lua}}		\| {{code\|1=mSu._main('12', '8', {align = 'c', lineHeight = '0.8em'})\|2=lua}}
	\| {{su\|p=12\|b=8\|a=c\|lh=0.~~9em~~}}		\| {{su\|p=12\|b=8\|a=c\|lh=0.8em}}
	\|-		\|-
	\| {{code\|mSu._main('top-line text')\|lua}}		\| {{code\|mSu._main('top-line text')\|lua}}

Mscuthbert: added line height doc

2015-01-29T19:00:09Z

added line height doc

← Previous revision		Revision as of 19:00, 29 January 2015
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}}

Mr. Stradivarius: use _main instead of luaMain

2014-06-27T11:07:35Z

use _main instead of luaMain

← Previous revision		Revision as of 11:07, 27 June 2014
Line 13:		Line 13:
	</source>		</source>

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

	<source lang="lua">		<source lang="lua">
	mSu.~~luaMain~~(sup, sub, options)		mSu._main(sup, sub, options)
	</source>		</source>

Line 31:		Line 31:
	! Result		! Result
	\|-		\|-
	\| {{code\|mSu.~~luaMain~~('top-line text', 'bottom-line text')\|lua}}		\| {{code\|mSu._main('top-line text', 'bottom-line text')\|lua}}
	\| {{su\|p=top-line text\|b=bottom-line text}}		\| {{su\|p=top-line text\|b=bottom-line text}}
	\|-		\|-
	\| {{code\|1=mSu.~~luaMain~~('top-line text', 'bottom-line text', {fontSize = '100%'})\|2=lua}}		\| {{code\|1=mSu._main('top-line text', 'bottom-line text', {fontSize = '100%'})\|2=lua}}
	\| {{su\|p=top-line text\|b=bottom-line text\|w=100%}}		\| {{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}}		\| {{code\|1=mSu._main('top-line text', 'bottom-line text', {fontSize = 'f'})\|2=lua}}
	\| {{su\|p=top-line text\|b=bottom-line text\|w=f}}		\| {{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}}		\| {{code\|1=mSu._main('top-line text', 'bottom-line text', {align = 'r'})\|2=lua}}
	\| {{su\|p=top-line text\|b=bottom-line text\|a=r}}		\| {{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}}		\| {{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\|mSu.~~luaMain~~('top-line text')\|lua}}		\| {{code\|mSu._main('top-line text')\|lua}}
	\| {{su\|p=top-line text}}		\| {{su\|p=top-line text}}
	\|-		\|-
	\| {{code\|mSu.~~luaMain~~(nil, 'bottom-line text')\|lua}}		\| {{code\|mSu._main(nil, 'bottom-line text')\|lua}}
	\| {{su\|b=bottom-line text}}		\| {{su\|b=bottom-line text}}
	\|}		\|}

Mr. Stradivarius: add some examples

2014-06-17T09:57:02Z

add some examples

← Previous revision		Revision as of 09:57, 17 June 2014
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\|\|

Mr. Stradivarius: /* Usage from Lua modules */ add

2014-06-17T09:32:00Z

Usage from Lua modules: add

← Previous revision		Revision as of 09:32, 17 June 2014
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.

			All arguments are optional.

	<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|		<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|

Mr. Stradivarius: create

2014-06-17T09:31:08Z

create

New page

This module implements the {{tl|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 {{tl|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.

<source lang="lua">
local mSu = require('Module:Su')
</source>

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

<source lang="lua">
mSu.luaMain(sup, sub, options)
</source>

<var>sup</var> is the contents of the top line, and <var>sub</var> is the contents of the bottom line. <var>options</var> is a table that can contain the following fields:
* <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.

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||


}}</includeonly>