Шаблон:Cmbox/doc

Материал из Народные Сказки
Мета-шаблоны
блоков сообщений

{{Cmbox}}, название сокращенно от category message box — меташаблон различных шаблонов-сообщений для категорий, таких как шаблон {{Категория для распределения}}. Он предлагает несколько различных цветов, изображений и некоторых других функций.

Похож на шаблон {{Ambox}} и использует такие же параметры.

Использование[править код]

{{Cmbox
 | name         = 
 | subst        = <includeonly>{{Subst:проверка подстановки}}</includeonly>
 | type         = 
 | image        = 
 | text         = 
 | talk         = {{{talk|}}}
 | text-small   = 
 | date         = {{{date|}}}
 | cat          = 
 | all          = 
 | data-label-1 = Название атрибута "data-???" для JavaScript
 | data-value-1 = Значение атрибута "data-???" для JavaScript
 | data-label-2 = Название атрибута "data-???" для JavaScript
 | data-value-2 = Значение атрибута "data-???" для JavaScript
 | data-label-3 = Название атрибута "data-???" для JavaScript
 | data-value-3 = Значение атрибута "data-???" для JavaScript
}}<noinclude>{{Doc}}</noinclude>

Параметры[править код]

type[править код]

Типы меняют внешний вид шаблона:

image[править код]

Этот параметр позволяет изменить картинку шаблона:

Комбинации параметров[править код]

Более сложные варианты использования шаблона:

image[править код]

Вы можете выбрать уникальное изображение для шаблона, использую параметр image. Значение параметра |Image = должно иметь тот же синтаксис, как и при вставке изображения в статью (Википедия:Иллюстрирование#Вставка файла в статью). В стандарте, ширина — 40-50px. Например:

Шаблон:Категория для распределения

Пожалуйста, учтите:

  • Если изображение не указано, то оно будет зависеть от параметра type. (Смотрите о параметре #type выше.)
  • Если указано |Image = none, то никакое изображение выводится не будет, и текст займет всю площадь шаблона.
  • Если изображение выполняет чисто декоративную функцию, а также находится в общественном достоянии, удобство и доступность использования шаблоны может быть улучшена с помощью подавления ссылки на файл с помощью добавления параметров |Link = и |Alt =, как показано выше.

text, и text-small[править код]

Параметр text передает основной текст в шаблон. Постарайтесь сделать его как можно более кратким и понятным.

Параметр text-small показывает текст маленьким шрифт, не рекомендуем его использовать для файлов.

talk[править код]

Некоторые шаблоны-сообщения содержат ссылку на страницу обсуждения, и позволяют редактору уточнить заголовок необходимой секции для ссылки. Чтобы добиться такой функциональности, просто укажите при создании шаблона |Talk = {{{talk|}}}.

Примеры использования параметра редакторами:

  • |Talk = ЗАГОЛОВОК СЕКЦИИ — ссылка отправит читателя в необходимую секцию на странице обсуждения статьи. Пример — |Talk = Foo.
  • |Talk = ПОЛНОЕ НАЗВАНИЕ СТРАНИЦЫ ОБСУЖДЕНИЯ — шаблон выдаст ссылку на указанную страницу обсуждения (может содержать ссылку на секцию), например |Talk = Обсуждение:Banana#Foo.

Примечания:

  • При использовании этого параметра при создании шаблона, то ссылка на страницу обсуждения будет появляться и в самом шаблоне (для того, чтобы продемонстрировать функциональность), но на страницах она будет отображаться, только если параметр фактически указан.
  • Чтобы быть уверенным, что ссылка на страницу обсуждения постоянно показывается, вы можете использовать следующую конструкцию: |Talk = {{{talk|#}}}.
  • Строка не будет отображаться если страницы обсуждения статьи, или указанной страницы обсуждения не существует, и неважно что вы укажете в параметре.

date[править код]

Установка параметра date сообщает мета-шаблону, что в шаблон-сообщение был установлен в этот день: устанавливается как редакторами, так и ботами. Отображается мелким шрифтов в конце дополнительного сообщения.

Обратите внимание, возможны только следующие виды дат:

Также указание этого параметра включает категоризацию по времени, если параметр #cat определен.

cat[править код]

Этот параметр определяет по-месячную категорию для статей. Если |Cat = КАТЕГОРИЯ тогда:

  • статьи будут помещены в категорию Категория: КАТЕГОРИЯ с ДАТЫ если |Date = ДАТА указан.
  • статьи будут помещены в категорию Категория: КАТЕГОРИЯ если дата не указана.

Например, для шаблона {{Маргинальные теории}} указана категория |cat = РуСказки:Статьи, подозреваемые в наличии оригинальных исследований, и поэтому статья с шаблоном {{Маргинальные теории|date=12 января 2013}} будет помещена в категорию Категория:РуСказки:Статьи, подозреваемые в наличии оригинальных исследований с января 2013 года.

В параметре cat не должно быть ссылок, и префикса Category: или Категория:.

all[править код]

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

В параметре all не должно быть ссылок, и префикса Category: или Категория:.

Дополнительные параметры[править код]

imageright[править код]

С помощью этого параметра можно указать изображение в правой части сообщения. Синтаксис такой же, как и для параметра |Image =, за исключением того, что по умолчанию изображение отсутствует.

smallimage and smallimageright[править код]

С помощью этих параметров можно указать изображения для блока малого формата. Они не будут иметь никакого эффекта, если не указано |Small = left.

class[править код]

Пользовательские классы CSS для применения к сообщению. Если вы добавляете несколько классов, они должны быть разделены пробелом.

style and textstyle[править код]

Дополнительные значения CSS могут быть определены без кавычек " ", но с завершающими точками с запятой ;.

  • |Style = — определяет стиль, используемый всей таблицей окна сообщений. Это можно использовать для таких вещей, как изменение ширины окна.
  • |Textstyle = — относится к текстовой ячейке.

issue and fix[править код]

Вместо указания |Text = и |Text-small = можно использовать параметр |Issue =.

Индивидуальный текст для малого формата может быть определен с помощью |Fix =.

plainlinks[править код]

Обычно в Википедии внешние ссылки отмечены значком стрелки рядом с ними, например: Example.com. Однако в окнах сообщений значок стрелки по умолчанию скрыт, например: Example.com. Чтобы получить обычный стиль внешней ссылки со значком стрелки, используйте |Plainlinks = no.

cat2, cat3, all2, and all3[править код]

  • |Cat2 = и |Cat3 = предусматривают дополнительные помесячные категории; см. #cat.
  • |All2 = и |All3 = предусматривают дополнительные категории, в которые помещаются все статьи, как и в #all.

Технические детали[править код]

Если вам необходимо использовать специальные символы внутри параметра |Text =, то вам необходимо заменять их ESC-последовательностями:

{{Cmbox
| text  = <div>
Здесь знак равенства = открывающая и закрывающая фигурные скобки { }.  
А здесь знак разделения параметров {{!}} и две закрывающие фигурные скобки <nowiki>}}</nowiki>. 
А здесь знак разделения параметров перед двумя закрывающими фигурными скобками <nowiki>|}}</nowiki>.
</div>
}}
  • Этот шаблон использует cmbox CSS-классы в MediaWiki:Common.css влияющие на его внешний вид, то есть он полностью перенастраиваемый.
  • Внутри шаблона для формирования кода таблицы используется язык разметки HTML вместо языка викиразметки. Так делается во всех мета-шаблонах, так как у вики-разметки есть ряд недостатков. Например, она затрудняет использование функций парсера и специальных символов в параметрах.
  • Теги <div>, окружающие текст в приведенном выше примере, обычно не нужны. Но если текст содержит разрыв строки или строк, то иногда мы получаем странный межстрочный интервал. Особенно это происходит при использовании вертикальных списков. Используйте теги <div>, чтобы исправить такое поведение.

Семейство Mbox[править код]

В семействе Module:Message box есть семь меташаблонов:

  • {{Ambox}} для сообщений на страницах статей.
  • {{Cmbox}} для сообщений на страницах категорий.
  • {{Imbox}} для сообщений на страницах файлов (изображений).
  • {{Tmbox}} для сообщений на страницах обсуждения.
  • {{Fmbox}} для сообщений верхнего и нижнего интерфейса сайта.
  • {{Ombox}} для сообщений на других типах страниц.
  • {{Mbox}}, для сообщений, которые используются в разных пространствах имён и соответствующим образом изменяют их дизайн.

Тесно связанные меташаблоны:

  • {{Stub-meta}} для сообщений в заготовках статей.
  • {{Неоднозначность}}, для сообщений на страницах устранения неоднозначности.