Перейти к содержанию

Хабадпедия:Руководство по оформлению страниц

Материал из Хабадпедии
Содержание и стиль изложения

У руководства по оформлению страниц ясная и простая цель — добиться единообразия оформления статей Хабадпедии; это руководство по стилю. Иногда один способ лучше другого, но предпочтительно, чтобы все статьи были упорядочены и единообразны в оформлении, насколько это возможно, чтобы они были понятны и удобны для просмотра, чтения и редактирования. Это руководство сосредоточено на структуре статьи. Информацию о написании содержания статьи см. Хабадпедия:Руководство по написанию статей. Для тех, кто хочет знать, как оформление выполняется на практике, существует руководство по редактированию страниц, из которого вы узнаете, как выделять, отмечать, добавлять ссылки и прочее. Руководство, которое вы сейчас читаете, занимается главным образом вопросом когда — в каких случаях и ради какого стиля стоит ими пользоваться.

Прежде чем вкладывать силы в написание статьи, желательно проверить, заслуживает ли тема вообще энциклопедической статьи или же она неприемлема в Хабадпедии. Следует напомнить новым участникам, что ясное, информативное, нейтральное, оригинальное и полезное изложение всегда будет важнее внешнего вида и формата. Поскольку мы пишем на иврите, правила, относящиеся только к этому языку, сформулированы в Хабадпедия:Язык.

Помимо теоретического чтения здесь, можно брать пример со статей, оформление которых вам понравилось. Возьмите статью и подробно изучите, как она построена и написана, открыв её для редактирования (нажав на вкладку «Править код» вверху статьи). В конце вы можете закрыть её, ничего не изменив, но любую статью можно улучшить, и мы будем рады, если вы это сделаете.

Общая структура статей

Введение статьи

Указание Пояснение Примеры
Определение темы Статья должна начинаться с ясного, краткого и чёткого определения, хорошо описывающего тему, и очень общего, приблизительного резюме её основного содержания.
Очень желательно, чтобы название статьи было частью первого предложения, предпочтительно в его начале.
Желательный объём вводного раздела — обычно 2-4 абзаца.
Лучше избегать заголовка «Введение» в качестве первого заголовка, поскольку введение должно стоять в начале статьи ещё до него. Другое название для первой части статьи, идущей после введения, — «Общий обзор», но лучше подобрать более конкретную формулировку заголовка (если содержание это позволяет).
  • Код: '''Вино''' — напиток, изготавливаемый из плодов [[виноградной лозы]], которые относятся к [[семи видам]], которыми славится [[Эрец-Исраэль]].
  • Результат: Вино — напиток, изготавливаемый из плодов виноградной лозы, которые относятся к семи видам, которыми славится Эрец-Исраэль.
Выделение терминов Название/тема каждой статьи должно быть выделено жирным при первом его появлении в статье. Если у темы статьи более одного названия, укажите все их в первом абзаце статьи и выделите основные из них.
  • Код: '''Рав Йосеф-Ицхак Опен''' (прозвище: '''Пиче'''...
  • Результат: Рав Йосеф-Ицхак Опен (прозвище: Пиче...
Прояснение контекста Желательно также уже в первой строке пояснить контекст темы статьи (если он недостаточно ясен). Если статья посвящена теме из какого-либо вымышленного мира — например, персонажу, месту, понятию и т. п., источнику понятия и тому подобному, — это следует явно указать в начале статьи, включая источник термина.
  • Код: '''Гамма''', в [[музыке]], — это...
  • Результат: Гамма, в музыке, — это...

Основная часть статьи

Указание Пояснение Примеры

Содержание

Деление на короткие абзацы Желательно делать абзацы короткими, поскольку глаз утомляется после долгого чтения сплошного текста. По похожей причине статью следует разрежать — пустая строка между абзацами, между заголовком и абзацем и так далее. Вики-синтаксис для создания абзаца: пустая строка между двумя абзацами.
Ссылки на источники Важно включать ссылки на внешние источники с помощью сносок, подтверждающих достоверность излагаемых фактов. См.: Справка:Сноски
Можно включать немного цитат, но полные или менее существенные цитаты желательно давать ссылкой из статьи.

Пример кода для сноски:

{{הערה|שם המקור}}
Включение фотографий и иллюстраций Желательно, чтобы статья включала фотографии, иллюстрации и графические пособия рядом с абзацами, обычно слева от текста.
Предпочитайте свободные изображения изображениям добросовестного использования.
Избегайте визуальной перегрузки; предпочитайте ссылку на галерею размещению множества изображений.
Доступность статьи для людей с ограниченными возможностями: к изображению желательно добавлять подпись (описание), даже если изображение понятно или содержит собственное пояснение и подпись, ради доступности для инвалидов и людей с ограниченными возможностями.

Заголовки статьи

Деление на заголовки Заголовки помогают сделать статью яснее и упорядоченнее, разделяя её на подтемы, а также делают её удобной для использования и навигации через оглавление (которое создаётся и отображается автоматически). Словам, находящимся в заголовках разделов статьи, придаётся больший вес при выполнении поиска по энциклопедии. Пример кода:

== Заголовок ==

Разделение на подзаголовки Количество знаков равенства (одинаковое с обеих сторон заголовка) определяет размер заголовка и уровень подзаголовка.
Используйте заголовок уровня 2 для самых крупных заголовков (избегайте заголовка уровня 1)
Используйте заголовки уровня 3 для подтем, а заголовки уровня 4 — для самых мелких заголовков, для подразделов подтем или особых частей.
Когда каждый раздел самостоятелен, читатели, которых интересует главным образом определённый аспект, могут перейти к соответствующему разделу.
Пример кода:

== Главный заголовок== === Второстепенный заголовок ===

Избегайте чрезмерного дробления

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

Можно использовать пункты (маркированный список, с помощью звёздочки (*)) или полужирный текст (с помощью апострофа (')). Дополнительное преимущество такой разметки в том, что после неё не нужно делать отступ (пропускать две строки). Система сама отделяет заголовок от текста.
Избегайте ссылок в заголовках Следует избегать превращения заголовков абзацев и разделов (или их частей) в ссылки, поскольку это вызывает путаницу. Лучше поместить соответствующие ссылки в одно из первых предложений под заголовком.
Используйте ссылки на основные статьи и избегайте перечисления необязательных подробностей, которые могут войти в дочерние статьи.

Внутренние ссылки

Включение внутренних ссылок

В текст следует включать отсылки к другим связанным статьям — так называемые «внутренние ссылки», то есть слово (или последовательность слов) в тексте, являющееся ссылкой на другую статью.

Ссылки следует использовать для термина, понятия, времени, места, человека, предмета и т. д., которые упоминаются в статье и сами по себе заслуживают статьи (существует она или нет), и могут расширить и углубить знания за пределы содержания самой статьи.
Ссылки, соответствующие правилам именования в Хабадпедии, скорее всего, приведут к существующим статьям, а если нет — облегчат написание новых статей под «правильным» названием.
Ссылки должны быть точными. Иногда искомая статья находится под названием, несколько отличающимся от ожидаемого, поэтому стоит проверять каждую добавляемую ссылку и убеждаться, что она действительно ведёт на нужную статью.
Ссылка создаётся с помощью пары квадратных скобок с каждой стороны слова: например, [[Шедим и духи]].
Избегайте избытка ссылок Не превращайте в ссылку каждое появление слова — достаточно отметить его первое появление.

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

  • В статье о писателе Моше Коэне сказано, что он «переехал жить в город Арад». В этом контексте ясно, что нет смысла ставить ссылку на слово «город», так как ссылка не добавит существенной информации для понимания статьи о Моше Коэне.
  • В статье о каком-либо городе уместно поставить ссылку на статью, разъясняющую понятие «город», точно так же, как в статье о кибуце уместно поставить ссылку на статью, разъясняющую понятие «кибуц».
Понятные ссылки Можно делать ссылками слова, не совпадающие в точности с названием статьи, на которую нужно сослаться, как подробно описано на странице Справка:Ссылки. Вместе с тем следует убедиться, что понятно, куда ведёт ссылка, без необходимости переходить по ней. В случаях формы множественного числа, добавления определённого артикля «ה», служебных букв-приставок или любой другой буквы, которая не является частью самого слова, можно отметить только нужную часть слова вместо того, чтобы отмечать его целиком. Так легче читать, понимать и печатать.
Не следует использовать «нажмите здесь» в качестве слова-ссылки, поскольку оно не несёт информации.
Следует делать ссылками только слова, которые уже есть в тексте, или постараться вписать ссылку в ход текста (либо добавить в статью, без натяжки, текст, который позволит вставить ссылку). Если нет — можно поместить ссылку в конце статьи, в разделе «См. также». В любом случае название ссылки должно указывать тему, на которую она ведёт.
Можно делать ссылками слова, не совпадающие в точности с названием статьи, на которую нужно сослаться:
[[название статьи, на которую ведёт ссылка|слово-ссылка]]

«См. также» и «Литература»

Указание Пояснение Примеры
Расположение дополнительных разделов Заголовок раздела «См. также» ставится перед разделом «Литература» и разделом «Внешние ссылки».

См. также

Ссылки в разделе «См. также» Раздел «См. также» предназначен для того, чтобы направить читателей к связанным статьям, содержащим предысторию или дополнительные сведения, которые помогают понять тему текущей статьи.
Как правило, имеются в виду статьи, ещё не упомянутые среди ссылок в теле статьи, а иногда и уже упомянутые, но центральные и важные для того, чтобы их выделить, поскольку без их прочтения понимание темы может оказаться неполным, или их предыдущее упоминание в статье было слишком мимолётным по сравнению с их важностью.
Обычно нет необходимости включать в этот раздел статьи, входящие в категорию, к которой относится статья, поскольку отнесения к категории достаточно для достижения цели раздела «См. также». Когда категория большая и хочется обратить внимание читателя на немногие статьи из неё, их можно включить и в «См. также».
Раздел «См. также» оформляется в виде списка, и статьи перечисляются в нём маркированным списком — каждая ссылка на статью на отдельной строке.

== См. также ==
* [[Смотрите]]
* [[Взгляните]]
* [[Узрите]]

Литература

Ссылки на литературу Помимо интернет-ссылок, можно указать физические, не сетевые (не в интернете) источники информации, которые могут её дополнить (библиография): соответствующую книгу или статью. Большая часть информации в наши дни всё ещё находится в книгах, и желательно ссылаться на них.

Кроме того, желательно указывать «ссылки на источники» — если в статье есть конкретная отсылка к внешнему источнику или цитата из него. Например, если в статье упоминается некая статья, стоит сослаться на саму статью согласно Хабадпедия:Библиография.

Внешние ссылки

Ссылки на сайты Бывают случаи, когда уместно добавить более подробную информацию, или информацию по более узкой теме, или невербальное содержание (изображения, данные, графики и т. п.), источник которого — интернет. Это особенно важно, когда веб-сайт служит основным источником информации. Раздел «Внешние ссылки» ставится в конце статьи, после раздела «Литература». Способ оформления ссылки в Хабадпедии объясняется на странице Хабадпедия:Внешние ссылки.
Используйте шаблоны внешних ссылок для сохранения единообразного вида внешних ссылок

Отнесение к категориям и навигационным шаблонам

См.: Хабадпедия:Категория, а также Хабадпедия:Шаблоны

Особый текст

Когда в предложении речь идёт о каком-либо термине и он используется не обычным образом или не в обычном значении, его следует выделять двойными кавычками (") или полужирным шрифтом. В иврите курсив не используется (Italic. Например:

В статью можно добавить раздел цитат, относящихся к теме. Цитата помещается в кавычки, а если она длиннее одного-двух предложений — в абзац с отступом. Подробнее см. на странице Хабадпедия:Цитирование. (Правила оформления названий книг и статей см. на странице Хабадпедия:Библиография.)

При указании дат следует использовать определённый формат, как описано на странице Хабадпедия:Даты. То же касается чисел. Как правило, числа до десяти или любое число в начале слова следует писать словами, а не цифрами. Не следует использовать знак %, а только слово «процентов».

Важно помнить, что строка, начинающаяся с символа пробела без продолжения, будет пустой строкой в тексте. Абзац текста, начинающийся с пробела, будет оформлен моноширинным шрифтом и не будет переноситься на следующую строку. Такая строка расширяет всю страницу и нарушает последовательность чтения статьи, поэтому важно следить за тем, чтобы обычный абзац текста не начинался с пробела.

Шаблоны

Есть также готовые шаблоны, которые повторяются в Хабадпедии и способствуют сохранению единообразия; их можно копировать для более быстрой работы, и в любом случае желательно использовать формат, который они задают. Полный список шаблонов см. в списке шаблонов. Конкретные примеры:

Не мудрите и не щеголяйте. Не всегда стилистические добавки и особое оформление, которые вы пишете, действительно отображаются так, как вы задумали. Статья также не должна быть мультимедийным зрелищем в техниколоре — это всё-таки энциклопедия. Хабадпедию легко показывать, а её статьи легко править и дополнять, пока мы не делаем язык разметки сложнее, чем нужно для того, чтобы представить информацию полезным и ясным образом. Отсюда следует, что добавлять HTML-код нужно скупо и по обоснованной причине. Помните, что цель — прежде всего полезная энциклопедия, а сразу после этого — лёгкая для правки и улучшения. Оформление и эффекты — лишь средства служения этой цели, и не более того.

Сообщить об ошибке на этой странице