doc: move plugin documentation into plugin/ directory

[webber.git] / in / plugins / index.md

diff --git a/in/plugins/index.md b/in/plugins/index.md
new file mode 100644 (file)
index 0000000..588e653
--- /dev/null
+++ b/in/plugins/index.md
@@ -0,0 +1,25 @@
+title: Plugins
+parent: Webber
+ctime: 2009-06-26
+
+Webber doesn't do much on it's own. Almost all the real work is delegated
+to plugins. Those plugins do:
+
+* Read files and generate HTML snippets ([[read_rst.py|read_rst]],
+  [[read_markdown.py|read_markdown]], [[read_html.py|read_html]])
+  or copy files verbatim, e.g. for graphics
+  ([[read_copyonly.py|read_copyonly]])
+* Update internal state or modify HTML snippets
+  ([[hierarchy.py|hierarchy]], [[link.py|link]])
+* Create HTML pages ([[template_mako.py|template_mako]])
+
+There's another plugin there ([[skeleton.py|skeleton]], which is
+is just a demo for plugin-programmers.
+
+Plugins simply reside in the "`plugins/`" directory. However, webber
+doesn't load all of them automatically. Instead you specify in the
+configuration file [[webber.conf|configuration]] which
+plugins you want.
+
+Once plugins are loaded, webber orchestrates the work of itself and
+all plugins via [[hooks]].