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 wiki
  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      I think that the new globlist() function should do everything you need.
  35      Adding a field to the prefs page will be trivial --[[Joey]]
  36
  37   The first cut, I suppose, could use one sendmail process to batch-mail all
  38   subscribers for a given page.  However, in the long run, I can see users
  39   demanding a bit of feature creep:
  40
  41   4. Each user should be able to tune whether they see the actual diff parts or
  42      not.
  43   5. Each user should be able to set a maximum desired email size.
  44   6. We might want to support a user-specified shibboleth string that will be
  45      included in the email they receive so they can easily procmail the messages
  46      into a folder.
  47
  48   --[[BrandenRobinson]]
  49
  50 ## pluggable renderers
  51
  52 I'm considering a configurable rendering pipeline for each supported
  53 filename extension. So for ".mdwn" files, it would send the content through
  54 linkify, markdown, and finalize, while for ".wiki" files it might send it
  55 through just a wiki formatter and finalize.
  56
  57 This would allow not only supporting more types of markup, but changing
  58 what style of [[WikiLink]]s are supported, maybe some people want to add
  59 [[CamelCase]] for example, or don't like the [[SubPage/LinkingRules]].
  60
  61 The finalize step is where the page gets all the pretty junk around the
  62 edges, so that clearly needs to be pluggable too.
  63
  64 There also needs to be a step before finalize, where stuff like lists of pages
  65 that linked back to it could be added to the page. However, doing linkbacks
  66 also needs to tie into the main logic, to determine what pages need to be
  67 renered, so maybe that won't be a plugin.
  68
  69 ## revisit case
  70
  71 Being case insensative is handy, but it does make the [[BackLinks]] a bit
  72 ugly compared to other links. It should be possible to support pagenames
  73 that have uppercase, while still allowing them to be linked to using any
  74 case.
  75
  76 ## html
  77
  78 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.
  79
  80 All of this should be doable w/o touching a single line of code, just editing the [[templates]] BTW.
  81
  82 ## sigs
  83
  84 Need a way to sign name in page that's easier to type than "--\[[Joey]]"
  85 and that includes the date.
  86
  87 What syntax do other wikis use for this? I'm considering "\[[--]]" (with
  88 spaces removed) as it has a nice nmemonic.
  89
  90 OTOH, adding additional syntax for this would be counter to one of the
  91 design goals for ikiwiki: keeping as much markup as possible out of the
  92 wiki and not adding nonstandard markup. And it's not significantly hard to
  93 type "--\[[Joey]]", and as to the date, we do have page history.
  94
  95 ## recentchanges more than 100
  96
  97 Possibly add "next 100" link to it, but OTOH, you can just use svn log if
  98 you need that data..
  99
 100 ## search
 101
 102 * full text (use third-party tools?)
 103 * list of all missing pages
 104 * list of all pages or some kind of page map
 105
 106 ## page indexes
 107
 108 Might be nice to support automatically generating an index based on headers
 109 in a page, for long pages. The question is, how to turn on such an index?
 110
 111 ## basewiki underlay
 112
 113 Rather than copy the basewiki around everywhere, it should be configured to
 114 underlay the main srcdir, and pages be rendered from there if not in the
 115 srcdir. This would allow upgrades to add/edit pages in the basewiki.
 116
 117 Impementaion will be slightly tricky since currently ikiwiki is hardcoded
 118 in many places to look in srcdir for pages. Also, there are possible
 119 security attacks in the vein of providing a file ikiwiki would normally
 120 skip in the srcdir, and tricking it to processing this file instead of the
 121 one from the underlaydir.
 122
 123 There are also difficulties related to removing files from the srcdir, and
 124 exposing ones from the underlaydir. Will need to make sure that the mtime
 125 for the source file is zeroed when the page is removed, and that it then
 126 finds the underlay file and treats it as newer.
 127
 128 ## Logo
 129
 130 ikiwiki needs a logo. I'm thinking something simple like the word "ikiwiki"
 131 with the first "k" backwards; drawn to show that it's "wiki" reflected.
 132
 133 ## [[Bugs]]