Displays some information about DokuWiki's internals. (bundled with DokuWiki)
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.
~~INFO:keyword~~
| 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 |
| 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. ;-)
Arbitrary attribute definition and storage for user associated data.
$attribute = plugin_load('helper', 'attribute');| 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 |
| Description | Generates a list of users that have assigned attributes in the specified namespace. | |
|---|---|---|
| Return value | users | array |
| 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 |
| 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 |
| 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 |
| 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 |
| Description | Deletes all attribute data for a specified namespace for a user. Only useable by an admin. | |
|---|---|---|
| Return value | success | boolean |
Syntax and helper plugins for tooltips, including automatically generated tips based on page abstract.
$autotooltip = plugin_load('helper', 'autotooltip');| 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 |
| 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 |
Provides discussion funtionality for wiki pages
$discussion = plugin_load('helper', 'discussion');| Description | returns the header of the comments column for pagelist | |
|---|---|---|
| Return value | header | string |
| Description | returns the link to the discussion section with number of comments | |
|---|---|---|
| Parameters | id | string |
| number of comments (optional) | integer | |
| Return value | link | string |
| Description | returns pages with discussion sections, sorted by recent comments | |
|---|---|---|
| Parameters | namespace | string |
| number (optional) | integer | |
| Return value | pages | array |
| Description | returns recently added or edited comments individually | |
|---|---|---|
| Parameters | namespace | string |
| number (optional) | integer | |
| Return value | pages | array |
| Description | check if current user is member of moderator groups | |
|---|---|---|
| Return value | isModerator | boolean |
Lists pages in a nice formatted way
$pagelist = plugin_load('helper', 'pagelist');| Description | (optional) adds an extra column for plugin data | |
|---|---|---|
| Parameters | plugin name | string |
| column key | string | |
| Description | (optional) override value of an existing column, value equal to false disables column | |
|---|---|---|
| Parameters | column key | string |
| value | int|bool | |
| Description | (optional) Provide header data, if not given default values or [plugin]->th() is used | |
|---|---|---|
| Parameters | column key | string |
| value | int|bool | |
| Description | (optional) overrides default flags, or en/disable existing columns | |
|---|---|---|
| Parameters | flags | array |
| Return value | success | boolean |
| Description | (required) prepares the table header for the page list | |
|---|---|---|
| Description | (required) adds a page to the list | |
|---|---|---|
| Parameters | page attributes, 'id' required, others optional | array |
| Description | (required) returns the XHTML output | |
|---|---|---|
| Return value | xhtml | string |
tag wiki pages
$tag = plugin_load('helper', 'tag');| Description | takes an array of sortflags and overrides predefined value | |
|---|---|---|
| Parameters | name | string |
| Description | returns the header for the tags column for pagelist | |
|---|---|---|
| Return value | header | string |
| Description | returns the tag links of a given page | |
|---|---|---|
| Parameters | id | string |
| Return value | links | string |
| Description | generates tag links for given words | |
|---|---|---|
| Parameters | tags | array |
| Return value | links | string |
| 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 |
| Description | refines an array of pages with tags | |
|---|---|---|
| Parameters | pages to refine | array |
| refinement tags | string | |
| Return value | pages | array |
| 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 |