Модуль:Shortcut/документація
 | Це підсторінка документації модуля Модуль:Shortcut. Вона містить інформацію про використання, категорії та інший вміст, що не є частиною оригінальної сторінки модуля. |
 | Цей модуль позначено як К:такий, що потребує захищеного статусу (63). Завершені модулі використовуються в дуже великій кількості статей, або часто використовуються як підстановки. Позаяк акти вандалізму або помилки можуть вплинути на багато сторінок і навіть незначне редагування призведе до істотного навантаження на сервери, вони підлягають захисту від редагувань. |
 | Цей модуль Lua використовується на багатьох сторінках і його зміни будуть дуже помітними. Будь ласка, перевіряйте будь-які зміни на підсторінках /пісочниці та /тестів цього модуля, або у вашій пісочниці модуля, та зважайте на обговорення змін на сторінці обговорення перед їхнім впровадженням. |
 | Цей модуль залежить від наступних модулів: |
 | Цей модуль використовує TemplateStyles: |
Цей модуль створює контейнер, що показує посилання з короткою назвою на сторінку.
Використання
[ред. код]У вікітексті
[ред. код]У вікітексті, цей модуль повинен викликатися через шаблон, зазвичай {{shortcut}}. Детальніше щодо документації, будь ласка, дивіться сторінку шаблону. Однак, його можна викликати напряму, використавши синтаксис {{#invoke:shortcut|main|аргументи}}.
З Lua
[ред. код]Щоб використати цей модуль у Lua, спершу завантажте його.
local mShortcut = require('Module:Shortcut')
Тоді ви можете створити контейнери з короткою назвою, використавши наступний синтаксис:
mShortcut._main(shortcuts, options, frame, cfg)
- shortcuts є масивом скорочень назв сторінок. (обов'язковий)
- options є таблицею опцій. Підтримуються наступні ключі:
msg— повідомлення, що буде залишено після списку скорочень.category— якщо встановлено false (або значення, що вважається як false модулем Module:Yesno, таке як «no»), то не додаються категорії до сторінки.
- frame — об'єкт frame. Це необов'язковий аргумент та призначений лише для внутрішнього використання.
- cfg — таблиця значень config. Це необов'язковий аргумент та призначений лише для тестування.
Технічні деталі
[ред. код]Цей модуль має конфігураційний файл в Модуль:Shortcut/config. Він може використовуватися для перекладу цього модуля іншими мовами або для зміни деталей такі як назва категорій.
Це сторінка документації для Модуль:Shortcut