Metadata-Version: 1.0
Name: django-javascript-settings
Version: 1.0.1
Summary: django-javascript-settings is a Django application that provides a way of passing settings for Django applications to JavaScript.
Home-page: UNKNOWN
Author: Tomasz Wysocki
Author-email: tomasz@wysocki.info
License: UNKNOWN
Description: javascript-settings
        ========================
        
        javascript-settings is a Django application that provides
        a way of passing settings for Django applications to JavaScript.
        
        Installation
        ------------
        
        Package
        _______
        
        javascript-settings can be installed as a normal Python package.
        
        Example instalation for pip::
        
            $ pip install javascript-settings
        
        Example instalation from file::
        
            $ pip install javascript-settings-1.1.tar.gz
        
        Configuration
        -------------
        
        settings.py
        ___________
        
        Add javascript-settings to INSTALLED_APPS::
        
            INSTALLED_APPS = (
                ...
                'javascript_settings',
                ...
            )
        
        template
        ________
        
        Add javascript-settings tag to your main template::
        
            {% load javascript_settings_tags %}
            <script type="text/javascript">{% javascript_settings %}</script>
        
        Usage
        -----
        
        Configuration is defined by adding ``javascript_settings`` function to urls.py of app.
        ``javascript_settings`` should take no arguments and return json-serializable object.
        Serialized object is then avaliable in Javascript as ``configuration['app_name']``.
        
        If you want to place ``javascript_settings`` in different location, then you can
        define ``JAVASCRIPT_SETTINGS_SCAN_MODULES`` as a dictionary of ``'app_name': 'module_location'``.
        
        Example
        -------
        
        Template::
        
            {% load javascript_settings_tags %}
            <script type="text/javascript">{% javascript_settings %}</script>
        
        urls.py in an app::
        
            def javascript_settings():
                js_conf = {
                        'page_title': 'Home',
                        'page_version': '1.9.20',
                        'css': {
                            'white': './css/white.css',
                            'black': './css/black.css',
                            'print': './css/print.css',
                        },
                        'default_css': 'white',
                }
                return js_conf
        
        For example the app is named "home".
        
        Result::
        
            <script type="text/javascript">var configuration = {'home': {'page_title': 'Home', 'page_version': '1.9.20', 'css': {'white': './css/white.css', 'black': './css/black.css', 'print': './css/print.css'}, 'default_css': 'white'}};</script>
        
Platform: UNKNOWN
