Создание документации в Wiki. Полезные плагины

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

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

Сама по себе DokuWiki имеет открытый код и при желании в ней можно реализовать практически любой функционал. Но стоит иметь ввиду, что при каждом обновлении ядра придется мержить все ранее сделанные изменения. Основной плюс плагинов в том, что они устанавливаются отдельно и при обновлении не удаляются, а продолжают так же исправно работать.

Все плагины устанавливаются администратором в директорию lib/plugins/. Обязательно прочтите предупреждение при использовании плагинов. Некоторые плагины конфликтуют между собой, поэтому иногда приходится выбирать и оставлять наиболее полезные и нужные.

Плагин header2

Плагин header2 позволяет делать клевые заголовки-ссылки. По умолчанию в вики заголовок не может являться ссылкой, если вы попробуете скомбинировать ссылку и заголовок с помощью стандартного синтаксиса, то в результате ничего толкового не получите.

После подключения плагина header2 каждый заголовок может быть превращен в ссылку. Для этого используется следующий синтаксис:

===== [[Wiki:nazvanie_stati|Это заголовок второго уровня со ссылкой]] =====

С точки зрения веб-технологий и юзабилити заголовок-ссылка правильнее и удобнее чем слово «Дальше» или фраза «Перейти в раздел». Поэтому настоятельно рекомендую этот плагин к установке.

Один небольшое минус омрачает его использование при создании документации — header2 конфликтует с плагином dw2pdf, который выгружает содержимое доки в отдельный pdf-файл. Но вместо dw2pdf можно использовать другой плагин.

Плагин Site Export

Этот плагин больше подойдет администратору вики, т.к. он не доступен простому пользователю или редактору. Зато он может выгружать всю документацию в виде HTML страницы, включая все изображения и меда-файлы. Помимо стандартной выгрузки плагин позволяет применять шаблоны к выгружаемым данным.

Для обычных пользователей можно добавить кнопку выгрузки содержимого в опенофис формат (odt). Делается это администратором в настройках вики. Выгрузка происходит постранично, но выгружается сразу все содержимое. Этот функционал помог обойтись без плагина dw2pdf и иметь всегда под рукой оффлайн вариант документации.

Установить плагин Site Export.

Плагин BlogTNG

Установка плагина BlogTNG расширяет возможности вики-документации и позволяет на её основе создать полноценный блог, который содержит:

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

Настройка выводимых публикаций происходит непосредственно в момент встраивания блога на страницу. Код блога выглядит так:

<blog list>
  blog   default
  tpl    default
  sortby created
  limit  10
  tags   0
</blog>

На странице может быть добавлен любой текст до тега <blog> и после тега </blog>. Он будет отображаться на странице вместе со списком анонсов. В самом коде содержатся следующие параметры:

  • blog — название блога, анонсы публикаций которого будут выводиться, блогов может быть сколько угодно.
  • tpl — название шаблона.
  • sortby — тип сортировки, по умолчанию сортируется по дате создания — created (кроме того может принимать значения lastmod, title, page или random).
  • limit — количество анонсов отображаемых на одной странице.
  • tags — отображать или нет список тегов.

У плагина есть еще ряд параметров, но я их не использую. Узнать о них и установить BlogTNG можно на странице о плагине.

Альтернативой BlogTNG является Blog плагин, однако для его работы в вики должны быть установлены плагины Include и Pagelist. При этом имеется конфликт между header2 и Include. Поэтому я предпочел не ставить этот блог плагин, хотя он и считается более распространенным.

 

На сегодня я закончу с описанием плагинов. Отмечу лишь то, что для DokuWiki уже создано более 1000 плагинов среди которых каждый найдет для себя нужный. Все плагины собраны на странице «Плагины» и условно поделены на несколько категорий:

  • Syntax-плагины расширяют синтаксис «DokuWiki».
  • Action-плагины заменяют или расширяют основную функциональность «DokuWiki».
  • Admin-плагины предоставляют дополнительные инструменты администрирования.
  • Helper-плагины обеспечивают работу других плагинов.
  • Render-плагины добавляют новые режимы экспорта или заменяют стандартные средства визуализации XHTML.
  • Auth-плагины добавляют модули аутентификации.