User Tools

Site Tools


Sidebar


Site Information


Interactive Maps

Sidebar

site:plugins

Installed Plugins

~~INFO:syntaxplugins~~

~~INFO:adminplugins~~

~~INFO:actionplugins~~

~~INFO:rendererplugins~~

~~INFO:helperplugins~~

~~INFO:helpermethods~~

Popularity Feedback Plugin

Send anonymous data about your wiki to the DokuWiki developers

$popularity = plugin_load('helper', 'popularity');

$popularity->isAutoSubmitEnabled()

DescriptionCheck if autosubmit is enabled
Return valueresultbool

$popularity->sendData()

DescriptionSend the popularity data
Parametersdatastring

$popularity->gatherAsString()

DescriptionGather the popularity data
Return valuedatastring

$popularity->lastSentTime()

DescriptionCompute the last time popularity data was sent
Return valuedataint

Pagelist Plugin

Lists pages in a nice formatted way

$pagelist = plugin_load('helper', 'pagelist');

$pagelist->addColumn()

Descriptionadds an extra column for plugin data
Parametersplugin namestring
column keystring

$pagelist->setFlags()

Descriptionoverrides standard values for showfooter and firstseconly settings
Parametersflagsarray
Return valuesuccessboolean

$pagelist->startList()

Descriptionprepares the table header for the page list

$pagelist->addPage()

Descriptionadds a page to the list
Parameterspage attributes, 'id' required, others optionalarray

$pagelist->finishList()

Descriptionreturns the XHTML output
Return valuexhtmlstring

Tag Plugin

tag wiki pages

$tag = plugin_load('helper', 'tag');

$tag->th()

Descriptionreturns the header for the tags column for pagelist
Return valueheaderstring

$tag->td()

Descriptionreturns the tag links of a given page
Parametersidstring
Return valuelinksstring

$tag->tagLinks()

Descriptiongenerates tag links for given words
Parameterstagsarray
Return valuelinksstring

$tag->getTopic()

Descriptionreturns a list of pages tagged with the given keyword
Parametersnamespace (optional)string
number (not used)integer
tag (required)string
Return valuepagesarray

$tag->tagRefine()

Descriptionrefines an array of pages with tags
Parameterspages to refinearray
refinement tagsstring
Return valuepagesarray

$tag->tagOccurrences()

Descriptionreturns a list of tags with their number of occurrences
Parameterslist of tags to get the occurrences forarray
namespaces to which the search shall be restrictedarray
if all tags shall be returned (then the first parameter is ignored)boolean
if the namespaces shall be searched recursivelyboolean
Return valuetagsarray

include plugin

Functions to include another page in a wiki page

$include = plugin_load('helper', 'include');

$include->get_flags()

Descriptionoverrides standard values for showfooter and firstseconly settings
Parametersflagsarray

discussion plugin

Provides discussion funtionality for wiki pages

$discussion = plugin_load('helper', 'discussion');

$discussion->th()

Descriptionreturns the header of the comments column for pagelist
Return valueheaderstring

$discussion->td()

Descriptionreturns the link to the discussion section with number of comments
Parametersidstring
number of comments (optional)integer
Return valuelinkstring

$discussion->getThreads()

Descriptionreturns pages with discussion sections, sorted by recent comments
Parametersnamespacestring
number (optional)integer
Return valuepagesarray

$discussion->getComments()

Descriptionreturns recently added or edited comments individually
Parametersnamespacestring
number (optional)integer
Return valuepagesarray
site/plugins.txt · Last modified: 2016/10/10 04:30 by terrill