]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blob - doc/todo.mdwn
web commit by joey
[git.ikiwiki.info.git] / doc / todo.mdwn
1 ## online page editing
3 * Missing conflict detection, just overwrites changes and does not svn up
4   first..
6   How to resolve this? Would this work when saving a page?
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.
15   No, it won't work, because the other committer updates the srcdir when they make their commit, so svn does not get a chance to merge in the changes on update in step 2. Hmm..
17   Well, it could keep track of the version number of the page it started editing, and if it's changed during the edit, ask svn to merge all changes from that version number to head into the page after writing it out. Doing that without races with other svn committers seems tricky.
19   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.
20    
21 * Eventually, might want page deletion.
22 * Eventually, might want file upload.
24 ## recentchanges
26 * Should support RSS for notification of new and changed pages. 
28   This can be a static rss file that is generated when the moo
29 is built. (As long as all changes to all pages is ok.)
31 * Should support mail notification of new and changed pages.
33   Hmm, should be easy to implement this.. it runs as a svn post-coommit hook
34   already, so just look at the userdb, svnlook at what's changed, and send
35   mails to people who have subscribed.
37   A few details:
38   1. [[Joey]] mentioned that being able to subscribe to globs as well as
39      explicitly named pages would be desirable.
40   2. I think that since we're using Perl on the backend, being able to
41      let users craft their own arbitrary regexes would be good.
43      Joey points out that this is actually a security hole, because Perl
44      regexes let you embed (arbitrary?) Perl expressions inside them.  Yuck!
46      It would also be good to be able to subscribe to all pages except discussion pages or the SandBox: `* !*/discussion !sandobx`, maybe --[[Joey]]
48   3. Of course if you do that, you want to have form processing on the user
49      page that lets them tune it, and probably choose literal or glob by
50      default.
52   The first cut, I suppose, could use one sendmail process to batch-mail all
53   subscribers for a given page.  However, in the long run, I can see users
54   demanding a bit of feature creep:
56   4. Each user should be able to tune whether they see the actual diff parts or
57      not.
58   5. Each user should be able to set a maximum desired email size.
59   6. We might want to support a user-specified shibboleth string that will be
60      included in the email they receive so they can easily procmail the messages
61      into a folder.
63   --[[BrandenRobinson]]
65 ## pluggable renderers
67 I'm considering a configurable rendering pipeline for each supported
68 filename extension. So for ".mdwn" files, it would send the content through
69 linkify, markdown, and finalize, while for ".wiki" files it might send it
70 through just a wiki formatter and finalize.
72 This would allow not only supporting more types of markup, but changing
73 what style of [[WikiLink]]s are supported, maybe some people want to add
74 [[CamelCase]] for example, or don't like the [[SubPage/LinkingRules]].
76 The finalize step is where the page gets all the pretty junk around the
77 edges, so that clearly needs to be pluggable too.
79 There also needs to be a step before finalize, where stuff like lists of pages
80 that linked back to it could be added to the page. However, doing linkbacks
81 also needs to tie into the main logic, to determine what pages need to be
82 renered, so maybe that won't be a plugin.
84 ## revisit case
86 Being case insensative is handy, but it does make the [[BackLinks]] a bit
87 ugly compared to other links. It should be possible to support pagenames
88 that have uppercase, while still allowing them to be linked to using any
89 case.
91 ## html
93 Make the html valid. Add css.
95 ## sigs
97 Need a way to sign name in page that's easier to type than "--\[[Joey]]"
98 and that includes the date.
100 What syntax do other wikis use for this? I'm considering "\[[--]]" (with
101 spaces removed) as it has a nice nmemonic.
103 OTOH, adding additional syntax for this would be counter to one of the
104 design goals for ikiwiki: keeping as much markup as possible out of the
105 wiki and not adding nonstandard markup. And it's not significantly hard to
106 type "--\[[Joey]]", and as to the date, we do have page history.
108 ## recentchanges links to commit diffs
110 Would take a bit more viewcvs integration, let the be a "[diff]" link in
111 recentchanges that goes to the diff for any listed change.
113 ## recentchanges more than 100
115 Possibly add "next 100" link to it, but OTOH, you can just use svn log if
116 you need that data..
118 ## base wiki
120 Need a toned down version of this wiki with a basic frontpage, sandbox and
121 docs to use as a seed for new wikis.
123 ## search
125 * full text (use third-party tools?)
126 * list of all missing pages
127 * list of all pages or some kind of page map
129 ## page indexes
131 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?
133 ## page locking
135 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. 
137 Probably it's ok if locking is only supported for web commits.
139 ## [[Bugs]]