Шаблон:Портал/doc

Назначение

Шаблон {{портал}} используют для создания порталов — заглавных страниц на определённую тему или предметную область.

Параметры

Категории

категория

Название категории (без префикса), в которой хранятся статьи на тему портала и/или подкатегории с такими статьями. Например, для портала Биология значение этого параметра выглядит так: Биология. Из содержимого указанной категории могут быть автоматически сформированы списки статей и подкатегорий. Подробнее о том, как это происходит рассказано ниже, в разделе Автоматизация.

категория_участников

Название категории (без префикса), в которую включены страницы участников портала. Например, для портала Математика это категория Участники-математики, а для портала Автомобили — категория Участники портала «Автомобили». Из содержимого указанной категории, шаблон {{портал}} автоматически формирует список участников портала. Подробности см. в разделе Автоматизация.

Коробочки

Шаблон {{портал}} делит тело страницы портала на два столбца (колонки), и в каждом столбце может быть размещено желаемое количество коробочек. В каждой колонке можно разместить до 9 коробочек.

Коробочки могут быть разных типов в зависимости от содержания, для которого предназначена та или иная коробочка.

О коробочках

Коробочка — это такая финтифлюшка прямоугольной формы, обрамлённая рамкой и снабжённая полем для заголовка. Внутри рамки располагается какой-нибудь контент: текст, картинки, списки и т. п. Каждая коробочка — это отдельный раздел портала. Указанное вами наименование раздела — например «Избранная статья», «Знаете ли вы», «Полезные советы на каждый день» — попадает в заголовок коробочки. Вам решать, какие коробочки вам нужны, как их обзывать и какой контент в них помещать.

Поскольку колонок в портале две — левая и правая, в наименовании параметров коробочки указывают буквы «л» (лево) или «п» (право), соответственно. Коробочек в портале может быть много. Поэтому каждой коробочке присвоен порядковый номер, который прикручен к наименованию параметра коробочки. Например, параметр лкор1_тип говорит нам о том, что это параметр относится к первой коробочке левой колонки, а пкор4_тип — к четвёртой коробочке правой колонки. У всех коробочек одинаковый набор параметров, и параметры одной коробочки отличаются от параметров другой только префиксами вроде лкор1, лкор7, пкор1, пкор4 и т. д.

Всё просто и понятно.

Типы коробочек

articles

Список статей. (См. условия и ограничения в разделе Автоматизация ниже.)

cats

Список категорий. (См. условия и ограничения в разделе Автоматизация ниже.)

doyouknow

Рубрика «Знаете ли вы, что».

featured

Коробочка для избранной статьи по теме.

newpages

Список новых статей.

good

Коробочка для хорошей статьи.

image

Избранное изображение.

todo

Раздел «Чем я могу помочь».

users

Список участников портала.

Зачем нужно указывать тип коробочки? А вот зачем — Если вы указали какой-то из перечисленных выше типов, то все остальные параметры (для данной коробочки) необязательны. Вы получите множество плюшек: оформление коробочки и её заголовок по умолчанию, красную ссылку на страницу содержимого коробочки (со стандартным названием, например, «/Статья2» для хорошей статьи). Некоторые коробочки даже сами сгенерируют содержимое (подробнее об этом, см. раздел Автоматизация ниже).

«Да видал я ваши типы в белых тапочках! — резонно можете возразить вы. — Могу ли я задать свой собственный тип?» Можете! Однако учтите следующее — Если вы указали в параметре «тип» что-нибудь нестандартное, тогда на помощь нашего умного кода не рассчитывайте :) И это ещё не всё! Если вы укажете неизвестное нам значение типа коробочки и при этом не укажете значения параметра «текст» или «шаблон», коробочка вообще не появится в портале…

Если вы всё же решили указать нестандартный тип, единственно возможное альтернативное значение — это generic. Если укажете что-нибудь другое, оно с высокой степенью вероятности может случайно совпасть с типом, который добавят в будущем, и тогда ваш портал сломается. Будете потом сидеть и плакать, как та бабка у разбитого корыта, у которой не получилось стать владычицей морскою. Оно вам нужно? Впрочем, у нас бывали случаи, когда нестандартный тип оказывался полезен: он, к примеру, помог сделать коробочку «Интересная задача» для портала Математика.

Итак, какие ещё у коробочки параметры? Для примера приведём параметры с префиксом лкор1 для коробочки, которая, как вы уже догадались из обозначения параметра, располагается под номером один в левом столбце портала:

лкор1_заголовок

Текст над содержимым коробочки (обведён рамкой).

лкор1_значок

Название картинки, которая будет слева от заголовка (всегда размером 20px в ширину).

лкор1_стиль

Стиль (CSS) рамки над коробочкой. Вы можете тут указать, скажем, значения background или border, чтобы изменить оформление. Например, в портале Коммунизм (ну, или марксизм-джедаизм, если точнее) вам может понадобиться покрасить их в красный цвет.

без_лкор1_править=1

Укажите этот параметр, чтобы убрать ссылку «[править]» из заголовка коробочки. Например, если у вас есть коробочка для новостей и бот, который её обновляет, то людям эту страницу изменять действительно не нужно.

лкор1_текст

Собственно содержимое коробочки. Особенности использования описаны ниже, в разделе Автоматизация.

лкор1_шаблон

Название подстраницы (без фигурных скобок), где находится содержимое коробочки. Особенности использования описаны ниже, в разделе Автоматизация.

лкор1_стиль_текста

Стиль (CSS), который будет применён к содержимому коробочки. Тут обычно меняют шрифт, указывая значения font-size, color, font-family и т. д. Не рекомендуется здесь задавать рамки коробочки значениями border.

Коробочки под колонками

Можно также создать до трёх «нижних» коробочек под колонками (на всю ширину страницы). Для этого используются параметры вида нкор1_тип.

Использование таких коробочек не рекомендуется. Они нужны только в том случае, если в портале должно быть что-то, не вмещающееся в колонку (из-за недостаточной её ширины). Например, крупная таблица матчей для портала Спорт.

Оформление портала

Совет

Цвета для порталов удобно подбирать по табличке Абсурдопедия:Цвета

Хотя цвета и рамки по умолчанию выглядят довольно нормально (они примерно такие же, как на заглавной странице), настоятельно рекомендуется чего-нибудь там поменять и перекрасить. Как мы уже говорили чуть выше, порталу Коммунизм разумно где-нибудь добавить красные цвета.

Поддерживаются следующие параметры, относящиеся к оформлению.

общий_фон

Цвет фона для всей страницы, кроме колонок, шапки и т. п.

колонка_стиль

Стиль колонки.

лколонка_стиль

Стиль левой колонки. По умолчанию — значение параметра колонка_стиль, если он есть.

пколонка_стиль

Стиль правой колонки (аналогично).

шрифт_обычный=1

Не применять шрифты Verdana, Arial, Helvetica (по умолчанию они используются во всём портале — используйте этот параметр, чтобы отключить). Для порталов не рекомендуется, зато пригодилось на Заглавной странице Абсурдопедии.

Цитата

Совет

Внутри шаблона цитаты удобно использовать шаблон {{q2}} для оформления. Также используйте теги <choose> и <option>, чтобы показывать случайную цитату из нескольких заготовленных (пример см. в шаблоне {{ЦитатаЗС}}).

Настройки цитаты (располагается над шапкой портала):

без_цитаты=1

Не показывать цитату вообще.

цитата_текст

Содержимое (только если цитата будет изменяться чрезвычайно редко, иначе используйте следующий параметр цитата_шаблон).

цитата_шаблон

Название подстраницы, где хранится цитата. По умолчанию — /Цитата, если эта подстраница существует. В противном случае, это {{ЦитатаЗС}} (выводит те же цитаты, что выводятся на заглавную страницу Абсурдопедии).

цитата_стиль

Стиль (CSS) для цитаты (тут можно задать рамку, фон, шрифт и т. п.).

Шапка

Шапка (голова портала) находится под цитатой и над колонками с коробочками. На её отображение влияют следующие параметры:

без_шапки=1

Не показывать шапку. Не рекомендуется (по соображениям здравого смысла — у каждого портала должна быть шапка; данный параметр введён для того, чтобы шаблон {{портал}} можно было использовать и для других страниц похожего «коробочного» строения, а не только для порталов).

шапка_текст

Содержимое шапки. Используйте этот параметр, если оно практически никогда не будет обновляться.

шапка_шаблон

Название подстраницы, содержащей шапку. По умолчанию — /Голова портала.

шапка_стиль

Стиль (CSS) для шапки.

шапка_править=1

Добавить к шапке ссылку [править]. Используйте этот параметр, если её надо довольно часто менять (например, если в шапке указано количество хороших статей по теме).

без_шапка_обновить=1

Убрать ссылку [обновить] из шапки. Обычно так делать не надо (разве только для полностью статических порталов, где везде используются параметры коробочек вида лкор1_текст, а не лкор1_шаблон).

Список порталов

Это навигационный шаблон {{Порталы}} прямо под шапкой. Поддерживаются следующие настройки:

без_списка_порталов=1

Вообще убрать список порталов. Не рекомендуется.

список_порталов_внешний_стиль

Этот стиль (CSS) влияет на внешнюю таблицу, в которой находится список порталов. В частности, тут можно задать внешнюю рамку и отступы (например, значениями margin-top).

список_порталов_стиль

Влияет непосредственно на текст — заголовок «Порталы» и сам список. Здесь можно задать фон под текстом или шрифт.

список_порталов_рамка_стиль

Этот параметр влияет на рамку между внешней границей списка и текстом. Здесь есть смысл задавать цвет фона и границу.

Хвост портала

Это текст под колонками. По умолчанию вообще отсутствует (и в большинстве порталов не нужен). Используется в основном для включения навигационных шаблонов (см. пример в портале Математика). Параметры:

хвост_текст

Текст, который нужно показать в хвосте портала. Он может содержать вики- и html-разметку и шаблоны.

хвост_шаблон

Название подстраницы (без фигурных скобок), содержащей контент для хвоста портала.

хвост_править

Добавить ссылку [править] (работает, если указан параметр хвост_шаблон). По умолчанию шаблон такую ссылку не показывает.

хвост_стиль

Оформление всего блока.

Служебные параметры

nocat=1

Не присваивает странице портала категории. Дополнительно передаёт значение nocat=1 шаблону {{Порталы}} и шаблону хвоста портала (хвост_шаблон, если этот параметр указан). Используйте в случаях, если вы применяете шаблон не на странице портала, а на черновике, пока портал ещё не готов и т. д.

экспериментальный=1

Если не указано значение параметра nocat, тогда этот параметр включает страницу в категорию Порталы в разработке.

Автоматизация

Содержимое коробочек

Шаблон {{портал}} настолько умён, что может сам автоматически создавать (и обновлять без вашего вмешательства) содержимое следующих коробочек:

• articles (статьи) — список статей по теме портала;
• cats (категории) — список категорий по теме портала;
• users (участники) — список участников портала.

Примечание.В приведённых здесь примерах, X — префикс наименования параметра с указателем «лево—право» и номером коробочки.

Коробочка articles

Для автоматического вывода списка статей, в параметре категория должна быть указана категория, в которой имеются в наличии статьи. Из статей, находящихся в данной категории, будет автоматически сформирован список, который отправится в коробочку articles. Параметры X_текст и X_шаблон в этом случае использовать не нужно.

Если тема или предметная область, для которой создаётся портал, широка и глубока, её корневая категория не обязательно содержит статьи — они как перепуганные воробьи разлетелись по подкатегориям. Если в данной категории нет статей, у вас есть два пути предоставления пользователям портала доступа к статьям, находящимся в подкатегориях:

Совет

Если встала необходимость использовать параметр X_текст, рекомендуется его использовать со статическим контентом тогда и только тогда, когда содержание коробочки почти никогда не изменяется. Пример: коробочка «Избранное фото» в портале Портал:Детям, её по задумке не нужно менять. Чтобы сделать контент коробочки интересным, его нужно периодически менять, что следует делать либо вручную, либо с использованием функции парсера #switch.

Если указано значение параметра X_шаблон, то параметр X_текст игнорируется; если не указано — заодно убирается ссылка [править], которая в этом случае и не нужна.

Значения обоих параметров могут содержать вики- и html-разметку и шаблоны.

1. вместо использования коробочки articles для вывода статей из указанной категории, используйте коробочку cats; или
2. для коробочки articles укажите значения одного из следующих параметров —
   1. X_текст — составленный вручную список статей или список, созданный автоматически, например {{#categorylist: Сочинения|150}}), или
   2. X_шаблон — наименование подстраницы, содержащей список интересующих вас категорий

Коробочка cats

Для автоматического вывода списка категорий, в параметре категория должна быть указана категория, в которой имеются в наличии подкатегории. Автоматически сформированный из них список подкатегорий отправится в коробочку cats. Параметры X_текст и X_шаблон в этом случае использовать не нужно.

Если подкатегорий в указанной вами категории нет, у шаблона попросту не будет данных для автоматического создания нужного списка. В этом случае:

1. не используйте коробочку cats; или
2. для коробочки cats укажите значения одного из следующих параметров —
   1. X_текст — составленный вручную список категорий или список, созданный автоматически, например <categorytree mode=categories hideroot=on>Сочинения</categorytree>), или
   2. X_шаблон — наименование подстраницы, содержащей список интересующих вас категорий.

Коробочка users

Для автоматического вывода списка участников портала, в параметре категория_участников должна быть указана категория, содержащая список участников портала. Этот список будет автоматически помещён в коробочку users. Параметры X_текст и X_шаблон в этом случае использовать не нужно.

Обратите внимание, что не все порталы имеют активных участников (соответствующая категория пуста), либо требуемой категории нет вовсе. В первом случае, категорию не указывают и коробочку users не используют. Во втором случае, вы можете либо создать такую категорию, добавить туда участников портала (как это делается, описано тут.) и затем указать её в параметре категория_участников, либо указать участников вручную в параметре X_текст или X_шаблон.

Категоризация

Использование шаблона {{портал}} освободит вас от необходимости категоризации портала вручную. Категория:Порталы будет присвоена странице портала автоматически. В дополнение, портал автоматически попадёт и в категорию, указанную в параметре категория. Например, порталу Математика автоматически присвоена Категория:Математика с ключом сортировки «*».

Использование

После заполнения шаблона, неиспользуемые параметры и html-комментарии <!-- ... --> можно удалить.

 {{портал
  | категория = 
  | категория_участников = 
  | экспериментальный = 1

  | общий_фон = 

  | <!-- без_цитаты = 1 -->
  | цитата_текст =
  | цитата_шаблон = 
  | цитата_стиль =

  | <!-- без_шапки = 1 -->
  | шапка_текст = 
  | шапка_шаблон = 
  | шапка_стиль = 
  | <!-- шапка_править = 1 -->
  | <!-- без_шапка_обновить = 1 -->

  | <!-- без_списка_порталов = 1 -->
  | список_порталов_внешний_стиль =
  | список_порталов_стиль =
  | список_порталов_рамка_стиль =

  | колонка_стиль =
  | лколонка_стиль = 
  | пколонка_стиль =

<!-- указать только одно значение лкор1_тип из этого списка -->
  | лкор1_тип = generic / featured / good / image / doyouknow / articles / newpages / cats / todo / users
  | лкор1_заголовок = 
  | лкор1_значок = 
  | <!-- без_лкор1_править = 1 -->
  | лкор1_стиль = 
  | лкор1_текст = 
  | лкор1_шаблон =

  | лкор2_тип = 
  ...
 
  | пкор1_тип = 
  ...
 
  | пкор2_тип = 
  ...

  | хвост_текст = 
  | хвост_шаблон = 
  | <!-- хвост_править = 1 -->
  | хвост_стиль =
 }}

Примеры

Примеры порталов, созданных по шаблону {{портал}}:

• Математика
• Физика
• Ёпрст