]> git.wincent.com - wikitext.git/blobdiff - doc/RELEASE-NOTES
Auto-initialize under Rails 3
[wikitext.git] / doc / RELEASE-NOTES
index 6a78ac996826a0d843dc178794728b63a7c1de4c..e45e1e5253995e72edd8ab5b27dbb2ea31e8454d 100644 (file)
@@ -1,3 +1,114 @@
+This file describes changes with some user or developer impact
+(significant changes to the externally visible behaviour of the
+extension, or things which may require action on the part of
+users or developers). Minor bugfixes and tweaks which don't
+require any user or developer action are generally not included
+in these release notes. For a full listing of all changes see
+the source code repository at: http://git.wincent.com.
+
+= Changes in 2.0
+
+* compatibility with the Rails 3 template handler API
+* use Rails 3 hooks to auto-initialize when listed in Gemfile
+* +code+ tags are now emitted instead of +tt+ tags for compliance
+  with the HTML5 specification
+
+= Changes in 1.12
+
+* the String#w and String#to_wikitext methods mark their returned
+  strings as html_safe under Rails 3
+
+= Changes in 1.11
+
+* extract Gem specification into separate file for compatibility
+  with Bundler's "install from Git repository" functionality
+* updates for compatibility with Rails 3
+
+= Changes in 1.10.1
+
+* fix builds on 64-bit Darwin platforms
+
+= Changes in 1.10
+
+* a +wikitext+ executable is now included for processing wikitext
+  markup from the commandline: input may come from filename
+  arguments specified on the commandline, piped in via standard
+  input, or typed in interactively via a tty
+
+= Changes in 1.9
+
+* NilClass#w method now accepts an optional parameters hash
+* new +link_proc+ option to Wikitext::Parser#parse allows you to
+  dynamically apply a custom CSS class based on the link target;
+  this can be used, for example, to provide "red links" for
+  articles which do not exist yet
+
+= Changes in 1.8
+
+* +pre+ tags may now take an optional +lang+ attribute to mark
+  up the translated text for syntax-highlighting
+* optimize use of ary_includes function, yielding a boost in
+  performance of several percent
+
+= Changes in 1.7
+
+* many optimizations for speed: performance has improved for
+  all input types and in some cases has more than doubled
+  (the biggest gains are for inputs with more multi-byte UTF-8
+  characters)
+* uses less memory and usage tends to remain more constant
+  due to less creation of temporary objects
+* smaller memory footprint due to removal of dead code
+* handle blank link text such as <tt>[[foo| ]]</tt>, making
+  behaviour consistent with existing handling of zero-width
+  link text (<tt>[[foo|]]</tt>)
+* don't apply +external+ CSS class when rolling back failed
+  internal links
+
+= Changes in 1.6
+
+* zero-length image targets (<tt>{{}}</tt>) are now passed through unchanged
+  rather than turned into +img+ tags
+* "absolute" image targets (all targets beginning with a leading
+  forward slash) such as <tt>{{/foo.png}}</tt> can be used to suppress the
+  image prefix that would otherwise be automatically prepended
+* the +indent+ option to the Wikitext::Parser#parse method now accepts
+  +false+ as a parameter to completely suppress all indentation
+* internal +require+ statments now use absolute paths to ensure that
+  files from other versions don't get pulled in inappropriately
+
+= Changes in 1.5.3
+
+* fixed broken handling of empty (zero-width) links such as
+  <tt>[[]]</tt>, <tt>[[|]]</tt> and <tt>[[|foo]]</tt>
+* improved handling of empty (whitespace-only) links such as
+  <tt>[[ ]]</tt> and <tt>[[   |foo]]</tt>
+* changed license from GPL v3 to the more permissive BSD license
+  (specifically the Simplified or "2-clause" version of the BSD
+  license, as used by FreeBSD)
+
+= Changes in 1.5.2
+
+* the +mailto+ class is now consistently applied to all mailto URIs
+* works around a bug in Rails 2.3.2
+* fixes a minor bug with +pre+ and +blockquote+ start tags when they
+  appear immediately after the shorthand notation of +pre+ and
+  +blockquote+ blocks
+
+= Changes in 1.5.1
+
+* the +w+ and +to_wikitext+ methods now accept an options hash
+
+= Changes in 1.5.0
+
+* added +base_heading_level+ parser option
+* changes for compatibility with Ruby 1.9 (compiles and all specs
+  pass)
+
+= Changes in 1.4.1
+
+* include necessary file that was missing from 1.4.0 gem
+
 = Changes in 1.4.0
 
 * "special links" inside internal link spans (double square
@@ -5,3 +116,7 @@
   spans: where previously you used <tt>[[issues/210 | ticket 210]]</tt>
   you should now use <tt>[/issues/210 ticket 210]</tt>
 * relatedly, the +treat_slash_as_special+ attribute has been removed
+
+= Changes prior to 1.4.0
+
+Please see the source code repository browser at http://git.wincent.com.