Энциклобогия:Шаблоны
Механизм шаблонов
Шаблон — это вики-страница, расположенная в пространстве Шаблон
. Каждая такая страница является заготовкой оформления (тексты, рамки, изображения, изменяемые тексты), и предназначена для вставки в другую вики-страницу.
Использование шаблонов
Использование шаблона — это буквально вставка в редактируемый текст строки вызова шаблона: {{Имя шаблона}}
. В результате, после сохранения (и в предварительном просмотре) на месте вставки будет отображаться содержимое страницы шаблона. Например, строка вызова простого шаблона Шаблон:DateGE в режиме набора текста должна выглядеть вот так: {{DateGE}}
. После записи страницы вместо строки вызова отобразится содержимое шаблона: 6505й день г. э.. Проверка проводится в режиме предпросмотра.
Кратко о том, как применять шаблоны, также описано в справке Как править статьи[1]. В целом, независимо от уровня вашей подготовки, при применении шаблона рекомендуется сверяться не только с его документацией (отражена на странице шаблона и обычно содержит примеры), но и с оформлением уже существующих и тематически схожих статей.
Параметры
Большинство шаблонов обладают параметрами (иногда называемых полями), позволяющими настроить их корректное отображение. У каждого параметра в любом шаблоне есть своё имя. Чтобы при вызове шаблона там же, внутри фигурных скобок задать какому-то параметру значение, надо просто указать это значение после знака равно: имя_параметра = значение_параметра
. Чтобы сервер понял, где кончается имя шаблона, а где начинается название параметра, каждую такую запись следует отделять от предыдущей вертикальной чертой[2], по принципу, отображённому в примере:
Вызов без задания параметров | {{Имя_шаблона}}
|
Вызов с одним параметром | {{Имя_шаблона|имя_параметра_1 = значение_параметра_1}}
|
Вызов с несколькими параметрами | {{Имя_шаблона|имя_параметра_1 = значение_параметра_1|имя_параметра_2 = значение_параметра_2|имя_параметра_3 = значение_параметра_3}}
|
Допускается также написание в несколько строк | {{Название шаблона |имя_параметра_1 = значение_параметра_1 |имя_параметра_2 = значение_параметра_2 |имя_параметра_3 = значение_параметра_3 }} |
Именем параметра может выступать и число (например, 1, 2, 3, …
), тогда при вызове его имя можно не указывать, а присвоение произойдёт по порядку введения значений. То есть записи вида {{God|1 = Godville}}
и {{God|Godville}}
равнозначны и отобразятся как Godville. Параметров может быть много, но совсем не обязательно их все указывать при вызове и заполнять значениями. Если никакое значение не задано или параметр вообще не упомянут при вызове, шаблон отображается так, будто задано пустое значение. К примеру, вызов шаблона
{{God|Godville|Администратор Годвилля}}
даёт ссылку на профиль бога (имя которого указано в первом поле) и замещает её текстом (указанным во втором поле): Администратор Годвилля. При этом если значение второго параметра не указано
{{God|Godville}}
, то замещение имени альтернативным текстом производиться не будет: Godville. Таким образом второй параметр в этом шаблоне является необязательным. В большинстве оформительских шаблонов предпочтительно оставлять необязательные поля пустыми, чтобы соответствующие части оформления попросту не отображались, а не заполнять их значениями-пустышками вроде «нет», «не известно», «будет позже», которые приводят отображению того, что должно быть скрыто при отсутствии данных.
Документация к шаблонам
Как правило, к каждому шаблону составляется инструкция по его использованию — подстраница документации. Именно в документации описаны параметры шаблона, возможности и ограничения, дана заготовка для копирования, необходимая для вызова шаблона, и примеры применения. Специально искать документацию не придётся — она автоматически выводится на странице шаблона.
Маленький чит для ПК: при редактировании текста любой статьи под окном ввода отображается раскрываемый список «Шаблоны, используемые на этой странице», который позволяет правым щелчком мыши быстро открыть страницу используемого шаблона и свериться с его документацией на предмет доступных параметров и нюансов их применения.
Все доступные шаблоны
Самый быстрый способ найти все доступные шаблоны — это переход по одноименной ссылке в главном меню Энциклобогии, ссылка приведёт вас в категорию для шаблонов. Бо́льшая часть шаблонов, предназначенных для различного оформления текста и иллюстраций, лежит непосредственно в категории, а остальные разнесены по тематическим подкатегориям:
Также можно воспользоваться расширенным поиском (в пространстве Шаблон).
Краткое описание подкатегорий и некоторых шаблонов
Шаблоны, объединённые в подкатегории
Ниже дано краткое описание назначения шаблонов, рассортированных в подкатегории. Более подробное описание — по ссылкам в разворачивающемся списке для каждой подборки.
Категория
.
Файл
.
Нерассортированные шаблоны
Здесь дано краткое описание почти всех нерассортированных шаблонов. Обычно это шаблоны для форматирования текста и прочее оформление.
Шаблоны из основной категории Шаблоны:
- {{'}} — предназначен для добавления знака ударения (́) к символу текста.
- {{-}} — служит для отмены обтекания предшествующих ему элементов страницы.
- {{Awards}} — служит для отображения информации о медалях («золотых иероглифах») бога.Может быть переименован.
- {{DateGE}} — преобразует введённую дату в количество дней от/до сотворения Годвилля.
- {{DaysBetween}} — рассчитывает количество дней между двумя заданными датами или заданной и текущей датой.
- {{Hider}} — предназначен для того, чтобы скрыть часть текста (т. н. «спойлер»). В закрытом состоянии спойлер подвержен наползанию изображений, рекомендуется применять в паре с шаблоном {{-}}. Бесполезен для мобильной версии.
- {{Quote}} — отображает цитату из дневника аналогично дневниковому оформлению.Может быть переименован.
- {{TOC-Right}} и {{TOC-Left}} — выстраивают содержание (оглавление) страницы по правому/левому краю с обтеканием текстом с противоположной стороны. Бесполезны для мобильной версии.
- {{Врезка}} — предназначен для визуального выделения из статьи небольших блоков текста.
- {{Задание}} — отображает текст задания, визуально очень похоже на данные со страницы героя. Устаревший шаблон. Криво отображается, не подходит для мобильной версии. Может быть удален.
- {{Примечания}} — размещает примечания в заданном месте. Заменяет собой строку <references/>.
- {{Колонка}} — позволяет форматировать текст, обычно список, в несколько колонок. Плохо работает в мобильной версии.
- {{Кратное изображение}} — более компактная альтернатива классической галереи (сформированной тегом) для отображения тесно связанных одноформатных (обычно парных) изображений.
- {{Врезка}} — предназначен для визуального выделения из статьи небольших блоков текста.
- {{Цитата}} — предназначен для красивого оформления разного рода цитат.
Примечания
- ↑ Интересующиеся тонкостями внутреннего устройства шаблонов и механизмом их работы, могут найти подробные описания в Википедии.
- ↑ Из-за того, что параметры шаблонов при вызове отделяются друг от друга вертикальными чертами, если в качестве значения параметра вам необходимо использовать вертикальную черту, сделать это напрямую не удастся — вики-движок подумает, что вы просто пытаетесь отделить очередной параметр. В таких случаях вместо вертикальной черты можно использовать подстановку {{!}}.