Debian Codegraph @

docs/change_log/release-2.0.md

raw
1 title: Release Notes for v2.0
2
3 Python-Markdown 2.0 Release Notes
4 =================================
5
6 We are happy to release Python-Markdown 2.0, which has been over a year in the
7 making. We have rewritten significant portions of the code, dramatically
8 extending the extension API, increased performance, and added numerous
9 extensions to the distribution (including an extension that mimics PHP Markdown
10 Extra), all while maintaining backward compatibility with the end user API in
11 version 1.7.
12
13 Python-Markdown supports Python versions 2.3, 2.4, 2.5, and 2.6. We have even
14 released a version converted to Python 3.0!
15
16 Backwards-incompatible Changes
17 ------------------------------
18
19 While Python-Markdown has experienced numerous internal changes, those changes
20 should only affect extension authors. If you have not written your own
21 extensions, then you should not need to make any changes to your code.
22 However, you may want to ensure that any third party extensions you are using
23 are compatible with the new API.
24
25 The new extension API is fully [documented](../extensions/api.md) in the docs.
26 Below is a summary of the significant changes:
27
28 * The old home-grown NanoDOM has been replaced with ElementTree. Therefore all
29 extensions must use ElementTree rather than the old NanoDOM.
30 * The various processors and patterns are now stored with OrderedDicts rather
31 than lists. Any code adding processors and/or patterns into Python-Markdown
32 will need to be adjusted to use the new API using OrderedDicts.
33 * The various types of processors available have been either combined, added,
34 or removed. Ensure that your processors match the currently supported types.
35
36 What's New in Python-Markdown 2.0
37 ---------------------------------
38
39 Thanks to the work of Artem Yunusov as part of GSoC 2008, Python-Markdown uses
40 ElementTree internally to build the (X)HTML document from markdown source text.
41 This has resolved various issues with the older home-grown NanoDOM and made
42 notable increases in performance.
43
44 Artem also refactored the Inline Patterns to better support nested patterns
45 which has resolved many inconsistencies in Python-Markdown's parsing of the
46 markdown syntax.
47
48 The core parser had been completely rewritten, increasing performance and, for
49 the first time, making it possible to override/add/change the way block level
50 content is parsed.
51
52 Python-Markdown now parses markdown source text more closely to the other
53 popular implementations (Perl, PHP, etc.) than it ever has before. With the
54 exception of a few minor insignificant differences, any difference should be
55 considered a bug, rather than a limitation of the parser.
56
57 The option to return HTML4 output as apposed to XHTML has been added. In
58 addition, extensions should be able to easily add additional output formats.
59
60 As part of implementing markdown in the Dr. Project project (a Trac fork), among
61 other things, David Wolever refactored the "extension" keyword so that it
62 accepts either the extension names as strings or instances of extensions. This
63 makes it possible to include multiple extensions in a single module.
64
65 Numerous extensions are included in the distribution by default. See
66 [available_extensions](../extensions/index.md) for a complete list.
67
68 See the [Change Log](index.md) for a full list of changes.
69