Minecraft Wiki:Керівництво по стилю

Матеріал з Minecraft Wiki
Перейти до: навігація, пошук
Дане керівництво/даний посібник переписується.
На даний момент в ньому можуть міститися помилки.

У цьому документі розглядаються рекомендації та вказівки по стилю і оформлення статей Minecraft Wiki.

Введення

Метою цього керівництва є усунення можливих суперечностей в плані того, як повинні бути написані статті для Minecraft Wiki. Питання можуть виникнути як через нестачу інформації, так і через відсутність єдиної думки про те, яких правил дотримуватися. Крім того, це керівництво дає уявлення новачкам про те, як слід писати статті.

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

Перш ніж приступити до написання статті, слід з'ясувати, чи відповідає її предмет критеріям значущості. Якщо не відповідає, то або стаття не може бути написана, або варто додати вміст в іншу статтю, близьку по темі. Крім того, для статті необхідно вибрати назву, яка відповідає умовам найменування.

Текст статей

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

Текст статей слід писати в науковому стилі від третьої особи. При цьому слід уникати використання незрозумілою термінології без роз'яснення її значення (в цьому випадку корисний шаблон {{Спливаючий текст}}). З іншого боку, слід уникати жаргонних і просторічних виразів. У разі необхідності звернення до читачів (найчастіше в інструкціях) допустимо використовувати займенник «ви», а при доведенні тверджень можливе використання дієслів 1-ї особи множини (припустим і т.д.).

Вміст статті повинно якомога ширше охоплювати свою тему, відображаючи всі можливі нюанси обговорюваного предмета. З іншого боку, не повинно бути відхилень від теми. Вміст, що представляє собою повне керівництво, має бути виділено в окрему статтю (див. Minecraft Wiki:Значущість#Інші види статей).

Інформація повинна бути перевірюваної. Якщо мова йде не про тривіальний факт, який можна підтвердити всередині гри або програми, то слід виділити посилання на джерело факту за допомогою тегів <ref></ref>, а внизу статті створити розділ «Примітки» з використанням однойменного шаблону {{Примітки}}. Точно так же виділяються і власне вставні примітки до тексту статті. Кількість використовуваних в статті домислів і непідтверджених фактів повинно зводитися до мінімуму; при необхідності їх використання слід точно давати зрозуміти про те, що вони не підтверджені. Список офіційних джерел розташовується тут.

Не допускаються явні граматичні та орфографічні помилки в тексті. Див. також розділ Орфографія і граматика.

Історична інформація та очікувані зміни

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

Інформація, що стосується історії описуваного предмета статті, а так само актуальна тільки для попередніх версій гри, програми або модифікації, повинні поміщатися в спеціальний розділ «Історія» (див. Структура статей). Якщо предмет статті неактуальний як такої, то вгорі статті слід встановити шаблон {{Застаріле}}; стаття при цьому повинна відображати стан останньої версії, за якої предмет був актуальний. Неприпустимо змішання в одному місці інформації про різні версії, так як вона може відвернути або, що ще гірше, заплутати читача.

При випуску кожного нового повного оновлення слід приводити оновлення інформації. Шаблони, пов'язані з версіями, слід переставити або вилучити в залежності від результату поновлення, а застарілу інформацію (якщо така є) перенести в розділ «Історія».

Сторонній контент

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

Інформація про стороннє додатковому контенті модифікації (додаток к модифікації, створене автором або авторами, не пов'язаними з автором або авторами модифікації) може бути згадана в статтях модифікації тільки в рамках розділу «Додатковий контент», «Доповнення» або «Додатково». Правила для інших взаємодій однієї модифікації з властивостями елемента з іншого поки не встановлені.

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

На початку основних статей про стороннє контенті або статей, які представляють собою список стороннього контента, необхідно розміщувати шаблон {{Відмова від відповідальності}}. Шаблон {{Модифікація}} викликає шаблон {{Відмова від відповідальності}}, тому окремо прописувати шаблон для статей модифікацій не потрібно.

Оформлення статей

Статті повинні бути оформлені якісно, щоб підвищити їх читаність і поліпшити сприйняття.

Форматування і типографіка

Для виділення звичайного тексту слід використовувати курсивне накреслення. Напівжирним шрифтом слід виділяти тільки першу згадку назви описуваного терміну в статті. Комбінацію цих накреслень, а також нестандартні види регістра на кшталт MINECRAFT або MiNeCrAfT використовувати не можна. Слід звернути увагу, що абревіатури (наприклад БФНП) як раз потрібно писати великими літерами.

Ручне перевизначення кольору тексту допустимо тільки в наступних випадках:

  • В широко використовуваних шаблонах загального призначення, з метою колірного кодування елементів обмеженим безліччю неяскравих кольорів. приклади:
    • {{Переваги}} і {{Недоліки}} (використовуються для полегшення читачам переходу до ключової інформації);
    • {{Таблиця вибору}} (Використовується в таблицях, зазвичай сортируемих, щоб більш наочно відображати відмінності між різними об'єктами одного класу, наприклад в шаблоні {{Таблиця руйнування}});
  • з метою представлення використовується в грі колірного кодування на вікі. Приклади:
    • {{Слот}} (підказка може використовувати кольорове оформлення).

Виділення оригінальних іншомовних назв, в тому числі назв комп'ютерних ігор (включаючи Minecraft), курсивом обов'язково.

  • Якщо заголовок статті цілком є такою назвою, використовуйте шаблон {{Курсив}}.
  • При необхідності виділити курсивом тільки частину заголовка, використовуйте ключове слово {{DISPLAYTITLE}}, наприклад {{DISPLAYTITLE:Книги про ''Minecraft''}}.

Рекомендується використання в тексті топографічних символів:

  • В якості лапок рекомендується використовувати символи « і » (&laquo; и &raquo;), а для внутрішніх лапок — символи и (&bdquo; і &rdquo;). Машинописні лапки " слід використовувати в програмному коді.
  • Для символу апострофа (використовується в іншомовних назвах) рекомендується використовувати символ (&rsquo;). Машинописні апостроф ' крім застосувань в програмуванні використовується в вікі-коді для форматування.
  • Рекомендується використовувати символ довгого тире (&mdash;). Перед ним бажано використовувати замість звичайного пробілу нерозривний пробіл   (&nbsp;).

Розділи статті починаються з заголовків 2-го рівня (== Заголовок ==). Рівні заголовків розділів визначаються кількістю символів «дорівнює» з кожного боку назви розділу. Слід збільшувати рівень заголовка разом з глибиною розділу. Тема 1-го рівня (= Заголовок =) автоматично додається програмним забезпеченням сайту в якості заголовка всієї статті; додавати такі заголовки вручну не слід.

Для маркованих і нумерованих списків, а також таблиць слід по можливості використовувати вікі-код, а не HTML-розмітку. Елементи одного і того ж списку не повинні відбиватися друг від друга порожніми рядками.

Для дат в тексті слід використовувати формат ДД ммм РРРР [р.] (наприклад 18 березня 2010, 4 листопада 2017 р.) Використовувати фрагмент «р.» не обов'язково, але рекомендується. Для дат в сортируемих таблицях слід використовувати формат РРРР-ММ-ДД (наприклад, 2010-03-18, 2017-11-04), причому для дня і місяця обов'язково слід використовувати по дві цифри — це полегшить сортування таблиць по датах.

Орфографія і граматика

При написанні варто слідувати всім нормам і правилам української мови. Орфографічні і граматичні помилки вкрай небажані, оскільки можуть створити враження непрофесійно або недостовірно написаного тексту.

Назви об'єктів гри або її модифікацій (блоків, предметів, мобів, біомов, будівель та природних утворень), які не є власними іменами, обов'язково повинні писатися відповідно до правил, прийнятих для імен загальних (пісковик, пекельна зірка, лусківниця, їдальня гора, місто Краю, ущелина). Іменами власними є назви вимірювань (Звичайний світ, Нижній світ, Край; те ж саме відноситься до вимірювань з модифікацій). В оригінальній локалізації гри (en-US, американський англійський), як правило, для назв використовується регістр, де кожне слово починається з великої літери, незалежно від того, власна назва чи це чи ні (наприклад, End Stone, Wither Skeleton) — в українській мові таке не прийнято (зазначені приклади перекладаються як камінь Краю, скелет-висушувач).

Назви чар, ефектів, режимів гри завжди пишуться в лапках з великої літери і в називному відмінку (чар «Гострота IV», в режимі «Творчість», від ефекту «Регенерація»). Назви етапів розробки гри (крім офіційного релізу гри), такі як Indev, Alpha, Beta, пишуться також з великої літери і не переводяться на українську мову.

Окремі слова, пов'язані з тематикою Minecraft, вимагають особливої уваги при написанні:

  • крафт (не «крафтинг»);
  • спавн (не «спаун»; те ж саме відноситься до похідного слова спавнер);
  • чари (не «зачарування»);
  • модифікація (не «мод»);
  • доповнення (не «аддон», є транслітерацією англійського слова add-on).

Посилання

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

  • Кількість посилань не повинно становити більше 10% від всього тексту статті.
  • Слід уникати розміщення посилань на різні статті поруч один з одним таким чином, що зовні вони виглядають як одне посилання, якщо це не погіршить сприйняття тексту.
  • Слід уникати зайвих посилань на одну і ту ж статтю, так як це може, по-перше, відволікти читача, а по-друге, викликати помилкове враження того, що це посилання на різні статті. Між посиланнями на одну і ту ж статтю слід витримувати відстань, але не занадто велике. Рекомендується залишати по одному посиланню на одну і ту ж статтю на один або невелику кількість розділів, якщо вони маленькі, щоб читачі, що потрапили через посилання з інших статей на конкретні розділи, змогли не витрачати час на пошук посилань на термін.
  • Слід при можливості використовувати скорочений синтаксис посилань з дописуванням закінчення відразу після закриваючих дужок ([[вовк]]ів вместо [[Вовк|вовків]]). Якщо використовувана в тексті форма терміна, для якого є стаття, збігається з формою його називного відмінка (наприклад, не вистачає зілля — форма родового відмінка збігається з формою називного відмінка), то зайве перевизначення тексту посилання (не вистачає [[зілля|зілля]]) делать не стоит.
  • Для посилання на статті про елементи модифікацій існує особливий шаблон {{Коротке посилання}}, за варіантами використання схожий зі звичайними посиланнями (зокрема, він також підтримує дописування закінчення). Наприклад: {{с|діамант|gt}}иШаблон:Си.
  • Припустимо посилатися на перенаправлення ([[цегляна плита]], при цьому сторінка Цегляна плита перенаправляє на статтю Плита), якщо тільки не використовується синтаксис зміни тексту посилання ([[стаття|текст]]) і якщо посилання розміщується не на шаблоні або інший включається на сторінці. З іншого боку, не слід забувати про те, що при наведенні курсору миші (для комп'ютерів) на посилання відображається спливаючий текст з назвою статті, що корисно, наприклад, при розшифрування абревіатур; в цьому випадку переважно посилатися прямо на статтю, а не створювати перенаправлення (наприклад, {{с|універсальна рідинна капсула|ic2|УРК}}Шаблон:С). Зворотне, втім, інколи теж вірно — так, сторінка IndustrialCraft 2/Попіл перенаправляє на окремий розділ статті IndustrialCraft 2/Твердопаливний теплогенератор, однак краще (і простіше) при згадці попелу посилатися саме на попіл, хоча особливості відмінювання цього слова не дозволяють використовувати простий синтаксис дописування закінчення ({{с|попіл|ic2|піпла}}Шаблон:С).

Ілюстрації, схеми і відеофайли

Завданням ілюстрацій (зображень) є візуальне доповнення того, що сказано в тексті.

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

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

Зображення, що показують застарілий вміст, повинні бути або оновлені, або поміщені в підрозділ галереї «Історія» (див. Галерея), або вилучені.

Для відображення схематичних зображень з блоків, схем з червоного каменю чи інших схематичних зображень рекомендується при можливості не завантажувати нові файли, а використовувати шаблони {{Схема}}, {{БлокСітка}}, {{Багатошарова схема}} і їм подібні.

Використання відеофайлів регулюється особливими правилами.

Цитати

Цитати використовуються для прямої вставки в текст статті тексту з стороннього джерела із зазначенням останнього. Вказівка ​​джерела і виділення цитованого тексту необхідно, щоб не порушували можливі авторські права на нього. Цитування слід використовувати тоді, коли по-іншому передати подібний текст не можна.

Для вставки цитат використовується шаблон {{Цитата}}. Можливе додавання зображення джерела (фотографію людини, аватарку співробітника Mojang AB, емблему організації) зліва від тексту цитати. Вставка оригіналу цитати (якщо вона на іноземній мові) на даний момент шаблоном не підтримується.

Обсяг цитат не повинен перевищувати однієї третини від усього обсягу тексту.

Інше

Якщо існує необхідність додавання вмісту, який мав би бути показано відразу при відкритті сторінки, але яке може бути відображено пізніше, то такий вміст має бути вміщено в розкривну таблицю (CSS-клас collapsible collapsed) або розкривний контейнер, такий як шаблон {{Спойлер}}. Якщо таблиця повинна мати можливість розкриття і приховування, але вміст має бути показано відразу, то для неї слід використовувати клас collapsible, без collapsed.

Структура статей

Ці вимоги покликані впорядкувати поділ статей на розділи. Залежно від характеру статей їх структура буває різною, але в той же час є розділи, загальні для всіх сторінок.

Введення статті

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

Відро — інструмент, використовуваний для збіру, перенесення та встановлення рідин.

При вказівці походження терміна або оригінальної назви його слід вказати в дужках (саме оригінальна назва має при цьому бути виділено курсивом): крафт (від англ. craft — ремесло).

Не можна допускати накопичення інформації. Часта помилка при написанні безлічі статей — розміщення основної інформації виключно в введенні, без створення окремих розділів. Не слід забувати про те, що введення повинно узагальнювати написане в статті. Також поширене вказування історичної інформації в введенні, що неприпустимо з причин, вказаних в розділі Історична інформація та очікувані зміни.

Розглянемо, наприклад, демонстраційну ситуацію. На зеленому фоні — термінологічні, орфографічні, пунктуаційні і граматичні помилки, на рожевому — історічна інформація, а на жовтому — зайва інформація.

Блок трави - один з перших в грі блоків. Початково блок трави з'являється на верхньому шарі землі.
У Indev блок трави гинув, якщо над нею розташовувався будь-який непрозорий блок або рідина. З Beta, завдяки динамічному освітленню, блок трави може рости в часткової темряві. За фізичними властивостями ідентична землі, видобуток трави також призводить до випадання блоку землі. Блок трави росте не тільки при сонячному світлі, але і при світлі факелів, що дозволяє «провести» її в будь-який уютненькое подземельіце. Для зростання потрібно рівень світла не менше 4. Дерн може бути видобутий інструментом з зачаруванням Шовковий дотик і установлена в Нижньому світі.
Після Halloween Update, при додаванні біомів, дерн став мати різний колір в різних біомам. При цьому тільки верхня сторона мала колір біома, колір трави же на боках блоку залишався соковито зеленим. Це було виправлено в оновленні Beta 1.5 (проте на низьких налаштуваннях графіки це до сих пір не виправлено), також в цьому оновленні змінився колір трави на більш реалістичний і красивий.

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

Блок трави — один з перших в грі блоків, генерований в якості верхнього шару землі.

З іншого боку, зворотне теж неприпустимо. Розвиваючи приклад вище, слід зазначити, що введення у вигляді «Блок трави — це блок» також не підходить, оскільки не вказує основне значення предмета статті.

Перед текстом введення розмічаються різні шаблони в наступному порядку:

Види статей

Для окремих видів статей є особливі вимоги щодо вмісту та членування на розділи. Деякі з них вказані в окремих сторінках, інтегрованих з керівництвом по стилю.

Сторінки вирішення неоднозначності

Особливий рід сторінок складають сторінки дозволу неоднозначності. Вони використовуються вказівки всіх значень певного слова, а також для навігації між відповідними статтями.

У таких статтях введення вказує на те, що термін має ті чи інші значення. Деякі значення зводяться до загальних понять (наприклад, діамант), тоді це загальне значення може вказуватися. Якщо груп значень кілька, допустимо виділяти для кожної окремий розділ.

Значення перераховуються в маркованих списках. Якщо є стаття, яка пояснює те чи інше значення, то посилання на неї обов'язкове.

Сторінки вирішення неоднозначності повинні бути позначені в укладення шаблоном {{Неоднозначність}}.

Основні розділи

В основних розділах вказується опис предмета статті.

Значна частина розділів специфічна для певного виду статей. Для повного їхнього списку див. Види статей.

Галерея

Галерея містить зображення, пов'язані з темою статті, але не розташовані в інших її розділах.

Для створення галереї необхідно використовувати тег gallery:

<gallery>
Зображення 1.png|Зображення 1
Зображення 2.png|Зображення 2
</gallery>

Якщо галерея складається переважно з скріншотів (найбільш типовий випадок) чи інших файлів з співвідношенням сторін, далеким від квадратного (найчастіше 16:9 або 4:3), то для поліпшення читаності слід використовувати галереї з режимом packed (mode="packed"):

<gallery mode="packed">
Зображення 1.png|Зображення 1
Зображення 2.png|Зображення 2
</gallery>

Перед розміщенням зображень в галереях необхідно ознайомитися з становищем про ілюстрації.

Цікаві факти

У розділі «Цікаві факти» містяться відомості, які не входять в рамки інших розділів.

  • У розділі не повинні бути присутніми домисли або чиїсь думки.
  • Факти повинні бути саме цікавими — вони повинні надавати інформацію, яка читачам мало відома, але може викликати у них інтерес. Занадто очевидні факти не допускаються.
  • Історичні факти не допускаються (вони повинні розміщуватися в розділі «Історія», якщо такий існує).
  • Факти про зовнішній вигляд елемента гри або модифікації вказувати не рекомендується. Якщо вони не відносяться до того пакету ресурсів, який використовується в грі або модифікації за замовчуванням, то приводити їх взагалі неприпустимо.

Висновок

У висновку розміщуються посилання на інші статті, близькі по темі, примітки, категорії і посилання на аналогічні статті в інших мовних розділах (інтервікі).

Посилання на близькі по темі статті наводяться в розділі «Див. також». Наприклад, якщо мова йде про стіни з кругляку, то в цьому розділі можна навести посилання на статтю про функціонально близькій паркану.

Після розділу «Див. також» (якщо він існує) розміщується розділ «Примітки». Тут міститься шаблон {{Примітки}}, який відображає всі виноски на статті. За допомогою параметрів можна розташувати виноски в кілька колонок ({{Примітки|2}}, {{Примітки|3}} і т.д.). Розділ «Примітки», якщо він існує, повинен бути останнім у статті.

Після всіх розділів розташовуються в наступному порядку:

  • навігаційні шаблони;
  • категорії (наприклад, [[Категория:Тверді блоки]]);
  • посилання на статті в інших розділах (інтервікі-посилання), такі як [[en:Chicken]] або [[de:Huhn]]. Вони будуть додані на бічну панель зліва. Рекомендується розміщувати інтервікі в алфавітному порядку за кодами мов.