]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/todo.mdwn
committing changes for conflict test
[git.ikiwiki.info.git] / doc / todo.mdwn
index 7565c5b5934373f189068729c78cf1b0228c81a3..71c0eb9727a8e74fc066b78dd63c55e60ace39dd 100644 (file)
@@ -1,8 +1,25 @@
 ## online page editing
 
-* Missing support for preview.
 * Missing conflict detection, just overwrites changes and does not svn up
   first..
+
+  How to resolve this? Would this work when saving a page?
+
+  1. write changes to wc
+  2. svn up (so it can merge with any other changes)
+  3. check for conflicts
+  4. if conflicts, read in page w/conflict markers, svn revert page, and display resolution form
+  5. otherwise, svn commit
+  6. if commit fails, perhaps we were raced and there are conflicts still; so check for conflicts and if found, goto 2.
+
+  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..
+
+  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.
+
+  If each commit operated in a separate copy of the wc, that was created for the commit, the steps above would work. But it would be very expensive to make and maintain all those copies.
+
+  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.
+   
 * Eventually, might want page deletion.
 * Eventually, might want file upload.
 
@@ -19,10 +36,33 @@ is built. (As long as all changes to all pages is ok.)
   already, so just look at the userdb, svnlook at what's changed, and send
   mails to people who have subscribed.
 
-## docs
+  A few details:
+  1. [[Joey]] mentioned that being able to subscribe to globs as well as
+     explicitly named pages would be desirable.
+  2. I think that since we're using Perl on the backend, being able to
+     let users craft their own arbitrary regexes would be good.
+
+     Joey points out that this is actually a security hole, because Perl
+     regexes let you embed (arbitrary?) Perl expressions inside them.  Yuck!
+
+     It would also be good to be able to subscribe to all pages except discussion pages or the SandBox: `* !*/discussion !sandobx`, maybe --[[Joey]]
 
-Need to turn [[usage]] into a man page.
-this wiki too. Can markdown generate a man page somehow?
+  3. Of course if you do that, you want to have form processing on the user
+     page that lets them tune it, and probably choose literal or glob by
+     default.
+
+  The first cut, I suppose, could use one sendmail process to batch-mail all
+  subscribers for a given page.  However, in the long run, I can see users
+  demanding a bit of feature creep:
+
+  4. Each user should be able to tune whether they see the actual diff parts or
+     not.
+  5. Each user should be able to set a maximum desired email size.
+  6. We might want to support a user-specified shibboleth string that will be
+     included in the email they receive so they can easily procmail the messages
+     into a folder.
+
+  --[[BrandenRobinson]]
 
 ## pluggable renderers
 
@@ -88,4 +128,14 @@ docs to use as a seed for new wikis.
 * list of all missing pages
 * list of all pages or some kind of page map
 
+## page indexes
+
+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?
+
+## page locking
+
+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. 
+
+Probably it's ok if locking is only supported for web commits.
+
 ## [[Bugs]]