]> sipb.mit.edu Git - ikiwiki.git/blob - doc/todo.mdwn
add archive pages and fix some bugs
[ikiwiki.git] / doc / todo.mdwn
1 ## online page editing
2
3 * Eventually, might want page deletion.
4 * Eventually, might want file upload.
5
6 ## recentchanges
7
8 * Should support mail notification of new and changed pages.
9
10   Hmm, should be easy to implement this.. it runs as a svn post-coommit hook
11   already, so just look at the userdb, svnlook at what's changed, and send
12   mails to people who have subscribed.
13
14   A few details:
15   1. [[Joey]] mentioned that being able to subscribe to globs as well as
16      explicitly named pages would be desirable.
17   2. I think that since we're using Perl on the backend, being able to
18      let users craft their own arbitrary regexes would be good.
19
20      Joey points out that this is actually a security hole, because Perl
21      regexes let you embed (arbitrary?) Perl expressions inside them.  Yuck!
22
23      It would also be good to be able to subscribe to all pages except discussion pages or the SandBox: `* !*/discussion !sandobx`, maybe --[[Joey]]
24
25   3. Of course if you do that, you want to have form processing on the user
26      page that lets them tune it, and probably choose literal or glob by
27      default.
28
29      I think that the new globlist() function should do everything you need.
30      Adding a field to the prefs page will be trivial --[[Joey]]
31
32   The first cut, I suppose, could use one sendmail process to batch-mail all
33   subscribers for a given page.  However, in the long run, I can see users
34   demanding a bit of feature creep:
35
36   4. Each user should be able to tune whether they see the actual diff parts or
37      not.
38   5. Each user should be able to set a maximum desired email size.
39   6. We might want to support a user-specified shibboleth string that will be
40      included in the email they receive so they can easily procmail the messages
41      into a folder.
42
43   --[[BrandenRobinson]]
44
45 ## pluggable renderers
46
47 I'm considering a configurable rendering pipeline for each supported
48 filename extension. So for ".mdwn" files, it would send the content through
49 linkify, markdown, and finalize, while for ".wiki" files it might send it
50 through just a wiki formatter and finalize.
51
52 This would allow not only supporting more types of markup, but changing
53 what style of [[WikiLink]]s are supported, maybe some people want to add
54 [[CamelCase]] for example, or don't like the [[SubPage/LinkingRules]].
55
56 The finalize step is where the page gets all the pretty junk around the
57 edges, so that clearly needs to be pluggable too.
58
59 There also needs to be a step before finalize, where stuff like lists of pages
60 that linked back to it could be added to the page. However, doing linkbacks
61 also needs to tie into the main logic, to determine what pages need to be
62 renered, so maybe that won't be a plugin.
63
64 ## blogging
65
66 - Add a small form at top and bottom of a blog to allow entering
67   a title for a new item, that goes to a template to create the new page.
68 - Should probably add params to control various rss fields like the blog
69   title, its author email, its copyright info, etc. 
70
71 ## revisit case
72
73 Being case insensative is handy, but it does make the [[BackLinks]] a bit
74 ugly compared to other links. It should be possible to support pagenames
75 that have uppercase, while still allowing them to be linked to using any
76 case.
77
78 ## html
79
80 Make the html valid. Add css and prettify. Make RecentChanges use table for formatting, and images to indicate web vs svn commits and to link to diffs.
81
82 All of this should be doable w/o touching a single line of code, just editing the [[templates]] BTW.
83
84 ## sigs
85
86 Need a way to sign name in page that's easier to type than "--\[[Joey]]"
87 and that includes the date.
88
89 What syntax do other wikis use for this? I'm considering "\[[--]]" (with
90 spaces removed) as it has a nice nmemonic.
91
92 OTOH, adding additional syntax for this would be counter to one of the
93 design goals for ikiwiki: keeping as much markup as possible out of the
94 wiki and not adding nonstandard markup. And it's not significantly hard to
95 type "--\[[Joey]]", and as to the date, we do have page history.
96
97 ## recentchanges more than 100
98
99 Possibly add "next 100" link to it, but OTOH, you can just use svn log if
100 you need that data..
101
102 ## search
103
104 * page name substring search
105 * full text (use third-party tools?)
106
107 ## lists
108
109 * list of all missing pages
110
111 This could be its own static pages updated when other pages are updated.
112 Perhaps this ties in with the pluggable renderers stuff.
113
114 ## page indexes
115
116 Might be nice to support automatically generating an index based on headers
117 in a page, for long pages. The question is, how to turn on such an index?
118
119 ## basewiki underlay
120
121 Rather than copy the basewiki around everywhere, it should be configured to
122 underlay the main srcdir, and pages be rendered from there if not in the
123 srcdir. This would allow upgrades to add/edit pages in the basewiki.
124
125 Impementaion will be slightly tricky since currently ikiwiki is hardcoded
126 in many places to look in srcdir for pages. Also, there are possible
127 security attacks in the vein of providing a file ikiwiki would normally
128 skip in the srcdir, and tricking it to processing this file instead of the
129 one from the underlaydir.
130
131 There are also difficulties related to removing files from the srcdir, and
132 exposing ones from the underlaydir. Will need to make sure that the mtime
133 for the source file is zeroed when the page is removed, and that it then
134 finds the underlay file and treats it as newer.
135
136 ## wikilinks features
137
138 - \[[John|Fred]] is a Wikipedia method for linking to the one page
139   while displaying it as the other, Kyle would like this.
140
141 ## Logo
142
143 ikiwiki needs a logo. I'm thinking something simple like the word "ikiwiki"
144 with the first "k" backwards; drawn to show that it's "wiki" reflected.
145
146 ## [[Bugs]]