Ганджавики:Оформление статей

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

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

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

Структура статьи

Исходный текст любой статьи Ганджавики можно разделить на ряд самостоятельных блоков, следующих в определённом порядке. Некоторые из них могут присутствовать не во всех статьях.

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

Оформлению основной части статьи посвящена большая часть этого руководства (см. ниже).

2. «См. также» (список дополнительных внутренних ссылок)

В указанный раздел могут быть включены ссылки на статьи Ганджавики, тематически связанные с данной статьёй; данный раздел не является обязательным.

3. «Примечания»

При наличии сносок в основном тексте они должны отображаться в разделе «Примечания».

Подробнее по этой теме см.: Ганджавики:Сноски

4. «Ссылки» (список дополнительных внешних ссылок)

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

Подробнее по этой теме см.: Ганджавики:Внешние ссылки
Примечание. Вышеуказанный порядок служебных разделов («См. также» — «Примечания» — «Ссылки») является рекомендуемым.

5. Стандартные шаблонные пометки

После обязательной информационной части статьи и ссылок следует необязательный блок шаблонных пометок.

• горизонтальные навигационные шаблоны.

6. Категории

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

Подробнее по этой теме см.: Категоризация

Основной текст статьи

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

Механизм Wiki обеспечивает автоматическую вёрстку строк, выравнивая текст на странице в соответствии с индивидуальными настройками пользователя (по умолчанию — по левому краю), поэтому для разметки основного текста статьи не следует использовать инструменты языка HTML (шрифтовое и цветовое выделения и др.).

Механизм переноса слов в Ганджавики не реализован, поэтому в помещаемом в статью тексте символов переноса быть не должно.

Рубрикация

Если размер статьи превысил 3000—5000 символов, то рационально выделить преамбулу, в которой дать определение предмета статьи и представить краткую версию статьи, а остальной текст разделить на блоки — использовать рубрикацию. Цель рубрикации — создание чёткой системы заголовков, ясно отражающей логическую структуру статьи.

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

Заголовки набираются по несложным правилам:

• каждый заголовок занимает отдельную строку, при этом:
  • не ставится точка в конце;
  • не следует использовать шаблоны;
  • избегайте из соображений веб-доступности вики-ссылок в заголовке, особенно в случаях, когда ссылка не покрывает его целиком;
  • не следует также ставить сноски в заголовке — они должны относиться к тексту, а не к заголовку;
• перед заголовком одна строка остаётся пустой;
• текст рубрики начинается сразу со следующей после заголовка строки:

…текст статьи.

== Новый заголовок ==
Продолжение текста статьи...

При разделении текста на части в первую очередь следует руководствоваться принципом разумности и необходимостью обеспечения максимального удобства для читателя. Лучше всего заранее продумать содержание заголовков, их взаимную подчинённость и соотношение с текстом. При этом важно соблюдать логическую соподчинённость заголовков разного уровня.

Знаки препинания

При расстановке знаков препинания в тексте статей в первую очередь следует руководствоваться действующими правилами русского языка.

При наборе запятая (,), точка с запятой (;), двоеточие (:), точка (.), восклицательный знак (!), вопросительный знак (?) и многоточие (…) от предшествующего слова пробелом не отделяются, но отделяются одиночным пробелом от последующего слова. Пример:

Пожалуйста, уважайте других участников игры — это не просто персонажи, а живые люди. (Ilia Sprite (adm))

Отсюда следует, что при наборе традиционных сокращений, следует использовать пробел: т. е. (то есть), т. о. (таким образом), т. к. (так как), т. н. (так называемое), и т. д. (и так далее), и т. п. (и тому подобное).

Правильно: и т. п.

Неправильно: и т.п.

Для сохранения целостности сокращения, чтобы избежать разделения его элементов при переводе строки, предпочтительнее использовать так называемый «неразрывный пробел» ( ), на месте которого разделение строк невозможно, или специальный шаблон {{nobr}}, в случае, если неразрывными пробелами требуется соединить несколько слов:

т. к. и т. п.

т. к. и т. п.

{{nobr|т. к.}} {{nobr|и т. п.}}

т. к. и т. п.

Скобки

В тексте в качестве скобок используются круглые скобки: «(текст в скобках)». Если внутри круглых скобок требуются вложенные скобки, используются квадратные скобки: «(текст [в] скобках)». Внутри квадратных скобок можно использовать фигурные скобки «{}». При наборе открывающая (левая) скобка «(» от последующего знака не отделяется, а перед ней ставится обычный пробел. Закрывающая (правая) скобка «)» набирается без пробела сразу после окончания текста внутри, а пробел ставится, как и при наборе большинства знаков препинания, после неё. Аналогичные правила действуют и для квадратных «[]», фигурных «{}», а также угловых «<>» скобок.

Пример:

(текст в скобках [внутри которых есть ещё скобки] при чтении можно пропустить без ущерба для смысла).

Кавычки

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

В Ганджавики в основном тексте статьи допускается использовать кавычки лишь двух типов рисунков — угловые, или типографские, кавычки (т. н. «ёлочки») и т. н. кавычки-„лапки“, причём последние используются в том случае, когда в тексте, который находится в кавычках, встречаются слова, в свою очередь заключённые в кавычки (вложенные кавычки). Кавычки с рисунком типа “обе верхние” или "прямые" в традиционной русской типографике не используются.

Пример:

ЗАО «Издательский дом „Название“».

Тире (—)

При наборе в тексте тире с обеих сторон отделяется пробелами, причём слева предпочтительно ставить неразрывный пробел, чтобы препятствовать нежелательному появлению тире в начале строки.

Пример:

Онлайн-игра «Ганджубасовые войны» — это игра в мафию, боевой симулятор и экономическая стратегия.

Однако, когда тире выступает в качестве интервала значений или диапазона, отделять его с двух сторон пробелами не нужно, например:

на это потребуется примерно 10—12 часов.

Это правило справедливо для интервалов, указанных в цифровой форме; если интервал указан в словесной форме, то тире следует отделить пробелами с двух сторон:

в декабре — январе проводится новогодняя программа.

Другие знаки

Минус (-)

Минус используется как символ отношений в математических формулах, а также для указания знака отрицательных чисел и значений физических величин, причём во втором случае набор осуществляется без пробела. Например:

2 - 5 = -3;

-3 - 8 = -11.

Знаки процента, номера и параграфа

Знаки процента (%), номера (№) и параграфа (§) используются только с относящимися к ним числами, от которых отделяются неразрывным пробелом. Если необходимо использовать сдвоенные знаки параграфа, то они между собой не разделяются. Знак номера перед несколькими (многими) номерами не удваивается.

Примеры:

эффективность тепловизора 60 %;

суперсет № 5; см. § 11;

№ 4—8;

§§ 6—9; или § 6—9.

Однако в тех случаях, когда знак процента используется для сокращённой записи сложных слов, образованных при помощи числительного и прилагательного процентный, знак процента набирается вплотную к числу, то есть без пробела. Например:

20%-я маскировка (означает двадцатипроцентная маскировка), 10%-й тепловизор, но

видимость в бою составляет 20 % и т. п.

Выделение

Для логического выделения слов в тексте следует использовать полужирное и курсивное начертания шрифта.

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

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

Курсив

Курсивом выделяются приводимые в скобках — в том числе в начале статей — оригинальные написания заимствованных понятий и терминов иноязычного происхождения.

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

Числа

Помещая в статью числовые данные, обратите, пожалуйста, внимание на нижеследующие правила.

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

Примеры:

• 75; 397; 1234;
• 66 231; 2 154 700;
• 10 000 000 000.

Неправильно: 3896558; 87,788,457; 1.000.000; 4'572'468; 1 234.

При обозначении десятичных дробей в качестве разделителя целой и дробной частей числа используется запятая, причём ни до, ни после неё пробел не ставится: 11,68. Если требуется записать несколько десятичных дробей в ряд, в качестве разделителя между ними следует использовать точку с запятой:

8,2; 0,011; 32,54.

Дробная часть десятичных дробей делится неразрывными пробелами на группы по три знака слева:

78 575,845 72; 0,000 017 748.

Представление чисел прописью или цифрами

Следует избегать необоснованного употребления как прописной формы числа, так и цифровой.

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

В цифровой форме числа пишутся, когда:

• число является многозначным;
• следует ряд из нескольких чисел. Например:

Продаёт разное количество амуниции: 10 тепловизоров, 50 рыбы, 20 ржавых гранат и еще 3 стимпак урона XL.

• числа сочетаются с единицами измерений. Например:

цена до 700 гб.

Числа следует давать прописью, когда:

• количественное числительное начинает предложение;
• если число стоит в косвенном падеже не при единицах измерений. Например:

Игрок обычно воевал с двумя покемонами на Outlande. вместо: Игрок обычно воевал с 2 покемонами на Outlande.

• последовательность нескольких чисел в цифровой форме может затруднить чтение. Например:

доставили 20 сорокатонных вагонов ТНТ или доставили двадцать 40-тонных вагонов ТНТ вместо: доставили 20 40-тонных вагонов ТНТ.

Сочетание цифровой и словесной форм представления чисел

Используется при обозначении крупных круглых величин (тысяч, миллионов, миллиардов) в виде сочетания цифр с сокращением тыс., млн, млрд. Например:

22 тыс., 100 млн, 16 млрд.

Обратите внимание: сокращение тыс. содержит точку, тогда как млн и млрд — нет.

Если требуется написать подряд два порядковых числительных с наращениями, разделённых запятой или соединённых союзом, то окончание добавляют к каждому из них:

1-й, 2-й ряды;

3-й и 4-й класс брони;

20-е и 30-е уровни.

Если последовательно идут более двух таких числительных, разделённых запятой или точкой с запятой или соединённых союзом, то падежное окончание наращивается только у последнего числительного. Например:

игроки 5, 7, 9-х уровней;

8, 11, 15 или 18-й секторы.

Если два числительных разделены тире, то наращение делают только у второго, когда оно одинаковое у обоих числительных, или у каждого числительного — когда предшествующие первому числительному слова управляют только им и не связаны со вторым. Например:

40—50-е уровни игроков;

в 20-м — 30-х секторах.

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

сектора 6; формулу 4; на рис. 15; в табл. 8;

в 6-м секторе; 4-ю формулу; на 15-м рисунке; 8-й таблице.

Кроме того, не наращивают окончания для номера года и числа месяца, если слово «год» и названия месяца следуют тотчас за числом. Но если слово «год» или название месяца опущено или стоит перед числом, то окончание следует наращивать. Например:

в 2003 году; 13 марта 2003 года;

в марте 2003-го; в декабре, числа 30-го.

Неправильно:

в 2003-м году; 13-го марта 2003-го года.

У количественных числительных окончания не наращивают:

суперсет состоит из 5 предметов.

Неправильно:

суперсет состоит из 5-ти предметов.

При этом: «игрок с 7-летним стажем» (а не «игрок с 7-и летним стажем»).

Диапазоны

Предпочтительным способом определения интервала значений является постановка знака тире (—), в некоторых случаях возможна постановка знака многоточия (…).

При указании диапазона вида «от — до» в словесной форме используется знак тире, окружённый пробелами. Например:

проход шириной семь — десять миллиметров;

в июле — августе мы брали рейтинг.

Но обратите внимание, что если речь идёт не об интервале, а о приближённом значении, для разделения слов следует использовать знак дефиса (-). Например:

одна-две пули;

пройти десять-пятнадцать клеток.

При цифровой форме, как интервала, так и приближённого значения, между числами набирается знак тире, который от цифр пробелом не отделяется. Например:

проход шириной 7—10 миллиметров;

20—30 % участников;

в 5—7 раз больше.

Обратите внимание, что если указывается диапазон значений с наименованием, то наименование набирается один раз после последнего числа:

5—10 %;

15—20 млн ганджубаксов

Единицы измерения

Проценты и номера

См. выше: Знаки процента, номера и параграфа.

Денежные единицы

Наименования денежных единиц (ганджубакс, евро-юнит) пишутся полностью после денежной суммы через неразрывный пробел. Допускается использование сокращений (гб, EUN), которые также располагаются после цифр через неразрывный пробел.

Примеры:

100 ганджубаксов

100 гб.

80 евро-юнитов

80 EUN

Сокращения

Также см. выше: Сочетание цифровой и словесной форм представления чисел.

Без веских причин слова сокращать нельзя.

Следует избегать употребления неоднозначных или непонятных сокращений. В то же время применение общепринятых сокращений, соответствующих характеру и стилю текста, часто бывает полезным, так как сокращения уменьшают объём текста и позволяют читателю лучше сконцентрироваться на его смысле.

Создавать в статье отдельный раздел с расшифровкой всех специальных сокращений, как правило, не следует.

По возможности следует избегать сокращений, которые совпадают по написанию с другими, имеющими иное значение. Такие сокращения допустимы только в том случае, если содержание сокращения ясно из контекста.

Единство стиля. Важно придерживаться единого стиля сокращений на протяжении всей статьи. То есть, однотипные слова и словосочетания должны или сокращаться все без исключения или не сокращаться вовсе. Сюда же относится и сокращение близких по значению слов.

Таблицы

Для единообразного оформления статей рекомендуется использовать в общих случаях таблицы класса standard. Оформление таблиц для специальных случаев приведено в статье Оформление таблиц, а в статье Ганджавики:Таблицы дано подробное описание составления самих таблиц.

Иллюстрации

Подписи к иллюстрациям

Как правило, все помещаемые в статью иллюстрации следует снабжать кратким информативным пояснением — подписями. Однако подпись не должна дословно дублировать часть текста энциклопедической статьи.

В состав подписи могут входить следующие элементы:

• условное обозначение иллюстрации — слово Рис.;
• название иллюстрации.

Естественно, что в подавляющем большинстве случаев состав подписи будет ограничен двумя-тремя элементами или даже одним.

Примеры подписей к иллюстрациям:

• Рис. 1. Личная почта
• Маскхалат KillSuit

Обратите внимание: в конце подписи никаких знаков препинания ставить не нужно. Части подписи обычно разделяются точкой, а элементы одной части — запятой. Условное обозначение и номер выделяются полужирным, а экспликация набирается с новой строки шрифтом меньшего размера.

Формулы

Математические формулы в Ганджавики следует оформлять с помощью специального языка разметки формул — TeX.

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

$1-{\frac {1}{2}}+{\frac {1}{3}}-{\frac {1}{4}}+\cdots =\ln 2$

• Корни уравнения $ax^{2}+bx+c=0$ можно отыскать по формуле:

$x_{1,2}={{-b\pm {\sqrt {b^{2}-4ac}}} \over {2a}}$

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

${\begin{matrix}f(n+1)&=&(n+1)^{2}\\\ &=&n^{2}+2n+1\end{matrix}}$

Способы написания формул на языке TeX описаны подробнее в статье Ганджавики:Формулы.

Сноски (примечания)

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

В движке Ганджавики — MediaWiki — существует встроенная поддержка сносок.

Связь между текстом и сноской показывается цифрой или значком, который ставится в основном тексте после фрагмента поясняемого текста, а в разделе «Примечания» — перед текстом сноски.

Движок наделяет сноски свойствами гиперссылок и позволяет переходить через их значки от основного текста к тексту примечания и наоборот — от текста примечания к тому месту в основном тексте, к которому примечание относится.

Создание сносок

Сноски в статье можно создавать, используя парный тег <ref></ref>.

В самом простом случае для создания сноски надо после поясняемого текста — без предваряющего пробела и перед знаками препинания — вставить теги <ref></ref>, а между ними вписать текст примечания. Затем, в конце статьи, после основного текста, необходимо создать раздел «Примечания» и вставить в него единственную строку с тегом <references />. Если вы забудете вставить тег <references />, сноски видны не будут.

Внутренние и внешние ссылки в сносках внутри тегов <ref></ref> можно делать как обычно, например: [[Ганджавики]], [http://ganjawiki.ru].

См. также

• Ганджавики:Как править статьи