doc/todo.mdwn

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