https://github.com/maykinmedia/djangocms-export-page

Export a Django CMS page or a model view to a DOCX document
https://github.com/maykinmedia/djangocms-export-page

djangocms docx-generator

Last synced: about 2 months ago
JSON representation

Export a Django CMS page or a model view to a DOCX document

• Host: GitHub
• URL: https://github.com/maykinmedia/djangocms-export-page
• Owner: maykinmedia
• License: mit
• Created: 2018-08-30T10:14:14.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-30T17:04:39.000Z (2 months ago)
• Last Synced: 2024-10-30T18:18:43.854Z (2 months ago)
• Topics: djangocms, docx-generator
• Language: Python
• Homepage: https://pypi.org/project/djangocms-export-page/
• Size: 94.7 KB
• Stars: 0
• Watchers: 5
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        

Django CMS Export Page

=================================================

:Version: 0.1.0

:Source: https://bitbucket.org/maykinmedia/djangocms-export-page

:Keywords: ``django`` ``cms`` ``export`` ``docx``

:PythonVersion: 3.4

|build-status| |requirements| |coverage|

|python-versions| |django-versions| |pypi-version|

Export a Django CMS page or a model view to a DOCX document

.. contents::

.. section-numbering::

Features

========

* Adds a menu entry in the CMS toolbar to export the current page

* Ability to export a custom model, including placeholder fields

.. image:: img/page-export-menu.png

Installation

============

Requirements

------------

* Python 3.4 or above

* setuptools 30.3.0 or above

* Django 1.11 or above

* Django CMS 3.4.6 or above

Install

-------

.. code-block:: bash

    pip install djangocms-export-page

Usage

=====

In your Django settings:

.. code-block:: python

    INSTALLED_APPS = [

        ...

        'djangocms_export_page',

        ...

    ]

CMS Page

--------

CMS Page don't need any extra configuration to work.

If a Plugin has a reverse ForeignKey that would behave like children,

add the following to the CMSPlugin model class:

.. code-block:: python

    _export_page = {

        'children': 'items'

    }

    @property

    def items(self):

        return self.frequentlyaskedquestion_set.all()

where `items` is a iterable attribute of the model class.

And for on the ForeignKey Django model class:

.. code-block:: python

    _export_page = {

        'fields': ['name', ... ]

    }

If you want to export the contents of a ForeignKey or OneToOneField inside the regular model you can use

`_export_page_field_names`. Now these fields will be put in the some level as the plugin fields.

.. code-block:: python

    _export_page_field_names = ['number', 'title', 'lead', 'display_date', 'date', 'location']

Django Model

------------

If you need to export a Django model included in a AppHook,

add the following to the model class:

.. code-block:: python

    _export_page = {

        'sections': [{

            'name': 'Meta',

            'fields': ['title', ... ]

        }, {

            'name': 'Body',

            'fields': ['content']

        }],

    }

It's better to put the PlaceholderField (here `content`) in a separate section.

Static Placeholders

-------------------

If you also want to export the static placeholders of a page, some extra configuration

is required. There is a setting called `EXPORT_STATIC_PLACEHOLDERS`.

.. code-block:: python

    EXPORT_STATIC_PLACEHOLDERS = {

        'template_name': ['static_placeholder_code']

    }

So with the cms settings it will look like this:

.. code-block:: python

    # test.html

    


        {% static_placeholder 'test-placeholder' %}

    


    # settings.py

    CMS_TEMPLATES = [

        ('test.html', _('Test page')),

    ]

    EXPORT_STATIC_PLACEHOLDERS = {

        'test.html': ['test-placeholder']

    }

.. |build-status| image:: https://travis-ci.org/maykinmedia/djangocms-export-page.svg?branch=develop

    :target: https://travis-ci.org/maykinmedia/djangocms-export-page

.. |requirements| image:: https://requires.io/github/maykinmedia/djangocms-export-page/requirements.svg?branch=develop

    :target: https://requires.io/github/maykinmedia/djangocms-export-page/requirements/?branch=develop

    :alt: Requirements status

.. |coverage| image:: https://codecov.io/gh/maykinmedia/djangocms-export-page/branch/develop/graph/badge.svg

    :target: https://codecov.io/gh/maykinmedia/djangocms-export-page

    :alt: Coverage status

.. |python-versions| image:: https://img.shields.io/pypi/pyversions/djangocms-export-page.svg

.. |django-versions| image:: https://img.shields.io/pypi/djversions/djangocms-export-page.svg

.. |pypi-version| image:: https://img.shields.io/pypi/v/djangocms-export-page.svg

    :target: https://pypi.org/project/djangocms-export-page/