プラグイン
Plugins provide a system of extending DokuWiki's features without the need to hack the original code (and so again on each update).
A Plugin is installed by putting it into its own folder beyond lib/plugins/. For many plugins this can be done automatically using the plugin manager.
There are several plugin types which interchange with different parts of DokuWiki. A plugin can consist of multiple types.
Currently available Plugin Types:
- more to come?
→ You can customize the design of DokuWiki by using templates.
Available Plugins
Did you create a plugin? Link it here.
Users please keep in mind the plugin API is still experimental2) and may change frequently, some plugins may not work due to API changes. If you encounter a non working plugin please contact the author and ask for an update.
Action Plugins
| Plugin Name | Info | Author | compatible DokuWiki version(s) | Incompatible with plugin(s) |
|---|---|---|---|---|
| akismet | Check edits against the Akismet webservice for spam | Andreas Gohr | devel | |
| Blog | Use DokuWiki as blogging tool | Esther Brunner | devel | Blog (old version) |
| badbehaviour | Test various headers and other HTTP related behaviour for bad spiders and spammers | Andreas Gohr | devel | |
| CAPTCHA | Use a CAPTCHA mechanism to protect the Wiki from automatic spamming | Andreas Gohr | devel | |
| Discussion | Add comments to a wiki page and show a simple thread list with recent comments | Esther Brunner | devel | Blog (old version) |
| GoogleSearch | Replace the wiki builtin search with Google's search API | Andreas Gohr | rc/devel | |
| Login Redirector | Redirect a dokuwiki login request to another URL | Christopher Smith | rc/devel | |
| Page Redirector | Redirect a wiki page to another wiki page | David Lorentsen | 2006-11-06 | |
| Tag | Assign category tags to wiki pages and show a simple topic list | Esther Brunner | devel | Blog (old version) |
| Template Switcher | Let the user switch the layout template for his/her current session | Gerry Weißbach | rc/devel | |
| userXtension V2.0 | This plugin provides another plugin type beside the syntax, admin and action plugins. It is the user plugin type. | Gerry Weißbach | devel | |
| Edit Section Reorganizer | Moves the edit section buttons up to their heading, and supports nested edit sections. | Ben Coburn | 2006-11-06 | |
| pdfex | Export PDF (a sample how to export any format) | Werner Flamme | rc/devel |
Admin Plugins
| Menu Sort | Plugin Name | Info | Author | compatible DokuWiki version(s) | Incompatible with plugin(s) |
|---|---|---|---|---|---|
| 1 | ACL | Manage page and namespace ACL settings (bundled with DokuWiki) | Frank Schubert | ||
| 2 | darcs | Interface for updating dokuwiki via darcs | Alexander 'E-Razor' Krause | ||
| 2 | user manager | Manage registered users (bundled with DokuWiki) Works with any auth backend | Christopher Smith | ||
| 20 | Plugin Manager | Manage your wiki's plugins (bundled with DokuWiki) | Christopher Smith | ||
| 40 | Searchindex Manager | Can (re)build the searchindex for the complete wiki | Andreas Gohr | ||
| 67/68 | CacheRevisionsEraser | Erase entire cache and/or old wiki revisions | JustBurn | ||
| 50 | zip | Backup to and restore from a zip file of wiki contents | Andrew Pilsch | ||
| 100 | Config | Manage your wiki's configuration settings (bundled with DokuWiki) | Christopher Smith | ||
| 101 | TxtConf | Manage your wiki's Text Configuration Files | Stephane Chamberland | dev [as of 2006-07-04] | |
| - | pagemove | Move and rename pages whilst maintaining the links | Gary Owen | ||
| - | BackupTool for DokuWiki | Backup your site and configuration data to a file. | Terence J. Grant | 2006-03-09 | |
| - | Google Analytics for DokuWiki | This tool allows you to set a code for use with Google Analytics, which allows you to track your visitors. | Terence J. Grant | 2006-03-09, 2006-09-28 | |
| - | sympaauth | Use Sympa mailing server for authentication and group definition]] | David Pépin CRU | 2006-03-09 | |
| - | Display Wiki Page for DokuWiki | This plugin defines an additional template function such that you can display more than one wiki page at a time on any given document. | Terence J. Grant | 2006-03-09, 2006-09-28 | |
| - | Referrers for DokuWiki | This plugin logs referrers for your site, so you can see where your traffic comes from. | Terence J. Grant | 2006-03-09, 2006-09-28 | |
| - | GeoURL for DokuWiki | This plugin allows you to set geographic data for your Wiki with GeoURL, which allows you and your visitors to find geotgaphicaly nearly sites. | Krzysztof Burghardt | 2006-03-09 |
Syntax Plugins
Formatting
| Sort | Plugin Name | Info | Author | compatible DokuWiki version(s) | Incompatible with plugin(s) | Depends on plugin(s) |
|---|---|---|---|---|---|---|
| 306 | actionlink | Lets you use actionlinks in your wiki syntax | nowotny | |||
| 30 | backlinks | Show A list of all the backlinks to the current page | Jonathan Arkell | |||
| 303 | Backlinks | Another Backlinks-Plugin that shows the backlinks to the current page. | Michael Klier | 2006-10-08 | backlinks | - |
| bibtex | Transform bibtex citations into nice APA format | Christophe Ambroise | ||||
| 357 | Bookmark | Insert bookmark. | Otto Vainio | |||
| 195 | Boxes | Boxes to highlight part of your page - in many styles | Christopher Smith | |||
| 105 | changelog | Show the changelog in a page | iDo | |||
| 999 | chessdiagram | Creates a chessboard from FEN or 8×8 characters | Michael Arlt | 2006-11-06 | ||
| 308 | Clearfloat | Small plugin to clear previous floating elements such as images. | Michael Klier | |||
| 51 | commentsrc | Make a text only visible when editing the page | iDo | |||
| 15 | complex_lists | Create complex multi-level lists with cross-references - suitable for writing legal documents such as contracts and statutes | Troy Rollo | |||
| 311 | Composer | Show contents of all files in a namespace, in a single page | Michael Grosser | 2006-03-09 | ||
| 309 | contact | Add a Contact Form to a page | Bob Baddeley | |||
| 155 | CSV | Display CSV as table | Steven Danz | |||
| 1 | datefilter | Filters lines if a date is found which is in the past | Michael Arlt | 2006-11-06 | ||
| 500 | Date/Time | Standardize date/time formats. (command) | Spider Joe | |||
| 174 | Diff | A diff highlighting plugin | M.Watermann | |||
| 7 | Directory content | Show content of a directory | Natalia Pujol | |||
| 10 | Definition List | (X)HTML Definition lists, simple syntax and smart styling | Christopher Smith | |||
| 18 | Definition List | (X)HTML style definition list | Matthias Watermann | |||
| 3 | Definition List | Another (X)HTML definition list. IMHO with better (simpler and smarter) syntax | Marc Wäckerlin | |||
| 157 | divalign | Align content left, right, center, or justify | Jason Byrne | |||
| 500 | Div/Span Shorthand | Shorthand for HTML divs and spans. | Spider Joe | |||
| 299 | externallink | Add links to pages in same host, but outside wiki | Otto Vainio | |||
| 404 | Folded | Allows folding spans (inline text) and folding divs (block elements) | Esther Brunner | |||
| 333 | gcalendar | Turn wiki-pages into a group-calendar with icons | Frank Hinkel | 2006-11-06 | ||
| 321 | Hidden Comment | Add comments / notes to your wiki source that won't be shown on the page | Esther Brunner | |||
| 90 | Highlight | Highlighting text in various colors | Joseph Nahmias | 2006-03-09 | ||
| 95 | Hilited | For highlighting text | Esther Brunner | |||
| 325 | HTML comment | Enables HTML comments. | Christopher Arndt | |||
| 6 | Horizontal Rule | Add Horizontal rules | Matthias Watermann | |||
| 305 | iframe | Load an external web page into your wiki page | Christopher Smith | |||
| 137 | In and Out | Enables a simple syntax for inserted and deleted text | design1st.org | |||
| 138 | indexmenu | Allows you to insert the index of a specified namespace in your pages | Samuele Tognini | 2006-03-09 and 2006-10-08rc | ||
| 138 | indexmenu2 | Allows you to insert the index of a specified namespace in your pages | Ilya Lebedev | 2006-03-09 | indexmenu | remotescript |
| 139 | alphaindex | Allows you to insert the alphabetical index of a namespace in a page | Hubert Molière | |||
| 155 | info | Displays information about DokuWikis internals (bundled with DokuWiki) | Andreas Gohr | |||
| 135 | Inserted | For marking text as inserted | Esther Brunner | |||
| 2 | Important_Paragraf | Create a paragraf with <div class="important"> or with any other class | Marc Wäckerlin | divalign | ||
| 1 | Important_Text | Mark a text with <span class="important"> or with any other class | Marc Wäckerlin | divalign | ||
| 444 | keyboard | Marks text as keyboard keys | Gina Haeussge | |||
| 109 | lastmod | Displays the timestamp of the last modification | Dennis Ploeger | |||
| 100 | linebreak | Generate line breaks in output for line breaks in raw wiki data | Christopher Smith | |||
| 244 | Link Way | Extends the link syntax so you can put the title before the brackets | Allen Ormond | |||
| 203 | navilevel | A navigation tree that adapts to the page that hosts it | thanos | 2006-03-09 | ||
| 176 | nbsp | Use non-breaking spaces | M.Watermann | |||
| 111 | Note | Display nice notes/tips/warnings | Olivier Cortes | |||
| 45 | NumberedHeadings | Adds numbered headings | Lars J. Metz | 2006-03-09 | ||
| 50 | outdent | Backout of section indenting (without using an empty header) | Christopher Smith | |||
| 1/1 | Outliner | Enable collapsible outline tree page layout | Pavel Vitis | |||
| 195 | Side Note | Allow sidenotes including image caption | Stephane Chamberland | |||
| 400 | signhere | Include a signature line in a wiki page | Dennis Ploeger | |||
| 107 | skill | Show Skill level for a page | iDo | |||
| 999 | songlist | Generate wiki code from lines of a master page, indexed by IDs | Reinhold Kainhofer | |||
| 999 | Tab | Inserts 5 non-breaking spaced to 'force' a tab | Tim Skoch | |||
| 9/500 | Term | Register term and then highlight it across whole page with <acronym> tag | Pavel Vitis | |||
| 358 | Timer | Show content on page at selected timeperiod | Otto Vainio | |||
| 304 | Uparrow | Shows a simple arrow-image which links to the top of the current page. | Michael Klier | |||
| 193 | xterm | documenting xterminal output without forcing linefeeds | Tom Trenker | 2006-03-09 | ||
| 195 | phpinc | Including a PHP/HTML file into your wiki | Markus Frosch | |||
| - | Anormal Tracker Plugin | Plugin to count visitors for external URLs and downloadable stuff via anormal tracker / | Gerry Weißbach | |||
| - | Menu Pop Up | Define a link or text to show an included DokuWiki page while hovered (description in German atm) | Gerry Weißbach | |||
| 205 | Styler | This plugin provide additional formatting of your texts: expanded quotations, epigraps, verses, etc | Ivan A-R | |||
| 299 | pageindex | Bulleted list of pages within an namespace | Kite | |||
| 299 | incl_form | Safely include PHP forms | Kite |
Formatting Replacements
| Sort | Plugin Name | Info | Author | compatible DokuWiki version(s) | Incompatible with plugin(s) |
|---|---|---|---|---|---|
| 275 | camelcase | A replacement for Dokuwiki CamelCase syntax, uses “_” to separate words in pages names | Christopher Smith | ||
| 195 | Code | A replacement for Dokuwiki <code>..</code> syntax, adds a title line | Christopher Smith | ||
| 8 | Un/Ordered List | (X)HTML style un/ordered lists | Matthias Watermann | ||
| 330 | Source | Include a file, with syntax highlighting, in a wiki page | Christopher Smith |
Markup Schemes
| Sort | Plugin Name | Info | Author | compatible DokuWiki version(s) | Incompatible with plugin(s) |
|---|---|---|---|---|---|
| 105 | BBCode | Makes the use of BBcode syntax possible | Esther Brunner | ||
| 9, 49, 105 | Creole | Adds Creole 0.1 support for DokuWiki | Esther Brunner | ||
| 200 | Docbook | Renders Docbook code as XHTML using XSLT | Daniel Calviño Sánchez | ||
| 100 | latexrender | parses latex blocks | Alexander 'E-Razor' Krause | ||
| 205 | Markdown | enables you to write pages using the markdown syntax | Carl-Christian Salvesen | ||
| 208 | Math Plugin | Render mathematical expressions graphically - 100% pure php! | Christopher Smith | ||
| 209 | MathMulti | Render math [(La)TeX or Plain Text idioma] expressions as image or MathML (use Mimetex, itex2mml or plain2mml) | Stephane Chamberland | ||
| 890 | Textile | textile markup | Myles Braithwaite | ||
| 100 | exttab1 | renders table in WikiMedia style | Werner Flamme | rc/devel |
Media
| Sort | Plugin Name | Info | Author | compatible DokuWiki version(s) | Incompatible with plugin(s) |
|---|---|---|---|---|---|
| 192 | ABC | Display sheet music | Anika Henke | 2005-07-01 - 2006-11-06 and devel | |
| 160 | Amazon | Pulls book info from Amazon | Andreas Gohr | ||
| 400 | Amazon-heavy | Pulls book and media info from Amazon | Thomas Baumann | ||
| 156 | chess | converts FEN Strings to a chess board | Tobias Gerner | ||
| 200 | ditaa | Convert ascii-flowcharts to png-files using ditaa | Dennis Ploeger | ||
| 731 | draw | Draw and edit diagrams using a Java Applet | Julian Rueth | ||
| 299 | Flickr | The Flickr plugin provides an easy access to any Flickr image. | Norbert Csík | ||
| 56 | fortune | Show qotd (Quote Of The Day) | Otto Vainio | ||
| 123 | Freemind | Display Freemind Mindmaps in your wiki. (command) | Patrick Maué | ||
| 301 | Gallery | Generate a gallery from images in a namespace | Andreas Gohr | ||
| - | Gallery | Generate a gallery from images in a namespace, can create and save thumbnails | Stefan Jahn | ||
| 100 | GNUplot | renders mathematical graphs nicely | Alexander 'E-Razor' Krause | ||
| 900 | google maps | Add google maps to your wiki page | Christopher Smith | 2006-03-05 and later | |
| 100 | Graphviz | New'n'fresh graphviz-plugin. Enjoy | Carl-Christian Salvesen | ||
| 313 | iCal | Creates iCal events that can be downloaded and added to your calendar | Esther Brunner | ||
| 322 | ISBN | Adds an Bookimage by ISBN and links to amazon | bektek | ||
| 298 | icq | Displays online status on ICQ users | Jakob Jensen | ||
| 312 | lastfm | Displays statistics from the last.fm Service for a given user | Michael Klier | >= 2006-03-09 | |
| 125 | mediamanager | Media Manager | Bob Baddeley | ||
| 999 | PhotoBlox | Uses BlogBox's PhotoBlox application to show galleries | Norbert Csík | ||
| 316 | sparkline | Enables display of sparkline graphs | Esther Brunner/Riny Heijdendael | ||
| 299 | toplist | Insert Toplist.cz status image into your dokuwiki page | Mario Lacko | ||
| 314 | vCard | Creates vCards that can be downloaded and added to your addressbook | Esther Brunner | ||
| 306 | video | Embed video into the page | Jason Byrne | ||
| 302 | xfortune | Show random fortune cookies (updated via AJAX) | Andreas Gohr | ||
| 310 | media_attached | media upload is attached to each page | Franz Xaver | ||
| - | Guestbook | A MySQL-based Guestbook with some security features, such as AntiSpam Array | Gerry Weißbach |
Behavior
| Sort | Plugin Name | Info | Author | compatible DokuWiki version(s) | Incompatible with plugin(s) | Depends on plugin(s) |
|---|---|---|---|---|---|---|
| 199 | addnewpage | Add a select box and an input box for adding new page | iDo | |||
| 300 | arguments | Return a value from $_GET array | Olivier Fraysse | |||
| 900/999 | autolink | Register page to be automatcally linked from other pages | Otto Vainio | |||
| 400 | bliki | Creates a simple blog engine using namespaces to store entries by date (apparently in development at the same time as Esther's!) | Beau Lebens | |||
| 307 | Blog | Display a number of recently changed pages of a given namespace | Esther Brunner | include | ||
| – | chat | AJAX-driven Chat plugin | Pavel Vitis | |||
| 98 | Cloud | Show a cloud of the most frequently used words | Esther Brunner | |||
| 308 | Content | Derivative of Blog plugin, with certain enhancement and extension | Adrian Sai-wah Tam | |||
| 500 | Command | Easily create custom syntax commands. | Spider Joe | |||
| 168 | Doodle | Create a poll that helps scheduling meetings | Esther Brunner | |||
| 239 | Explain | Explains terms and links to two alternative definitions. Terms are defined in a configuration file for the whole wiki. Just like acronyms. | Marc Wäckerlin | |||
| 249 | GOTO | Easily create redirects inside your wiki. | Allen Ormond | |||
| 360 | ifauth | Show content on page only for authorized group | Otto Vainio | |||
| 303 | Include | Include a wiki page in another | Esther Brunner | |||
| 303 | includeuserpage | include a page based on user name | Jean-Marc Lagacé | |||
| 1 | isns | if called page doesn't exist, convert pagename in namespace name and try to open the index | iDo | |||
| 498 | Language markup | text in a different language | Matthias Watermann | |||
| 108 | Local date | Display date/time in client's regional format | Pavel Vitis | |||
| 99 | Meta | Set Metadata | Esther Brunner | |||
| 50 | multinamespace | Allow to put a file in multiple namespace | iDo | |||
| 106 | newpage | Add a link wich allow user to add a new page in wiki | iDo | |||
| 990 | orphanswanted | Find Orphan pages, Wanted pages with reference counts. Also shows reference counts for linked pages | D A Edmunds | |||
| 0 | phpwikify (Discuss) | Allows one the possibility of having output of php scripts parsed | Kasper Sandberg | |||
| 167 | Poll | Create a poll on your wiki page | Esther Brunner | |||
| 314? | Routeplaner | Extand contact information with a description of the journey using lycos.de. | Deshi | |||
| 107 | socialmark | Add link to “social bookmark” a page | iDo | |||
| 555 | sql | Execute SQL query and display the result as a table | Slim Amamou | |||
| 129 | stats | Show some wiki statistics | Paco Avila (Monkiki) | |||
| 500 | Template | Render a data set from a template. (command) | Spider Joe | |||
| 302 | templater | Allow wikipages to become templates for inclusion into other wikipages, like wikipedia | Jonathan Arkell | |||
| 99 | Variable | Display some dynamic info like current page, user or date | Esther Brunner | |||
| 158 | WordPress Most Recent Entries(discuss) | Show recent(or all) entries from any WordPress blog using a template. | Peter DeWeese | |||
| - | Diskussion Forum | Bliki-based Diskussion Forum | Thomas Preißler | |||
| - | remotescript | Remote Scripting (Ajax) controller to create ajax-aware plugins | Ilya Lebedev | 2006-03-09 | ||
| - | livepreview | Live preview for the Dokuwiki pages, taked from the server using the RemoteScript controller | Ilya Lebedev | 2006-03-09 | remotescript |
Plugins that don't fit above
Sorry, people. I don't know, where to fit this new plugin as it is some kind of “template”-plugin and it doesn't follow the normal plugin structure. Please correct the place. Thanks.
Dennis Ploeger 2006-05-02 11:34
It's not really a plugin but more of a tip/hack as it requires actual modification of core DokuWiki code. I suspect you could make it into a plugin using the new event system and action plugins.
| Sort | Plugin Name | Info | Author | compatible DokuWiki version(s) |
|---|---|---|---|---|
| 999 | template_chooser | A simple dropdown box in editmode allows you to paste content from a template into the current document | Dennis Ploeger | |
| 100/999 | DokuTeXit | Generate LaTeX file from dokuwiki format and so PDF files (if latex is present) |