]> git.wincent.com - wikitext.git/blob - doc/RELEASE-NOTES
Auto-initialize under Rails 3
[wikitext.git] / doc / RELEASE-NOTES
1 This file describes changes with some user or developer impact
2 (significant changes to the externally visible behaviour of the
3 extension, or things which may require action on the part of
4 users or developers). Minor bugfixes and tweaks which don't
5 require any user or developer action are generally not included
6 in these release notes. For a full listing of all changes see
7 the source code repository at: http://git.wincent.com.
8
9 = Changes in 2.0
10
11 * compatibility with the Rails 3 template handler API
12 * use Rails 3 hooks to auto-initialize when listed in Gemfile
13 * +code+ tags are now emitted instead of +tt+ tags for compliance
14   with the HTML5 specification
15
16 = Changes in 1.12
17
18 * the String#w and String#to_wikitext methods mark their returned
19   strings as html_safe under Rails 3
20
21 = Changes in 1.11
22
23 * extract Gem specification into separate file for compatibility
24   with Bundler's "install from Git repository" functionality
25 * updates for compatibility with Rails 3
26
27 = Changes in 1.10.1
28
29 * fix builds on 64-bit Darwin platforms
30
31 = Changes in 1.10
32
33 * a +wikitext+ executable is now included for processing wikitext
34   markup from the commandline: input may come from filename
35   arguments specified on the commandline, piped in via standard
36   input, or typed in interactively via a tty
37
38 = Changes in 1.9
39
40 * NilClass#w method now accepts an optional parameters hash
41 * new +link_proc+ option to Wikitext::Parser#parse allows you to
42   dynamically apply a custom CSS class based on the link target;
43   this can be used, for example, to provide "red links" for
44   articles which do not exist yet
45
46 = Changes in 1.8
47
48 * +pre+ tags may now take an optional +lang+ attribute to mark
49   up the translated text for syntax-highlighting
50 * optimize use of ary_includes function, yielding a boost in
51   performance of several percent
52
53 = Changes in 1.7
54
55 * many optimizations for speed: performance has improved for
56   all input types and in some cases has more than doubled
57   (the biggest gains are for inputs with more multi-byte UTF-8
58   characters)
59 * uses less memory and usage tends to remain more constant
60   due to less creation of temporary objects
61 * smaller memory footprint due to removal of dead code
62 * handle blank link text such as <tt>[[foo| ]]</tt>, making
63   behaviour consistent with existing handling of zero-width
64   link text (<tt>[[foo|]]</tt>)
65 * don't apply +external+ CSS class when rolling back failed
66   internal links
67
68 = Changes in 1.6
69
70 * zero-length image targets (<tt>{{}}</tt>) are now passed through unchanged
71   rather than turned into +img+ tags
72 * "absolute" image targets (all targets beginning with a leading
73   forward slash) such as <tt>{{/foo.png}}</tt> can be used to suppress the
74   image prefix that would otherwise be automatically prepended
75 * the +indent+ option to the Wikitext::Parser#parse method now accepts
76   +false+ as a parameter to completely suppress all indentation
77 * internal +require+ statments now use absolute paths to ensure that
78   files from other versions don't get pulled in inappropriately
79
80 = Changes in 1.5.3
81
82 * fixed broken handling of empty (zero-width) links such as
83   <tt>[[]]</tt>, <tt>[[|]]</tt> and <tt>[[|foo]]</tt>
84 * improved handling of empty (whitespace-only) links such as
85   <tt>[[ ]]</tt> and <tt>[[   |foo]]</tt>
86 * changed license from GPL v3 to the more permissive BSD license
87   (specifically the Simplified or "2-clause" version of the BSD
88   license, as used by FreeBSD)
89
90 = Changes in 1.5.2
91
92 * the +mailto+ class is now consistently applied to all mailto URIs
93 * works around a bug in Rails 2.3.2
94 * fixes a minor bug with +pre+ and +blockquote+ start tags when they
95   appear immediately after the shorthand notation of +pre+ and
96   +blockquote+ blocks
97
98 = Changes in 1.5.1
99
100 * the +w+ and +to_wikitext+ methods now accept an options hash
101
102 = Changes in 1.5.0
103
104 * added +base_heading_level+ parser option
105 * changes for compatibility with Ruby 1.9 (compiles and all specs
106   pass)
107
108 = Changes in 1.4.1
109
110 * include necessary file that was missing from 1.4.0 gem
111
112 = Changes in 1.4.0
113
114 * "special links" inside internal link spans (double square
115   brackets) are no longer supported; instead use external link
116   spans: where previously you used <tt>[[issues/210 | ticket 210]]</tt>
117   you should now use <tt>[/issues/210 ticket 210]</tt>
118 * relatedly, the +treat_slash_as_special+ attribute has been removed
119
120 = Changes prior to 1.4.0
121
122 Please see the source code repository browser at http://git.wincent.com.