]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - debian/NEWS
update news for template change
[git.ikiwiki.info.git] / debian / NEWS
index 461a81977eeb4c7caf903c934d2463ee71af0247..69967c84caddd974552344e0098eaccfde912e4f 100644 (file)
@@ -1,4 +1,191 @@
-ikiwiki (2.21) unstable; urgency=low
+ikiwiki (3.20100422) unstable; urgency=low
+
+  This version of ikiwiki has a lot of changes that you need to know about.
+
+  Now you can include customised versions of templates in the source
+  of your wiki. (For example, templates/page.tmpl.) When these templates
+  are changed, ikiwiki will automatically rebuild pages that use them.
+
+  The --getctime switch is renamed to --gettimes, and it also gets the 
+  file modification time. And it's a lot faster (when using git). But
+  the really important change is, you don't have to remember to use this
+  switch. Now ikiwiki will do it when it needs to.
+
+  At last, the "tagged()" pagespec only matches tags, not regular wikilinks.
+  If your wiki accidentially relied on the old, buggy behavior, you might
+  need to change its pagespecs to use "link()".
+
+  Many of your wishes have been answered: Now tag pages can automatically be
+  created when new tags are used. This feature is enabled by default if you
+  have configured a tagbase. It can be turned on or off using the
+  tag_autocreate setting.
+
+  These changes may also affect some users:
+
+  * The title_natural sort method (as used by the inline directive, etc)
+    have been moved to the new sortnaturally plugin, which is not enabled
+    by default since it requires the Sort::Naturally perl module.
+
+  * TMPL_INCLUDE is no longer supported in any template used by ikiwiki.
+    It used to be allowed in certian templates, but not in others.
+
+  * The add_templates option has been removed from the underlay plugin.
+    If you used this option, you can instead use templates/ subdirectories
+    inside underlay directories added by the add_underlays option.
+
+  Due to the above and other changes, all wikis need to be rebuilt on
+  upgrade to this version. If you listed your wiki in /etc/ikiwiki/wikilist
+  this will be done automatically when the Debian package is upgraded. Or
+  use ikiwiki-mass-rebuild to force a rebuild.
+
+ -- Joey Hess <joeyh@debian.org>  Wed, 21 Apr 2010 20:31:29 -0400
+
+ikiwiki (3.20091017) unstable; urgency=low
+
+  To take advantage of significant performance improvements, all
+  wikis need to be rebuilt on upgrade to this version. If you
+  listed your wiki in /etc/ikiwiki/wikilist this will be done
+  automatically when the Debian package is upgraded. Or use
+  ikiwiki-mass-rebuild to force a rebuild.
+
+ -- Joey Hess <joeyh@debian.org>  Mon, 05 Oct 2009 16:48:59 -0400
+
+ikiwiki (3.1415926) unstable; urgency=low
+
+  In order to fix a performance bug, all wikis need to be rebuilt on
+  upgrade to this version. If you listed your wiki in
+  /etc/ikiwiki/wikilist this will be done automatically when the
+  Debian package is upgraded. Or use ikiwiki-mass-rebuild to force
+  a rebuild.
+
+ -- Joey Hess <joeyh@debian.org>  Tue, 25 Aug 2009 17:24:43 -0400
+
+ikiwiki (3.13) unstable; urgency=low
+
+  The `ikiwiki-transition deduplinks` command introduced in the
+  last release was buggy. If you followed the NEWS file instructions
+  and ran it, you should run `ikiwiki -setup` to rebuild your wiki
+  to fix the problem.
+
+ -- Joey Hess <joeyh@debian.org>  Fri, 22 May 2009 13:04:02 -0400
+
+ikiwiki (3.12) unstable; urgency=low
+
+  You may want to run `ikiwiki-transition deduplinks your.setup`
+  after upgrading to this version of ikiwiki. This command will
+  optimise your wiki's saved state, removing duplicate information
+  that can slow ikiwiki down.
+
+ -- Joey Hess <joeyh@debian.org>  Wed, 06 May 2009 00:25:06 -0400
+
+ikiwiki (3.01) unstable; urgency=low
+
+  If your wiki uses git, and you have a `diffurl` configured in
+  its setup file, you should be aware that gitweb has stopped
+  supporting the url form commonly used for the `diffurl`.
+
+  You can change your setup to use the newer gitweb url form:
+
+    http://git.example.com/gitweb.cgi?p=wiki.git;a=blobdiff;f=[[file]];h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_commit]];hpb=[[sha1_parent]]
+
+  The changes from the old form are the addition of the `hpb` parameter,
+  and the change to the value used for the `hb` parameter.
+
+ -- Joey Hess <joeyh@debian.org>  Mon, 05 Jan 2009 18:18:05 -0500
+
+ikiwiki (3.00) unstable; urgency=low
+
+  The 3.0 release of ikiwiki changes several defaults and finishes
+  some transitions. You will need to modify your wikis to work with
+  ikiwiki 3.0. A document explaining the process is available
+  in </usr/share/doc/ikiwiki/html/tips/upgrade_to_3.0.html>
+
+ -- Joey Hess <joeyh@debian.org>  Tue, 23 Dec 2008 16:14:18 -0500
+
+ikiwiki (2.62) unstable; urgency=low
+
+  TexImg standard preamble changed
+
+  The teximg plugin now has a configurable LaTeX preamble.
+  As part of this change the `mchem` LaTeX package has been removed from
+  the default LaTeX preamble as it wasn't included in many TeX installations.
+
+  The previous behaviour can be restored by adding the following to your
+  ikiwiki setup:
+
+        teximg_prefix => '\documentclass{scrartcl}
+                \usepackage[version=3]{mhchem}
+                \usepackage{amsmath}
+                \usepackage{amsfonts}
+                \usepackage{amssymb}
+                \pagestyle{empty}
+                \begin{document}',
+
+  In addition, the rendering mechanism has been changed to use `dvipng` by
+  default, if available.
+
+ -- Joey Hess <joeyh@debian.org>  Sun, 24 Aug 2008 15:00:40 -0400
+
+ikiwiki (2.60) unstable; urgency=low
+
+  Admin preferences are moving from the web interface to the setup file.
+  There are three new options in the setup file: `locked_pages`, `banned_users`,
+  and `allowed_attachments`. The admin prefs page can still be used, but
+  that's deprecated, and the prefs will be hidden if a value is not already
+  set. If a value is set in the web interface, you're encouraged to move that
+  setting to your setup file now, since version 3.0 will remove the deprecated
+  admin prefs web interface.
+
+  Also, the layout of the setup file has changed in a significant way in this
+  release. Old setup files will continue to work, but new features, like the
+  new websetup interface, require a new format setup file. You can convert
+  old setup files into the new format by running 
+  `ikiwiki-transition setupformat ikiwiki.setup`
+
+ -- Joey Hess <joeyh@debian.org>  Fri, 01 Aug 2008 17:02:14 -0400
+
+ikiwiki (2.52) unstable; urgency=low
+
+  All wikis need to be rebuilt on upgrade to this version. If you listed your
+  wiki in /etc/ikiwiki/wikilist this will be done automatically when the
+  Debian package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
+
+ -- Joey Hess <joeyh@debian.org>  Sun, 06 Jul 2008 15:10:05 -0400
+
+ikiwiki (2.49) unstable; urgency=low
+
+  The search plugin no longer uses hyperestraier. Instead, to use it you
+  will now need to install xapian-omega, and the Search::Xapian,
+  HTML::Scrubber, and Digest::SHA1 perl modules. Ie,
+  `apt-get install xapian-omega libsearch-xapian-perl libhtml-scrubber-perl libdigest-sha1-perl`
+
+  Also, wikis that use the search plugin will need to be rebuilt,
+  since the search form has changed. This will not be done automatically,
+  but can be done by running `ikiwiki-mass-upgrade` as root, or
+  running `ikiwiki -setup` on individual setup files.
+
+ -- Joey Hess <joeyh@debian.org>  Wed, 04 Jun 2008 00:29:28 -0400
+
+ikiwiki (2.48) unstable; urgency=high
+
+  If you allowed password based logins to your wiki, those passwords were
+  stored in cleartext in the userdb. To guard against exposing users'
+  passwords, I recommend you install the Authen::Passphrase perl module, and
+  then run `ikiwiki-transition hashpassword /path/to/srcdir` to replace all
+  existing cleartext passwords with strong (blowfish) hashes.
+
+ -- Joey Hess <joeyh@debian.org>  Thu, 29 May 2008 14:39:34 -0400
+
+ikiwiki (2.46) unstable; urgency=low
+  There were some significant template changes in ikiwiki 2.42 (and 1.33.5).
+  If you have locally modified versions of the templates, they need to be
+  updated. Most notably, the editpage.tmpl has a new FIELD-SID added to it,
+  without which web editing will fail.
+ -- Joey Hess <joeyh@debian.org>  Tue, 06 May 2008 14:30:14 -0400
+
+ikiwiki (2.40) unstable; urgency=low
 
   ikiwiki now has an new syntax for preprocessor directives, using the
   prefix '!':
@@ -18,19 +205,39 @@ ikiwiki (2.21) unstable; urgency=low
   in their setup files.
 
   To convert your wiki to the new syntax, ikiwiki provides a new script
-  ikiwiki-prefix-directives.  It will convert preprocessor directives in
-  all files given on the command line.  To convert an entire wiki:
-
-  find wikidir/ -type f -name '*.mdwn' -print0 | xargs -0 ikiwiki-prefix-directives
+  ikiwiki-transition.
 
   Even with prefix_directives disabled, ikiwiki now allows an optional '!'
   prefix on preprocessor directives (but still requires a space).  Thus, a
   directive which uses a '!' prefix and contains a space will work with
-  ikiwiki 2.21 and newer, regardless of the value of prefix_directives.
+  ikiwiki 2.40 and newer, regardless of the value of prefix_directives.
   This allows the underlay to work with all ikiwikis.
 
  -- Josh Triplett <josh@freedesktop.org>  Sat, 26 Jan 2008 16:26:47 -0800
 
+ikiwiki (2.30) unstable; urgency=low
+
+  Ever feel that ikiwiki's handling of RecentChanges wasn't truely in the
+  spirit of a wiki compiler? Well, that's changed. The RecentChanges page is
+  now a static page, not a CGI. Users can subscribe to its rss/atom feeds.
+  Custom RecentChanges pages can be easily set up that display only changes
+  to a subset of pages, or only changes by a subset of users.
+  
+  All wikis need to be rebuilt on upgrade to this version. If you listed your
+  wiki in /etc/ikiwiki/wikilist this will be done automatically when the
+  Debian package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
+
+  With this excellent new RecentChanges support, the mail notification system
+  is its age (and known to be variously buggy and underimplemented for
+  various VCSes), and so ikiwiki's support for sending commit mails is REMOVED
+  from this version. If you were subscribed to commit mails, you should be
+  able to accomplish the same thing by subscribing to a RecentChanges feed.
+
+  The "notify" field in setup files is no longer used, and
+  silently ignored. You may want to remove it from your setup file.
+
+ -- Joey Hess <joeyh@debian.org>  Tue, 29 Jan 2008 17:18:31 -0500
+
 ikiwiki (2.20) unstable; urgency=low
 
   The template plugin has begin to htmlize the variables passed to templates.
@@ -57,7 +264,7 @@ ikiwiki (2.14) unstable; urgency=low
 
   This version of ikiwiki is more picky about symlinks in the path leading
   to the srcdir, and will refuse to use a srcdir specified by such a path.
-  This  was necessary to avoid some potential exploits, but could potentially
+  This was necessary to avoid some potential exploits, but could potentially
   break (semi-)working wikis. If your wiki has a srcdir path containing a
   symlink, you should change it to use a path that does not.