Files changed (8)
+This will create a hierarchy of static files (stored by default in ``<project_root>/locale/dbgettext``, configurable using the ``DBGETTEXT_PATH`` and ``DBGETTEXT_ROOT`` settings) containing the translatable strings. E.g.::
+as per usual, and these strings will be catalogued for you together with the rest of the translatable strings from your code and templates.
+**Note:** the ``<DBGETTEXT_PATH>/<DBGETTEXT_ROOT>`` directory is purged each time ``dbgettext_export`` is run to ensure that old data (e.g. from deleted objects) does not persist in the catalogue.
+Here lies some basic documentation to get you started with django-dbgettext. The application itself is not overly large or complex, and I recommend perusing the source code for a full understanding.
+The premise of django-dbgettext is simple: `gettext <http://www.gnu.org/software/gettext>`_ is already used for translating content from Django's source code and templates, so why not use it for translating database content also? Then the whole process is unified and simplified for translators, and there is no need to provide custom administration interfaces for dynamic content. Simply use the ``dbgettext_export`` `management command <http://docs.djangoproject.com/en/dev/howto/custom-management-commands/>`_ to export the content from the database prior to running `makemessages <http://docs.djangoproject.com/en/dev/topics/i18n/#message-files>`_.
+Models can be registered for django-dbgettext in a similar fashion to registering `ModelAdmin classes <http://docs.djangoproject.com/en/dev/ref/contrib/admin/#modeladmin-objects>`_ for ``django.contrib.admin``
+Simply create a ``gettext.py`` file within your application root directory, import the dbgettext ``registry`` object, and register your Models together with their customised ``dbgettext.models.Options``. For example::
+That's it. Your ``gettext.py`` files will be automatically imported by django-dbgettext, and registered models will be included when running :doc:`dbgettext_export <dbgettext_export>`.
+* ``DBGETTEXT_PATH``: path (absolute or relative to project root) where :doc:`dbgettext_export <dbgettext_export>` should store its output. Defaults to ``locale``.
+* ``DBGETTEXT_ROOT``: name of directory within ``DBGETTEXT_PATH`` (redundancy to provide protection from auto-purging upon export). Defaults to ``dbgettext``.