doc/todo.mdwn

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