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