Руниверсалис:Краткое описание
Краткое описание добавляется в статьи (или на иные страницы) для лучшей идентификации предмета статьи, если её название не является исчерпывающим. Краткое описание помогает пользователям быстрее находить нужную статью.
Краткое описание высвечивается под названием статьи в поисковом запросе, под названием статьи, в мобильной версии, может вызываться посредством «волшебного слова» {{GETSHORTDESC}}, а также посредством Action API.
Краткое описание добавляется на страницу с помощью шаблона {{Кратко}}. Технически добавление краткого описания в статьи основано на расширении движка mw:Extension:ShortDescription.
Примеры использования
Краткое описание помогает лучше идентифицировать предмет статьи, для чего:
- может содержать краткое указание на область статьи,
- может содержать краткое описательное пояснение,
- устранять неоднозначность при поиске, чтобы отличить тему статьи от тем с похожим названием в других областях.
Краткое описание добавляется посредством шаблона {{Кратко}}, который необходимо разместить вверху страницы:
{{Кратко|здесь должно быть краткое описание}}
.png)
Пример заполненного шаблона для статьи Москва, который даёт результат, отображенный на иллюстрации:
{{кратко|город, столица России}}
Помимо отображения в поисковом поле краткое описание можно:
- увидеть под заглавием страницы в мобильной версии (для отображения краткого описания под заглавием в десктопной версии нужно включить соответствующий гаджет в личных настройках);
- вызывать с помощью «волшебного слова»
{{GETSHORTDESC}},- например, код
{{GETSHORTDESC:Москва}}даёт результат: город, столица России; это можно использовать в списках ссылок типа раздела «См. также» (удобно это делать посредством шаблона {{Ссылка с описанием}});
- например, код
- вызывать с помощью запросов Action API,
- например, для получения краткого описания в формате JSON для статьи Москва через API можно использовать ссылку https://руни.рф/api.php?action=query&prop=description&titles=Москва&format=json&formatversion=2
Если название статьи достаточно информативно и краткое описание не требуется, то используйте следующий код: {{кратко|нет}}.
Краткое описание может также добавляться через шаблоны-карточки, в которые внедряется стандартный или автоматически формируемый текст краткого описания (тоже посредством шаблона {{Кратко}}). Примеры таких шаблонов-карточек см. в категории Руниверсалис:Шаблоны-карточки, включающие краткое описание (не забывайте помещать шаблон-карточку в эту категорию, если внедрили в него шаблон {{Кратко}}).
Если требуется добавить уникальное краткое описание в статью, в которой уже есть стандартное краткое описание, добавленное через шаблон-карточку, то следует добавить в статью заполненный требуемым текстом шаблон {{Кратко}}, разместив его после шаблона-карточки.
Правила написания текста краткого описания
Технические требования
- краткое описание должно быть написано простым текстом, без HTML-тегов, CSS-оформления, вики-разметки, типографских знаков, эмодзи;
- краткое описание следует писать со строчной буквы (не заглавной);
- точку в конце описания ставить не следует;
- желательно, чтобы описание не превышало 50 символов (с пробелами), а ещё лучше — было в пределах 40 символов, которых достаточно для 80% коротких описаний (поскольку краткие предназначены для быстрого просмотра, длинные и углублённые описания могут оказаться менее полезными),
- не следует использовать скобки (например, для указания дат жизни следует написать российский художник, 1900—2000, а не помещать годы в скобки),
- допустимо использовать в кратком описании запятые, но не более двух, рекомендуется ограничиваться одной (то есть вариант российский художник, 1900—2000 предпочтительнее варианта художник, Россия, 1900—2000, но допустимы оба).
Содержательные требования
- краткое описание является частью статьи, поэтому подчиняется всем правилам, предъявляемым к статьям, в том числе о нейтральности;
- краткое описание предназначено в первую очередь для того, чтобы помогать идентифицировать предмет статьи, в том числе отличить статью от статей с аналогичным названием в результатах поиска, а не для определения предмета статьи;
- в тексте краткого описания опирайтесь на общепринятые факты, которые не будут подвержены быстрым изменениям, избегайте помещать в краткое описание то, что может быть воспринято как спорное, предвзятое или рекламное содержание;
- избегайте жаргона, используйте в кратком описании простые, понятные термины, которые не требуют детального знания предмета;
- избегайте дублирования информации, которая уже есть в названии, но не не волнуйтесь, если вам для контекста нужно повторить в кратком описании пару слов из названия;
- избегайте определений типа «вышедший на пенсию», «закрытый», «текущий», «новый», «недавний», «запланированный», «будущий» и т. п.;
- избегайте оценочных определений типа «знаменитый», «популярный» и т. п.;
- даты или диапазоны дат рекомендуются, если они дополняют краткое описание или устраняют неоднозначность; краткие описания в статьях о конкретных изданиях и исторических событиях, как правило, выигрывают от датировки, но стоит помнить, что описание должно быть кратким.
Частные требования к группам статей
Для групп статей (например, фильмов и т.п.) могут быть введены частные правила для единообразия оформления (вводятся через обсуждение на странице обсуждения данного руководства по итогу администратора), которые будут обязательны к исполнению во всех статьях групп.
Примеры кратких описаний
- Для статьи о человеке: «[принадлежность стране] [чем известен человек]» (примеры: «российский композитор», «кубинский боксёр»).
- Для статьи о географическом объекте: «[тип объекта] в [регионе/стране/etc.]» (примеры: «город во Флориде, США», «мост в Санкт-Петербурге, Россия»).
- Для статье об организме: «[вид] [общее название или описание]» (примеры: «семейство бабочек», «вымершие морские моллюски»). Не включайте в краткое описание названия семейств или другие таксономические термины.
- Для статьи о произведении: «[тип публикации] [автор] [год]» (примеры: «роман Льва Толстого, 1869», «стихотворение Александра Пушкина, 1829»)
- Для статей на другие темы: «тип [объекта]», «концепция в [научной области]» и т.п. (примеры: «тип подводной лодки», «концепция в статистике»).
Какие страницы должны содержать краткое описание
Все статьи основного пространства имён должны иметь краткое описание.
Страницы-перенаправления, списки и большинство страниц, не относящихся к основному пространству имён, обычно не нуждаются в кратком описании. В отдельных случаях добавление краткого описания может быть полезным и необходимым.
В случае перенаправлений краткое описание может быть полезным в качестве указателя на то, что по данной теме может быть создана отдельная статья. Размещать шаблон с кратким описанием следует после кода перенаправления.
