git.oblomov.eu Git - ikiwiki/blob - doc/todo/basewiki_should_be_self_documenting.mdwn

   1 The pages in the basewiki should be fully self-documenting as far as what
   2 users need to know to edit pages in the wiki. [[ikiwiki/Formatting]]
   3 documents the basics, but doesn't include every preprocessor directive.
   4
   5 > Thanks to Joey's work applying and fixing up my patches, this is mostly done.
   6 > The one thing I'd add above the way things currently work would be to add
   7 > the [[plugins/listdirectives]] plugin to [[plugins/goodstuff]].
   8 > Doing that requires making the decision about whether you really want the
   9 > documentation in every wiki - it is 200k.  -- [[Will]]
  10
  11 >> I don't think that it needs to be in goodstuff to close this, though I
  12 >> might decide to add it to goodstuff later. [[done]] --[[Joey]]
  13
  14 Note that there's a disctinction between being self-documenting for users,
  15 and being complete documentation for ikiwiki. The basewiki is _not_
  16 intended to be the latter, so it lacks the usage page, all the plugin
  17 pages, etc.
  18
  19 I've made some progress toward making the basewiki self-documenting by moving
  20 the docs about using templates, shortcuts, and blogs from the plugin pages,
  21 onto the pages in the basewiki.
  22
  23 Here are some of the things that are not documented in full in the
  24 basewiki:
  25
  26         joey@kodama:~/src/ikiwiki/doc/plugins>grep usage *
  27         aggregate.mdwn:## usage
  28         graphviz.mdwn:page.  Example usage:
  29         graphviz.mdwn:amounts of processing time and disk usage.
  30         img.mdwn:## usage
  31         linkmap.mdwn:set of pages in the wiki. Example usage:
  32         map.mdwn:This plugin generates a hierarchical page map for the wiki. Example usage:
  33         postsparkline.mdwn:# usage
  34         sparkline.mdwn:# usage
  35         sparkline.mdwn:more detail in [its wiki](http://sparkline.wikispaces.com/usage).
  36         table.mdwn:## usage
  37
  38 Meta is another one.
  39
  40 See also: [[Conditional_Underlay_Files]]