]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/todo/plugin.mdwn
web commit by joey
[ikiwiki.git] / doc / todo / plugin.mdwn
index 284ed7a06626e7a7041fe69d78f4f9d1e2d0ea7c..e36f1e3ca5d030eb9f52eb1239340c70326b95e5 100644 (file)
@@ -1,16 +1,29 @@
-For one type of plugin, see [[todo/PluggableRenderers]]. 
+Suggestions of ideas for plugins:
 
-A plugin system should ideally support things like:
-
-* [[todo/lists]] of pages, of mising pages / broken links, of registered users, etc
+* list of registered users
 * a [[todo/link_map]]
-* [[todo/sigs]]
+* [[todo/sigs]] ?
 * [[pageindexes]]
-* Wiki stats, such as the total number of pages, total number of links, most linked to pages, etc, etc.
-* etc
+* Wiki stats, such as total number of links, most linked to pages
+* Support [[RecentChanges]] as a regular page containing a plugin that updates each time there is a change, and statically builds the recent changes list. (Would this be too expensive/inflexible? There might be other ways to do it as a plugin, like making all links to RecentChanges link to the cgi and have the cgi render it on demand.)
+* Support for smileys or other symbols. I appreciate the support for check
+  marks, etc in other wikis. Needs some free smiley files.
+* For PlaceWiki I want to be able to do some custom plugins, including one
+  that links together subpages about the same place created by different
+  users. This seems to call for a plugin that applies to every page w/o any
+  specific marker being used, and pre-or-post-processes the full page
+  content. It also needs to update pages when related pages are added,
+  so it needs to register dependencies pre-emptively between pages,
+  or something. It's possible that this is a special case of backlinks and
+  is best implemented by making backlinks a plugin somehow. --[[Joey]]
+
+## case study: Moin Moin plugins
 
-Considering ikiwiki plugins, one idea I have is to make the [[PreProcessorDirective]]s be a plugin. A setting in the config file would enable various plusins, which are perl modules, that each provide one or more preprocessor directives. 
+See <http://moinmoin.wikiwikiweb.de/MoinDev/PluginConcept>
 
-Since preprocessing happens before htmlization but after a page is loaded and linkified, it should be possible to use it to create something like a link map or lists, or a page index. Page inlining and rss generation is already done via preprocessor directives and seems a natureal as a plugin too. 
+6 different types of plugins:
 
-Note that things like a link map or a broken link list page would need to be updated whenever a set (or all) pages change; the %inlinepages hash already allows for pages to register this, although it might need to be renamed. 
+* *actions* are possibly out of scope for ikiwiki, this is probably what it uses for cgi script type stuff. Unless ikiwiki wants to allow pluggable CGI script stuff, it doesn't need these.
+* *parsers* and *formatters* are basically what I've been calling [[PluggableRenderers]]. MoinMoin separates these, so that a page is parsed to (presumbly) some intermediate form before being output as html or some other form. That's a nice separation, but what to do about things like markdown that are both a parser and a formatter?
+* *macros* and *processors* are analagous to preprocessor directives. A processor can operate on a large block of text though.
+* *themes* should be irrellevant (ikiwiki has [[templates]]).