Перейти до вмісту

Хабадпедія:Посібник з оформлення сторінок

Матеріал з Хабадпедії
Зміст і стиль викладу

Посібник з оформлення сторінок має ясну і просту мету — досягти одноманітності оформлення статей Хабадпедії; це посібник зі стилю. Іноді один спосіб кращий за інший, але бажано, щоб усі статті були впорядковані й однакові за оформленням, наскільки це можливо, щоб вони були зрозумілими і зручними для перегляду, читання і редагування. Цей посібник зосереджений на структурі статті. Інформацію про написання змісту статті див. Хабадпедія:Посібник з написання статей. Для тих, хто хоче знати, як оформлення виконується на практиці, існує посібник з редагування сторінок, з якого ви дізнаєтеся, як виділяти, позначати, додавати посилання тощо. Посібник, який ви зараз читаєте, займається головним чином питанням коли — у яких випадках і заради якого стилю варто ними користуватися.

Перш ніж вкладати сили в написання статті, бажано перевірити, чи заслуговує тема взагалі на енциклопедичну статтю, чи ж вона неприйнятна в Хабадпедії. Слід нагадати новим учасникам, що ясний, інформативний, нейтральний, оригінальний і корисний виклад завжди буде важливішим за зовнішній вигляд і формат. Оскільки ми пишемо івритом, правила, що стосуються лише цієї мови, сформульовано в Хабадпедія:Мова.

Крім теоретичного читання тут, можна брати приклад зі статей, оформлення яких вам сподобалося. Візьміть статтю і докладно вивчіть, як вона побудована і написана, відкривши її для редагування (натиснувши на вкладку «Редагувати код» угорі статті). Наприкінці ви можете закрити її, нічого не змінивши, але будь-яку статтю можна поліпшити, і ми будемо раді, якщо ви це зробите.

Загальна структура статей

Вступ статті

Вказівка Пояснення Приклади
Визначення теми Стаття повинна починатися з ясного, короткого і чіткого визначення, що добре описує тему, і дуже загального, приблизного підсумку її основного змісту.
Дуже бажано, щоб назва статті була частиною першого речення, бажано на його початку.
Бажаний обсяг вступного розділу — зазвичай 2-4 абзаци.
Краще уникати заголовка «Вступ» як першого заголовка, оскільки вступ має стояти на початку статті ще до нього. Інша назва для першої частини статті, що йде після вступу, — «Загальний огляд», але краще дібрати конкретніше формулювання заголовка (якщо зміст це дозволяє).
  • Код: '''Вино''' — напій, що виготовляється з плодів [[виноградної лози]], які належать до [[семи видів]], якими славиться [[Ерец-Ісраель]].
  • Результат: Вино — напій, що виготовляється з плодів виноградної лози, які належать до семи видів, якими славиться Ерец-Ісраель.
Виділення термінів Назва/тема кожної статті має бути виділена жирним при першій її появі в статті. Якщо тема статті має більше однієї назви, вкажіть їх усі в першому абзаці статті і виділіть основні з них.
  • Код: '''Рав Йосеф-Іцхак Опен''' (прізвисько: '''Піче'''...
  • Результат: Рав Йосеф-Іцхак Опен (прізвисько: Піче...
Прояснення контексту Бажано також уже в першому рядку пояснити контекст теми статті (якщо він недостатньо ясний). Якщо стаття присвячена темі з якогось вигаданого світу — наприклад, персонажу, місцю, поняттю тощо, джерелу поняття і тому подібному, — це слід явно вказати на початку статті, включно з джерелом терміна.
  • Код: '''Гама''', у [[музиці]], — це...
  • Результат: Гама, у музиці, — це...

Основна частина статті

Вказівка Пояснення Приклади

Зміст

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

Приклад коду для виноски:

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

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

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

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

Поділ на підзаголовки Кількість знаків рівності (однакова з обох боків заголовка) визначає розмір заголовка і рівень підзаголовка.
Використовуйте заголовок рівня 2 для найбільших заголовків (уникайте заголовка рівня 1)
Використовуйте заголовки рівня 3 для підтем, а заголовки рівня 4 — для найдрібніших заголовків, для підрозділів підтем або особливих частин.
Коли кожен розділ самостійний, читачі, яких цікавить головним чином певний аспект, можуть перейти до відповідного розділу.
Приклад коду:

== Головний заголовок== === Другорядний заголовок ===

Уникайте надмірного дроблення

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

Можна використовувати пункти (маркований список, за допомогою зірочки (*)) або напівжирний текст (за допомогою апострофа (')). Додаткова перевага такої розмітки в тому, що після неї не потрібно робити відступ (пропускати два рядки). Система сама відокремлює заголовок від тексту.
Уникайте посилань у заголовках Слід уникати перетворення заголовків абзаців і розділів (або їхніх частин) на посилання, оскільки це спричиняє плутанину. Краще помістити відповідні посилання в одне з перших речень під заголовком.
Використовуйте посилання на основні статті і уникайте переліку необов'язкових подробиць, які можуть увійти до дочірніх статей.

Внутрішні посилання

Включення внутрішніх посилань

До тексту слід включати відсилання до інших пов'язаних статей — так звані «внутрішні посилання», тобто слово (або послідовність слів) у тексті, яке є посиланням на іншу статтю.

Посилання слід використовувати для терміна, поняття, часу, місця, людини, предмета тощо, які згадуються в статті і самі по собі заслуговують на статтю (існує вона чи ні), і можуть розширити й поглибити знання за межі змісту самої статті.
Посилання, що відповідають правилам іменування в Хабадпедії, найімовірніше, приведуть до наявних статей, а якщо ні — полегшать написання нових статей під «правильною» назвою.
Посилання мають бути точними. Іноді шукана стаття знаходиться під назвою, дещо відмінною від очікуваної, тому варто перевіряти кожне посилання, яке додаєте, і переконуватися, що воно справді веде на потрібну статтю.
Посилання створюється за допомогою пари квадратних дужок з кожного боку слова: наприклад, [[Шедім і духи]].
Уникайте надлишку посилань Не перетворюйте на посилання кожну появу слова — досить позначити його першу появу.

Питання про те, коли перетворювати слово на посилання, а коли цього не робити, непросте, як пояснює такий приклад: слово «місто» тривіальне, усі читачі його добре розуміють, і тому виникає питання, коли доречно робити його посиланням, а коли це буде посилання, на яке читачі не відчують потреби натиснути.

  • У статті про письменника Моше Когена сказано, що він «переїхав жити до міста Арад». У цьому контексті ясно, що немає сенсу ставити посилання на слово «місто», оскільки посилання не додасть суттєвої інформації для розуміння статті про Моше Когена.
  • У статті про якесь місто доречно поставити посилання на статтю, що роз'яснює поняття «місто», точно так само, як у статті про кібуц доречно поставити посилання на статтю, що роз'яснює поняття «кібуц».
Зрозумілі посилання Можна робити посиланнями слова, що не збігаються точно з назвою статті, на яку треба послатися, як докладно описано на сторінці Довідка:Посилання. Водночас слід переконатися, що зрозуміло, куди веде посилання, без потреби переходити за ним. У випадках форми множини, додавання означеного артикля «ה», службових літер-префіксів або будь-якої іншої літери, яка не є частиною самого слова, можна позначити лише потрібну частину слова замість того, щоб позначати його цілком. Так легше читати, розуміти і друкувати.
Не слід використовувати «натисніть тут» як слово-посилання, оскільки воно не несе інформації.
Слід робити посиланнями лише слова, які вже є в тексті, або постаратися вписати посилання в хід тексту (чи додати до статті, без натяжки, текст, який дозволить вставити посилання). Якщо ні — можна помістити посилання наприкінці статті, у розділі «Див. також». У будь-якому разі назва посилання має вказувати тему, на яку воно веде.
Можна робити посиланнями слова, що не збігаються точно з назвою статті, на яку треба послатися:
[[назва статті, на яку веде посилання|слово-посилання]]

«Див. також» і «Література»

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

Див. також

Посилання в розділі «Див. також» Розділ «Див. також» призначений для того, щоб спрямувати читачів до пов'язаних статей, що містять передісторію або додаткові відомості, які допомагають зрозуміти тему поточної статті.
Як правило, маються на увазі статті, ще не згадані серед посилань у тілі статті, а іноді й уже згадані, але центральні й важливі для того, щоб їх виділити, оскільки без їх прочитання розуміння теми може виявитися неповним, або їхня попередня згадка в статті була надто побіжною порівняно з їхньою важливістю.
Зазвичай немає потреби включати в цей розділ статті, що входять до категорії, до якої належить стаття, оскільки віднесення до категорії досить для досягнення мети розділу «Див. також». Коли категорія велика і хочеться звернути увагу читача на небагато статей з неї, їх можна включити і в «Див. також».
Розділ «Див. також» оформлюється у вигляді списку, і статті перелічуються в ньому маркованим списком — кожне посилання на статтю в окремому рядку.

== Див. також ==
* [[Дивіться]]
* [[Погляньте]]
* [[Узріть]]

Додаткова література

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

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

Зовнішні посилання

Посилання на сайти Бувають випадки, коли доречно додати докладнішу інформацію, або інформацію на вужчу тему, або невербальний зміст (зображення, дані, графіки тощо), джерело якого — інтернет. Це особливо важливо, коли вебсайт є основним джерелом інформації. Розділ «Зовнішні посилання» ставиться наприкінці статті, після розділу «Література». Спосіб оформлення посилання в Хабадпедії пояснюється на сторінці Хабадпедія:Зовнішні посилання.
Використовуйте шаблони зовнішніх посилань для збереження одноманітного вигляду зовнішніх посилань

Віднесення до категорій і навігаційних шаблонів

Див.: Хабадпедія:Категорія, а також Хабадпедія:Шаблони

Особливий текст

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

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

Під час зазначення дат слід використовувати певний формат, як описано на сторінці Хабадпедія:Дати. Те саме стосується чисел. Як правило, числа до десяти або будь-яке число на початку слова слід писати словами, а не цифрами. Не слід використовувати знак %, а лише слово «відсотків».

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

Шаблони

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

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

Повідомити про помилку на цій сторінці