reviewed, not merged

[git.ikiwiki.info.git] / doc / tips / upgrade_to_3.0.mdwn

diff --git a/doc/tips/upgrade_to_3.0.mdwn b/doc/tips/upgrade_to_3.0.mdwn
index 50c4201030511b2aa2de752b48d8e8b54d0e885c..05b6d6fbd03d72f181c6733ab1fa6bf15f27a433 100644 (file)
--- a/doc/tips/upgrade_to_3.0.mdwn
+++ b/doc/tips/upgrade_to_3.0.mdwn
@@ -13,7 +13,7 @@ interface, need the new format setup file.
 You can convert old setup files into the new format by running
 `ikiwiki-transition setupformat your.setup`
 
 You can convert old setup files into the new format by running
 `ikiwiki-transition setupformat your.setup`
 

-# moving settings from Preferences page
+## moving settings from Preferences page

 
 The admin preferences page used to have settings for allowed attachments,
 locked pages, and banned users. These three settings have moved to the
 
 The admin preferences page used to have settings for allowed attachments,
 locked pages, and banned users. These three settings have moved to the


@@ -21,9 +21,9 @@ setup file, and will no longer appear on the admin preferences page once
 your wiki is upgraded to 3.0.
 
 You can move these preferences into the setup file by running
 your wiki is upgraded to 3.0.
 
 You can move these preferences into the setup file by running

-`ikiwiki-transition moveprefs your.setup`
+`ikiwiki-transition moveprefs your.setup; ikiwiki -setup your.setup -refresh -wrappers`

 
 

-(Make sure you have converted the setuop file to the new format first.)
+(Make sure you have converted the setup file to the new format first.)

 
 ## prefix directives
 
 
 ## prefix directives
 


@@ -37,20 +37,15 @@ following to your setup file:
        
        prefix_directives => 0,
 
        
        prefix_directives => 0,
 

-But it's not hard to convert your wiki to the new syntax. You can use
-[[ikiwiki-transition]]. It will convert preprocessor directives in all
-files given on the command line. To convert an entire wiki:
+To convert to the new syntax, make sure that your setup file does *not*
+contain the above, then run `ikiwiki-transition prefix_directives your.setup`

 
 

-       find wikidir/ -type f -name '*.mdwn' -print0 | xargs -0 ikiwiki-transition prefix_directives
-
-Be sure to modify the find to list all pages in the wiki if you're using
-other markup than markdown. You will probably want to commit the changes
-when you're done too.
+(And then commit the changes it makes to pages in your srcdir.)

 
 ## GlobLists
 
 In 3.0, the old "GlobList" syntax for [[PageSpecs|ikiwiki/PageSpec]] is no
 
 ## GlobLists
 
 In 3.0, the old "GlobList" syntax for [[PageSpecs|ikiwiki/PageSpec]] is no

-longer supported. A GlobList contains multiple term, but does not separate
+longer supported. A GlobList contains multiple terms, but does not separate

 them with "and" or "or":
 
        sandbox !*/Discussion
 them with "and" or "or":
 
        sandbox !*/Discussion


@@ -87,7 +82,14 @@ Otherwise, follow this procedure to upgrade a wiki using the aggregate plugin:
    `ikiwiki-transition aggregateinternal your.setup`,
 3. Refresh the wiki. (`ikiwiki -setup your.setup -refresh`)
 
    `ikiwiki-transition aggregateinternal your.setup`,
 3. Refresh the wiki. (`ikiwiki -setup your.setup -refresh`)
 

-## googlecalendar
+## embed / googlecalendar
+
+The googlecalendar plugin has been deprecated for a long time, and is
+removed in 3.0.
+
+The embed plugin is also now deprecated, though not yet removed.

 
 

-This plugin has been deprecated for a long time, and is removed in 3.0. If
-your wiki used it, you should enable the [[plugins/embed]] plugin, instead.
+If you use either plugin to embed content from google, youtube, etc,
+into your wiki, you should instead configure the [[plugins/htmlscrubber]]
+to skip sanitising some pages, via the `htmlscrubber_skip` setting.
+See [[embedding_content]] for examples.