Author: adrian Date: 2007-03-27 17:18:52 -0500 (Tue, 27 Mar 2007) New Revision: 4833
Modified: django/trunk/docs/add_ons.txt Log: Fixed #3781 -- Improved docs/add_ons.txt to clarify use of contrib apps. Thanks, Simon G. Modified: django/trunk/docs/add_ons.txt =================================================================== --- django/trunk/docs/add_ons.txt 2007-03-27 19:02:32 UTC (rev 4832) +++ django/trunk/docs/add_ons.txt 2007-03-27 22:18:52 UTC (rev 4833) @@ -9,6 +9,13 @@ This code lives in ``django/contrib`` in the Django distribution. Here's a rundown of the packages in ``contrib``: +.. admonition:: Note + + For most of these add-ons -- specifically, the add-ons that include either + models or template tags -- you'll need to add the package name (e.g., + ``'django.contrib.admin'``) to your ``INSTALLED_APPS`` setting and re-run + ``manage.py syncdb``. + .. _"batteries included" philosophy: http://docs.python.org/tut/node12.html#batteries-included admin @@ -147,14 +154,21 @@ markup ====== -A collection of template filters that implement these common markup languages: +A collection of template filters that implement common markup languages: - * `Textile`_ - * `Markdown`_ - * `ReST (ReStructured Text)`_ + * ``textile`` -- implements `Textile`_ + * ``markdown`` -- implements `Markdown`_ + * ``restructuredtext`` -- implements `ReST (ReStructured Text)`_ -For documentation, read the source code in django/contrib/markup/templatetags/markup.py. +In each case, the filter expects formatted markup as a string and returns a +string representing the marked-up text. For example, the ``textile`` filter +converts text that is marked-up in Textile format to HTML. +To activate these filters, add ``'django.contrib.markup'`` to your +``INSTALLED_APPS`` setting. Once you've done that, use ``{% load markup %}`` in +a template, and you'll have access to these filters. For more documentation, +read the source code in django/contrib/markup/templatetags/markup.py. + .. _Textile: http://en.wikipedia.org/wiki/Textile_%28markup_language%29 .. _Markdown: http://en.wikipedia.org/wiki/Markdown .. _ReST (ReStructured Text): http://en.wikipedia.org/wiki/ReStructuredText --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Django updates" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/django-updates?hl=en -~----------~----~----~----~------~----~------~--~---
