Skip to main content

A Wagtail richdocument content type built with wagtail streamfield.

Project description

This is a wagtail app to be applied on wagtail generic docs. It adds the following streamfield blocks:

  • doc_byline

  • body_text

  • quote

  • bustout

  • code_chunk

  • math_formula

  • table

  • media_embed

Dependencies

Quick Start

install from pypy:

pip install wagtail-utphy-richdocument

add “utphy_richdocument” and “wagtail.contrib.table_block” to your INSTALLED_APPS setting:

INSTALLED_APPS = [
    ...
    'wagtail.contrib.table_block',
    'utphy_richdocument',
]
  • In your own app create a new model which subclasses the StreamFieldDoc model.

models.py:

from utphy_richdocument.models import StreamFieldDoc
from wagtail.wagtailadmin.edit_handlers import StreamFieldPanel

class YourModel(StreamFieldDoc):
    template = 'path_to_your_template.html'

    content_panels = Page.content_panels + [
        # your_model_fields
        StreamFieldPanel('body'),
]
  • In your template, make sure you have the following snippet:

path_to_your_template.py:

{% for block in self.body %}
  {{block}}
{% endfor %}

Finally run:

python manage.py collectstatic
python manage.py makemigrations
python manage.py migrate

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wagtail-utphy-richdocument-0.7.5.tar.gz (23.6 kB view details)

Uploaded Source

File details

Details for the file wagtail-utphy-richdocument-0.7.5.tar.gz.

File metadata

File hashes

Hashes for wagtail-utphy-richdocument-0.7.5.tar.gz
Algorithm Hash digest
SHA256 0d0a3a3f8750fcf18deb0d48e268e7b22ccbbc614bdb5c434e9fa223d5aa8901
MD5 3d644255027dc7b285053317dbe0ce01
BLAKE2b-256 62f23023fb760b9c3ab15f74ba39a4306159f4fa1655f40ebfab95285da5ca95

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page