Плагины

В «ДокуВики» имеется гибкий API плагинов, который позволяет расширять их функциональность — вводить дополнительные синтаксические моды, специальные режимы действий, новые форматы экспорта и многое другое. В зависимости от предназначения плагина, плагин может состоять из одного или более типов плагинов, представленных ниже.

В настоящее время «ДокуВики» содержит пять разных типов плагинов.

• Синтаксические плагины расширяют базовый синтаксис «ДокуВики».
• Плагины действий могут быть использованы для расширения или изменения многих аспектов основных операци «ДокуВики»: от сохранения статей до введения новых режимов действия.
• Плагины администрирования могут предоставить функциональность администрирования «ДокуВики» — эти плагины доступны для суперпользователей и менеджеров через кнопку «Управление» (Admin).
• Вспомогательные плагины могут использоваться для обеспечения функциональности для многих других плагинов, чтобы не реализовывать в этих плагинах снова и снова одни и те же функции.
• Плагины рендеринга позволяют создавать новые режимы экспорта и заменить стандартный для «ДокуВики» рендер xhtml.

A valid plugin name should only contain the characters a-z and 0-9. Underscore is NOT allowed as this is used to separate plugin name for component name. Using underscore will also give a popularity rating of zero. If same name are used by two different plugins they are mutually excluding and inherent incompatible, furthermore only one of them can have a plugin homepage on dokuwiki.org.

A Wizard to create the basic skeleton for a DokuWiki plugin can be found at http://pluginwizard.dokuwiki.org/ and is recommended to be used for starting the development.

If you later need to extend your plugin refer to the plugin file structure on how files are arranged in a plugin.

Если вы создали плагин, пожалуйста, поделитесь им с сообществом. Just create a page named after your plugin in the plugin namespace. E.g. if your pluginfolder is named sample create a page plugin:sample here in the wiki.

The page should contain all needed documentation on how to install and use the plugin and give users a pretty good idea what it does before installing the plugin. Adding screenshots might be a good idea as well¹⁾. Plugin homepage template contains more tips on how to make an user friendly page.

At the top of the plugin page a few metadata fields have to be filled. A description of each field can be found here.

Uploads are not allowed on dokuwiki.org, so you need to host your plugin files somewhere else. We recommend to manage your source with a Revision Control System like git. If you do, it's easiest to use a public repository host like Github which offers also a bug tracker for your repository.

Plugin Survey 2010 — обзор для разработчиков, в котором рассмотрены все плагины, представленные в пространстве имён «plugin» сайта www.dokuwiki.org. Данные были собраны 05.09.2010 г. автоматическим скриптом с небольшой ручной правкой и обработкой. Было проверено 697 страниц, содержащих 672-а плагина. Исходные коды 647-и плагинов (96%) были загружены и проанализированы.