Tag/tag.png

Unsupported Version
This article applies to an unsupported version of Ubuntu. More info...

Tag/tag.png

Style Cleanup Required
This article does not follow the style standards in the Wiki Guide. More info...

Tag/tag.png

Candidate for Deletion
This article may not be appropriate for this wiki, and may be deleted. More info...

В качестве wiki-движка используется программа MoinMoin. Эта страница содержит заметки о том, как публиковать документацию в wiki. Наша цель состоит в том, чтобы создать доступную, надёжную и централизованную документацию.

Создание страниц

Для создания нового руководства надо выполнить два простых шага:

  1. Поиск. Перед добавлением руководства в wiki, воспользуйтесь поиском по статьям с похожей темой. Если найденные документы недостаточно заполнены или устарели, обновите их ! Будет лучше, если множество статей со схожей темой вы объедините в одно подробное руководство.

  2. Создание страницы. Если руководств по заданной теме не найдено, создайте новую страницу.

    • Подумайте над названием - выбор точного имени очень важен для того, чтобы пользователь легко и быстро нашёл ваше руководство.
      1. Выберете наглядное имя, описывающее суть содержимого
      2. Избегайте слова "howto" в заголовке страницы (здесь всё howto !)
      3. Выберете имя с заглавными буквами (типа WikiName). Не используйте пробелы или подчеркивания в именах.

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

Стиль

Указания по стилю, используемом в документации

  • Основные принципы

    • Релизы Ubuntu - старайтесь всегда указывать для какой версии Ubuntu написано руководство. Когда указываете версию Ubuntu, используйте запись вида "Ubuntu X.XX (Прозвище)" или просто "Ubuntu X.XX". Например, "Ubuntu 5.10 (Breezy Badger)" или "Ubuntu 5.10", вместо "Breezy" или "Ubuntu Breezy".

    • Репозитории - указывайте (capitalize) наименования репозиториев Universe и Multiverse, когда используете. Также должны указываться наименования Linux, Ubuntu, Windows и т.п.

    • Установка ПО - при описании установки ПО, пытайтесь не указывать менеджер пакетов (например, apt-get). Вместо этого просто используйте фразу "Установите пакет X из репозитория Y". Если надо, сделайте ссылку на страницу, документирующую отличный менеджер пакетов (см. InstallingSoftware).

    • Источник ПО - в основном советуется программное обеспечение из главного источника (Main repository), перед эквивалентным ПО из других источников (Universe repositories), как гарантировано обновляемое и безопасное.

    • Объединяйте, не дублируйте! - обыщите wiki в полной мере перед добавлением материала. Если уже есть страница с подробным описанием темы, не добавляйте новую. Лучше объедините материал с существующей страницей. При этом, на существующей странице новые сведенья пишите в подходящем для них месте.

  • Styleguide - the Documentation Team has published some specific guidelines for documentation, the Documentation Team Styleguide.

Форматирование

Справка по оформлению страниц

Основы

  • Разделяйте абзацы пустой строкой.
  • Для создания списков, поставьте пробел в начало строки и после него звёздочку - "*" (для маркированного списка), номер (для нумерованного списка) или букву (буквенный список).
  • Для создания заголовков, напишите = Заголовок = для заголовка первого уровня, == Заголовок == для заголовка 2 уровня и так далее...

  • Заключите слово или фразу в кавычки из 2 апострофов '' для отображения курсивом, и в тройные апострофы для отображения полужирным шрифтом.

  • Для оформления цитаты заключите абзац в фигурные скобки  {{{  }}}.

Например, страница может выглядеть так:

= Заголовок страницы =
== Подзаголовок ==
Этот текст показывает писание в wiki. Следующие пункты важны:
 * Прочитайте рекомендации по стилю оформления
 * Убедитесь, что вы не повторяете уже существующий материал в wiki
 * ask the Documentation Team to check the guide afterwards and apply the appropriate tags.

Следующий абзац - буквенный список:
 a. это ''первый'' пункт
 a. это ''второй'' пункт
 a. это ''третий'' пункт
{{{
это блок кода
} }} (пробела не должно быть в вашей версии)

За подробной справкой обращайтесь в HelpContents

Дополнительные возможности

Wiki имеет много дополнительных возможностей для писателя! Например:

  • Увидеть все возможности форматирования wiki можно на странице SyntaxReference.

  • Вставка иконок показана на IconsPage

  • Вставка таблицы содержания страницы, подобно той, что на верху этой страницы:
    • ||<tablestyle="float:right; font-size: 0.9em; width:40%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;">'''Содержание'''[[BR]][[TableOfContents]]||
  • Для вставки простой таблицы содержания, без рамки вокруг, пишите так: [[TableOfContents]])

Удаление и переименование

Удаление и переименование страниц в этой wiki запрещено, но если вам необходимо это сделать - сообщите в WikiTeam.

Коммуникация

Guidelines for ensuring that your work is communicated to others working on the wiki.

WikiGuideRu (last edited 2017-09-03 04:26:50 by ckimes)