wiki:plugin:info
Содержание
Info Plugin
Совместим с «Докувики»
(bundled)
Displays some information about DokuWiki's internals. (bundled with DokuWiki)
Description
The plugin serves as simple sample syntax plugin and is included in the DokuWiki distribution. It is able to display some information about DokuWiki's internals, for example a list of installed and enabled plugins.
Syntax
~~INFO:keyword~~
- keyword can be one of:
- syntaxmodes — Displays the complete list of parser modes together with their getSort() values. See also syntax plugins.
- syntaxtypes — Displays which syntax types are used by available plugins. The syntax type determine which syntax may be nested.
- syntaxplugins — Displays a list of available syntax plugins.
- adminplugins — Displays a list of available admin plugins.
- actionplugins — Displays a list of available action plugins.
- rendererplugins — Displays a list of available render plugins.
- helperplugins — Displays a list of available helper plugins.
- helpermethods — Displays documentation of helper plugin class methods along with parameters and return values. One example of a helper plugin supporting this is pagelist.
- datetime — Shows the current date and time. This will be cached with the page. It can be used for cache debugging.
Examples
~~INFO:syntaxmodes~~
| plugin_phpwikify | 0 |
| listblock | 10 |
| plugin_tablelayout | 20 |
| preformatted | |
| notoc | 30 |
| plugin_dw2pdf_pagesetting | 40 |
| nocache | |
| plugin_dw2pdf_exportlink | 41 |
| header | 50 |
| plugin_diagram_splitter | 55 |
| table | 60 |
| plugin_typography_base | 67 |
| plugin_typography_bgcolor | |
| plugin_typography_fontcolor | |
| plugin_typography_fontfamily | |
| plugin_typography_fontsize | |
| plugin_typography_fontweight | |
| plugin_typography_smallcaps | |
| plugin_typography_webfont | |
| strong | 70 |
| emphasis | 80 |
| underline | 90 |
| plugin_description | 98 |
| plugin_meta | 99 |
| plugin_fontawesome_fontawesome | 100 |
| monospace | |
| plugin_htmlmetatags_syntax | 110 |
| subscript | |
| superscript | 120 |
| deleted | 130 |
| plugin_dbquery_query | 135 |
| linebreak | 140 |
| plugin_xref | 150 |
| footnote | |
| plugin_dbquery_macro | 155 |
| plugin_info | |
| plugin_pluginrepo_entry | |
| plugin_pluginrepo_news | |
| plugin_pluginrepo_query | |
| plugin_pluginrepo_table | |
| plugin_statdisplay | |
| plugin_translation_notrans | |
| plugin_translation_trans | |
| hr | 160 |
| plugin_autotooltip | 165 |
| plugin_pagelist | 168 |
| unformatted | 170 |
| plugin_htmlok_phpblock | 180 |
| plugin_htmlok_phpok | |
| plugin_htmlok_htmlblock | 190 |
| plugin_htmlok_htmlok | |
| plugin_dokuteaser_closesection | 195 |
| plugin_dokuteaser_dokuteaser | |
| plugin_htmldetailstag_details | |
| plugin_htmldetailstag_summary | |
| plugin_note | |
| plugin_wrap_closesection | |
| plugin_wrap_div | |
| plugin_wrap_divblock | |
| plugin_wrap_divwrap | |
| plugin_wrap_span | |
| plugin_wrap_spaninline | |
| plugin_wrap_spanwrap | |
| plugin_codeprettify_code | 199 |
| plugin_cellbg | 200 |
| plugin_rating | |
| code | |
| file | 210 |
| quote | 220 |
| plugin_discussion_comments | 230 |
| smiley | |
| acronym | 240 |
| entity | 260 |
| multiplyentity | 270 |
| quotes | 280 |
| plugin_tag_searchtags | 295 |
| plugin_tag_topic | |
| plugin_icons_breeze | 299 |
| plugin_icons_fa | |
| plugin_icons_fab | |
| plugin_icons_fl | |
| plugin_icons_flag | |
| plugin_icons_fugue | |
| plugin_icons_glyphicon | |
| plugin_icons_icon | |
| plugin_icons_mdi | |
| plugin_icons_oxygen | |
| plugin_icons_ra | |
| plugin_icons_silk | |
| plugin_icons_typcn | |
| plugin_stars2 | |
| internallink | 300 |
| plugin_gallery_list | 301 |
| plugin_gallery_main | |
| plugin_tag_count | 305 |
| plugin_tag_tag | |
| plugin_tag_tagpage | |
| plugin_discussion_threads | 306 |
| rss | 310 |
| plugin_diagrams_embed | 319 |
| plugin_diagrams_mediafile | |
| media | 320 |
| externallink | 330 |
| emaillink | 340 |
| windowssharelink | 350 |
| eol | 370 |
| plugin_stepbystep_innerstep | 410 |
| plugin_stepbystep_step | |
| plugin_diagram_main | 999 |
~~INFO:syntaxtypes~~
| container | listblock, table, quote, hr, plugin_diagram_main, plugin_diagram_splitter, plugin_htmldetailstag_details, plugin_htmldetailstag_summary, plugin_note, plugin_tablelayout |
| baseonly | header |
| formatting | strong, emphasis, underline, monospace, subscript, superscript, deleted, footnote, plugin_cellbg, plugin_dokuteaser_dokuteaser, plugin_typography_base, plugin_typography_bgcolor, plugin_typography_fontcolor, plugin_typography_fontfamily, plugin_typography_fontsize, plugin_typography_fontweight, plugin_typography_smallcaps, plugin_typography_webfont, plugin_wrap_div, plugin_wrap_divblock, plugin_wrap_divwrap, plugin_wrap_span, plugin_wrap_spaninline, plugin_wrap_spanwrap |
| substition | acronym, smiley, wordblock, entity, camelcaselink, internallink, media, externallink, linebreak, emaillink, windowssharelink, filelink, notoc, nocache, multiplyentity, quotes, rss, plugin_autotooltip, plugin_dbquery_macro, plugin_dbquery_query, plugin_description, plugin_diagrams_embed, plugin_diagrams_mediafile, plugin_discussion_comments, plugin_discussion_threads, plugin_dokuteaser_closesection, plugin_dw2pdf_exportlink, plugin_dw2pdf_pagesetting, plugin_fontawesome_fontawesome, plugin_gallery_list, plugin_gallery_main, plugin_htmlmetatags_syntax, plugin_icons_breeze, plugin_icons_fa, plugin_icons_fab, plugin_icons_fl, plugin_icons_flag, plugin_icons_fugue, plugin_icons_glyphicon, plugin_icons_icon, plugin_icons_mdi, plugin_icons_oxygen, plugin_icons_ra, plugin_icons_silk, plugin_icons_typcn, plugin_info, plugin_meta, plugin_pagelist, plugin_pluginrepo_entry, plugin_pluginrepo_news, plugin_pluginrepo_query, plugin_pluginrepo_table, plugin_stars2, plugin_statdisplay, plugin_stepbystep_innerstep, plugin_stepbystep_step, plugin_tag_count, plugin_tag_searchtags, plugin_tag_tag, plugin_tag_tagpage, plugin_tag_topic, plugin_translation_notrans, plugin_translation_trans, plugin_wrap_closesection, plugin_xref |
| protected | preformatted, code, file, plugin_codeprettify_code, plugin_htmlok_htmlblock, plugin_htmlok_htmlok, plugin_htmlok_phpblock, plugin_htmlok_phpok, plugin_phpwikify, plugin_rating |
| disabled | unformatted |
| paragraphs | eol |
'Substition' may look like a typo, but it's not (any more). It's transformed into the “standard”. See this footnote for an explanation. ;-)
~~INFO:syntaxplugins~~
- Auto-Tooltip 2025-07-20 — Eli Fenton
Syntax and helper plugins for tooltips, including automatically generated tips based on page abstract. - Code Prettifier 2023-09-16 — Satoshi Sahara
syntax highlighting of source code snippets in wiki page using Javascript code prettifier - description plugin 2025-05-16 — Mark C. Prins, Ikuo Obataya, Matthias Schulte
Add a specified string to a description meta header - discussion plugin 2021-12-31 — Michael Hamann, Gerrit Uitslag, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner, Matthias Schulte
Provides discussion funtionality for wiki pages - Gallery Plugin 2024-04-30 — Andreas Gohr
Creates a gallery of images from a namespace or RSS/ATOM feed - HTML Details Tag Plugin 2021-03-18 — Sascha Klawohn
Use the HTML <details> and <summary> tag for toggling information - Meta plugin 2024-08-07 — Michael Hamann
Set Metadata for the current page. (previous authors: Esther Brunner, Gina Häußge, Michael Klier) - Pagelist Plugin 2023-08-27 — Matthias Schulte, Michael Hamann, Michael Klier, Gina Haeussge
Lists pages in a nice formatted way - Repository plugin 2024-02-09 — Andreas Gohr/Håkan Sandell
Helps organizing the plugin and template repository - StepByStep plugin 2023-09-25 — saggi
Displays step-by-step tutorials, spoilers, or more information about a topic - tablelayout plugin 2022-03-28 — Michael Große
Set the width of table columns and set which lines to fix - Tag Plugin 2023-10-17 — Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
tag wiki pages - Typography plugin 2020-07-31 — Satoshi Sahara
Enable typesetting capabilities with CSS font properties such as font face, size, weight, and color of text - Wrap Plugin 2023-08-13 — Anika Henke
Universal plugin which combines functionalities of many other plugins. Wrap wiki text inside containers (divs or spans) and give them a class (choose from a variety of preset classes), a width and/or a language with its associated text direction.
~~INFO:adminplugins~~
- BackupTool for DokuWiki 1.0.1 2020-10-21 — Terence J. Grant
A tool to backup your data and configuration. - CustomButtons Plugin 2021-02-28 — Constantinos Xanthopoulos, Gerrit Uitslag
A plugin for adding custom buttons to the toolbar, to shortcut commonly used code blocks. - discussion plugin 2021-12-31 — Michael Hamann, Gerrit Uitslag, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner, Matthias Schulte
Provides discussion funtionality for wiki pages - IP Ban Manager 2019-07-31 — Andreas Gohr
Allows administrators and managers to ban certain IP addresses from accessing the wiki - Popularity Feedback Plugin 2015-07-15 — Andreas Gohr
Send anonymous data about your wiki to the DokuWiki developers - Revert Manager 2015-07-15 — Andreas Gohr
Allows you to mass revert recent edits to remove Spam or vandalism - Two Factor Authentication - Core Plugin 2024-03-27 — Andreas Gohr, Michael Wilmes
Creates a two factor authentication mechanism - DokuWiki Upgrade Plugin 2025-12-09 — Andreas Gohr
Automatically upgrade your DokuWiki install to the most recent stable release
~~INFO:actionplugins~~
- Auto-Tooltip 2025-07-20 — Eli Fenton
Syntax and helper plugins for tooltips, including automatically generated tips based on page abstract. - CAPTCHA Plugin 2023-12-06 — Andreas Gohr
Use a CAPTCHA challenge to protect DokuWiki against automated spam - Code Prettifier 2023-09-16 — Satoshi Sahara
syntax highlighting of source code snippets in wiki page using Javascript code prettifier - CustomButtons Plugin 2021-02-28 — Constantinos Xanthopoulos, Gerrit Uitslag
A plugin for adding custom buttons to the toolbar, to shortcut commonly used code blocks. - description plugin 2025-05-16 — Mark C. Prins, Ikuo Obataya, Matthias Schulte
Add a specified string to a description meta header - discussion plugin 2021-12-31 — Michael Hamann, Gerrit Uitslag, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner, Matthias Schulte
Provides discussion funtionality for wiki pages - Gallery Plugin 2024-04-30 — Andreas Gohr
Creates a gallery of images from a namespace or RSS/ATOM feed - IP Ban Manager 2019-07-31 — Andreas Gohr
Allows administrators and managers to ban certain IP addresses from accessing the wiki - DokuWiki plugin for Matomo 2018-05-19 — Marcel Lange
Plugin for the new 3.x version of Matomo (formaly Piwik). It's the followup version of https://www.dokuwiki.org/plugin:piwik2 - Repository plugin 2024-02-09 — Andreas Gohr/Håkan Sandell
Helps organizing the plugin and template repository - Popularity Feedback Plugin 2015-07-15 — Andreas Gohr
Send anonymous data about your wiki to the DokuWiki developers - safefnrecode plugin 2012-07-28 — Andreas Gohr
Changes existing page and foldernames for the change in the safe filename encoding - tablelayout plugin 2022-03-28 — Michael Große
Set the width of table columns and set which lines to fix - Tag Plugin 2023-10-17 — Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
tag wiki pages - Two Factor Authentication - Google Authenticator Plugin 2022-04-07 — Anna Dabrowska, Michael Wilmes
Google Authenticator support plugin for the Twofactor authentication plugin. - Two Factor Authentication - Core Plugin 2024-03-27 — Andreas Gohr, Michael Wilmes
Creates a two factor authentication mechanism - Typography plugin 2020-07-31 — Satoshi Sahara
Enable typesetting capabilities with CSS font properties such as font face, size, weight, and color of text - Wrap Plugin 2023-08-13 — Anika Henke
Universal plugin which combines functionalities of many other plugins. Wrap wiki text inside containers (divs or spans) and give them a class (choose from a variety of preset classes), a width and/or a language with its associated text direction.
~~INFO:rendererplugins~~
- Auto-Tooltip 2025-07-20 — Eli Fenton
Syntax and helper plugins for tooltips, including automatically generated tips based on page abstract.
~~INFO:helperplugins~~
- Attribute Plugin 2023-07-11 — CosmoCode & Michael Wilmes
Arbitrary attribute definition and storage for user associated data. - Auto-Tooltip 2025-07-20 — Eli Fenton
Syntax and helper plugins for tooltips, including automatically generated tips based on page abstract. - CAPTCHA Plugin 2023-12-06 — Andreas Gohr
Use a CAPTCHA challenge to protect DokuWiki against automated spam - discussion plugin 2021-12-31 — Michael Hamann, Gerrit Uitslag, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner, Matthias Schulte
Provides discussion funtionality for wiki pages - Pagelist Plugin 2023-08-27 — Matthias Schulte, Michael Hamann, Michael Klier, Gina Haeussge
Lists pages in a nice formatted way - Repository plugin 2024-02-09 — Andreas Gohr/Håkan Sandell
Helps organizing the plugin and template repository - Popularity Feedback Plugin 2015-07-15 — Andreas Gohr
Send anonymous data about your wiki to the DokuWiki developers - tablelayout plugin 2022-03-28 — Michael Große
Set the width of table columns and set which lines to fix - Tag Plugin 2023-10-17 — Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
tag wiki pages - Typography plugin 2020-07-31 — Satoshi Sahara
Enable typesetting capabilities with CSS font properties such as font face, size, weight, and color of text - DokuWiki Upgrade Plugin 2025-12-09 — Andreas Gohr
Automatically upgrade your DokuWiki install to the most recent stable release - Wrap Plugin 2023-08-13 — Anika Henke
Universal plugin which combines functionalities of many other plugins. Wrap wiki text inside containers (divs or spans) and give them a class (choose from a variety of preset classes), a width and/or a language with its associated text direction.
~~INFO:helpermethods~~
Attribute Plugin
Arbitrary attribute definition and storage for user associated data.
$attribute = plugin_load('helper', 'attribute');$attribute->enumerateAttributes()
| Description | Generates a list of known attributes in the specified namespace for a user. If user is present, must be an admin, otherwise defaults to currently logged in user. | |
|---|---|---|
| Return value | attributes | array |
$attribute->enumerateUsers()
| Description | Generates a list of users that have assigned attributes in the specified namespace. | |
|---|---|---|
| Return value | users | array |
$attribute->set()
| Description | Set the value of an attribute in a specified namespace. Returns boolean success (false if something went wrong). If user is present, must be an admin, otherwise defaults to currently logged in user. | |
|---|---|---|
| Return value | success | boolean |
$attribute->exists()
| Description | Checks if an attribute exists for a user in a given namespace. If user is present, must be an admin, otherwise defaults to currently logged in user. | |
|---|---|---|
| Return value | exists | boolean |
$attribute->del()
| Description | Deletes attribute data in a specified namespace by its name. If user is present, must be an admin, otherwise defaults to currently logged in user. | |
|---|---|---|
| Return value | success | boolean |
$attribute->get()
| Description | Retrieves a value for an attribute in a specified namespace. Returns retrieved value or null. $success out-parameter can be checked to check success (you may have false, null, 0, or '' as stored value). If user is present, must be an admin, otherwise defaults to currently logged in user. | |
|---|---|---|
| Return value | value | mixed |
$attribute->purge()
| Description | Deletes all attribute data for a specified namespace for a user. Only useable by an admin. | |
|---|---|---|
| Return value | success | boolean |
Auto-Tooltip
Syntax and helper plugins for tooltips, including automatically generated tips based on page abstract.
$autotooltip = plugin_load('helper', 'autotooltip');$autotooltip->forText()
| Description | Manually construct a tooltip | |
|---|---|---|
| Parameters | content | string |
| tooltip | string | |
| title (optional) | string | |
| preTitle (optional) | string | |
| classes (optional) | string | |
| textClasses (optional) | string | |
| Return value | result | string |
$autotooltip->forWikilink()
| Description | Generate a tooltip from a wikilink | |
|---|---|---|
| Parameters | id | string |
| content (optional) | string | |
| preTitle (optional) | string | |
| classes (optional) | string | |
| textClasses (optional) | string | |
| Return value | result | string |
discussion plugin
Provides discussion funtionality for wiki pages
$discussion = plugin_load('helper', 'discussion');$discussion->th()
| Description | returns the header of the comments column for pagelist | |
|---|---|---|
| Return value | header | string |
$discussion->td()
| Description | returns the link to the discussion section with number of comments | |
|---|---|---|
| Parameters | id | string |
| number of comments (optional) | integer | |
| Return value | link | string |
$discussion->getThreads()
| Description | returns pages with discussion sections, sorted by recent comments | |
|---|---|---|
| Parameters | namespace | string |
| number (optional) | integer | |
| Return value | pages | array |
$discussion->getComments()
| Description | returns recently added or edited comments individually | |
|---|---|---|
| Parameters | namespace | string |
| number (optional) | integer | |
| Return value | pages | array |
$discussion->isDiscussionModerator()
| Description | check if current user is member of moderator groups | |
|---|---|---|
| Return value | isModerator | boolean |
Pagelist Plugin
Lists pages in a nice formatted way
$pagelist = plugin_load('helper', 'pagelist');$pagelist->addColumn()
| Description | (optional) adds an extra column for plugin data | |
|---|---|---|
| Parameters | plugin name | string |
| column key | string | |
$pagelist->modifyColumn()
| Description | (optional) override value of an existing column, value equal to false disables column | |
|---|---|---|
| Parameters | column key | string |
| value | int|bool | |
$pagelist->setHeader()
| Description | (optional) Provide header data, if not given default values or [plugin]->th() is used | |
|---|---|---|
| Parameters | column key | string |
| value | int|bool | |
$pagelist->setFlags()
| Description | (optional) overrides default flags, or en/disable existing columns | |
|---|---|---|
| Parameters | flags | array |
| Return value | success | boolean |
$pagelist->startList()
| Description | (required) prepares the table header for the page list | |
|---|---|---|
$pagelist->addPage()
| Description | (required) adds a page to the list | |
|---|---|---|
| Parameters | page attributes, 'id' required, others optional | array |
$pagelist->finishList()
| Description | (required) returns the XHTML output | |
|---|---|---|
| Return value | xhtml | string |
Tag Plugin
tag wiki pages
$tag = plugin_load('helper', 'tag');$tag->overrideSortFlags()
| Description | takes an array of sortflags and overrides predefined value | |
|---|---|---|
| Parameters | name | string |
$tag->th()
| Description | returns the header for the tags column for pagelist | |
|---|---|---|
| Return value | header | string |
$tag->td()
| Description | returns the tag links of a given page | |
|---|---|---|
| Parameters | id | string |
| Return value | links | string |
$tag->tagLinks()
| Description | generates tag links for given words | |
|---|---|---|
| Parameters | tags | array |
| Return value | links | string |
$tag->getTopic()
| Description | returns a list of pages tagged with the given keyword | |
|---|---|---|
| Parameters | namespace (optional) | string |
| number (not used) | integer | |
| tag (required) | string | |
| Return value | pages | array |
$tag->tagRefine()
| Description | refines an array of pages with tags | |
|---|---|---|
| Parameters | pages to refine | array |
| refinement tags | string | |
| Return value | pages | array |
$tag->tagOccurrences()
| Description | returns a list of tags with their number of occurrences | |
|---|---|---|
| Parameters | list of tags to get the occurrences for | array |
| namespaces to which the search shall be restricted | array | |
| if all tags shall be returned (then the first parameter is ignored) | boolean | |
| if the namespaces shall be searched recursively | boolean | |
| Return value | tags | array |
Только авторизованные участники могут оставлять комментарии.
wiki/plugin/info.txt · Последнее изменение: — VladPolskiy