Merge branch 'master' into debian-jessie-backports

[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 3a515a61f6e0a20672d501e89459e448749dbbd0..8ec2389353f9d57b66b1d6018db17ab509f63beb 100644 (file)
--- a/doc/tips/upgrade_to_3.0.mdwn
+++ b/doc/tips/upgrade_to_3.0.mdwn
@@ -1,3 +1,5 @@
+[[!meta date="2008-12-23 16:20:37 -0500"]]
+
 Version 3.0 of ikiwiki makes some significant changes, which
 you will need to deal with when upgrading from ikiwiki 2.x.
 
@@ -13,7 +15,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`
 
-# 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
@@ -21,7 +23,7 @@ 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
-`ikiwiki-transition moveprefs your.setup`
+`ikiwiki-transition moveprefs your.setup; ikiwiki --setup your.setup --refresh --wrappers`
 
 (Make sure you have converted the setup file to the new format first.)
 
@@ -37,15 +39,15 @@ following to your setup file:
        
        prefix_directives => 0,
 
-To convert to the new syntax, run 
-`ikiwiki-transition prefix_directives your.setup`
+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`
 
 (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
-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
@@ -80,9 +82,16 @@ Otherwise, follow this procedure to upgrade a wiki using the aggregate plugin:
 2. Use [[ikiwiki-transition]] to rename all existing aggregated `.html`
    files in the srcdir. The command to run is
    `ikiwiki-transition aggregateinternal your.setup`,
-3. Refresh the wiki. (`ikiwiki -setup your.setup -refresh`)
+3. Refresh the wiki. (`ikiwiki --setup your.setup --refresh`)
+
+## embed / googlecalendar
+
+The googlecalendar plugin has been deprecated for a long time, and is
+removed in 3.0.
 
-## googlecalendar
+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.