* Add an orphans plugin for finding pages that nothing links to.
[ikiwiki.git] / doc / todo / plugin.mdwn
1 A plugin system should ideally support things like:
2
3 * [[todo/lists]] of pages, of mising pages / broken links (done), orphaned
4   pages (done), of registered users, etc
5 * a [[todo/link_map]]
6 * [[todo/sigs]] ?
7 * [[pageindexes]]
8 * Wiki stats, such as the total number of pages (done), total number of links, most linked to pages, etc, etc.
9 * wiki info page, giving the ikiwiki version etc
10 * would it be useful to reimplement the hyperestradier search integration as a plugin?
11 * 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.)
12 * Support for smileys or other symbols. I appreciate the support for check
13   marks, etc in other wikis.
14 * For PlaceWiki I want to be able to do some custom plugins, including one
15   that links together subpages about the same place created by different
16   users. This seems to call for a plugin that applies to every page w/o any
17   specific marker being used, and pre-or-post-processes the full page
18   content. It also needs to update pages when related pages are added,
19   so it needs to register dependencies pre-emptively between pages,
20   or something. It's possible that this is a special case of backlinks and
21   is best implemented by making backlinks a plugin somehow. --[[Joey]]
22 * etc
23 * For another type of plugin, see [[todo/PluggableRenderers]].
24
25 Another, separate plugin system that already (mostly) exists in ikiwiki is
26 the RCS backend, which allows writing modules to drive other RCS systems
27 than subversion.
28
29 ## case study: Moin Moin plugins
30
31 See <http://moinmoin.wikiwikiweb.de/MoinDev/PluginConcept>
32
33 6 different types of plugins:
34
35 * *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.
36 * *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?
37 * *macros* and *processors* are analagous to preprocessor directives. A processor can operate on a large block of text though.
38 * *themes* should be irrellevant (ikiwiki has [[templates]]).