Hopiu/django-modeltranslation
1
0
Fork 0
mirror of https://github.com/Hopiu/django-modeltranslation.git synced 2026-03-16 22:10:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
django-modeltranslation/docs/modeltranslation
History
Dirk Eschler 2a63788e0d Added requirements for 0.9 release (ref #299).
2015-04-16 10:46:15 +02:00
..
_static Added a empty _static directory to docs (alongside a useless .gitignore to allow to commit it with git). Suppresses a warning generated by sphinx. 2012-11-13 14:46:50 +01:00
admin.rst General documentation improvements. 2014-07-20 01:58:00 +02:00
authors.rst Major refactoring of the documentation. 2012-10-17 15:02:22 +02:00
caveats.rst Small docs update. 2014-03-26 18:54:20 +01:00
changelog.rst Included changelog in documentation. 2013-01-31 17:44:37 +01:00
commands.rst General documentation improvements. 2014-07-20 01:58:00 +02:00
conf.py Prepared 0.7.3 release. 2014-01-05 00:40:01 +01:00
contribute.rst Added line about about coveralls and included shields in contribute chapter. 2014-07-27 00:52:18 +02:00
forms.rst General documentation improvements. 2014-07-20 01:58:00 +02:00
index.rst Add docs about empty_values (close #211). 2013-11-09 14:28:38 +01:00
installation.rst Added requirements for 0.9 release (ref #299). 2015-04-16 10:46:15 +02:00
make.bat Converted documentation to shpinx and added an initial setup (work-in-progress). 2012-10-17 11:18:36 +02:00
Makefile Converted documentation to shpinx and added an initial setup (work-in-progress). 2012-10-17 11:18:36 +02:00
readme.rst Major refactoring of the documentation. 2012-10-17 15:02:22 +02:00
registration.rst Added migrations (Django 1.7) documentation. 2014-07-27 02:33:26 +02:00
related_projects.rst Consistent capitalization of titles in docs. 2012-10-22 11:57:52 +02:00
usage.rst Add fallback to values and values_list (close #258). 2014-07-29 17:42:17 +03:00

readme.rst 

================
Modeltranslation
================

The modeltranslation application is used to translate dynamic content of
existing Django models to an arbitrary number of languages without having to
change the original model classes. It uses a registration approach (comparable
to Django's admin app) to be able to add translations to existing or new
projects and is fully integrated into the Django admin backend.

The advantage of a registration approach is the ability to add translations to
models on a per-app basis. You can use the same app in different projects,
may they use translations or not, and you never have to touch the original
model class.


.. image:: http://img.shields.io/travis/deschler/django-modeltranslation/master.png?style=flat
    :target: https://travis-ci.org/deschler/django-modeltranslation

.. image:: http://img.shields.io/coveralls/deschler/django-modeltranslation.png?style=flat
    :target: https://coveralls.io/r/deschler/django-modeltranslation

.. image:: https://pypip.in/v/django-modeltranslation/badge.png?style=flat
    :target: https://pypi.python.org/pypi/django-modeltranslation/
    :alt: Latest PyPI version

.. image:: https://pypip.in/py_versions/django-modeltranslation/badge.png?style=flat
    :target: https://pypi.python.org/pypi/django-modeltranslation/
    :alt: Supported Python versions

.. image:: https://pypip.in/d/django-modeltranslation/badge.png?style=flat
    :target: https://pypi.python.org/pypi/django-modeltranslation/
    :alt: Number of PyPI downloads


Features
========

- Add translations without changing existing models or views
- Translation fields are stored in the same table (no expensive joins)
- Supports inherited models (abstract and multi-table inheritance)
- Handle more than just text fields
- Django admin integration
- Flexible fallbacks, auto-population and more!


Project Home
------------
https://github.com/deschler/django-modeltranslation

Documentation
-------------
https://django-modeltranslation.readthedocs.org/en/latest

Mailing List
------------
http://groups.google.com/group/django-modeltranslation