Шаблон:Кратко

Документация

[просмотр | править | история | обновить]

Этот шаблон реализован на основе Lua:

с использованием модуля String;
с использованием модуля Check for unknown parameters.

Шаблон для добавления краткого описания предмета статьи, что помогает читателям лучше его идентифицировать. Принципы написания текста краткого описания см.в правиле: Руниверсалис:Краткое описание.

Краткое описание высвечивается под названием статьи в поисковом запросе, под названием статьи, может вызываться посредством «волшебного слова» {{GETSHORTDESC}} и Action API.

Другие названия этого шаблона: {{Краткое описание}}, {{Short description}}, {{Shortdescr}}.

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

{{Кратко|здесь должно быть краткое описание}}

Следует:

писать краткое описание со строчной буквы (не заглавной),
стараться, чтобы описание не превышало 50 символов (с пробелами), а ещё лучше — было в пределах 40 символов.

Если название статьи достаточно информативно и краткое описание не требуется, то используйте следующий код: {{кратко|нет}}.

Как писать краткое описание

Принципы и рекомендации написания текстов кратких описаний изложены на странице Руниверсалис:Краткое описание#Правила написания текста краткого описания.

Описание

В конечном счёте, все статьи должны иметь краткое описание:

через непосредственное использование данного шаблона (в этом случае краткое описание будет уникальным для статьи);
или через включение краткого описания в шаблон (такой как шаблоны неоднозначности), где общего краткого описания достаточно для большого класса страниц;
или через использование параметров шаблона-карточки, посредством которых будет формироваться текст краткого описания.

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

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

Если названия статьи достаточно для надежной идентификации нужной статьи, можно использовать «обнулённый» вариант описания {{кратко|нет}}.

Примеры

Заполненный шаблон кратко следует добавлять вверху страницы.

Пример заполненного шаблона для статьи Москва:

{{кратко|город, столица России}}

Пример получения краткого описания из статьи посредством «волшебного слова» {{GETSHORTDESC}}:

Код {{GETSHORTDESC:Москва}} даёт результат: город, столица России

Категории, добавляемые шаблоном

Проверочные:

Общие:

Категория:Страницы с кратким описанием — общая категория для всех страниц, имеющих краткое описание;
Категория:Статьи с кратким описанием — категория для статей (основного пространства), имеющих краткое описание;
Категория:Страницы с кратким описанием вне основного пространства — категория для страниц вне основного пространства, имеющих краткое описание;
Категория:Руниверсалис:Шаблоны-карточки, включающие краткое описание — шаблоны-карточки, в которые внедрено автоматическое добавление в статьи краткого описания

См.также