]> sipb.mit.edu Git - ikiwiki.git/blob - doc/todo.mdwn
support arbitrary characters in page titles, via some ugly use of unicode
[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 and rss
65
66 The wiki should emit rss feeds for pages. The simple case is a regular
67 page. The complex case is a blog composed of multiple pages.
68
69 ### single page
70
71 Just create an rss feed with one element, that contains the last diff to
72 the page, or the contents of the page, or something like that. Whenever the
73 page is changed, rss readers should see the single post in the feed as a
74 new post, so they'll dump out the page again. Simple, allows subscribing to
75 any page as an RSS feed if you want to see just changes to that page.
76
77 ### multi-page blog
78
79 This also takes care of the feature of wanting to make a wiki page
80 comprised of several sub-pages that can be independantly edited. Add a
81 token that can be embedded into a page and that specifies a [[GlobList]] of
82 pages. Now when any page matching the globs changes, this page must be
83 updated too. 
84
85 For the html rendering, just embed the most recently created N pages in the
86 [[GlobList]], with the title of each being a link to the individual page,
87 plus a link to an additional page that lists all the titles of every
88 matching page in creation order (archives). Plus at the bottom a small web
89 form that prompts for a title and allows creating a new page for a new blog
90 post.
91
92 For the rss rendering, generate a proper weblog of the same pages.
93 Of course for permalinks use the links to the subpages.
94
95 Note that this allows for weblogs with different sections, etc.
96
97 Requirements:
98
99 * Need to keep track of creation dates of pages in the index file.
100 * Need to keep track of the globlists in the index file.
101    - Probably need to redesign the index file format to allow for this sort
102      of future expansion.
103 * Need to pick a good token and note that the token will need to be passed
104   multiple parameters. Possibly something like this:
105
106         [[embed pages="myblog/*" show="30"]]
107
108 ## revisit case
109
110 Being case insensative is handy, but it does make the [[BackLinks]] a bit
111 ugly compared to other links. It should be possible to support pagenames
112 that have uppercase, while still allowing them to be linked to using any
113 case.
114
115 ## html
116
117 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.
118
119 All of this should be doable w/o touching a single line of code, just editing the [[templates]] BTW.
120
121 ## sigs
122
123 Need a way to sign name in page that's easier to type than "--\[[Joey]]"
124 and that includes the date.
125
126 What syntax do other wikis use for this? I'm considering "\[[--]]" (with
127 spaces removed) as it has a nice nmemonic.
128
129 OTOH, adding additional syntax for this would be counter to one of the
130 design goals for ikiwiki: keeping as much markup as possible out of the
131 wiki and not adding nonstandard markup. And it's not significantly hard to
132 type "--\[[Joey]]", and as to the date, we do have page history.
133
134 ## recentchanges more than 100
135
136 Possibly add "next 100" link to it, but OTOH, you can just use svn log if
137 you need that data..
138
139 ## search
140
141 * page name substring search
142 * full text (use third-party tools?)
143
144 ## lists
145
146 * list of all missing pages
147 * list of all pages or some kind of page map (probably covered by the rss
148   feeds stuff above)
149
150 These could be their own static pages updated when other pages are updated.
151 Perhaps this ties in with the pluggable renderers stuff.
152
153 ## page indexes
154
155 Might be nice to support automatically generating an index based on headers
156 in a page, for long pages. The question is, how to turn on such an index?
157
158 ## basewiki underlay
159
160 Rather than copy the basewiki around everywhere, it should be configured to
161 underlay the main srcdir, and pages be rendered from there if not in the
162 srcdir. This would allow upgrades to add/edit pages in the basewiki.
163
164 Impementaion will be slightly tricky since currently ikiwiki is hardcoded
165 in many places to look in srcdir for pages. Also, there are possible
166 security attacks in the vein of providing a file ikiwiki would normally
167 skip in the srcdir, and tricking it to processing this file instead of the
168 one from the underlaydir.
169
170 There are also difficulties related to removing files from the srcdir, and
171 exposing ones from the underlaydir. Will need to make sure that the mtime
172 for the source file is zeroed when the page is removed, and that it then
173 finds the underlay file and treats it as newer.
174
175 ## Logo
176
177 ikiwiki needs a logo. I'm thinking something simple like the word "ikiwiki"
178 with the first "k" backwards; drawn to show that it's "wiki" reflected.
179
180 ## [[Bugs]]