3d77179cf96e45e15c4b0104070600f7a45a8c9d
[ikiwiki.git] / doc / todo / firm_up_plugin_interface.mdwn
1 I don't want this interface to be too firm; it's ok for a plugin like
2 `ddate` to redefine an internal function like IkiWiki::displaytime if it
3 wants to.. But plugins that still access stuff through IkiWiki:: should be
4 aware that that stuff can change at any time and break them. Possibly without
5 perl's type checking catching the breakage, in some cases. Plugins that
6 only use exported symbols should not be broken by future ikiwiki changes.
7
8 Functions used by only some plugins, undecided about exporting:
9
10 * lockwiki, unlockwiki (aggregate)
11         Too internal to ever be exported.
12 * loadindex (aggregate)
13         Too internal to ever be exported.
14 * titlepage (aggregate)
15         Not until more than one thing uses it.
16 * basename (polygen, inline, search, polygen)
17 * dirname (linkmap, inline)
18         For basename and dirname, they could just use standard perl library
19         stuff. Howevever, ikiwiki's versions are slightly different and I'd
20         need to check if the standard versions work for the uses made in
21         these plugins. Inclined not to export.
22 * abs2rel (linkmap, inline)
23         This *is* the library version, just optimised to work around a bug.
24         Don't export this.
25 * possibly_foolish_untaint (aggregate, polygen)
26         Probably better to implement yourself.
27 * htmlize
28 * linkify
29 * preprocess
30 * filter
31         The 4 above are used by a few plugins, but problimatic since plugins 
32         typically also define functions with these names.. I also feel that
33         this part of ikiwiki needs some more work before it's set in stone.
34         These are always called together, in the same order, though
35         sometimes htmlize isn't included.
36
37 Variables used by plugins but not exported yet:
38
39 * %IkiWiki::pagecase (aggregate)
40 * %IkiWiki::backlinks (pagestats)
41
42 [[todo/done]]