Add remove/escape/replace functions to markdown filter

[Eric Abrahamsen]

Markdown.py supports a variety of safe_modes, allowing users to replace HTML, escape it, or remove it cleanly. Django's markdown template filter currently doesn't support anything but replacement with a string. This patch to the markdown() function in django.contrib.markup.templatetags provides that ability, allowing users to pass "safe","remove","escape" or "replace" as the first argument in the extension list. Backwards compatibility is maintained.

Improvements to the patch are welcome...

[Eric Abrahamsen]

new version of the markup filter

[Thomas Güttler]

I think this is a good snippet. But it is not important to have it in the django source. (my opinion)

[James Bennett]

Django's Markdown filter already allows you to use any Markdown extensions you have installed, including safe mode.

[Timothée Peignier <tim@…>]

In fact, we can use extensions but not passing options to safe_mode extension which are : 'remove', 'escape', 'replace' (see ​http://www.freewisdom.org/projects/python-markdown/Using_as_a_Module).

At least, it could be great to be able to change markdown.HTML_REMOVED_TEXT cleanup within Django settings.

[Timothée Peignier <tim@…>]

Adding settings to customize markdown remove text

[Timothée Peignier <tim@…>]

Markdown filter accepting options for safe_mode

[girzel@…]

Fixed a typo: line 65 should be a comparison (==) not assignment (=)...

[Dana Woodman <dana@…>]

This ticket has been sitting around for 2 years. Any chance we can see it implemented?

It is a simple, straightforward fix that works and does not cause any backward-incompatible changes. It enables the use of Markdown's VERY useful HTML replacing, which many (including me) need in our projects.

Is there a reason it hasn't been implemented? If not, when could we expect it integrated?

Who can I bribe with a beer to get this thing put into core?

[Łukasz Rekucki]

1. The patch needs unittests to show that it works correctly.
2. It needs documentation. Current docs for markup are not very user friendly, but at least the doc string gives you some clue how to use it. Updating the docstring is a minimum. Write proper docs for those template tags for bonus points :)
3. It needs some more work. My biggest annoyance is markdown.HTML_REMOVED_TEXT - I could live with it's content if it was translatable, but changing it to something more human-friendly is desirable. Also, while there probably are no extensions called "remove", "escape" and "replace" the names are a bit confusing. I propose using something like {{ text|markdown:"safe=replace,more_extensions" }} instead.

[Jacob]

Milestone 1.4 deleted

[anonymous]

+1!

[thomaspurchas]

Also includes tests

[thomaspurchas]

Replying to lrekucki:

1. The patch needs unittests to show that it works correctly.
2. It needs documentation. Current docs for markup are not very user friendly, but at least the doc string gives you some clue how to use it. Updating the docstring is a minimum. Write proper docs for those template tags for bonus points :)
3. It needs some more work. My biggest annoyance is markdown.HTML_REMOVED_TEXT - I could live with it's content if it was translatable, but changing it to something more human-friendly is desirable. Also, while there probably are no extensions called "remove", "escape" and "replace" the names are a bit confusing. I propose using something like {{ text|markdown:"safe=replace,more_extensions" }} instead.

lrekucki I have implemented the safe mode setting using {{ text|markdown:"safe=replace,more_extensions" }} as you suggested, the attached patch also includes some new tests as well.

Also if you can still remember could you clarify what you mean by:

My biggest annoyance is markdown.HTML_REMOVED_TEXT - I could live with it's content if it was translatable, but changing it to something more human-friendly is desirable.

[Claude Paroz]

contrib.markup has been deprecated (#18504) and will be removed in Django 1.6. We won't add any new feature to it, and we encourage users to create external apps or contribute to an existing one. Closing as obsolete.