Документация Wiki

Оглавление документа:

Концепция wiki

Основы работы

Правка страниц

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

Синтаксис wiki

Описание разметки

BBCode

Владение документами

Рефакторинг

Права доступа

Комментарии и файлы

Концепция wiki

Изначально wiki — это открытая среда для обмена знаниями и коллективного творчества. Хотя обмен знаниями и совместную работу над, к примеру, содержанием сайта можно вести традиционными средствами — в форумах и с помощью веб-редакторов, — эти подходы имеют ряд ограничений. В частности, форумы не позволяют структурировать информацию, а лишь последовательно публиковать (добавлять) новую. А подключение к работе над сайтом неограниченного числа людей, помимо того, что трудно реализуемо, может иметь нежелательные последствия для безопасности.

Wiki можно представить как рабочий стол с разложенными черновиками, к которому может подойти любой человек и внести в тексты свои корректировки или написать что-то новое. При этом каждый черновик обладает важным свойством — историей редакций^[link1] (изменений), по которой можно отследить, как (и кем) документ изменялся во времени и, при необходимости, "вернуть" его в одно из предыдущих состояний.

В остальном wiki подобна обычному веб-сайту: одни ее страницы могут быть вложены в другие (такие многоуровневые документы называются кластерами^[link2]), могут ссылаться друг на друга с помощью обычных свободных ссылок, содержать загруженные файлы.

Сайт "openPGP в России" использует платформу wiki, во-первых, в качестве системы управления и, во-вторых, ради поддержания открытости^[link3] работы над материалами. В то же время, это не классическая wiki с горизонтально структурированным содержимым: все документы сайта распределены между соответствующими "папками", такими, как, например, Библиотека^[link4] или FAQ^[link5]. Более подробно об устройстве сайта вы можете прочитать здесь^[link6].

Основы работы

Каждый читатель wiki может выступать и ее автором или корректором: исправлять орфографические ошибки, добавлять новый материал, изменять устаревший. (Некоторые страницы, обычно служебные, могут иметь ограничения на возможность правки, но в остальном вы можете редактировать любые документы wiki.)

Правка страниц

Чтобы начать редактировать страницу, нажмите в панели инструментов в левой верхней части страницы на пиктограмму карандаша (в зависимости от выбранного оформления сайта может потребоваться прокрутить страницу вниз и нажать на вкладку "Правка"). Аналогичного результата можно добиться, нажав на клавиатуре Alt+E.

Писать или править простой текст несложно. В этом поможет редактор WikiEdit, позволяющий производить основные действия с текстом. Но для более сложного форматирования необходимо ознакомиться с правилами и синтаксисом wiki (см. ниже).

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

Чтобы создать новую страницу, можно поступить одним из трёх способов. Во-первых, можно указать ссылку на нее в готовом тексте. Такая ссылка на несуществующую страницу будет выглядеть как подчёркнутый пунктиром текст, справа от которого стоит ссылка [создать]. Если щелкнуть мышью по этой ссылке, вы приступите к созданию новой страницы. Во-вторых, можно воспользоваться инструментом создания нового документа (в стандартном оформлении он расположен в панели в верхнем левом углу страницы). В-третьих, можно ввести название страницы непосредственно в адресную строку браузера наподобие http://www.pgpru.com/НоваяСтраница.

Не забывайте, что поскольку этот сайт — не классическая wiki, и жестко модерируется, вам необходимо четко следовать правилам размещения страниц согласно их содержанию. Со всей этой информацией вы можете ознакомиться в правилах сайта^[link7]. Также не все части сайта доступны для создания новых документов. Если имеется ограничение доступа, вы получите предупреждение.

Синтаксис wiki

Форматирование текста в wiki осуществляется с помощью специальных знаков разметки. Это может сложно звучать, но в действительности интуитивно понятно и просто, если соблюдать правило двойных символов. Например, если вы хотите подчеркнуть текст, окружите его с двух сторон парами знаков подчеркивания, вот так: __подчеркнутый текст__. Если текст нужно выделить жирным, используйте двойные знаки звездочки: **жирный текст**.

При этом, как и в разметке HTML, для создания комбинированного форматирования знаки разметки wiki можно вкладывать друг в друга. К примеру, чтобы выделить текст подчеркнутым жирным курсивом, используйте подобный формат: __**//ваш текст//**__.

Чтобы необходимый двойной повтор символов не расценивался wiki как знак разметки и не форматировал текст, поставьте перед этими символами знак тильды (~). К примеру, такой текст не будет выделен жирным: ~**не выделять**. (Альтернативный способ заставить wiki выводить текст, как есть, — это заключить его в двойные кавычки: ""--не зачеркивать текст--"". Оба способа равноправны, но для работы с большими блоками текста двойные кавычки более удобны.)

Существует множество других элементов разметки, с которыми вы познакомитесь на следующих страницах. Но не забывайте, что большинство из них ограничено концом абзаца и должно вплотную прилегать к размечаемому тексту. А те немногие, что не ограничены концом абзаца (это зачеркивание и цветовые выделения) все равно требуют, чтобы к ним вплотную прикасался текст. То есть __вот так__ будет работать, а __вот
так__ — нет.

Описание разметки

• Основы форматирования^[link8] — основные способы выделения и маркировки текста, создание заголовков.
• Сложное форматирование^[link9] — создание таблиц, сносок, списков, отступов, цитат, и определений.
• Ссылки и кластеры^[link2] — правила выделения ссылок и создания ссылок между страницами кластера.
• Макросы и форматтеры^[link10] — расширенные возможности форматирования и маркировки текста (для опытных пользователей).
• Действия^[link11] — создание специальных динамических элементов, таких как автоматические оглавления, списки ссылок и страниц и многое другое (для опытных пользователей).

Поэкспериментировать и на практике изучить wiki-разметку, без опасения что-нибудь сломать, вы можете в нашей "песочнице"^[link12].

BBCode

Если вам привычнее и удобнее пользоваться разметкой BBCode, она также поддерживается. Заметьте, однако, что это ограниченная поддержка, и некоторые возможности BBCode (например, свободный выбор размера шрифта или цвета текста) не предусмотрены. Подробнее...^[link13]

Владение документами

Если вы зарегистрированы в wiki, то, создав новую страницу, вы становитесь ее владельцем и можете сами через меню свойств (кнопка с молотком и гаечным ключом в панели инструментов) устанавливать правила доступа к ней посторонних, при необходимости переименовывать ее, удалять и т.д. Однако, владение документами — это не только права, но и обязанности. Об этом и пойдет речь ниже.

Рефакторинг

Самое главное право владельца страницы — это возможность осуществлять управление ее редакциями. Например, если кто-нибудь случайно или нарочно удалит весь текст документа, владелец может "откатить" его к одному из предыдущих корректных состояний. Но это право подразумевает и ответственность владельца: если не в состоянии поддерживать свое имущество в порядке — передай его другому. Подробнее...^[link14]

Права доступа

Владелец страницы или администратор wiki с помощью специальных списков допуска могут определять доступ других участников и читателей wiki к главным функциям работы с документами. Так, владелец может запретить правку документа для любых посторонних, а возможность чтения и комментирования оставить только для нескольких коллег. Подробнее...^[link15]

Комментарии и файлы

Помимо правки текста страниц их владельцы могут загружать на сервер иллюстрации к своим документам и другие небольшие файлы. А для простых читателей будет полезна система комментариев, позволяющая оставлять собственные отзывы о тех или иных страницах. Подробнее...^[link16]