Support for contrib/markdown extension_configs in settings.py

[bdejong]

Markdown has support for "extension configs". For example: the "wikilink" extension normally turns [[link]] into <a href="/link/" class="wikilink">link</a>, but if you want to change the link class or the prefix of the URL you need to do this through configuration of the extension.

This patch allows you to add the configuration in the settings.py file as such:

MARKDOWN_EXTENSION_CONFIGS = {
    'wikilink': [
                ('base_url', '/help/'),
                ('end_url', ''),
                ('html_class', 'wikilink')
                ]
}

It's a very small patch but helps a lot when using markdown extensions. Almost all extensions have some form of configuration available.

[bdejong]

markdown extension_configs patch, svn revision 9791 version

[bdejong]

Ah, saw that the restrucured text markup template used a different name (and method of getting the config) for the config value. Changed the code to match that example:

MARKDOWN_FILTER_SETTINGS = {'wikilink': [('base_url', '/help/'), ('end_url', '/'), ('html_class', 'wikilink')]}

Now using:

extension_configs = getattr(settings, "MARKDOWN_FILTER_SETTINGS", {})
md = markdown.Markdown(extensions=extensions, extension_configs=extension_configs, safe_mode=safe_mode)

[bdejong]

documentation for additional (and django 1.0) markup parameters and settings

[bdejong]

The documentation diff also includes documentation for features which were already in django 1.0, but were not documented.

I.e. the usage of RESTRUCTUREDTEXT_FILTER_SETTINGS and markdown extensions.

[(none)]

Milestone post-1.0 deleted

[dc]

Maybe MarkupField (#10317) will solve this in more generic and elegant way?

[Jacob]

This is a feature add -- bump to 1.2.

[jkocherhans]

Feature. Bumping to 1.3.

[James Bennett]

The request for documentation for reST filter support has been split off to #13310; this ticket is now solely for the feature of supporting Markdown extensions.

[James Bennett]

1.3 is feature-frozen now.

[Julien Phalip]

Could someone write tests for this? Also, all changes would need to be combined in one single diff patch.

[Aymeric Augustin]

Change UI/UX from NULL to False.

[Aymeric Augustin]

Change Easy pickings from NULL to False.

[Claude Paroz]

contrib.markup has been deprecated (#18504) and will be removed in Django 1.6. Closing as obsolete.