Это старая версия документа.


Wiki: Общая инструкция

Ресурс работает по принципу «вики»: любой участник Форума1) может свободно отредактировать любую статью в доступных для правки разделах, и изменения будут сразу же учтены и отображены на сайте. Как создавать, редактировать и удалять страницы, вы узнаете ниже.

Создание

Общие принципы и рекомендации

  • Непременно поищите, не написал ли кто-нибудь уже эту статью, прежде, чем начинать свою2);
  • Можно начать страницу с существующей ссылки, хотя существование ссылки не отменяет предыдущий пункт3);
  • Помните о том, что нужно написать короткое вступление в начале новой статьи. Читатели могут попасть сюда откуда угодно, поэтому следует дать чёткое понятие о предмете уже в первых абзацах;
  • Просмотрите Именование статей перед тем, как давать имя новой странице. Правильное наименование даст уверенность в том, что на вашу страницу будут указывать корректные ссылки с других относящихся к теме страниц, и что страницу не придётся потом переименовывать.

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

При выборе имени статьи следует учитывать следующие правила:

  • Имя должно быть понятным и отражать суть статьи. Использование слов, напрямую не относящихся к теме статьи не допускается. В имени статьи особенно важна стилистика и отсутствие ошибок.
  • Краткость - сестра таланта. Придумайте как можно меньшее по длине имя статьи. Не стоит указывать бесполезные «[*] в ubuntu», «[*] и всё такое» «статья о [*]». Допустим, если вы пишете статью о программе - только краткое имя программы4).
  • Не стоит указывать в имени номера версий - программы меняются, имя статьи - нет5). Исключения составляют статьи, направленные на рассмотрение конкретных выпусков программы6).
  • Создание статей во вложенных пространствах имён крайне нежелательно. Это возвращает организацию статей на ресурсе к структуре категорий, наперекор действующей системе тэгов. Все статьи следует размещать в разделе wiki/.

Создание ссылок на ещё не существующие страницы

Если во время редактирования существующей статьи Вас осенит мысль, что какая-либо программа, пакет, библиотека или термин, встречающиеся в этой статье, достойны отдельной статьи, просто обрамите это слово (или др.) двойными квадратными скобками, [[вот так]]. Это называется «викификацией»7) текста.
Чтобы создать новую страницу, вы можете начать с уже существующей ссылки на эту страницу. Ссылки на ненаписанные ещё страницы показаны бледно-оранжевым цветом с прерывистым подчёркиванием. Перейдя по этой ссылке, вы попадете на страницу, на которой говорится:

 Эта страница ещё не существует

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

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

Используйте кнопку «Просмотр» для предварительного просмотра внешнего вида редактируемой статьи!

Создание страницы с поискового запроса

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

Создание страницы по прямому переходу

Ещё вариант, наиболее простой. Следует просто вручную перейти на несуществующую страницу, введя ссылку на неё в адресной строке браузера:

http://help.ubuntu.ru/wiki/Пример названия статьи

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

Редактирование

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

Правила написания

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

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

Блокировка статьи

FIXMED При открытии страницы редактирования статьи одним участником она становится недоступной для редактирования всеми остальными участниками на определённый период времени9) во избежание недоразумений - статья редактируется поочерёдно. По истечении времени, отведённого для редактирования статьи участнику, блокировка оной прекратится, о чём пользователь будет заблаговременно уведомлён за одну минуту до окончания блокировки.

Помните о блокировке статьи. Не оставляйте статью заблокированной, если вы, например, зашли просто посмотреть исходный код страницы.

Просмотр и сохранение

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

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

Удаление

Как это не прискорбно, некоторые страницы10) приходится удалять.

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

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

См.также

1)
авторизованный на ресурсе Документации со своим логином и паролем с http://forum.ubuntu.ru
2)
Если вы хотите создать новую статью, сначала стоит проверить, используя форму поиска в правом верхнем углу страницы, не создал ли уже кто-нибудь статью на эту или очень похожую тему.
3)
Так называемые «ссылки-призраки», выглядящие вот так — ссылки, которые вставлены в текст, но для которых ещё нет статьи.
4)
не GNU_nano и, конечно же, не текстовый_редактор_GNU_nano_2_на_русском_языке_в_Ubuntu_12.04_LTS, а просто nano
5)
по сути, переименование статей хоть и возможно, но крайне нежелательно
7)
Построение структурированной взаимосвязи статей посредством создания внутренних ссылок
8)
откуда-то с википедии
9)
FIXME - конкретнее?
10)
если список статей, поставленных в очередь на удаление пуст, значит, их всё-таки кто-то удалилm(