Inhaltsverzeichnis

Info Plugin

~~INFO:syntaxmodes~~

listblock10
preformatted20
notoc30
plugin_dw2pdf_pagesetting40
nocache
plugin_dw2pdf_exportlink41
header50
table60
plugin_mathjax_protecttex65
strong70
emphasis80
underline90
plugin_cloud98
plugin_siteexport_toc100
monospace
plugin_inlinejs_preloader110
plugin_keywords_keywords
subscript
superscript120
deleted130
linebreak140
footnote150
plugin_bureaucracy155
plugin_info
plugin_simplenavi
plugin_vshare_debug
plugin_color158
plugin_vshare_video159
hr160
plugin_pagelist168
unformatted170
plugin_confightmlok_html190
plugin_confightmlok_htmlblock
plugin_wrap_closesection195
plugin_wrap_div
plugin_wrap_divblock
plugin_wrap_divwrap
plugin_wrap_span
plugin_wrap_spaninline
plugin_wrap_spanwrap
plugin_addnewpage199
plugin_sectiontoggle
code200
file210
quote220
plugin_discussion_comments230
smiley
acronym240
plugin_todo_list250
entity260
multiplyentity270
quotes280
plugin_tag_searchtags295
plugin_tag_topic
plugin_inclform299
plugin_subpages
plugin_siteexport_aggregate300
plugin_siteexport_siteexport
internallink
plugin_gallery_list301
plugin_gallery_main
plugin_jplayer
plugin_inlinejs_embedblock305
plugin_inlinejs_embedcss
plugin_inlinejs_embedder
plugin_inlinejs_embedinline
plugin_tag_count
plugin_tag_tag
plugin_tag_tagpage
plugin_discussion_threads306
rss310
plugin_avatar315
plugin_svgembed
plugin_caption_caption319
plugin_caption_reference
media320
externallink330
emaillink340
windowssharelink350
eol370
plugin_siteexport_toctools999
plugin_todo_todo

~~INFO:syntaxtypes~~

containerlistblock, table, quote, hr, plugin_caption_caption, plugin_svgembed
baseonlyheader
formattingstrong, emphasis, underline, monospace, subscript, superscript, deleted, footnote, plugin_color, plugin_wrap_div, plugin_wrap_divblock, plugin_wrap_divwrap, plugin_wrap_span, plugin_wrap_spaninline, plugin_wrap_spanwrap
substitionacronym, smiley, wordblock, entity, camelcaselink, internallink, media, externallink, linebreak, emaillink, windowssharelink, filelink, notoc, nocache, multiplyentity, quotes, rss, plugin_addnewpage, plugin_avatar, plugin_bureaucracy, plugin_caption_reference, plugin_cloud, plugin_discussion_comments, plugin_discussion_threads, plugin_dw2pdf_exportlink, plugin_dw2pdf_pagesetting, plugin_gallery_list, plugin_gallery_main, plugin_inclform, plugin_info, plugin_jplayer, plugin_keywords_keywords, plugin_pagelist, plugin_sectiontoggle, plugin_simplenavi, plugin_siteexport_aggregate, plugin_siteexport_siteexport, plugin_siteexport_toctools, plugin_subpages, plugin_tag_count, plugin_tag_searchtags, plugin_tag_tag, plugin_tag_tagpage, plugin_tag_topic, plugin_todo_list, plugin_todo_todo, plugin_vshare_debug, plugin_vshare_video, plugin_wrap_closesection
protectedpreformatted, code, file, plugin_inlinejs_embedblock, plugin_inlinejs_embedcss, plugin_inlinejs_embedder, plugin_inlinejs_embedinline, plugin_inlinejs_preloader, plugin_mathjax_protecttex, plugin_siteexport_toc
disabledunformatted, plugin_confightmlok_html, plugin_confightmlok_htmlblock
paragraphseol

'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~~

~~INFO:adminplugins~~

~~INFO:actionplugins~~

~~INFO:rendererplugins~~

~~INFO:helperplugins~~

~~INFO:helpermethods~~

Avatar

Displays avatar images

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

$avatar->getXHTML()

Descriptionreturns the XHTML to display an avatar
Parametersuser or mailstring
title (optional)string
align (optional)string
size (optional)integer
Return valuexhtmlstring

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_action->run()

DescriptionHandle the user input
Parametersfieldshelper_plugin_bureaucracy_field[]
thanksstring
argvarray
Return valuefalse on error, thanks message on successbool|string

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_actionmail->run()

DescriptionHandle the user input
Parametersfieldshelper_plugin_bureaucracy_field[]
thanksstring
argvarray
Return valuefalse on error, thanks message on successbool|string

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_actionscript->run()

DescriptionHandle the user input
Parametersfieldshelper_plugin_bureaucracy_field[]
thanksstring
argvarray
Return valuefalse on error, thanks message on successbool|string

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_actiontemplate->run()

DescriptionHandle the user input
Parametersfieldshelper_plugin_bureaucracy_field[]
thanksstring
argvarray
Return valuefalse on error, thanks message on successbool|string

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_field->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_field->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_field->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_field->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_field->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_field->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_field->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fieldaddpage->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fieldaddpage->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fieldaddpage->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fieldaddpage->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fieldaddpage->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fieldaddpage->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fieldaddpage->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fielddate->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fielddate->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fielddate->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fielddate->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fielddate->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fielddate->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fielddate->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fieldemail->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fieldemail->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fieldemail->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fieldemail->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fieldemail->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fieldemail->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fieldemail->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fieldfieldset->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fieldfieldset->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fieldfieldset->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fieldfieldset->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fieldfieldset->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fieldfieldset->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fieldfieldset->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fieldfile->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fieldfile->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fieldfile->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fieldfile->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fieldfile->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fieldfile->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fieldfile->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fieldhidden->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fieldhidden->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fieldhidden->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fieldhidden->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fieldhidden->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fieldhidden->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fieldhidden->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fieldhiddenautoinc->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fieldhiddenautoinc->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fieldhiddenautoinc->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fieldhiddenautoinc->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fieldhiddenautoinc->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fieldhiddenautoinc->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fieldhiddenautoinc->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fieldmultiselect->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fieldmultiselect->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fieldmultiselect->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fieldmultiselect->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fieldmultiselect->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fieldmultiselect->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fieldmultiselect->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fieldnumber->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fieldnumber->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fieldnumber->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fieldnumber->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fieldnumber->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fieldnumber->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fieldnumber->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fieldonoff->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fieldonoff->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fieldonoff->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fieldonoff->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fieldonoff->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fieldonoff->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fieldonoff->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fieldpassword->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fieldpassword->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fieldpassword->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fieldpassword->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fieldpassword->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fieldpassword->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fieldpassword->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fieldradio->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fieldradio->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fieldradio->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fieldradio->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fieldradio->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fieldradio->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fieldradio->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fieldselect->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fieldselect->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fieldselect->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fieldselect->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fieldselect->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fieldselect->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fieldselect->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fieldstatic->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fieldstatic->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fieldstatic->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fieldstatic->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fieldstatic->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fieldstatic->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fieldstatic->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fieldsubject->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fieldsubject->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fieldsubject->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fieldsubject->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fieldsubject->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fieldsubject->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fieldsubject->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fieldsubmit->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fieldsubmit->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fieldsubmit->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fieldsubmit->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fieldsubmit->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fieldsubmit->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fieldsubmit->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fieldtextarea->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fieldtextarea->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fieldtextarea->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fieldtextarea->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fieldtextarea->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fieldtextarea->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fieldtextarea->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fieldtextbox->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fieldtextbox->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fieldtextbox->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fieldtextbox->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fieldtextbox->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fieldtextbox->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fieldtextbox->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fieldtime->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fieldtime->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fieldtime->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fieldtime->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fieldtime->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fieldtime->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fieldtime->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fieldusemailtemplate->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fieldusemailtemplate->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fieldusemailtemplate->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fieldusemailtemplate->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fieldusemailtemplate->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fieldusemailtemplate->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fieldusemailtemplate->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fielduser->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fielduser->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fielduser->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fielduser->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fielduser->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fielduser->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fielduser->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fieldusers->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fieldusers->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fieldusers->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fieldusers->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fieldusers->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fieldusers->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fieldusers->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fieldwiki->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fieldwiki->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fieldwiki->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fieldwiki->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fieldwiki->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fieldwiki->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fieldwiki->after_action()

DescriptionExecuted after performing the action hooks

Bureaucracy Plugin

Create forms and generate pages or emails from them

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

$bureaucracy_fieldyesno->initialize()

DescriptionInitiate object, first parameters are at least cmd and label
Parametersparamsarray

$bureaucracy_fieldyesno->renderfield()

DescriptionAdd parsed element to Form which generates XHTML
Parametersparamsarray
formDoku_Form
formidinteger

$bureaucracy_fieldyesno->handle_post()

DescriptionHandle a post to the field
Parametersvaluearray
fieldshelper_plugin_bureaucracy_field[]
indexDoku_Form
formidinteger
Return valueisvalidbool

$bureaucracy_fieldyesno->getFieldType()

DescriptionGet the field type
Return valuefieldtypestring

$bureaucracy_fieldyesno->isSet_()

DescriptionWhether the field is true (used for depending fieldsets)
Return valueissetbool

$bureaucracy_fieldyesno->getParam()

DescriptionGet an arbitrary parameter
Parametersnamestring
Return valueParameter valuemixed|null

$bureaucracy_fieldyesno->after_action()

DescriptionExecuted after performing the action hooks

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

$discussion->isDiscussionModerator()

Descriptioncheck if current user is member of moderator groups
Return valueisModeratorboolean

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
Parametersplugin namestring
column keystring

$pagelist->modifyColumn()

Description(optional) override value of an existing column, value equal to false disables column
Parameterscolumn keystring
valueint|bool

$pagelist->setHeader()

Description(optional) Provide header data, if not given default values or [plugin]->th() is used
Parameterscolumn keystring
valueint|bool

$pagelist->setFlags()

Description(optional) overrides default flags, or en/disable existing columns
Parametersflagsarray
Return valuesuccessboolean

$pagelist->startList()

Description(required) prepares the table header for the page list

$pagelist->addPage()

Description(required) adds a page to the list
Parameterspage attributes, 'id' required, others optionalarray

$pagelist->finishList()

Description(required) returns the XHTML output
Return valuexhtmlstring

Tag Plugin

tag wiki pages

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

$tag->overrideSortFlags()

Descriptiontakes an array of sortflags and overrides predefined value
Parametersnamestring

$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