====== Info Plugin ======

---- plugin ----
description: Displays some information about DokuWiki's internals. (bundled with DokuWiki)
author     : Andreas Gohr
email      : andi@splitbrain.org
type       : syntax
lastupdate : 
compatible : (bundled)
depends    : 
conflicts  : 
similar    : 
tags       : listing, plugins, !bundled
----
The plugin serves as simple sample [[devel:syntax_plugins|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]].

===== Download and Installation =====

The Plugin is bundled with DokuWiki (at least since 2007-06-26) and does not need to be installed separately.

===== Syntax =====
<code>
~~INFO:keyword~~
</code>
  * **keyword** can be one of:
    * //version// --- Displays current DokuWiki version.
    * //syntaxmodes// --- Displays the complete list of [[devel:parser|parser modes]] together with their [[devel:parser#order_of_adding_modes_important|getSort()]] values. See also [[devel:syntax plugins]].
    * //syntaxtypes// --- Displays which [[devel:syntax_plugins#syntax types]] are used by available plugins. The syntax type determine which syntax may be nested.
    * //syntaxplugins// --- Displays a list of available [[this>plugins?plugintype=1|syntax]] plugins. 
    * //adminplugins// --- Displays a list of available [[this>plugins?plugintype=2|admin]] plugins.
    * //actionplugins// --- Displays a list of available [[this>plugins?plugintype=4|action]] plugins. 
    * //rendererplugins// --- Displays a list of available [[this>plugins?plugintype=8|render]] plugins. 
    * //helperplugins// --- Displays a list of available [[this>plugins?plugintype=16|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 [[plugin:pagelist]].

===== Examples =====

==== INFO:version ====

~~INFO:version~~
==== INFO:syntaxmodes ====

~~INFO:syntaxmodes~~
==== INFO:syntaxtypes ====
~~INFO:syntaxtypes~~

'Substition' may look like a typo, but it's not (any more). It's transformed into the “standard”. See [[this>devel:syntax_plugins?s[]=substition&s[]=typo#fn__5|this footnote]] for an explanation. ;-)

==== INFO:syntaxplugins ====
~~INFO:syntaxplugins~~

==== INFO:adminplugins ====

~~INFO:adminplugins~~

==== INFO:actionplugins ====

~~INFO:actionplugins~~

==== INFO:rendererplugins ====

~~INFO:rendererplugins~~

==== INFO:helperplugins ====

~~INFO:helperplugins~~

==== INFO:helpermethods ====

~~INFO:helpermethods~~

===== Development =====

=== Source Code ===

The source code is available from [[devel:git]].

=== Bugs ===

Submit bugs and feature wishes in the DokuWiki [[:bugs|Bugtracker]].