Metadata-Version: 1.1
Name: django-phrase
Version: 0.0.2
Summary: Connect your Django apps to PhraseApp, the powerful in-context-translation solution.
Home-page: https://github.com/phrase/django-phrase
Author: Manuel Boy
Author-email: info@phraseapp.com
License: BSD
Download-URL: https://github.com/phrase/django-phrase
Description: =============
        django-phrase
        =============
        
        PhraseApp_ makes it easy and fast to localize you mobile app or website.
        
        This adapter lets you connect your Django_ application to PhraseApp and integrate the powerful In-Context-Editor_ into your apps.
        
        .. _PhraseApp: https://phraseapp.com
        .. _Django: https://www.djangoproject.com
        .. _In-Context-Editor: https://phraseapp.com/features/context-view
        
        How does it work?
        -----------------
        
        django-phrase provides In-Context translating facilities to your Django app by hooking into `i18n template tags`_.
        
        It exposes the underlying key names to the javascript editor that is provided by PhraseApp.
        
        To get started with PhraseApp you need to `sign up for a free account <https://phraseapp.com/signup>`_.
        
        
        Installation
        ------------
        
        Install the package with pip::
        
            pip install django-phrase
        
        And add phrase to the list of installed apps::
        
            INSTALLED_APPS = (
                'phrase',
            )
        
        You can now use the ``phrase_i18n`` template tag in your templates::
        
            {% load phrase_i18n %}
        
        Note: You have to load ``phrase_i18n`` *after* you load ``ì18n`` in order to let phrase override the translation methods. 
        
        Last step: add the javascript snippet to your base layout file with the folling tag. This should go inside the ``<head>`` section of your template file::
        
            {% phrase_javascript %}
        
        
        Configuration
        -------------
        
        You can configure PhraseApp in your settings with these default options::
        
            PHRASE_ENABLED = True
            PHRASE_AUTH_TOKEN = 'YOUR_AUTH_TOKEN'
            PHRASE_PREFIX = '{{__'
            PHRASE_SUFFIX = '__}}'
        
        **************
        PHRASE_ENABLED
        **************
        
        Enable/Disable In-Context-Editing completely and fall back to standard Django i18n handling. Disable PhraseApp for production environments at any time!
        
        *****************
        PHRASE_AUTH_TOKEN
        *****************
        
        Add your project auth token. You find your project auth token on the `project overview page <https://phraseapp.com/projects>`_.
        
        *************
        PHRASE_PREFIX
        *************
        
        Change the prefix and suffix of the keys that are rendered by PhraseApp. Default typically works great but this can conflict with some JavaScript liberaries. Use this setting to change prefix and suffix to custom ones if necessary.
        
        More Information
        ----------------
        
        * Signup_
        * Documentation_
        * Support_
        
        .. _i18n template tags: https://docs.djangoproject.com/en/1.5/topics/i18n/translation/#internationalization-in-template-code
        .. _Signup: https://phraseapp.com/docs
        .. _Documentation: https://phraseapp.com/docs
        .. _Support: https://phraseapp.com/support
        
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Internationalization
Classifier: Topic :: Software Development :: Localization
