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 Note that there's a disctinction between being self-documenting for users,
   6 and being complete documentation for ikiwiki. The basewiki is _not_
   7 intended to be the latter, so it lacks the usage page, all the plugin
   8 pages, etc.
   9
  10 I've made some progress toward making the basewiki self-documenting by moving
  11 the docs about using templates, shortcuts, and blogs from the plugin pages,
  12 onto the pages in the basewiki.
  13
  14 Here are some of the things that are not documented in full in the
  15 basewiki:
  16
  17         joey@kodama:~/src/ikiwiki/doc/plugins>grep usage *
  18         aggregate.mdwn:## usage
  19         graphviz.mdwn:page.  Example usage:
  20         graphviz.mdwn:amounts of processing time and disk usage.
  21         img.mdwn:## usage
  22         linkmap.mdwn:set of pages in the wiki. Example usage:
  23         map.mdwn:This plugin generates a hierarchical page map for the wiki. Example usage:
  24         postsparkline.mdwn:# usage
  25         sparkline.mdwn:# usage
  26         sparkline.mdwn:more detail in [its wiki](http://sparkline.wikispaces.com/usage).
  27         table.mdwn:## usage
  28
  29 Meta is another one.
  30
  31 See also: [[Conditional_Underlay_Files]]