<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>upgrade to 3.0</title> <meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="stylesheet" href="../style.css" type="text/css" /> <link rel="stylesheet" href="../local.css" type="text/css" /> </head> <body> <div class="page"> <div class="pageheader"> <div class="header"> <span> <span class="parentlinks"> <a href="../index.html">ikiwiki</a>/ <a href="../tips.html">tips</a>/ </span> <span class="title"> upgrade to 3.0 </span> </span> </div> </div> <div id="pagebody"> <div id="content" role="main"> <p>Version 3.0 of ikiwiki makes some significant changes, which you will need to deal with when upgrading from ikiwiki 2.x.</p> <div class="toc"> <ol> <li class="L2"><a href="#index1h2">setup file format change</a> </li> <li class="L2"><a href="#index2h2">moving settings from Preferences page</a> </li> <li class="L2"><a href="#index3h2">prefix directives</a> </li> <li class="L2"><a href="#index4h2">GlobLists</a> </li> <li class="L2"><a href="#index5h2">aggregateinternal</a> </li> <li class="L2"><a href="#index6h2">embed / googlecalendar</a> </li> </ol> </div> <h2><a name="index1h2"></a>setup file format change</h2> <p>The layout of the setup file changed in a significant way in version 2.60 of ikiwiki. If you have not changed yours to the new format, now would be a good time to do so. Some new features, like the <a href="../plugins/websetup.html">websetup</a> interface, need the new format setup file.</p> <p>You can convert old setup files into the new format by running <code>ikiwiki-transition setupformat your.setup</code></p> <h2><a name="index2h2"></a>moving settings from Preferences page</h2> <p>The admin preferences page used to have settings for allowed attachments, locked pages, and banned users. These three settings have moved to the setup file, and will no longer appear on the admin preferences page once your wiki is upgraded to 3.0.</p> <p>You can move these preferences into the setup file by running <code>ikiwiki-transition moveprefs your.setup; ikiwiki --setup your.setup --refresh --wrappers</code></p> <p>(Make sure you have converted the setup file to the new format first.)</p> <h2><a name="index3h2"></a>prefix directives</h2> <p>In 3.0, the syntax ikiwiki uses for <a href="../ikiwiki/directive.html">directives</a> has changed, requiring that the directive start with a bang: </p> <pre><code>[[!directive ...]] </code></pre> <p>If you would like to keep the old syntax, it is still supported, add the following to your setup file:</p> <pre><code>prefix_directives => 0, </code></pre> <p>To convert to the new syntax, make sure that your setup file does <em>not</em> contain the above, then run <code>ikiwiki-transition prefix_directives your.setup</code></p> <p>(And then commit the changes it makes to pages in your srcdir.)</p> <h2><a name="index4h2"></a>GlobLists</h2> <p>In 3.0, the old "GlobList" syntax for <a href="../ikiwiki/pagespec.html">PageSpecs</a> is no longer supported. A GlobList contains multiple terms, but does not separate them with "and" or "or":</p> <pre><code>sandbox !*/Discussion </code></pre> <p>To convert this to a modern PageSpec, simply add "and" or "or" as appropriate between terms:</p> <pre><code>sandbox and !*/Discussion </code></pre> <p>GlobLists have been deprecated for more than two years. If your wiki dates to the ikiwiki 1.0 era, you should check it for any that might have lurked unnoticed in it since back then. Ikiwiki version 2.72 will print warnings about any GlobLists it sees.</p> <h2><a name="index5h2"></a>aggregateinternal</h2> <p>If your wiki uses the <a href="../plugins/aggregate.html">aggregate</a> plugin, it will start to aggregate feeds to special "internal" pages.</p> <p>If you don't want this change, you can add the following to your setup file:</p> <pre><code>aggregateinternal => 0, </code></pre> <p>Otherwise, follow this procedure to upgrade a wiki using the aggregate plugin:</p> <ol> <li>Update all <a href="../ikiwiki/pagespec.html">PageSpecs</a> that refer to the aggregated pages -- such as those in inlines. Put "internal()" around globs in those PageSpecs. For example, if the PageSpec was <code>foo/*</code>, it should be changed to <code>internal(foo/*)</code>. This has to be done because internal pages are not matched by regular globs.</li> <li>Use <a href="../ikiwiki-transition.html">ikiwiki-transition</a> to rename all existing aggregated <code>.html</code> files in the srcdir. The command to run is <code>ikiwiki-transition aggregateinternal your.setup</code>,</li> <li>Refresh the wiki. (<code>ikiwiki --setup your.setup --refresh</code>)</li> </ol> <h2><a name="index6h2"></a>embed / googlecalendar</h2> <p>The googlecalendar plugin has been deprecated for a long time, and is removed in 3.0.</p> <p>The embed plugin is also now deprecated, though not yet removed.</p> <p>If you use either plugin to embed content from google, youtube, etc, into your wiki, you should instead configure the <a href="../plugins/htmlscrubber.html">htmlscrubber</a> to skip sanitising some pages, via the <code>htmlscrubber_skip</code> setting. See <a href="./embedding_content.html">embedding content</a> for examples.</p> </div> </div> <div id="footer" class="pagefooter" role="contentinfo"> <div id="pageinfo"> <div id="backlinks"> Links: <a href="../news/ikiwiki_version_3.0.html">news/ikiwiki version 3.0</a> <a href="../roadmap.html">roadmap</a> </div> <div class="pagedate"> Last edited <span class="date">Tue Feb 26 23:01:54 2019</span> <!-- Created <span class="date">Tue Dec 23 21:20:37 2008</span> --> </div> </div> <!-- from ikiwiki --> </div> </div> </body> </html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
a2ac79ac252ef7b89f2f0fc449728720
>
files
>
722
