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