]> git.wincent.com - wikitext.git/blob - doc/RELEASE-NOTES
Prepare 4.2 release
[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 4.2
10
11 * add +pre_code+ parse option
12
13 = Changes in 4.1.2
14
15 * rebuild (no code changes) to replace broken executable in 4.1.1 release
16
17 = Changes in 4.1.1 (yanked)
18
19 * add official support for Ruby 2.2.x
20
21 = Changes in 4.1
22
23 * add a Haml filter; to use, require "wikitext/haml_filter"
24
25 = Changes in 4.0.3
26
27 * permit building on Ruby 2.1.0
28
29 = Changes in 4.0.2
30
31 * fix broken gemspec responsible for faulty builds in version 4.0.2
32
33 = Changes in 4.0.1
34
35 * fix build issues on Linux machines (with GNU install)
36 * the +wikitext+ binary no longer has a hard dependency on the HighLine gem
37
38 = Changes in 4.0
39
40 * requires Ruby 2.0.0; for older versions of Ruby please use a previous
41   Wikitext release
42
43 = Changes in 3.1
44
45 * the +link_proc+ parse option can now be set as an attribute on the parser
46   at initialization or via an accessor
47 * fix underescaping of ampersands in URIs
48
49 = Changes in 3.0.1
50
51 * fix bad output when emitting external links containing email addresses
52
53 = Changes in 3.0
54
55 * fix newline-swallowing bug which affected "PRE" blocks with lines beginning
56   with a "PATH" token
57
58 = Changes in 3.0b
59
60 * silence deprecation warnings triggered under Rails 3.1
61 * note that this release supports only Rails 3.1; for older
62   versions of Rails you should continue to use the Wikitext
63   2.1.x series, which continues to be supported
64
65 = Changes in 2.1.1
66
67 * fix a couple of token-swallowing bugs that manifested when certain
68   invalid markup was fed into the translator
69
70 = Changes in 2.1
71
72 * the +external_link_rel+ attribute can be used to include a
73   "nofollow" +rel+ attribute in external links (patch from Mike
74   Stangel)
75
76 = Changes in 2.0
77
78 * compatibility with the Rails 3 template handler API
79 * use Rails 3 hooks to auto-initialize when listed in Gemfile
80 * +code+ tags are now emitted instead of +tt+ tags for compliance
81   with the HTML5 specification
82 * new +output_style+ setting to switch between HTML syntax (the new
83   default) and XML syntax
84
85 = Changes in 1.12
86
87 * the String#w and String#to_wikitext methods mark their returned
88   strings as html_safe under Rails 3
89
90 = Changes in 1.11
91
92 * extract Gem specification into separate file for compatibility
93   with Bundler's "install from Git repository" functionality
94 * updates for compatibility with Rails 3
95
96 = Changes in 1.10.1
97
98 * fix builds on 64-bit Darwin platforms
99
100 = Changes in 1.10
101
102 * a +wikitext+ executable is now included for processing wikitext
103   markup from the commandline: input may come from filename
104   arguments specified on the commandline, piped in via standard
105   input, or typed in interactively via a tty
106
107 = Changes in 1.9
108
109 * NilClass#w method now accepts an optional parameters hash
110 * new +link_proc+ option to Wikitext::Parser#parse allows you to
111   dynamically apply a custom CSS class based on the link target;
112   this can be used, for example, to provide "red links" for
113   articles which do not exist yet
114
115 = Changes in 1.8
116
117 * +pre+ tags may now take an optional +lang+ attribute to mark
118   up the translated text for syntax-highlighting
119 * optimize use of ary_includes function, yielding a boost in
120   performance of several percent
121
122 = Changes in 1.7
123
124 * many optimizations for speed: performance has improved for
125   all input types and in some cases has more than doubled
126   (the biggest gains are for inputs with more multi-byte UTF-8
127   characters)
128 * uses less memory and usage tends to remain more constant
129   due to less creation of temporary objects
130 * smaller memory footprint due to removal of dead code
131 * handle blank link text such as <tt>[[foo| ]]</tt>, making
132   behaviour consistent with existing handling of zero-width
133   link text (<tt>[[foo|]]</tt>)
134 * don't apply +external+ CSS class when rolling back failed
135   internal links
136
137 = Changes in 1.6
138
139 * zero-length image targets (<tt>{{}}</tt>) are now passed through unchanged
140   rather than turned into +img+ tags
141 * "absolute" image targets (all targets beginning with a leading
142   forward slash) such as <tt>{{/foo.png}}</tt> can be used to suppress the
143   image prefix that would otherwise be automatically prepended
144 * the +indent+ option to the Wikitext::Parser#parse method now accepts
145   +false+ as a parameter to completely suppress all indentation
146 * internal +require+ statments now use absolute paths to ensure that
147   files from other versions don't get pulled in inappropriately
148
149 = Changes in 1.5.3
150
151 * fixed broken handling of empty (zero-width) links such as
152   <tt>[[]]</tt>, <tt>[[|]]</tt> and <tt>[[|foo]]</tt>
153 * improved handling of empty (whitespace-only) links such as
154   <tt>[[ ]]</tt> and <tt>[[   |foo]]</tt>
155 * changed license from GPL v3 to the more permissive BSD license
156   (specifically the Simplified or "2-clause" version of the BSD
157   license, as used by FreeBSD)
158
159 = Changes in 1.5.2
160
161 * the +mailto+ class is now consistently applied to all mailto URIs
162 * works around a bug in Rails 2.3.2
163 * fixes a minor bug with +pre+ and +blockquote+ start tags when they
164   appear immediately after the shorthand notation of +pre+ and
165   +blockquote+ blocks
166
167 = Changes in 1.5.1
168
169 * the +w+ and +to_wikitext+ methods now accept an options hash
170
171 = Changes in 1.5.0
172
173 * added +base_heading_level+ parser option
174 * changes for compatibility with Ruby 1.9 (compiles and all specs
175   pass)
176
177 = Changes in 1.4.1
178
179 * include necessary file that was missing from 1.4.0 gem
180
181 = Changes in 1.4.0
182
183 * "special links" inside internal link spans (double square
184   brackets) are no longer supported; instead use external link
185   spans: where previously you used <tt>[[issues/210 | ticket 210]]</tt>
186   you should now use <tt>[/issues/210 ticket 210]</tt>
187 * relatedly, the +treat_slash_as_special+ attribute has been removed
188
189 = Changes prior to 1.4.0
190
191 Please see the source code repository browser at http://git.wincent.com.