X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/99fce0af0d4e99bc81ef7847bfbe77662763e805..4da365136ac123291d3b608adb3192311692182d:/doc/ikiwiki-transition.mdwn diff --git a/doc/ikiwiki-transition.mdwn b/doc/ikiwiki-transition.mdwn index da3b3a8d5..8b7c3579f 100644 --- a/doc/ikiwiki-transition.mdwn +++ b/doc/ikiwiki-transition.mdwn @@ -1,6 +1,6 @@ # NAME -ikiwiki-transition - transition ikiwiki pages to new syntaxes +ikiwiki-transition - transition ikiwiki pages to new syntaxes, etc # SYNOPSIS @@ -8,12 +8,15 @@ ikiwiki-transition type ... # DESCRIPTION -`ikiwiki-transition` aids in converting ikiwiki pages when -there's a major change in ikiwiki syntax. +`ikiwiki-transition` aids in converting wiki pages when +there's a major change in ikiwiki syntax. It also handles other transitions +not involving wiki pages. -Currently only one such transition is handled, the `prefix_directives` mode -converts the specified ikiwiki page from the old preprocessor directive -syntax, requiring a space, to the new syntax, prefixed by '!'. +# prefix_directives + +The `prefix_directives` mode converts the specified ikiwiki page from +the old preprocessor directive syntax, requiring a space, to the new +syntax, prefixed by '!'. Preprocessor directives which already use the new syntax will remain unchanged. @@ -22,14 +25,40 @@ Note that if the page contains wiki links with spaces, which some older versions of ikiwiki accepted, the prefix_directives transition will treat these as preprocessor directives and convert them. -One other transition is handled, the `indexdb` mode handles converting -a plain text `.ikiwiki/index` file to a binary `.ikiwiki/indexdb`. In this -mode, you should specify the srcdir of the wiki as the second parameter. -You do not normally need to run `ikiwiki-transition indexdb`; ikiwiki will -automatically run it as necessary. +# setupformat + +The `setupformat` mode converts a setup file from using a single `wrappers` block +to using `cgi_wrapper`, `git_wrapper`, etc. + +Note that all comments and any unusual stuff like perl code in the setup +file will be lost, as it is entirely rewritten by the transition. + +# aggregateinternal + +The `aggregateinternal` mode moves pages aggregated by the aggregate plugin +so that the `aggregateinternal` option can be enabled. + +# indexdb + +The `indexdb` mode handles converting a plain text `.ikiwiki/index` file to +a binary `.ikiwiki/indexdb`. In this mode, you should specify the srcdir of +the wiki as the second parameter. You do not normally need to run +`ikiwiki-transition indexdb`; ikiwiki will automatically run it as +necessary. + +# hashpassword + +The `hashpassword` mode forces any plaintext passwords stored in the +`.ikiwiki/userdb` file to be replaced with password hashes. (The +Authen::Passphrase perl module is needed to do this.) In this mode, you +should specify the srcdir of the wiki as the second parameter. + +If this is not done explicitly, a user's plaintext password will be +automatically converted to a hash when a user logs in for the first time +after upgrade to ikiwiki 2.48. # AUTHOR -Josh Triplett +Josh Triplett , Joey Hess Warning: this page is automatically made into ikiwiki-transition's man page, edit with care