Модуль:Su/документація

Це сторінка документації для Модуль:Su

Цей модуль впроваджує шаблон {{su}}. Він використовується, щоб створювати дві менші рядка тексту на одному справжньому рядку.

Використання з вікітексту

Цей модуль не можу бути використаний напряму з вікітексту. Його можна використати лише через використання шаблону, зазвичай шаблону {{su}}. Будь ласка, дивіться докумантацію на сторінці шаблону.

Використання в модулях Lua

Щоб використати модуль в інших модулях Lua, спершу завантажте модуль.

local mSu = require('Module:Su')

Тоді ви можете згенерувати рядки su, використавши функцію _main.

mSu._main(sup, sub, options)

sup містить вміст верхнього рядка та sub містить вміст нижнього рядка. options є таблицею, що містить наступні поля:

align — можна встановити значення «r» або «right» для вирівнювання справа та «c» або «center» для вирівнювання по центру. Будь-яке інше значення вирівняє вивід ліворуч. Значення повинно бути рядком (string).
fontSize — розмір шрифту тексту, наприклад «90%». Якщо встановити «f» або «fixed», то модуль виведе шрифт фіксованої ширини з розміром 80%. Значення повинно бути рядком (string).
lineHeight — відстань від верху до низу (включно з верхнім символом). Стандартне значення — 1.2em. Значення повинно бути рядком (string).
verticalAlign — Вирівнювання основи від низу. Стандартне значення залежить від наявності sub; -0.4em, якщо наявне, 0.8em, якщо ні. Значення повинно бути рядком (string).

Всі аргументи є необов'язковими.

Приклади

Код	Результат
`mSu._main('верхній рядок тексту', 'нижній рядок тексту')`	^{верхній рядок тексту} _{нижній рядок тексту}
`mSu._main('верхній рядок тексту', 'нижній рядок тексту', {fontSize = '100%'})`	^{верхній рядок тексту} _{нижній рядок тексту}
`mSu._main('верхній рядок тексту', 'нижній рядок тексту', {fontSize = 'f'})`	^{верхній рядок тексту} _{нижній рядок тексту}
`mSu._main('верхній рядок тексту', 'нижній рядок тексту', {align = 'r'})`	^{верхній рядок тексту} _{нижній рядок тексту}
`mSu._main('верхній рядок тексту', 'нижній рядок тексту', {align = 'c'})`	^{верхній рядок тексту} _{нижній рядок тексту}
`mSu._main('12', '8', {align = 'c', lineHeight = '0.8em'})`	¹² ₈
`mSu._main('верхній рядок тексту')`	^{верхній рядок тексту}
`mSu._main(nil, 'нижній рядок тексту')`	_{нижній рядок тексту}