Metadata-Version: 1.1
Name: django-madcap-flare
Version: 0.0.3
Summary: Integrate Madcap Flare docs into your Django project
Home-page: https://github.com/mypebble/django-madcap-flare
Author: Pebble
Author-email: scott.walton@mypebble.co.uk
License: MIT
Description: Madcap Flare Integration
        ========================
        
        Simple integration tools to link to embedded Madcap Flare help
        
        Installation
        ------------
        
        Install the Madcap Flare integration from PyPi:
        
        ::
        
            pip install django-madcap-flare
        
        and add it to your settings.py:
        
        .. code:: python
        
            INSTALLED_APPS = [
                ...
                'madcap_flare',
                ...
            ]
        
        You will also need to configure the ```MADCAP_FLARE_ROOT`` and
        ``MADCAP_FLARE_TAGS`` <#configuring>`__
        
        Usage
        -----
        
        You can convert Madcap Flare header files into a Python dict with the
        ``get_help_mapping`` command:
        
        ::
        
            python manage.py get_help_mapping path_to_file.h
        
        This will output a dict on the command line that you can copy into your
        settings.py file.
        
        Configuring
        ~~~~~~~~~~~
        
        To setup your template tags, take the output of ``get_help_mapping`` and
        set it to the ``MADCAP_FLARE_TAGS`` in settings.py:
        
        .. code:: python
        
            MADCAP_FLARE_TAGS = {
              'my-help-topic': '1000',
              'other-help-topic': '2000',
            }
        
            MADCAP_FLARE_ROOT = 'https://www.example.com/help_topics/'
        
        The ``MADCAP_FLARE_ROOT`` setting tells Django what to use for your host
        name and default path.
        
        View Mixin
        ~~~~~~~~~~
        
        To inject your information into your templates, you can use the view
        mixin for Madcap Flare:
        
        .. code:: python
        
            from django.views.generic import ListView
        
            from madcap_flare.views import MadcapFlareMixin
        
            from myproject.myapp.models import MyModel
        
        
            class MyListView(MadcapFlareMixin, ListView):
                """Sample list view.
                """
        
                help_key = 'my-help-topic'
                queryset = MyModel.objects.all()
        
        The MadcapFlareMixin injects the ``help_key`` object into your template
        context.
        
        Template Tag
        ~~~~~~~~~~~~
        
        The ``madcap_flare_help`` template tag outputs a Madcap Flare URL that
        can be linked from your templates:
        
        .. code:: html
        
            {% load madcap_flare_tags %}
        
            <p>To get more help on this feature, see our
              <a href="{% madcap_flare_help %}">documentation</a>
            </p>
        
        With the ``help_key`` set above, this will output:
        
        .. code:: html
        
            <p>To get more help on this feature, see our
              <a href="https://www.example.com/help_topics/Default.htm#cshid=1000">documentation</a>
            </p>
        
        Developing
        ----------
        
        To test the integration just run:
        
        .. code:: bash
        
            virtualenv venv
            . venv/bin/activate
            pip install -r requirements.txt
            python setup.py develop
            python tests/manage.py test
        
        Writing Docs for PyPI
        ~~~~~~~~~~~~~~~~~~~~~
        
        To convert the docs to RST for PyPI:
        
        .. code:: bash
        
            pandoc --from=markdown --to=rst --output=README.txt README.md
        
        
Keywords: django madcap flare web development
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
