]> git.wincent.com - wikitext.git/blob - doc/RELEASE-NOTES
Implement "link_proc" option ("red link" support)
[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 1.9
10
11 * NilClass#w method now accepts and optional parameters hash
12 * new +link_proc+ option to Wikitext::Parser#parse allows you to
13   dynamically apply a custom CSS class based on the link target;
14   this can be used, for example, to provide "red links" for
15   articles which do not exist yet
16
17 = Changes in 1.8
18
19 * +pre+ tags may now take an optional +lang+ attribute to mark
20   up the translated text for syntax-highlighting
21 * optimize use of ary_includes function, yielding a boost in
22   performance of several percent
23
24 = Changes in 1.7
25
26 * many optimizations for speed: performance has improved for
27   all input types and in some cases has more than doubled
28   (the biggest gains are for inputs with more multi-byte UTF-8
29   characters)
30 * uses less memory and usage tends to remain more constant
31   due to less creation of temporary objects
32 * smaller memory footprint due to removal of dead code
33 * handle blank link text such as <tt>[[foo| ]]</tt>, making
34   behaviour consistent with existing handling of zero-width
35   link text (<tt>[[foo|]]</tt>)
36 * don't apply +external+ CSS class when rolling back failed
37   internal links
38
39 = Changes in 1.6
40
41 * zero-length image targets (<tt>{{}}</tt>) are now passed through unchanged
42   rather than turned into +img+ tags
43 * "absolute" image targets (all targets beginning with a leading
44   forward slash) such as <tt>{{/foo.png}}</tt> can be used to suppress the
45   image prefix that would otherwise be automatically prepended
46 * the +indent+ option to the Wikitext::Parser#parse method now accepts
47   +false+ as a parameter to completely suppress all indentation
48 * internal +require+ statments now use absolute paths to ensure that
49   files from other versions don't get pulled in inappropriately
50
51 = Changes in 1.5.3
52
53 * fixed broken handling of empty (zero-width) links such as
54   <tt>[[]]</tt>, <tt>[[|]]</tt> and <tt>[[|foo]]</tt>
55 * improved handling of empty (whitespace-only) links such as
56   <tt>[[ ]]</tt> and <tt>[[   |foo]]</tt>
57 * changed license from GPL v3 to the more permissive BSD license
58   (specifically the Simplified or "2-clause" version of the BSD
59   license, as used by FreeBSD)
60
61 = Changes in 1.5.2
62
63 * the +mailto+ class is now consistently applied to all mailto URIs
64 * works around a bug in Rails 2.3.2
65 * fixes a minor bug with +pre+ and +blockquote+ start tags when they
66   appear immediately after the shorthand notation of +pre+ and
67   +blockquote+ blocks
68
69 = Changes in 1.5.1
70
71 * the +w+ and +to_wikitext+ methods now accept an options hash
72
73 = Changes in 1.5.0
74
75 * added +base_heading_level+ parser option
76 * changes for compatibility with Ruby 1.9 (compiles and all specs
77   pass)
78
79 = Changes in 1.4.1
80
81 * include necessary file that was missing from 1.4.0 gem
82
83 = Changes in 1.4.0
84
85 * "special links" inside internal link spans (double square
86   brackets) are no longer supported; instead use external link
87   spans: where previously you used <tt>[[issues/210 | ticket 210]]</tt>
88   you should now use <tt>[/issues/210 ticket 210]</tt>
89 * relatedly, the +treat_slash_as_special+ attribute has been removed
90
91 = Changes prior to 1.4.0
92
93 Please see the source code repository browser at http://git.wincent.com.