Модул:Shortcut/doc
 | Това е страница с документация за Модул:Shortcut. Тя съдържа упътване за употреба, категории и друго помощно съдържание, което не е част от самата страница на модула. |
Модулът създава каре съдържащо препратки към страниците на ползваните съкращения.
Употреба
От уикитекст
Оснновно се ползва индиректно чрез извикването му от шаблон, най-често {{съкр}}. За повече информация посетете страницата на шаблона. Позволена е и директната му употреба ползвайки следния синтаксис {{#invoke:shortcut|main|аргументи}}.
От Lua
Преди да ползвате модула е необходимо да го заредите.
local mShortcut = require('Модул:Shortcut')
След което за създаване карета на ползвайте следния синтаксис:
mShortcut._main(shortcuts, options, frame, cfg)
- shortcuts: масив съдържащ съкратените имена на страниците. (задължителен)
- options: таблица с опции. Поддържа следните ключове:
msg- съобщение което се поставя след препратките към съкращенията.category- ако е зададена стойност грешно (или стойност считана от Модул:Yesno за еквивалента на грешно, като например "не"), категоризиране на грешките не се поддържат.
- frame: структурен обект. Не е задължителен и е предназначен единствено за вътрешна употреба.
- cfg: таблица с конфигурационни стойности. Не е задължителен и е предназначен единствено за тестване.
Технически особености
Конфигурационния файл на модула се намира на Модул:Shortcut/config. Може да се ползва за превод на модула на друг език или за промяна на някой от параметрите. като например имената на категориите.