web commit by http://jcflack.myopenid.com/
[ikiwiki] / doc / todo / plugin.mdwn
1 Suggestions of ideas for plugins:
2
3 * enable editable, non-htmlized files
4
5     Some months ago, before upgrading my wiki, I used svn to check in an XML file
6     and a companion XSL file for client-side styling. That was cool, ikiwiki
7     copied them over unchanged and the file could be linked to as `\[[foo|foo.xml]]`.
8
9     I even had the XSL produce an `Edit` link at the top, because I wanted a simple
10     way for a web user to edit the XML. But I had to hack stuff to make the edit CGI
11     not say `foo.xml is not an editable page`.
12
13     I did that in a kind of slash-and-burn way, and apparently that's the one change
14     that was uncommitted when I upgraded ikiwiki, so now it's in the same place
15     as the wikiwyg project. On the bright side, that's a chance to think about how to
16     do it better.
17
18     Any suggestions for appropriate uses of existing plugins, or the plugin API,
19     to selectively add to the set of files in the working copy that the edit CGI
20     will consider editable? --ChapmanFlack 17July2008
21
22 * list of registered users - tricky because it sorta calls for a way to rebuild the page when a new user is registered. Might be better as a cgi?
23 > At best, this could only show the users who have logged in, not all
24 > permitted by the current auth plugin(s).  HTTP auth would need
25 > web-server-specific code to list all users, and openid can't feasibly do so
26 > at all. --[[JoshTriplett]]
27
28 * It would be nice to be able to have a button to show "Differences" (or 
29   "Show Diff") when editing a page. Is that an option that can be enabled?
30   Using a plugin?
31
32 * For PlaceWiki I want to be able to do some custom plugins, including one
33   that links together subpages about the same place created by different
34   users. This seems to call for a plugin that applies to every page w/o any
35   specific marker being used, and pre-or-post-processes the full page
36   content. It also needs to update pages when related pages are added,
37   so it needs to register dependencies pre-emptively between pages,
38   or something. It's possible that this is a special case of backlinks and
39   is best implemented by making backlinks a plugin somehow. --[[Joey]]
40
41 * random page (cgi plugin; how to link to it easily?)
42
43 * How about an event calendar. Events could be sub-pages with an embedded 
44   code to detail recurrance and/or event date/time
45
46 * rcs plugin ([[JeremyReed]] has one he has been using for over a month with over 850 web commits with 13 users with over ten commits each.)
47
48 * asciidoc or txt2tags format plugins
49
50   Should be quite easy to write, the otl plugin is a good example of a
51   similar formatter.
52
53 >>Isn't there a conflict between ikiwiki using \[\[  \]\] and asciidoc using the same?
54 >>There is a start of an asciidoc plugin at <http://www.mail-archive.com/asciidoc-discuss@metaperl.com/msg00120.html>
55 >>-- KarlMW
56
57 * manpage plugin: convert **"ls(1)"** style content into Markdown like **\[ls(1)\]\(http://example.org/man.cgi?name=ls&sect=1\)** or into HTML directly.
58
59 > With a full installation of groff available, man offers HTML output.  Might
60 > take some fiddling to make it fit into the ikiwiki templates, and you might
61 > or might not want to convert pages in the SEE ALSO as
62 > well. --[[JoshTriplett]]
63
64 * As I couldn't find another place to ask, I'll try here. I would like to install some contributed plugins, but can not find anywhere to downlod them.
65
66   > Not sure what you mean, the [[plugins/contrib]] page lists contributed plugins, and each of their pages tells where to download the plugin from.. --[[Joey]]
67
68 * I wrote a very crude wrapper around tex4ht to render TeX files.  I hesitate to give it a contrib/plugins page in its current state, but if someone wants to play, [here](http://www.cs.unb.ca/~bremner/wiki/software/ikiwiki/tex4ht.pm) it is.--[[DavidBremner]]
69
70 * Setting default values for the meta plugin in the setup file, particularly author, license, and copyright, would be useful 
71 There is work in progress at 
72 [[plugins/contrib/default_content_for___42__copyright__42___and___42__license__42__]]
73 -- [[DavidBremner]]
74
75 * Would it make sense to have a hook to set the page name?  This would solve a problem I see with 
76 [[source_code_highlighting|plugins/contrib/sourcehighlight]]
77 -- [[DavidBremner]]