Руководство по стилю

Материал из openSUSE.

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

Названия статей

Название вашей статьи является также её заглавием.

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

Заголовки

• Оборачивайте заголовки знаками равенства = (Заголовок), а не апострофами ''' (жирную разметку). Если заголовки оформлены правильно, в статье будет автоматически сформировано содержание.
• Начинайте с двойного ==, а не с одинарного =. Например:

==заголовок 1==
===подзаголовок 1.1===
===подзаголовок 1.2===
==заголовок 2==
===подзаголовок 2.2===
====подзаголовок 2.2.1====
=====подзаголовок 2.2.1.1=====

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

Разметка текста

Используйте возможности форматирования и разметки вики-движка MediaWiki для улучшения читаемости страницы. Пишите имена файлов и команды shell, используя моноширинный шрифт:

<tt>моноширинный шрифт</tt>

Встроенные возможности MediaWiki

Не используйте HTML-форматирование, кроме тех случаев, когда это действительно нужно. Форматирование MediaWiki придаёт статьям единообразный вид и упрощает написание, чтение и редактирование их исходного кода. Для того, чтобы узнать, какие инструменты форматирования и разметки можно использовать, посмотрите помощь по редактированию MediaWiki. Также можно посмотреть на исходный код некоторых страниц Википедии.

Комментарии

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

Избегайте упоминаний в статье о том, что статья не закончена или нуждается в доработке; используйте шаблон {{Доработка}}.

Если вы хотите обратиться к другим потенциальным редакторам, делайте комментарии, невидимые обычному читателю. Для этого заключите текст, предназначенный только для редакторов, в <!-- и -->.

Например следующий код:

hello <!--Это комментарий.--> world

отображается как:

hello world

Таким образом, комментарий виден только при просмотре исходного кода HTML или вики.

Шаблоны

http://ru.opensuse.org/Шаблоны

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

Искусственному наполнению — наше решительное «нет!»

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