LINUX.ORG.RU Good-penguin.pngWikiUnion Official Coat.png WikiUnion

Справка:Руководство по написанию статей

Материал из LORWiki
Перейти к навигацииПерейти к поиску

Не стоит воспринимать эти правила как догму, всегда могут быть исключения.

Оформление

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

Пробелы

Больная тема для многих. Обязательно к прочтению.

Запятая

Запятая всегда отбивается пробелом только справа.

Правильно Неправильно
И его, и его, всех забанить! Вася купил цитрус ,а Маша его не любит.

Скобки

Открывающая скобка отбивается слева, закрывающая — справа.

Правильно Неправильно
Он, конечно же, это знал (но не в полной мере),
ведь Дядя Петя очень злился на него.
Собака( породы Серый Кокс )
может быть очень злая.

Кавычки

Кавычки отбиваются подобно скобкам. Также нельзя использовать что-то вроде «<<plain text>>».

Правильно Неправильно
А наш «друг» не идёт с нами! Этот « мужик » любит выпить и по бабам.

Тире

  • В числовых диапазонах тире не отбивается пробелами.
Правильно Неправильно
1941⁠—⁠1945 20022009
  • После тире стоящего в начале абзаца ставят неразрывный пробел (или просто пробел, но только если вы уверены, что тире не уйдёт от строки).
Правильно Неправильно
— Эй ты! Эй,ты!
  • Остальные тире отбиваются узкими пробелами, причём пробел перед тире должен быть неразрывным (допускается ставить обычные).
Правильно Неправильно Клиника
Вася — вор! Петявор! Я-вор! (подразумевалось тире)
  • Перед «не» тире не ставится!
Правильно Неправильно
Третье блюдо не еда. Третье блюдо — не еда.

Сокращения

В конце предложения

Если точка после сокращения совпадает с точкой в конце предложения, то желательно это сокращение раскрыть. Но не следует в таких случаях ставить две точки подряд.

Прекрасно Нежелательно Неправильно
Петя, Вася, Миша, Дима и прочие. Петя, Вася, Миша, Дима и проч. Петя, Вася, Миша, Дима и проч..
«et cetera»

Латинское сокращение «etc» отбивается пробелом слева, запятая, в основном, перед ним не ставится.

Так как, «etc», по сути, эквивалиентно «и т. д.», то и правила на него распространяются такие же.

  • При перечислении без «и» запятая перед «etc» не ставится.
«Арбузы, бананы, апельсины etc»
«Арбузы, бананы, апельсины и так далее»
  • Если «и» при перечислении повторяется, то запятая необходима.
«И это, и то, etc»
«И это, и то, и так далее»

Нельзя писать «что-то, что-то и etc» — это грубая ошибка.

Написание «e.t.c.» — неправильно, потому что сокращение тут только последняя буква («etc» → «et cetera»)

Правильно Неправильно
Он, она, они etc. JB, jollheef, maxcom, etc.

Смайлики

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

Правильно Неправильно
Смешно :-) Можете пользоваться:-)

Ещё немного о различных чёрточках

Тире и дефис

Тире и дефис — разные вещи, не стоит их путать.

Правильно Неправильно
Петя — светоч! Вася - светоч!
Дефис и дефис‐минус

Дефис и дефис‐минус — разные вещи.

Второй используется, если нет возможности использовать остальные символы.

Правильно Неправильно
Дефис‐минус Дефис-минус
Дефис и минус

Это тоже разные вещи!

Правильно Неправильно
−1℃ -1oC

Короткое и длинное тире

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

Правильно Неправильно
1337⁠—⁠1380 19982017

Многоточие

Многоточие — единый знак.[1]

Правильно Неправильно
А он… Я вас всех...

Часто допускают ошибки ещё хуже:

  • «Я......»
  • «Эх, как вы могли. . .»
  • «Но блин..зачем..»

Многоточие и вопросительный, восклицательный знаки одновременно

Пруф: Д. Э. Розенталь, Справочник по правописанию и стилистике, § 137 «Многоточие и другие знаки».

Если вопросительному или восклицательному знакам сопутствует многоточие, то в многоточии одну точку убирают.

Так как авторы Unicode сейчас2018 вместо полезных занятий вводят ненужные вообще Emoji, а конкретнее: ненужные негры‐принцессы (нет, я не хотел сказать, что негры и негры‐принцессы не нужны; а хотел сказать, что такие Emoji не нужны), негры‐лесбиянки и так далее, то знак многоточия есть, а знака «?..» — нет; а значит, нам нужно использовать «?..» вместо нормального юникодного знака с нормальными интервалами между символами.

Выходом из ситуации может быть ручной кернинг, например, с помощью свойства «margin-left»:

Отредактировано вручную Без редактирования
Текст Кто тут?.. Кто тут?..
Вики‐текст Кто тут?<span style="margin-left: -1.3px; letter-spacing: 0.5px">..</span> Кто тут?..

Но тут нужно учитывать шрифт: в моноширинных шрифтах ручной кернинг вообще не требуется, а в некоторых других шрифтах начертание точки у восклицательного или вопросительного знака и точки как самостоятельного символа разное; для разных шрифтов понадобится разное значение для «margin-left».

Ну и ставить «?...» или «?…», конечно же, нельзя; пруф выше.

С восклицательным знаком дела обстоят точно так же: «!..».

Существует редкий случай, когда убираются две точки, — «?!.».

Правильно Неправильно
Вот в наши времена мы такое!.. Ну да ладно: не твоего ума дело. А надо?...

Кавычки

В русском языке допускаются только «кавычки‐ёлочки» и „кавычки‐лапки“.

«Программистские» кавычки — «"» — не допускаются. Они нужны программистам, в исходном коде.

Правильно Неправильно
«Юра» Купил "мохнатого".

Капслок

Набор капсом («ВОТ ТАК») не нужен.

Правки, набранные капсом, будут исправлены.

Правильно Расстрел на месте
Кровавая администрация забанила саныча. КРОВАВАЯ АДМИНИСТРАЦИЯ РАЗБАНЬТЕ СВЕТОЧА
ПОЖАЛЙСТААААААААААА

Буква «Ё»

Допускается её использование по усмотрению автора.

Но в рамках одной статьи следует придерживаться единого стиля.

В критических случаях («небо» и «нёбо») использование «ё» обязательно.

Любой, кто устроил войну правок и/или срач в обсуждении по поводу буквы «ё» и её нужности/ненужности будет покаран администрацией.

Код, выводы и логи

…оборачиваются в теги <tt> (для однострочных выражений) или <pre> (для многострочных).

Также допустима обёртка в <code> и <syntaxhighlight> (если необходима подсветка кода).

Если команда одна, то приглашение консоли можно не указывать. В обратном случае для команд, выполняемых обычным пользователем приглашение должно быть user@machine$, для рута — root@machine#.

Правильно Неправильно
sudo vasya228poopkin@motherpc: ~$ rm -rf /* jb: ~# dd if=/dev/zero of=/dev/sda

Расстановка типографских символов

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

Также символ можно вводить напрямую по юникодному коду: нужно зажать «Ctrl+Shift+u» и набрать код.

Викификатор

Для исправления плохо набранного текста можно использовать «Викификатор», но при этом нужно быть внимательным.

«Т. е.» и «т. н.»

Нельзя писать без пробела (хорошо бы неразрывного) в середине — «т.е.».

Правильно Неправильно
Он, т. е. не он… А, т.е. оно не работает?

Плашки

Главное правило — плашки не делают статью лучше (статью лучше делают люди, боты и скрипты).

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

Не стоит лепить плашки, не посмотрев в обсуждение. Помните, что ваше мнение может не совпадать с мнением других участников. Остерегайтесь войны правок.

Плашки с полем «reason»

Если наличествует параметр «reason» (причина), то не стоит туда писать что-то вроде «21231231», лучше оставить стандартный вариант.

Списки

Нумерованные списки пишутся через «#»:

# Пункт 1.
# Пункт 2.
# ???
# PROFIT!

А обычные — через «*»:

* ва;
* ся;
* пи;
* до;
* ре;
* ми.

Расставлять нумерацию вручную нельзя:

1. Не умею.
2. Верстать.
3. Вообще.

Точка с запятой или точка?

Списки можно оформлять так:

  • список с буллитами (без нумерации);
  • в нём пункты могут начинаться с маленьких букв;
  • тогда они завершаются точкой с запятой;
  • а в конце последнего ставится точка;
  • обычно так делается при достаточно коротких пунктах.

И так:

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

И вот так:

  1. Если список нумерованный с точками после цифры, то его пункты всегда начинаются с заглавной буквы (после точки) и завершаются точкой.
  2. Так‐то.

Названия программ, дистрибутивов и так далее

Нужно проверять соответствие названий программ, дистрибутивов и т. п. официальным, указанным на официальном сайте (например, openSUSE, а не OpenSUSE; Xfce, а не XFCE и т. д.).

Цитаты

Править орфографию, пунктуацию и прочее в цитатах нежелательно.

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

Наименование статей

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

Недопустимые символы

В наименовании не должно быть «/», «\», «—», кавычек и других символов, плохо обрабатываемых адресной строкой. В идеале в названии не должно быть и кириллицы, но, эй, мы с вами живем не в мире розовых пони.

Новые статьи

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

Когда статья будет готова, нужно сообщить модераторам о том, что нужно перенести статью в основное пространство имён.

Примечания

  1. Существует альтернативное мнение, http://www.artlebedev.ru/kovodstvo/sections/164/