doc/ikiwiki-transition.mdwn

   1 # NAME
   2
   3 ikiwiki-transition - transition ikiwiki pages to new syntaxes
   4
   5 # SYNOPSIS
   6
   7 ikiwiki-transition type ...
   8
   9 # DESCRIPTION
  10
  11 `ikiwiki-transition` aids in converting ikiwiki pages when
  12 there's a major change in ikiwiki syntax.
  13
  14 Currently only one such transition is handled, the `prefix_directives` mode
  15 converts the specified ikiwiki page from the old preprocessor directive
  16 syntax, requiring a space, to the new syntax, prefixed by '!'.
  17
  18 Preprocessor directives which already use the new syntax will remain
  19 unchanged.
  20
  21 Note that if the page contains wiki links with spaces, which some
  22 older versions of ikiwiki accepted, the prefix_directives transition will
  23 treat these as preprocessor directives and convert them.
  24
  25 One other transition is handled, the `indexdb` mode handles converting
  26 a plain text `.ikiwiki/index` file to a binary `.ikiwiki/indexdb`. In this
  27 mode, you should specify the srcdir of the wiki as the second parameter.
  28 You do not normally need to run `ikiwiki-transition indexdb`; ikiwiki will
  29 automatically run it as necessary.
  30
  31 # AUTHOR
  32
  33 Josh Triplett <josh@freedesktop.org>
  34
  35 Warning: this page is automatically made into ikiwiki-transition's man page, edit with care