web commit by BrandenRobinson: Explain why letting users specify regexes is bad.
[ikiwiki.git] / doc / todo.mdwn
index 4d82be9825dd98a940b92744f56a331edb73d7d7..d7326854efd2c79c5b0481072e82825137c693d3 100644 (file)
@@ -1,6 +1,5 @@
 ## online page editing
 
 ## online page editing
 
-* Missing support for preview.
 * Missing conflict detection, just overwrites changes and does not svn up
   first..
 * Eventually, might want page deletion.
 * Missing conflict detection, just overwrites changes and does not svn up
   first..
 * Eventually, might want page deletion.
@@ -15,13 +14,35 @@ is built. (As long as all changes to all pages is ok.)
 
 * Should support mail notification of new and changed pages.
 
 
 * Should support mail notification of new and changed pages.
 
-  Hmm, should be easy to implement this.. it runs as a svn post-cookit hook
+  Hmm, should be easy to implement this.. it runs as a svn post-coommit hook
   already, so just look at the userdb, svnlook at what's changed, and send
   mails to people who have subscribed.
 
   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.
 
 
-Need to document all the command line switches in a man page and somehow on this wiki too. Can markdown generate a man page somehow?
+     Joey points out that this is actually a security hole, because Perl
+     regexes let you embed (arbitrary?) Perl expressions inside them.  Yuck!
+
+  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
 
 
 ## pluggable renderers
 
@@ -55,10 +76,40 @@ Make the html valid. Add css.
 
 ## sigs
 
 
 ## sigs
 
-Need a way to sign name in page that's easier to type than "-- [[ Joey ]]"
+Need a way to sign name in page that's easier to type than "--\[[Joey]]"
 and that includes the date.
 
 and that includes the date.
 
-What syntax do other wikis use for this? I'm considering "[[ -- ]]" (with
+What syntax do other wikis use for this? I'm considering "\[[--]]" (with
 spaces removed) as it has a nice nmemonic.
 
 spaces removed) as it has a nice nmemonic.
 
+OTOH, adding additional syntax for this would be counter to one of the
+design goals for ikiwiki: keeping as much markup as possible out of the
+wiki and not adding nonstandard markup. And it's not significantly hard to
+type "--\[[Joey]]", and as to the date, we do have page history.
+
+## recentchanges links to commit diffs
+
+Would take a bit more viewcvs integration, let the be a "[diff]" link in
+recentchanges that goes to the diff for any listed change.
+
+## recentchanges more than 100
+
+Possibly add "next 100" link to it, but OTOH, you can just use svn log if
+you need that data..
+
+## base wiki
+
+Need a toned down version of this wiki with a basic frontpage, sandbox and
+docs to use as a seed for new wikis.
+
+## search
+
+* full text (use third-party tools?)
+* 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?
+
 ## [[Bugs]]
 ## [[Bugs]]