Skip to content

Commit 2398565

Browse files
committed
Restore some md3 branch deletions which are not (yet) relevent.
1 parent dd56b87 commit 2398565

File tree

8 files changed

+251
-227
lines changed

8 files changed

+251
-227
lines changed

docs/change_log/release-2.1.md

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ title: Release Notes for v2.1
33
Python-Markdown 2.1 Release Notes
44
=================================
55

6-
We are pleased to release Python-Markdown 2.1 which makes many
7-
improvements on 2.0. In fact, we consider 2.1 to be what 2.0 should have been.
8-
While 2.1 consists mostly of bug fixes, bringing Python-Markdown more inline
9-
with other implementations, some internal improvements were made to the parser,
6+
We are pleased to release Python-Markdown 2.1 which makes many
7+
improvements on 2.0. In fact, we consider 2.1 to be what 2.0 should have been.
8+
While 2.1 consists mostly of bug fixes, bringing Python-Markdown more inline
9+
with other implementations, some internal improvements were made to the parser,
1010
a few new built-in extensions were added, and HTML5 support was added.
1111

12-
Python-Markdown supports Python versions 2.4, 2.5, 2.6, 2.7, 3.1, and 3.2 out
13-
of the box. In fact, the same code base installs on Python 3.1 and 3.2 with no
12+
Python-Markdown supports Python versions 2.4, 2.5, 2.6, 2.7, 3.1, and 3.2 out
13+
of the box. In fact, the same code base installs on Python 3.1 and 3.2 with no
1414
extra work by the end user.
1515

1616
Backwards-incompatible Changes
@@ -19,34 +19,34 @@ Backwards-incompatible Changes
1919
While Python-Markdown has received only minor internal changes since the last
2020
release, there are a few backward-incompatible changes to note:
2121

22-
* Support had been dropped for Python 2.3. No guarantees are made that the
23-
library will work in any version of Python lower than 2.4. Additionally, while
24-
the library had been tested with Python 2.4, consider Python 2.4 support to be
22+
* Support had been dropped for Python 2.3. No guarantees are made that the
23+
library will work in any version of Python lower than 2.4. Additionally, while
24+
the library had been tested with Python 2.4, consider Python 2.4 support to be
2525
depreciated. It is not likely that any future versions will continue to support
26-
any version of Python less than 2.5. Note that Python 3.0 is not supported due
27-
to a bug in its 2to3 tool. If you must use Python-Markdown with Python 3.0, it
26+
any version of Python less than 2.5. Note that Python 3.0 is not supported due
27+
to a bug in its 2to3 tool. If you must use Python-Markdown with Python 3.0, it
2828
is suggested you manually use Python 3.1's 2to3 tool to do a conversion.
2929

3030
* Python-Markdown previously accepted positional arguments on its class and
3131
wrapper methods. It now expects keyword arguments. Currently, the positional
32-
arguments should continue to work, but the solution feels hacky and may be
33-
removed in a future version. All users are encouraged to use keyword arguments
32+
arguments should continue to work, but the solution feels hacky and may be
33+
removed in a future version. All users are encouraged to use keyword arguments
3434
as documented in the [Library Reference](../reference.md).
3535

3636
* Past versions of Python-Markdown provided module level Global variables which
3737
controlled the behavior of a few different aspects of the parser. Those global
38-
variables have been replaced with attributes on the Markdown class.
39-
Additionally, those attributes are settable as keyword arguments when
40-
initializing a class instance. Therefore, if you were editing the global
41-
variables (either by editing the source or by overriding them in your code),
42-
you should now set them on the class. See the
38+
variables have been replaced with attributes on the Markdown class.
39+
Additionally, those attributes are settable as keyword arguments when
40+
initializing a class instance. Therefore, if you were editing the global
41+
variables (either by editing the source or by overriding them in your code),
42+
you should now set them on the class. See the
4343
[Library Reference](../reference.md) for the options available.
4444

45-
* If you have been using the HeaderId extension
46-
to define custom ids on headers, you will want to switch to using the new
47-
Attribute List extension. The HeaderId extension
48-
now only auto-generates ids on headers which have not already had ids defined.
49-
Note that the Extra extension has been switched to use
45+
* If you have been using the [HeaderId](../extensions.md) extension
46+
to define custom ids on headers, you will want to switch to using the new
47+
[Attribute List](../extensions/attr_list.md) extension. The HeaderId extension
48+
now only auto-generates ids on headers which have not already had ids defined.
49+
Note that the [Extra](../extensions/extra.md) extension has been switched to use
5050
Attribute Lists instead of HeaderId as it did previously.
5151

5252
* Some code was moved into the `markdown.util` namespace which was previously
@@ -63,56 +63,56 @@ may want to remove them yourself as they are unlikely to work properly.
6363
What's New in Python-Markdown 2.1
6464
---------------------------------
6565

66-
Three new extensions were added. Attribute Lists,
67-
which was inspired by Maruku's feature of the same name,
68-
Newline to Break, which was inspired by GitHub
69-
Flavored Markdown, and Smart Strong, which
66+
Three new extensions were added. [Attribute Lists](../extensions/attr_list.md),
67+
which was inspired by Maruku's feature of the same name,
68+
[Newline to Break](../extensions/nl2br.md), which was inspired by GitHub
69+
Flavored Markdown, and [Smart Strong](../extensions/smart_strong.md), which
7070
fills a hole in the Extra extension.
7171

72-
HTML5 is now supported. All this really means is that new block level elements
72+
HTML5 is now supported. All this really means is that new block level elements
7373
introduced in the HTML5 spec are now properly recognized as raw HTML. As
7474
valid HTML5 can consist of either HTML4 or XHTML1, there is no need to add a
75-
new HTML5 serializers. That said, `html5` and `xhtml5` have been added as
75+
new HTML5 serializers. That said, `html5` and `xhtml5` have been added as
7676
aliases of the `html4` and `xhtml1` serializers respectively.
7777

78-
An XHTML serializer has been added. Previously, ElementTree's XML serializer
78+
An XHTML serializer has been added. Previously, ElementTree's XML serializer
7979
was being used for XHTML output. With the new serializer we are able to avoid
80-
more invalid output like empty elements (i.e., `<p />`) which can choke
80+
more invalid output like empty elements (i.e., `<p />`) which can choke
8181
browsers.
8282

83-
Improved support for Python 3.x. Now when running `setupy.py install` in
84-
Python 3.1 or greater the 2to3 tool is run automatically. Note that Python 3.0
83+
Improved support for Python 3.x. Now when running `setupy.py install` in
84+
Python 3.1 or greater the 2to3 tool is run automatically. Note that Python 3.0
8585
is not supported due to a bug in its 2to3 tool. If you must use Python-Markdown
8686
with Python 3.0, it is suggested you manually use Python 3.1's 2to3 tool to
8787
do a conversion.
8888

8989
Methods on instances of the Markdown class that do not return results can now
9090
be changed allowing one to do `md.reset().convert(moretext)`.
9191

92-
The Markdown class was refactored so that a subclass could define it's own
92+
The Markdown class was refactored so that a subclass could define it's own
9393
`build_parser` method which would build a completely different parser. In
94-
other words, one could use the basic machinery in the markdown library to
94+
other words, one could use the basic machinery in the markdown library to
9595
build a parser of a different markup language without the overhead of building
9696
the markdown parser and throwing it away.
9797

98-
Import statements within markdown have been improved so that third party
98+
Import statements within markdown have been improved so that third party
9999
libraries can embed the markdown library if they desire (licensing permitting).
100100

101-
Added support for Python's `-m` command line option. You can run the markdown
102-
package as a command line script. Do `python -m markdown [options] [args]`.
103-
Note that this is only fully supported in Python 2.7+. Python 2.5 & 2.6
101+
Added support for Python's `-m` command line option. You can run the markdown
102+
package as a command line script. Do `python -m markdown [options] [args]`.
103+
Note that this is only fully supported in Python 2.7+. Python 2.5 & 2.6
104104
require you to call the module directly (`markdown.__main__`) rather than
105105
the package (`markdown`). This does not work in Python 2.4.
106106

107-
The command line script has been renamed to `markdown_py` which avoids all the
108-
various problems we had with previous names. Also improved the command line
107+
The command line script has been renamed to `markdown_py` which avoids all the
108+
various problems we had with previous names. Also improved the command line
109109
script to accept input on `stdin`.
110110

111-
The testing framework has been completely rebuilt using the Nose testing
111+
The testing framework has been completely rebuilt using the Nose testing
112112
framework. This provides a number of benefits including the ability to better
113-
test the built-in extensions and other options available to change the parsing
113+
test the built-in extensions and other options available to change the parsing
114114
behavior. See the [Test Suite](../test_suite.md) documentation for details.
115115

116-
Various bug fixes have been made, which are too numerous to list here. See the
117-
[commit log](https://github.com/Python-Markdown/markdown/commits/master) for a
116+
Various bug fixes have been made, which are too numerous to list here. See the
117+
[commit log](https://github.com/Python-Markdown/markdown/commits/master) for a
118118
complete history of the changes.

docs/change_log/release-2.2.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,48 +3,48 @@ title: Release Notes for v2.2
33
Python-Markdown 2.2 Release Notes
44
=================================
55

6-
We are pleased to release Python-Markdown 2.2 which makes improvements on 2.1.
7-
While 2.2 is primarily a bug fix release, some internal improvements were made
6+
We are pleased to release Python-Markdown 2.2 which makes improvements on 2.1.
7+
While 2.2 is primarily a bug fix release, some internal improvements were made
88
to the parser, and a few security issues were resolved.
99

10-
Python-Markdown supports Python versions 2.5, 2.6, 2.7, 3.1, and 3.2 out
11-
of the box.
10+
Python-Markdown supports Python versions 2.5, 2.6, 2.7, 3.1, and 3.2 out
11+
of the box.
1212

1313
Backwards-incompatible Changes
1414
------------------------------
1515

1616
While Python-Markdown has received only minor internal changes since the last
1717
release, there are a few backward-incompatible changes to note:
1818

19-
* Support had been dropped for Python 2.4. No guarantees are made that the
20-
library will work in any version of Python lower than 2.5. Additionally, while
21-
the library had been tested with Python 2.5, consider Python 2.5 support to be
19+
* Support had been dropped for Python 2.4. No guarantees are made that the
20+
library will work in any version of Python lower than 2.5. Additionally, while
21+
the library had been tested with Python 2.5, consider Python 2.5 support to be
2222
depreciated. It is not likely that any future versions will continue to support
2323
any version of Python less than 2.6.
2424

25-
* For many years Python-Markdown has identified `<ins>` and `<del>` tags in
25+
* For many years Python-Markdown has identified `<ins>` and `<del>` tags in
2626
raw HTML input as block level tags. As they are actually inline level tags,
2727
this behavior has been changed. This may result in slightly different output.
2828
While in most cases, the new output is more correct, there may be a few edge
2929
cases where a document author has relied on the previous incorrect behavior.
3030
It is likely that a few adjustments may need to be made to those documents.
3131

3232
* The behavior of the `enable_attributes` keyword has been slightly altered.
33-
If authors have been using attributes in documents with `safe_mode` on, those
33+
If authors have been using attributes in documents with `safe_mode` on, those
3434
attributes will no longer be parsed unless `enable_attributes` is explicitly
3535
set to `True`. This change was made to prevent untrusted authors from injecting
36-
potentially harmful JavaScript in documents. This change had no effect when
36+
potentially harmful JavaScript in documents. This change had no effect when
3737
not in `safe_mode`.
3838

3939
What's New in Python-Markdown 2.2
4040
---------------------------------
4141

42-
The docs were refactored and can now be found at
42+
The docs were refactored and can now be found at
4343
<http://packages.python.org/Markdown/>. The docs are now maintained in the
4444
Repository and are generated by the `setup.py build_docs` command.
4545

46-
The Sane_Lists
47-
extension was added. The Sane Lists Extension alters the behavior of the
46+
The [Sane_Lists](../extensions/sane_lists.md)
47+
extension was added. The Sane Lists Extension alters the behavior of the
4848
Markdown List syntax to be less surprising by not allowing the mixing of list
4949
types. In other words, an ordered list will not continue when an unordered list
5050
item is encountered and vice versa.
@@ -56,9 +56,9 @@ As long as the provided module contains a compatible extension, the extension
5656
will be loaded.
5757

5858
The BlockParser API was slightly altered to allow `blockprocessor.run` to return
59-
`True` or `False` which provides more control to the block processor loop from
59+
`True` or `False` which provides more control to the block processor loop from
6060
within any Blockprocessor instance.
6161

62-
Various bug fixes have been made. See the
63-
[commit log](https://github.com/Python-Markdown/markdown/commits/master)
62+
Various bug fixes have been made. See the
63+
[commit log](https://github.com/Python-Markdown/markdown/commits/master)
6464
for a complete history of the changes.

docs/change_log/release-2.3.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Python-Markdown 2.3 Release Notes
44
=================================
55

66
We are pleased to release Python-Markdown 2.3 which adds one new extension,
7-
removes a few old (obsolete) extensions, and now runs on both Python 2 and
8-
Python 3 without running the 2to3 conversion tool. See the list of changes
7+
removes a few old (obsolete) extensions, and now runs on both Python 2 and
8+
Python 3 without running the 2to3 conversion tool. See the list of changes
99
below for details.
1010

1111
Python-Markdown supports Python versions 2.6, 2.7, 3.1, 3.2, and 3.3.
@@ -15,17 +15,17 @@ Backwards-incompatible Changes
1515

1616
* Support has been dropped for Python 2.5. No guarantees are made that the
1717
library will work in any version of Python lower than 2.6. As all supported
18-
Python versions include the ElementTree library, Python-Markdown will no
18+
Python versions include the ElementTree library, Python-Markdown will no
1919
longer try to import a third-party installation of ElementTree.
2020

2121
* All classes are now "new-style" classes. In other words, all classes
22-
subclass from 'object'. While this is not likely to affect most users,
22+
subclass from 'object'. While this is not likely to affect most users,
2323
extension authors may need to make a few minor adjustments to their code.
2424

2525
* "safe_mode" has been further restricted. Markdown formatted links must be
2626
of a known white-listed scheme when in "safe_mode" or the URL is discarded.
2727
The white-listed schemes are: 'HTTP', 'HTTPS', 'FTP', 'FTPS', 'MAILTO', and
28-
'news'. Schemeless URLs are also permitted, but are checked in other ways -
28+
'news'. Schemeless URLs are also permitted, but are checked in other ways -
2929
as they have been for some time.
3030

3131
* The ids assigned to footnotes now contain a dash (`-`) rather than a colon
@@ -36,24 +36,25 @@ you are outputting XHTML (the default) or HTML4.
3636

3737
* The `force_linenos` configuration setting of the CodeHilite extension has been
3838
marked as **Pending Deprecation** and a new setting `linenums` has been added to
39-
replace it. See documentation for the CodeHilite Extension for an explanation
40-
of the new `linenums` setting. The new setting will honor the old
41-
`force_linenos` if it is set, but it will raise a `PendingDeprecationWarning`
39+
replace it. See documentation for the [CodeHilite Extension] for an explanation
40+
of the new `linenums` setting. The new setting will honor the old
41+
`force_linenos` if it is set, but it will raise a `PendingDeprecationWarning`
4242
and will likely be removed in a future version of Python-Markdown.
4343

44+
[CodeHilite Extension]: ../extensions/codehilite.md
4445

4546
* The "RSS" extension has been removed and no longer ships with Python-Markdown.
46-
If you would like to continue using the extension (not recommended), it is
47+
If you would like to continue using the extension (not recommended), it is
4748
archived on [GitHub](https://gist.github.com/waylan/4773365).
4849

4950
* The "HTML Tidy" Extension has been removed and no longer ships with Python-Markdown.
50-
If you would like to continue using the extension (not recommended), it is
51-
archived on [GitHub](https://gist.github.com/waylan/5152650). Note that the
52-
underlying library, uTidylib, is not Python 3 compatible. Instead, it is
53-
recommended that the newer [PyTidyLib] (version 0.2.2+ for Python 3
54-
comparability - install from GitHub not PyPI) be used. As the API for that
55-
library is rather simple, it is recommended that the output of Markdown be
56-
wrapped in a call to PyTidyLib rather than using an extension (for example:
51+
If you would like to continue using the extension (not recommended), it is
52+
archived on [GitHub](https://gist.github.com/waylan/5152650). Note that the
53+
underlying library, uTidylib, is not Python 3 compatible. Instead, it is
54+
recommended that the newer [PyTidyLib] (version 0.2.2+ for Python 3
55+
comparability - install from GitHub not PyPI) be used. As the API for that
56+
library is rather simple, it is recommended that the output of Markdown be
57+
wrapped in a call to PyTidyLib rather than using an extension (for example:
5758
`tidylib.tidy_fragment(markdown.markdown(source), options={...})`).
5859

5960
[PyTidyLib]: http://countergram.com/open-source/pytidylib
@@ -65,16 +66,17 @@ What's New in Python-Markdown 2.3
6566
any need for running the 2to3 conversion tool. This not only simplifies testing,
6667
but by using Unicode_literals, results in more consistent behavior across
6768
Python versions. Additionally, the relative imports (made possible in Python 2
68-
via absolute_import) allows the entire library to more easily be embedded in a
69-
sub-directory of another project. The various files within the library will
69+
via absolute_import) allows the entire library to more easily be embedded in a
70+
sub-directory of another project. The various files within the library will
7071
still import each other properly even though 'markdown' may not be in Python's
7172
root namespace.
7273

73-
* The Admonition Extension has been added, which implements [rST-style][rST]
74-
admonitions in the Markdown syntax. However, be warned that this extension
75-
is experimental and the syntax and behavior is still subject to change. Please
74+
* The [Admonition Extension] has been added, which implements [rST-style][rST]
75+
admonitions in the Markdown syntax. However, be warned that this extension
76+
is experimental and the syntax and behavior is still subject to change. Please
7677
try it out and report bugs and/or improvements.
7778

79+
[Admonition Extension]: ../extensions/admonition.md
7880
[rST]: http://docutils.sourceforge.net/docs/ref/rst/directives.html#specific-admonitions
7981

8082
* Various bug fixes have been made. See the

0 commit comments

Comments
 (0)