Differences

This shows you the differences between two versions of the page.

--- plugin:info [2009-04-15 20:01] – 95.132.225.187
+++ plugin:info [2024-04-13 17:23] (current) – old revision restored (2020-08-12 12:15) bactram
@@ Line 6: / Line 6: @@
 email      : andi@splitbrain.org
 type       : syntax
-lastupdate :
+lastupdate : 2020-06-04
 compatible : (bundled)
 depends    :
 conflicts  :
 similar    :
-tags       : internals, plugins, modes, !bundled
+tags       : listing, plugins, !bundled
 ----
-~~INFO:syntaxplugins~~
-The plugin serves as simple sample plugin and is included in the DokuWiki Distribution.
+===== Description =====
+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.
 ===== Syntax =====
 <code>
-~~INFO:version~~
+~~INFO:keyword~~
-~~INFO:syntaxmodes~~
-~~INFO:syntaxtypes~~
-~~INFO:syntaxplugins~~
-~~INFO:adminplugins~~
-~~INFO:actionplugins~~
-~~INFO:rendererplugins~~
-~~INFO:helperplugins~~
-~~INFO:helpermethods~~
 </code>
+  * **keyword** can be one of:
+    * //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]].
+    * //datetime// --- Shows the current date and time. This will be cached with the page. It can be used for cache debugging.
-===== Example =====
+===== Examples =====
-==== INFO:version ====
+==== ~~INFO:syntaxmodes~~ ====
-~~INFO:version~~
-==== INFO:syntaxmodes ====
 ~~INFO:syntaxmodes~~
-==== INFO:syntaxtypes ====
+==== ~~INFO:syntaxtypes~~ ====
 ~~INFO:syntaxtypes~~
-==== INFO:syntaxplugins ====
+'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:adminplugins~~
-==== INFO:actionplugins ====
+==== ~~INFO:actionplugins~~ ====
 ~~INFO:actionplugins~~
-==== INFO:rendererplugins ====
+==== ~~INFO:rendererplugins~~ ====
 ~~INFO:rendererplugins~~
-==== INFO:helperplugins ====
+==== ~~INFO:helperplugins~~ ====
 ~~INFO:helperplugins~~
-==== INFO:helpermethods ====
+==== ~~INFO:helpermethods~~ ====
 ~~INFO:helpermethods~~
@@ Line 70: / Line 71: @@
-===== Discussion =====
-> Hi, there is a little typo here: I read //substition// in the table above. You can directly remove my note when it's read. --- //[[christophegragnic@yahoo.fr|Grahack]] 2008/05/23 08:49//
->> Hi, this is not a typo (any more). It's transformed into the “standard”. See [[http://www.dokuwiki.org/wiki:plugins:syntax?s[]=substition&s[]=typo#fn__5|this footnote]] for an explanation. ;-)   --- //[[http://www.the-evil.pointclark.net|Mischa The Evil]] 2008/06/11 22:11//
-> Hi, I am not happy with ''<nowiki>~~INFO:version~~</nowiki>'' reporting ''snapshot?'' as current version. Is there a simple way to display the snapshot date as version? //[[miquel.cabanas@uab.cat|Miquel]] 2008/07/01 12:48//
->> I've made a quick hack to solve this issue and have duplicated the code at ''inc/infoutils.php'' displaying the content of file ''VERSION''. The new portion of code displays the content of a new file called ''SNAPSHOT'' containing the snapshot creation time.
-> Hi, is there a list of possible keywords? i tried INFO:actionplugins and it worked, so what else is possible? --- //[[benny-wegner@gmx.de|Benny Wegner]] 2008/07/13 22:28//
->> looked up myself, its version, syntaxmodes, syntaxtypes, syntaxplugins, adminplugins, actionplugins, rendererplugins, helperplugins and helpermethods --- //[[benny-wegner@gmx.de|Benny Wegner]] 2008/07/13 22:28//