prototyping improvements

[ikiwiki.git] / doc / todo.mdwn

diff --git a/doc/todo.mdwn b/doc/todo.mdwn
index dd69e21fb6cf95d8a4ca65a783b65d032440500a..a377c6340dfd43e4c641bfdee73f00f47bae0dfa 100644 (file)
--- a/doc/todo.mdwn
+++ b/doc/todo.mdwn
@@ -1,8 +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.
 * Eventually, might want file upload.
 
 * Eventually, might want page deletion.
 * Eventually, might want file upload.
 


@@ -10,7 +7,7 @@
 
 * Should support RSS for notification of new and changed pages. 
 
 
 * Should support RSS for notification of new and changed pages. 
 

-  This can be a static rss file that is generated when the moo
+  This can be a static rss file that is generated when the wiki

 is built. (As long as all changes to all pages is ok.)
 
 * Should support mail notification of new and changed pages.
 is built. (As long as all changes to all pages is ok.)
 
 * Should support mail notification of new and changed pages.


@@ -19,10 +16,36 @@ 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.
 
   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 turn [[usage]] into a man page.
-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!
+
+     It would also be good to be able to subscribe to all pages except discussion pages or the SandBox: `* !*/discussion !sandobx`, maybe --[[Joey]]
+
+  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.
+
+     I think that the new globlist() function should do everything you need.
+     Adding a field to the prefs page will be trivial --[[Joey]]
+
+  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
 


@@ -52,7 +75,9 @@ case.
 
 ## html
 
 
 ## html
 

-Make the html valid. Add css.
+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.
+
+All of this should be doable w/o touching a single line of code, just editing the [[templates]] BTW.

 
 ## sigs
 
 
 ## sigs
 


@@ -67,23 +92,49 @@ 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.
 
 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..
 
 ## recentchanges more than 100
 
 Possibly add "next 100" link to it, but OTOH, you can just use svn log if
 you need that data..
 

-## setup classes
+## search
+
+* page name substring search
+* full text (use third-party tools?)
+
+## lists
+
+* list of all missing pages
+* list of all pages or some kind of page map
+
+These could be their own static pages updated when other pages are updated.
+Perhaps this ties in with the pluggable renderers stuff.
+
+## 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?
+
+## basewiki underlay
+
+Rather than copy the basewiki around everywhere, it should be configured to
+underlay the main srcdir, and pages be rendered from there if not in the
+srcdir. This would allow upgrades to add/edit pages in the basewiki.
+
+Impementaion will be slightly tricky since currently ikiwiki is hardcoded
+in many places to look in srcdir for pages. Also, there are possible
+security attacks in the vein of providing a file ikiwiki would normally
+skip in the srcdir, and tricking it to processing this file instead of the
+one from the underlaydir.
+
+There are also difficulties related to removing files from the srcdir, and
+exposing ones from the underlaydir. Will need to make sure that the mtime
+for the source file is zeroed when the page is removed, and that it then
+finds the underlay file and treats it as newer.
+
+## Logo

 
 

-The setup files should "use WikiWiki::Setup" and the like at the top, and
-indeed could just be one big use that passes all params to the module's
-importer. The module then handles running ikiwiki functions. This would
-allow for different types of setup files for more than just the one
-hardcoded thing there is now, and would probably be good for upgrades,
-incompatible changes, etc, too.
+ikiwiki needs a logo. I'm thinking something simple like the word "ikiwiki"
+with the first "k" backwards; drawn to show that it's "wiki" reflected.

 
 ## [[Bugs]]
 
 ## [[Bugs]]