Revision 8 as of 2007-05-03 11:47:40

Clear message

В качестве 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 the names of the Universe & Multiverse repositories when you use them. Also, Linux, Ubuntu, Windows, etc should be capitalized.

# capitalize - писать большими буквами ?

  • Установка ПО - при описании установки ПО, пытайтесь не указывать менеджер пакетов (например, apt-get). Вместо этого просто используйте фразу "Установите пакет X из Y репозитория". If appropriateappropriate, include a link to the page which documents the various package managers, InstallingSoftware.

  • Which software - in general, recommend software from the Main repository over equivalent software in the Universe repository, as the former have guaranteed security updates.

  • Integrate, don't duplicate! - do a comprehensive search of the help wiki before adding material. If a page already exists on a particular subject, don't add a second one with similar material. Integrate the material with the existing page, to improve it. So, new information should be added to the existing page in the appropriate place.

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

Помощь в оформлении страниц

Основы

  • Каждый абзац должен отделяться от других пустой линией.
  • Для создания списков, поставьте пробел в начало строки и звёздочку (* - для точек), номер (для нумерованного списка) или букву и т.д.

  • Для создания заголовков, используйте запись вида = Заголовок = для заголовка первого уровня, == Заголовок == для заголовка 2 уровня и так далее...

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

  • Для экранирования блока кода, заключите абзац в  {{{  }}}.

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

= Заголовок страницы =
== Подзаголовок ==
This page is going to explain how to write a guide on the wiki. The following things are important:
 * Read the docteam Styleguide
 * Make sure you are not reproducing material already on the wiki
 * ask the Documentation Team to check the guide afterwards and place it in CategoryCleanup

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

Это очень легко !

За подробной информацией обращайтесь в HelpContents

Advanced Features

As you edit the wiki you will learn how to use the power of the wiki software to do even more clever things! Here are some examples:

  • To see almost all the wiki's formatting in action, have a look at the SyntaxReference page.

  • Inserting Icons - see IconsPage

  • Inserting a table of contents such as what you see at the top of this page: 
    • ||<tablestyle="float:right; font-size: 0.9em; width:40%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;">'''Contents'''[[BR]][[TableOfContents]]||

  • To insert a simple table of contents, without the box around it, just use: [[TableOfContents]])

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

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

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

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