/docs/ref/contrib/markup.txt

https://code.google.com/p/mango-py/ · Plain Text · 49 lines · 38 code · 11 blank · 0 comment · 0 complexity · 1ea8d1e3b03c76ccd3a599a562a0c322 MD5 · raw file 

    

  1. =====================
    2. 

  2. django.contrib.markup
    3. 

  3. =====================
    4. 

  4. 

  5. .. module:: django.contrib.markup
    6. 

  6.    :synopsis: A collection of template filters that implement common markup languages.
    7. 

  7. 

  8. Django provides template filters that implement the following markup
    9. 

  9. languages:
    10. 

  10. 

  11.     * ``textile`` -- implements `Textile`_ -- requires `PyTextile`_
    12. 

  12.     * ``markdown`` -- implements `Markdown`_ -- requires `Python-markdown`_
    13. 

  13.     * ``restructuredtext`` -- implements `reST (reStructured Text)`_
    14. 

  14.       -- requires `doc-utils`_
    15. 

  15. 

  16. In each case, the filter expects formatted markup as a string and
    17. 

  17. returns a string representing the marked-up text. For example, the
    18. 

  18. ``textile`` filter converts text that is marked-up in Textile format
    19. 

  19. to HTML.
    20. 

  20. 

  21. To activate these filters, add ``'django.contrib.markup'`` to your
    22. 

  22. :setting:`INSTALLED_APPS` setting. Once you've done that, use
    23. 

  23. ``{% load markup %}`` in a template, and you'll have access to these filters.
    24. 

  24. For more documentation, read the source code in
    25. 

  25. :file:`django/contrib/markup/templatetags/markup.py`.
    26. 

  26. 

  27. .. warning::
    28. 

  28. 

  29.     The output of markup filters is marked "safe" and will not be escaped when
    30. 

  30.     rendered in a template. Always be careful to sanitize your inputs and make
    31. 

  31.     sure you are not leaving yourself vulnerable to cross-site scripting or
    32. 

  32.     other types of attacks.
    33. 

  33. 

  34. .. _Textile: http://en.wikipedia.org/wiki/Textile_%28markup_language%29
    35. 

  35. .. _Markdown: http://en.wikipedia.org/wiki/Markdown
    36. 

  36. .. _reST (reStructured Text): http://en.wikipedia.org/wiki/ReStructuredText
    37. 

  37. .. _PyTextile: http://loopcore.com/python-textile/
    38. 

  38. .. _Python-markdown: http://www.freewisdom.org/projects/python-markdown
    39. 

  39. .. _doc-utils: http://docutils.sf.net/
    40. 

  40. 

  41. reStructured Text
    42. 

  42. -----------------
    43. 

  43. 

  44. When using the ``restructuredtext`` markup filter you can define a
    45. 

  45. :setting:`RESTRUCTUREDTEXT_FILTER_SETTINGS` in your django settings to
    46. 

  46. override the default writer settings. See the `restructuredtext writer
    47. 

  47. settings`_ for details on what these settings are.
    48. 

  48. 

  49. .. _restructuredtext writer settings: http://docutils.sourceforge.net/docs/user/config.html#html4css1-writer
    50.