]> sipb.mit.edu Git - ikiwiki.git/blob - doc/todo.mdwn
web commit by joey: thoughts on conflict resolution, gobbing, locking
[ikiwiki.git] / doc / todo.mdwn
1 ## online page editing
2
3 * Missing conflict detection, just overwrites changes and does not svn up
4   first..
5
6   How to resolve this? Would this work when saving a page?
7
8   1. write changes to wc
9   2. svn up (so it can merge with any other changes)
10   3. check for conflicts
11   4. if conflicts, read in page w/conflict markers, svn revert page, and display resolution form
12   5. otherwise, svn commit
13   6. if commit fails, perhaps we were raced and there are conflicts still; so check for conflicts and if found, goto 2.
14
15   Note that unless we use `svn lock`, we really can't "warn" about concurrent edits and such the way other wikis do, which is ok, since that system sucks anyway. Using svn up for smart merging will be much nicer most of the time.
16    
17 * Eventually, might want page deletion.
18 * Eventually, might want file upload.
19
20 ## recentchanges
21
22 * Should support RSS for notification of new and changed pages. 
23
24   This can be a static rss file that is generated when the moo
25 is built. (As long as all changes to all pages is ok.)
26
27 * Should support mail notification of new and changed pages.
28
29   Hmm, should be easy to implement this.. it runs as a svn post-coommit hook
30   already, so just look at the userdb, svnlook at what's changed, and send
31   mails to people who have subscribed.
32
33   A few details:
34   1. [[Joey]] mentioned that being able to subscribe to globs as well as
35      explicitly named pages would be desirable.
36   2. I think that since we're using Perl on the backend, being able to
37      let users craft their own arbitrary regexes would be good.
38
39      Joey points out that this is actually a security hole, because Perl
40      regexes let you embed (arbitrary?) Perl expressions inside them.  Yuck!
41
42      It would also be good to be able to subscribe to all pages except discussion pages or the SandBox: `* !*/discussion !sandobx`, maybe --[[Joey]]
43
44   3. Of course if you do that, you want to have form processing on the user
45      page that lets them tune it, and probably choose literal or glob by
46      default.
47
48   The first cut, I suppose, could use one sendmail process to batch-mail all
49   subscribers for a given page.  However, in the long run, I can see users
50   demanding a bit of feature creep:
51
52   4. Each user should be able to tune whether they see the actual diff parts or
53      not.
54   5. Each user should be able to set a maximum desired email size.
55   6. We might want to support a user-specified shibboleth string that will be
56      included in the email they receive so they can easily procmail the messages
57      into a folder.
58
59   --[[BrandenRobinson]]
60
61 ## pluggable renderers
62
63 I'm considering a configurable rendering pipeline for each supported
64 filename extension. So for ".mdwn" files, it would send the content through
65 linkify, markdown, and finalize, while for ".wiki" files it might send it
66 through just a wiki formatter and finalize.
67
68 This would allow not only supporting more types of markup, but changing
69 what style of [[WikiLink]]s are supported, maybe some people want to add
70 [[CamelCase]] for example, or don't like the [[SubPage/LinkingRules]].
71
72 The finalize step is where the page gets all the pretty junk around the
73 edges, so that clearly needs to be pluggable too.
74
75 There also needs to be a step before finalize, where stuff like lists of pages
76 that linked back to it could be added to the page. However, doing linkbacks
77 also needs to tie into the main logic, to determine what pages need to be
78 renered, so maybe that won't be a plugin.
79
80 ## revisit case
81
82 Being case insensative is handy, but it does make the [[BackLinks]] a bit
83 ugly compared to other links. It should be possible to support pagenames
84 that have uppercase, while still allowing them to be linked to using any
85 case.
86
87 ## html
88
89 Make the html valid. Add css.
90
91 ## sigs
92
93 Need a way to sign name in page that's easier to type than "--\[[Joey]]"
94 and that includes the date.
95
96 What syntax do other wikis use for this? I'm considering "\[[--]]" (with
97 spaces removed) as it has a nice nmemonic.
98
99 OTOH, adding additional syntax for this would be counter to one of the
100 design goals for ikiwiki: keeping as much markup as possible out of the
101 wiki and not adding nonstandard markup. And it's not significantly hard to
102 type "--\[[Joey]]", and as to the date, we do have page history.
103
104 ## recentchanges links to commit diffs
105
106 Would take a bit more viewcvs integration, let the be a "[diff]" link in
107 recentchanges that goes to the diff for any listed change.
108
109 ## recentchanges more than 100
110
111 Possibly add "next 100" link to it, but OTOH, you can just use svn log if
112 you need that data..
113
114 ## base wiki
115
116 Need a toned down version of this wiki with a basic frontpage, sandbox and
117 docs to use as a seed for new wikis.
118
119 ## search
120
121 * full text (use third-party tools?)
122 * list of all missing pages
123 * list of all pages or some kind of page map
124
125 ## page indexes
126
127 Might be nice to support automatically generating an index based on headers in a page, for long pages. The question is, how to turn on such an index?
128
129 ## page locking
130
131 Some wikis will need the abiity to lock a page, or the whole wiki, so that only admins can edit them. Probably using the same globbing as for recentchanges mails to determine what to lock. 
132
133 Probably it's ok if locking is only supported for web commits.
134
135 ## [[Bugs]]