doc/todo.mdwn

   1 ## online page editing
   2
   3 * Eventually, might want page deletion.
   4 * Eventually, might want file upload.
   5
   6 ## recentchanges
   7
   8 * Should support RSS for notification of new and changed pages.
   9
  10   This can be a static rss file that is generated when the moo
  11 is built. (As long as all changes to all pages is ok.)
  12
  13 * Should support mail notification of new and changed pages.
  14
  15   Hmm, should be easy to implement this.. it runs as a svn post-coommit hook
  16   already, so just look at the userdb, svnlook at what's changed, and send
  17   mails to people who have subscribed.
  18
  19   A few details:
  20   1. [[Joey]] mentioned that being able to subscribe to globs as well as
  21      explicitly named pages would be desirable.
  22   2. I think that since we're using Perl on the backend, being able to
  23      let users craft their own arbitrary regexes would be good.
  24
  25      Joey points out that this is actually a security hole, because Perl
  26      regexes let you embed (arbitrary?) Perl expressions inside them.  Yuck!
  27
  28      It would also be good to be able to subscribe to all pages except discussion pages or the SandBox: `* !*/discussion !sandobx`, maybe --[[Joey]]
  29
  30   3. Of course if you do that, you want to have form processing on the user
  31      page that lets them tune it, and probably choose literal or glob by
  32      default.
  33
  34   The first cut, I suppose, could use one sendmail process to batch-mail all
  35   subscribers for a given page.  However, in the long run, I can see users
  36   demanding a bit of feature creep:
  37
  38   4. Each user should be able to tune whether they see the actual diff parts or
  39      not.
  40   5. Each user should be able to set a maximum desired email size.
  41   6. We might want to support a user-specified shibboleth string that will be
  42      included in the email they receive so they can easily procmail the messages
  43      into a folder.
  44
  45   --[[BrandenRobinson]]
  46
  47 ## pluggable renderers
  48
  49 I'm considering a configurable rendering pipeline for each supported
  50 filename extension. So for ".mdwn" files, it would send the content through
  51 linkify, markdown, and finalize, while for ".wiki" files it might send it
  52 through just a wiki formatter and finalize.
  53
  54 This would allow not only supporting more types of markup, but changing
  55 what style of [[WikiLink]]s are supported, maybe some people want to add
  56 [[CamelCase]] for example, or don't like the [[SubPage/LinkingRules]].
  57
  58 The finalize step is where the page gets all the pretty junk around the
  59 edges, so that clearly needs to be pluggable too.
  60
  61 There also needs to be a step before finalize, where stuff like lists of pages
  62 that linked back to it could be added to the page. However, doing linkbacks
  63 also needs to tie into the main logic, to determine what pages need to be
  64 renered, so maybe that won't be a plugin.
  65
  66 ## revisit case
  67
  68 Being case insensative is handy, but it does make the [[BackLinks]] a bit
  69 ugly compared to other links. It should be possible to support pagenames
  70 that have uppercase, while still allowing them to be linked to using any
  71 case.
  72
  73 ## html
  74
  75 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.
  76
  77 All of this should be doable w/o touching a single line of code, just editing the [[templates]] BTW.
  78
  79 ## sigs
  80
  81 Need a way to sign name in page that's easier to type than "--\[[Joey]]"
  82 and that includes the date.
  83
  84 What syntax do other wikis use for this? I'm considering "\[[--]]" (with
  85 spaces removed) as it has a nice nmemonic.
  86
  87 OTOH, adding additional syntax for this would be counter to one of the
  88 design goals for ikiwiki: keeping as much markup as possible out of the
  89 wiki and not adding nonstandard markup. And it's not significantly hard to
  90 type "--\[[Joey]]", and as to the date, we do have page history.
  91
  92 ## recentchanges more than 100
  93
  94 Possibly add "next 100" link to it, but OTOH, you can just use svn log if
  95 you need that data..
  96
  97 ## search
  98
  99 * full text (use third-party tools?)
 100 * list of all missing pages
 101 * list of all pages or some kind of page map
 102
 103 ## page indexes
 104
 105 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?
 106
 107 ## page locking
 108
 109 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.
 110
 111 Probably it's ok if locking is only supported for web commits.
 112
 113 ## Logo
 114
 115 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.
 116
 117 ## [[Bugs]]