doc/TODO

   1 Documentation TODO in no particular order grouped by style and content.
   2
   3 It would be nice to get some of these done for 1.6.
   4
   5 Style/Technical
   6 ---------------
   7
   8 * Re-check complete manual for consistency. The same things need to be
   9   consistently marked up, e.g. an item either always as <literal/> or
  10   always <emphasis/> (decide clearly which to use for what), make sure
  11   all option refs are links, things are consistently quoted.
  12   E.g. it has:
  13
  14     If the filename begins with a tilde (``&tilde;'')
  15
  16   and
  17
  18     If the filename ends with a vertical bar (&verbar;)
  19
  20   We need to choose either style and use it.
  21
  22 * Think about some way of templating to a) help improve consistency
  23   (i.e. some sort of macro to refer to key, options, functions, etc.)
  24   and b) reduce typing overhead.
  25
  26     <link linkend="pipe-split">&dollar;pipe&lowbar;split</link>
  27
  28   is neither fun to read nor to write. This would give us lots of
  29   options to improve it (e.g. an automated index). We depend on
  30   perl already to build docs, think about/look for simple perl
  31   templating engine.
  32
  33 * Find a way (XSLT?) to trim the TOC for the option reference; it's
  34   ugly but we probably want to keep the TOC depth as-is for other
  35   sections.
  36
  37 Content
  38 -------
  39
  40 * Some sections maybe should be better grouped by topic, instead of
  41   one section per task (e.g. hooks should be grouped under a section
  42   'hooks' in the config chapter).
  43
  44 * Talk a lot more about character sets and encodings.