Хабадпедия:Руководство по оформлению страниц
| Содержание и стиль изложения |
У руководства по оформлению страниц ясная и простая цель — добиться единообразия оформления статей Хабадпедии; это руководство по стилю. Иногда один способ лучше другого, но предпочтительно, чтобы все статьи были упорядочены и единообразны в оформлении, насколько это возможно, чтобы они были понятны и удобны для просмотра, чтения и редактирования. Это руководство сосредоточено на структуре статьи. Информацию о написании содержания статьи см. Хабадпедия:Руководство по написанию статей. Для тех, кто хочет знать, как оформление выполняется на практике, существует руководство по редактированию страниц, из которого вы узнаете, как выделять, отмечать, добавлять ссылки и прочее. Руководство, которое вы сейчас читаете, занимается главным образом вопросом когда — в каких случаях и ради какого стиля стоит ими пользоваться.
Прежде чем вкладывать силы в написание статьи, желательно проверить, заслуживает ли тема вообще энциклопедической статьи или же она неприемлема в Хабадпедии. Следует напомнить новым участникам, что ясное, информативное, нейтральное, оригинальное и полезное изложение всегда будет важнее внешнего вида и формата. Поскольку мы пишем на иврите, правила, относящиеся только к этому языку, сформулированы в Хабадпедия:Язык.
Помимо теоретического чтения здесь, можно брать пример со статей, оформление которых вам понравилось. Возьмите статью и подробно изучите, как она построена и написана, открыв её для редактирования (нажав на вкладку «Править код» вверху статьи). В конце вы можете закрыть её, ничего не изменив, но любую статью можно улучшить, и мы будем рады, если вы это сделаете.
Общая структура статей
Введение статьи
| Указание | Пояснение | Примеры | |
|---|---|---|---|
| Определение темы | Статья должна начинаться с ясного, краткого и чёткого определения, хорошо описывающего тему, и очень общего, приблизительного резюме её основного содержания.
|
| |
| Выделение терминов | Название/тема каждой статьи должно быть выделено жирным при первом его появлении в статье. Если у темы статьи более одного названия, укажите все их в первом абзаце статьи и выделите основные из них. |
| |
| Прояснение контекста | Желательно также уже в первой строке пояснить контекст темы статьи (если он недостаточно ясен). Если статья посвящена теме из какого-либо вымышленного мира — например, персонажу, месту, понятию и т. п., источнику понятия и тому подобному, — это следует явно указать в начале статьи, включая источник термина. |
|
Основная часть статьи
| Указание | Пояснение | Примеры | ||
|---|---|---|---|---|
Содержание | ||||
| Деление на короткие абзацы | Желательно делать абзацы короткими, поскольку глаз утомляется после долгого чтения сплошного текста. По похожей причине статью следует разрежать — пустая строка между абзацами, между заголовком и абзацем и так далее. | Вики-синтаксис для создания абзаца: пустая строка между двумя абзацами. | ||
| Ссылки на источники | Важно включать ссылки на внешние источники с помощью сносок, подтверждающих достоверность излагаемых фактов. См.: Справка:Сноски |
Пример кода для сноски:
| ||
| Включение фотографий и иллюстраций | Желательно, чтобы статья включала фотографии, иллюстрации и графические пособия рядом с абзацами, обычно слева от текста.
| |||
Заголовки статьи | ||||
| Деление на заголовки | Заголовки помогают сделать статью яснее и упорядоченнее, разделяя её на подтемы, а также делают её удобной для использования и навигации через оглавление (которое создаётся и отображается автоматически). Словам, находящимся в заголовках разделов статьи, придаётся больший вес при выполнении поиска по энциклопедии. | Пример кода:
== Заголовок == | ||
| Разделение на подзаголовки | Количество знаков равенства (одинаковое с обеих сторон заголовка) определяет размер заголовка и уровень подзаголовка.
|
Пример кода:
== Главный заголовок== === Второстепенный заголовок === | ||
| Избегайте чрезмерного дробления |
Не следует перегружать статью чрезмерным дроблением — вширь (избыток тем) или вглубь (избыток уровней деления), — поскольку это может создать путаницу, разрозненность и лишнюю нагрузку на содержание. Как правило, короткие абзацы не оправдывают собственного подзаголовка. | |||
| Избегайте ссылок в заголовках | Следует избегать превращения заголовков абзацев и разделов (или их частей) в ссылки, поскольку это вызывает путаницу. Лучше поместить соответствующие ссылки в одно из первых предложений под заголовком.
| |||
Внутренние ссылки | ||||
| Включение внутренних ссылок |
В текст следует включать отсылки к другим связанным статьям — так называемые «внутренние ссылки», то есть слово (или последовательность слов) в тексте, являющееся ссылкой на другую статью.
|
Ссылка создаётся с помощью пары квадратных скобок с каждой стороны слова: например, [[Шедим и духи]]. | ||
| Избегайте избытка ссылок | Не превращайте в ссылку каждое появление слова — достаточно отметить его первое появление.
| |||
| Понятные ссылки | Можно делать ссылками слова, не совпадающие в точности с названием статьи, на которую нужно сослаться, как подробно описано на странице Справка:Ссылки. Вместе с тем следует убедиться, что понятно, куда ведёт ссылка, без необходимости переходить по ней. В случаях формы множественного числа, добавления определённого артикля «ה», служебных букв-приставок или любой другой буквы, которая не является частью самого слова, можно отметить только нужную часть слова вместо того, чтобы отмечать его целиком. Так легче читать, понимать и печатать.
|
Можно делать ссылками слова, не совпадающие в точности с названием статьи, на которую нужно сослаться:
| ||
«См. также» и «Литература»
| Указание | Пояснение | Примеры | ||
|---|---|---|---|---|
| Расположение дополнительных разделов | Заголовок раздела «См. также» ставится перед разделом «Литература» и разделом «Внешние ссылки». | |||
См. также | ||||
| Ссылки в разделе «См. также» | Раздел «См. также» предназначен для того, чтобы направить читателей к связанным статьям, содержащим предысторию или дополнительные сведения, которые помогают понять тему текущей статьи.
|
== См. также == | ||
Литература | ||||
| Ссылки на литературу | Помимо интернет-ссылок, можно указать физические, не сетевые (не в интернете) источники информации, которые могут её дополнить (библиография): соответствующую книгу или статью. Большая часть информации в наши дни всё ещё находится в книгах, и желательно ссылаться на них.
Кроме того, желательно указывать «ссылки на источники» — если в статье есть конкретная отсылка к внешнему источнику или цитата из него. Например, если в статье упоминается некая статья, стоит сослаться на саму статью согласно Хабадпедия:Библиография. | |||
Внешние ссылки | ||||
| Ссылки на сайты | Бывают случаи, когда уместно добавить более подробную информацию, или информацию по более узкой теме, или невербальное содержание (изображения, данные, графики и т. п.), источник которого — интернет. Это особенно важно, когда веб-сайт служит основным источником информации. Раздел «Внешние ссылки» ставится в конце статьи, после раздела «Литература». Способ оформления ссылки в Хабадпедии объясняется на странице Хабадпедия:Внешние ссылки.
| |||
Отнесение к категориям и навигационным шаблонам
См.: Хабадпедия:Категория, а также Хабадпедия:Шаблоны
Особый текст
Когда в предложении речь идёт о каком-либо термине и он используется не обычным образом или не в обычном значении, его следует выделять двойными кавычками (") или полужирным шрифтом. В иврите курсив не используется (Italic. Например:
- Термин «итабхут» происходит от талмудического слова «овех».
- Йуд — десятая буква еврейского алфавита.
В статью можно добавить раздел цитат, относящихся к теме. Цитата помещается в кавычки, а если она длиннее одного-двух предложений — в абзац с отступом. Подробнее см. на странице Хабадпедия:Цитирование. (Правила оформления названий книг и статей см. на странице Хабадпедия:Библиография.)
При указании дат следует использовать определённый формат, как описано на странице Хабадпедия:Даты. То же касается чисел. Как правило, числа до десяти или любое число в начале слова следует писать словами, а не цифрами. Не следует использовать знак %, а только слово «процентов».
Важно помнить, что строка, начинающаяся с символа пробела без продолжения, будет пустой строкой в тексте. Абзац текста, начинающийся с пробела, будет оформлен моноширинным шрифтом и не будет переноситься на следующую строку. Такая строка расширяет всю страницу и нарушает последовательность чтения статьи, поэтому важно следить за тем, чтобы обычный абзац текста не начинался с пробела.
Шаблоны
Есть также готовые шаблоны, которые повторяются в Хабадпедии и способствуют сохранению единообразия; их можно копировать для более быстрой работы, и в любом случае желательно использовать формат, который они задают. Полный список шаблонов см. в списке шаблонов. Конкретные примеры:
- Шаблон страницы — для написания статьи
Не мудрите и не щеголяйте. Не всегда стилистические добавки и особое оформление, которые вы пишете, действительно отображаются так, как вы задумали. Статья также не должна быть мультимедийным зрелищем в техниколоре — это всё-таки энциклопедия. Хабадпедию легко показывать, а её статьи легко править и дополнять, пока мы не делаем язык разметки сложнее, чем нужно для того, чтобы представить информацию полезным и ясным образом. Отсюда следует, что добавлять HTML-код нужно скупо и по обоснованной причине. Помните, что цель — прежде всего полезная энциклопедия, а сразу после этого — лёгкая для правки и улучшения. Оформление и эффекты — лишь средства служения этой цели, и не более того.