Модуль:Заготовка/Документация
Внешний вид
Это страница документации Модуль:Заготовка.
Модуль существует для шаблона {{קצרמר}}. Он позволяет управлять модулем без необходимости добавлять дублирующийся код каждый раз, когда нужен новый тип. Модуль возвращает три функции:
- Функция main возвращает шаблон «Заготовка» для определённого типа заготовки.
- Функция templatedata возвращает отсортированный список всех типов заготовок для templatedata.
- Функция categories возвращает отсортированный список категорий статей всех типов для документации.
Модуль использует список типов на странице Модуль:Заготовка/list.json. Он написан на языке json. Структура записи следующая:
- Для большинства типов ключ — название типа, а содержимое — имя файла иконки.
- Для типов, у которых название типа отличается от названия категории, содержимое — массив из двух элементов. Первый — имя файла иконки, второй — название категории.
Например:
"תל אביב-יפו": "Tel-aviv city hall.jpg",
"תל אביב": [
"Tel-aviv city hall.jpg",
"תל אביב-יפו"
],
Указания по добавлению новых типов
- Чтобы добавить заготовку «Tel-Aviv», нужно выполнить следующие действия
- Добавить в файл Модуль:Заготовка/list.json строку
,"Tel-Aviv": "Tel-aviv city hall.jpg" - Если название типа отличается от названия категории, строка такова:
,"Tel-Aviv": ["Tel-aviv city hall.jpg", "Tel-Aviv-Yafo"] - Если нужно добавить рамку к изображению, следует обновить код следующим образом:
"יפן": "Flag of Japan.svg{{!}}גבול",
- Обратите внимание на запятую перед текстом. Она добавлена, потому что после каждой строки списка, кроме последней, должна стоять запятая.
- Движок автоматически позаботится о формате после сохранения, так что запятая будет перенесена в конец предыдущей строки. То же и с надлежащим форматированием квадратных скобок.
- Если в одном из названий есть знак двойных кавычек, перед ним нужно написать знак обратной косой черты, например
"תנ\"ך" - Исходный список был отсортирован, но в этом нет необходимости, так как модуль сортирует его автоматически после чтения.
- Список можно обновить в templatedata ниже, скопировав со страницы Шаблон:Заготовка/Список. При необходимости следует очистить кэш с помощью кнопки на этой странице. Если в названии типа есть двойные кавычки, нужно поставить перед ними обратную косую черту, например צה\"ל.
- Список категорий на этой странице обновляется автоматически. При необходимости можно очистить кэш с помощью прилагаемой кнопки.