doc/ikiwiki-transition.mdwn

   1 # NAME
   2
   3 ikiwiki-transition - transition ikiwiki pages to new syntaxes, etc
   4
   5 # SYNOPSIS
   6
   7 ikiwiki-transition type ...
   8
   9 # DESCRIPTION
  10
  11 `ikiwiki-transition` aids in converting wiki pages when there's a major
  12 change in ikiwiki syntax. It also handles other transitions not involving
  13 wiki pages.
  14
  15 # prefix_directives file ...
  16
  17 The `prefix_directives` mode converts the specified ikiwiki page from
  18 the old preprocessor directive syntax, requiring a space, to the new
  19 syntax, prefixed by '!'.
  20
  21 Preprocessor directives which already use the new syntax will remain
  22 unchanged.
  23
  24 Note that if the page contains wiki links with spaces, which some
  25 older versions of ikiwiki accepted, the prefix_directives transition will
  26 treat these as preprocessor directives and convert them.
  27
  28 # setupformat your.setup
  29
  30 The `setupformat` mode converts a setup file from using a single `wrappers` block
  31 to using `cgi_wrapper`, `git_wrapper`, etc.
  32
  33 Note that all comments and any unusual stuff like perl code in the setup
  34 file will be lost, as it is entirely rewritten by the transition.
  35
  36 # aggregateinternal your.setup
  37
  38 The `aggregateinternal` mode moves pages aggregated by the aggregate plugin
  39 so that the `aggregateinternal` option can be enabled.
  40
  41 # moveprefs your.setup
  42
  43 Moves values that used to be admin preferences into the setup file.
  44
  45 Note that all comments and any unusual stuff like perl code in the setup
  46 file will be lost, as it is entirely rewritten by the move.
  47
  48 # indexdb srcdir
  49
  50 The `indexdb` mode handles converting a plain text `.ikiwiki/index` file to
  51 a binary `.ikiwiki/indexdb`. You do not normally need to run
  52 `ikiwiki-transition indexdb`; ikiwiki will automatically run it as
  53 necessary.
  54
  55 # hashpassword srcdir
  56
  57 The `hashpassword` mode forces any plaintext passwords stored in the
  58 `.ikiwiki/userdb` file to be replaced with password hashes. (The
  59 Authen::Passphrase perl module is needed to do this.)
  60
  61 If this is not done explicitly, a user's plaintext password will be
  62 automatically converted to a hash when a user logs in for the first time
  63 after upgrade to ikiwiki 2.48.
  64
  65 # AUTHOR
  66
  67 Josh Triplett <josh@freedesktop.org>, Joey Hess <joey@ikiwiki.info>
  68
  69 Warning: this page is automatically made into ikiwiki-transition's man page, edit with care