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 mail notification of new and changed pages.
   9
  10   Hmm, should be easy to implement this.. it runs as a svn post-coommit hook
  11   already, so just look at the userdb, svnlook at what's changed, and send
  12   mails to people who have subscribed.
  13
  14   A few details:
  15   1. [[Joey]] mentioned that being able to subscribe to globs as well as
  16      explicitly named pages would be desirable.
  17   2. I think that since we're using Perl on the backend, being able to
  18      let users craft their own arbitrary regexes would be good.
  19
  20      Joey points out that this is actually a security hole, because Perl
  21      regexes let you embed (arbitrary?) Perl expressions inside them.  Yuck!
  22
  23      It would also be good to be able to subscribe to all pages except discussion pages or the SandBox: `* !*/discussion !sandobx`, maybe --[[Joey]]
  24
  25   3. Of course if you do that, you want to have form processing on the user
  26      page that lets them tune it, and probably choose literal or glob by
  27      default.
  28
  29      I think that the new globlist() function should do everything you need.
  30      Adding a field to the prefs page will be trivial --[[Joey]]
  31
  32   The first cut, I suppose, could use one sendmail process to batch-mail all
  33   subscribers for a given page.  However, in the long run, I can see users
  34   demanding a bit of feature creep:
  35
  36   4. Each user should be able to tune whether they see the actual diff parts or
  37      not.
  38   5. Each user should be able to set a maximum desired email size.
  39   6. We might want to support a user-specified shibboleth string that will be
  40      included in the email they receive so they can easily procmail the messages
  41      into a folder.
  42
  43   --[[BrandenRobinson]]
  44
  45 ## pluggable renderers
  46
  47 I'm considering a configurable rendering pipeline for each supported
  48 filename extension. So for ".mdwn" files, it would send the content through
  49 linkify, markdown, and finalize, while for ".wiki" files it might send it
  50 through just a wiki formatter and finalize.
  51
  52 This would allow not only supporting more types of markup, but changing
  53 what style of [[WikiLink]]s are supported, maybe some people want to add
  54 [[CamelCase]] for example, or don't like the [[SubPage/LinkingRules]].
  55
  56 The finalize step is where the page gets all the pretty junk around the
  57 edges, so that clearly needs to be pluggable too.
  58
  59 There also needs to be a step before finalize, where stuff like lists of pages
  60 that linked back to it could be added to the page. However, doing linkbacks
  61 also needs to tie into the main logic, to determine what pages need to be
  62 renered, so maybe that won't be a plugin.
  63
  64 ## blogging
  65
  66 - Add a small form at top and bottom of a blog to allow entering
  67   a title for a new item, that goes to a template to create the new page.
  68 - Add a link to the end of a blog to go to the archives; this would
  69   probably best be another cgi script, to avoid needing to generate big
  70   static pages for little used archives.
  71 - Should probably add params to control various rss fields like the blog
  72   title, its author email, its copyright info, etc.
  73
  74 ## revisit case
  75
  76 Being case insensative is handy, but it does make the [[BackLinks]] a bit
  77 ugly compared to other links. It should be possible to support pagenames
  78 that have uppercase, while still allowing them to be linked to using any
  79 case.
  80
  81 ## html
  82
  83 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.
  84
  85 All of this should be doable w/o touching a single line of code, just editing the [[templates]] BTW.
  86
  87 ## sigs
  88
  89 Need a way to sign name in page that's easier to type than "--\[[Joey]]"
  90 and that includes the date.
  91
  92 What syntax do other wikis use for this? I'm considering "\[[--]]" (with
  93 spaces removed) as it has a nice nmemonic.
  94
  95 OTOH, adding additional syntax for this would be counter to one of the
  96 design goals for ikiwiki: keeping as much markup as possible out of the
  97 wiki and not adding nonstandard markup. And it's not significantly hard to
  98 type "--\[[Joey]]", and as to the date, we do have page history.
  99
 100 ## recentchanges more than 100
 101
 102 Possibly add "next 100" link to it, but OTOH, you can just use svn log if
 103 you need that data..
 104
 105 ## search
 106
 107 * page name substring search
 108 * full text (use third-party tools?)
 109
 110 ## lists
 111
 112 * list of all missing pages
 113 * list of all pages or some kind of page map (probably covered by the rss
 114   feeds stuff above)
 115
 116 These could be their own static pages updated when other pages are updated.
 117 Perhaps this ties in with the pluggable renderers stuff.
 118
 119 ## page indexes
 120
 121 Might be nice to support automatically generating an index based on headers
 122 in a page, for long pages. The question is, how to turn on such an index?
 123
 124 ## basewiki underlay
 125
 126 Rather than copy the basewiki around everywhere, it should be configured to
 127 underlay the main srcdir, and pages be rendered from there if not in the
 128 srcdir. This would allow upgrades to add/edit pages in the basewiki.
 129
 130 Impementaion will be slightly tricky since currently ikiwiki is hardcoded
 131 in many places to look in srcdir for pages. Also, there are possible
 132 security attacks in the vein of providing a file ikiwiki would normally
 133 skip in the srcdir, and tricking it to processing this file instead of the
 134 one from the underlaydir.
 135
 136 There are also difficulties related to removing files from the srcdir, and
 137 exposing ones from the underlaydir. Will need to make sure that the mtime
 138 for the source file is zeroed when the page is removed, and that it then
 139 finds the underlay file and treats it as newer.
 140
 141 ## wikilinks features
 142
 143 - \[[John|Fred]] is a Wikipedia method for linking to the one page
 144   while displaying it as the other, Kyle would like this.
 145
 146 ## Logo
 147
 148 ikiwiki needs a logo. I'm thinking something simple like the word "ikiwiki"
 149 with the first "k" backwards; drawn to show that it's "wiki" reflected.
 150
 151 ## [[Bugs]]