devel:plugins
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
devel:plugins [2015-11-18 22:12] – [Plugin Development] 177.136.36.6 | devel:plugins [2023-09-19 11:00] – [Publishing a Plugin on dokuwiki.org] andi | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ======== | + | ====== |
- | [[DokuWiki]] has many features but all of them are easy to use. And many more can be added through the free [[plugin]] downloads. The list below should give you a first overview of what is available in [[DokuWiki]]. | + | |
- | Feel free to test DokuWiki | + | It is very easy to write a DokuWiki |
- | A big list of features is also available in the [[http:// | + | DokuWiki has a flexible plugin API which allows developers to extend its functionality, |
- | [[http:// | ||
- | ===== Basic Features ===== | ||
- | |||
- | * Simple [[wiki: | ||
- | * Unlimited [[attic|page revisions]] | ||
- | * [[Recent changes]] | ||
- | * Colored side by side [[diff]] support | ||
- | * Uploading and embedding of [[images]] and other media | ||
- | * Customizable [[Interwiki]] links | ||
- | * Optional [[CamelCase]] support | ||
- | * Content can be categorized in [[namespaces]], | ||
- | * Straightforward [[config|configuration]] | ||
- | |||
- | ===== High Usability ===== | ||
- | |||
- | * [[Section Editing]] allows editing of small parts of a page | ||
- | * [[Toolbar]] and [[accesskeys]] make editing easy for both beginners and professionals | ||
- | * Easy navigation through [[breadcrumbs]] | ||
- | * Automatic [[toc|table of contents]] generation | ||
- | * [[Locking]] to avoid edit conflicts | ||
- | * Automatic save to avoid content lost during editing | ||
- | |||
- | ===== Access Control and Anti-Spam Measures ===== | ||
- | |||
- | * Simple support for read only pages | ||
- | * Extended [[acl|Access Control Lists]] | ||
- | * Spam [[blacklist]] | ||
- | * [[config: | ||
- | * Mail address obfuscation and rel=nofollow support | ||
- | |||
- | ===== International ===== | ||
- | |||
- | * Support for over 50 [[Localization|languages]] | ||
- | * Full [[UTF-8 ]] support | ||
- | * [[Romanization]] support for nicer URLs | ||
- | * Optional automatic plural linking for English wikis | ||
- | ===== Fast ===== | ||
- | |||
- | * Index-based fast fulltext [[search]] | ||
- | * [[caching|Pagecaching]] for quicker rendering | ||
- | * Ajax-enhanced interface | ||
- | |||
- | ===== Extensible ===== | ||
- | |||
- | * Layout customizable through [[: | ||
- | * Features can be extended through [[plugins]] (over 900 already available) | ||
- | * Great [[faq: | ||
- | |||
- | ===== Easy Integration ===== | ||
- | |||
- | * No database required, it uses plain text files | ||
- | * [[Syndication]] of recent changes as RSS or ATOM feeds | ||
- | * [[: | ||
- | * Open Source and well documented [[development|source code]]... | ||
- | * and many more ... | ||
===== Plugin Types ===== | ===== Plugin Types ===== | ||
Line 72: | Line 16: | ||
* [[Remote Plugins]] allow to add webservices to your plugin. | * [[Remote Plugins]] allow to add webservices to your plugin. | ||
* [[Auth Plugins]] add additional authentication backend to the DokuWiki, which could be activated via configuration manager. | * [[Auth Plugins]] add additional authentication backend to the DokuWiki, which could be activated via configuration manager. | ||
+ | * [[CLI Plugins]] add command line tools to your plugin | ||
A simple plugin like [[plugin: | A simple plugin like [[plugin: | ||
=====Sources===== | =====Sources===== | ||
+ | |||
There are a number of sources especially for plugin development: | There are a number of sources especially for plugin development: | ||
* The [[devel: | * The [[devel: | ||
Line 81: | Line 27: | ||
* These [[security|security guidelines]] give some deeper understanding of common issues and presents some protection measures. | * These [[security|security guidelines]] give some deeper understanding of common issues and presents some protection measures. | ||
* Some general [[plugin programming tips]] are available, mostly good practices and pointers to handsome tools in DokuWiki. | * Some general [[plugin programming tips]] are available, mostly good practices and pointers to handsome tools in DokuWiki. | ||
+ | |||
===== Plugin Name ===== | ===== Plugin Name ===== | ||
Line 94: | Line 41: | ||
===== Plugin Wizard ===== | ===== Plugin Wizard ===== | ||
- | A Wizard to create the basic skeleton for a DokuWiki plugin can be found at http:// | + | A Wizard to create the basic skeleton for a DokuWiki plugin can be found at http:// |
If you later need to extend your plugin refer to the [[plugin_file_structure|plugin file structure]] on how files are arranged in a plugin. | If you later need to extend your plugin refer to the [[plugin_file_structure|plugin file structure]] on how files are arranged in a plugin. | ||
Line 102: | Line 49: | ||
If you created a plugin, please share it with the community. Just create a page named after your plugin in the plugin namespace. E.g. if your pluginfolder is named '' | If you created a plugin, please share it with the community. Just create a page named after your plugin in the plugin namespace. E.g. if your pluginfolder is named '' | ||
- | 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((You can use the [[plugin: | + | 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. When creating the new page, a namespace |
At the top of the plugin page a few metadata fields have to be filled. A description of each field can be found on [[plugin: | At the top of the plugin page a few metadata fields have to be filled. A description of each field can be found on [[plugin: | ||
- | From version Ponder Stibbons up an automated | + | Users will see that an update is available in the extension manager. For this to work properly it is necessary that the date “Last updated on” at the Plugin wiki page equals the date in the file [[devel: |
- | Uploads are not allowed on dokuwiki.org, | + | Uploads are not allowed on dokuwiki.org, |
Plugin developers can check the [[devel: | Plugin developers can check the [[devel: | ||
+ | |||
===== Overview of Plugin Survey===== | ===== Overview of Plugin Survey===== | ||
[[devel: | [[devel: | ||
devel/plugins.txt · Last modified: 2023-11-19 23:53 by Klap-in