springload / wagtailcommonblocks Goto Github PK

View Code? Open in Web Editor NEW

40.0 28.0 10.0 53 KB

Common StreamField blocks for Wagtail

Home Page: https://pypi.python.org/pypi/wagtailcommonblocks

License: MIT License

Python 87.06% JavaScript 1.94% HTML 7.65% Makefile 3.34%

wagtail blocks

wagtailcommonblocks's Introduction

wagtailcommonblocks

Common StreamField blocks for Wagtail.

Check out Awesome Wagtail for more awesome packages and resources from the Wagtail community.

Quickstart

Assuming you have a Wagtail project up and running:

pip install wagtailcommonblocks

Add commonblocks to your settings.py in the INSTALLED_APPS section, before the core wagtail packages:

...
    'commonblocks',
    'wagtail.contrib.wagtailsitemaps',
...

Available blocks

CommonPageChooserBlock
SimpleRichTextBlock
CommonImageBlock
CommonQuoteBlock
CommonHeadingBlock
CommonVideoBlock
CommonInternalLink
CommonExternalLink
CommonLinksBlock

You can override the headings of the CommonHeadingBlock block:

...
COMMONBLOCKS_HEADING = (
    ('h1', 'h1'),
    ('h2', 'h2'),
)

Development

Releases

Make a new branch for the release of the new version.
Update the CHANGELOG.
Update the version number in setup.py, following semver.
Make a PR and squash merge it.
Back on master with the PR merged, use make publish (confirm, and enter your password).
Finally, go to GitHub and create a release and a tag for the new version.
Done!

wagtailcommonblocks's People

Contributors

Stargazers

Watchers

Forkers

jordij rense grandrepublic rath-san dadafari patchwork-systems ibrahimawadhamid gaybro8777 lingster octavenz

wagtailcommonblocks's Issues

This project needs a maintainer

Hi,

This repository seems to lack maintenance, I propose myself as a new maintainer.

Could you give me the right to push in your repository or just transfer it on my account in github?

Thank you!

Not compatible with wagtail 1.5.x and above

Due to a change in concept and structure in wagtails:

wagtail.wagtailcore.fields
page-editor.js

This needs to be revised and fixed in a non breaking manner for existing content.

Update SimpleRichTextBlock and SimpleRichTextField to Draftail?

I believe SimpleRichTextBlock and SimpleRichTextField have been broken for a long time. Indeed, despite defining a small set of available elements, with Wagtail prior 1.12, the toolbar shows some additional elements:

In addition, it is now outdated:

Wagtail 1.12 introduced RichText features
Wagtail 2.0 uses Draftail as a default editor

#7 make just make it work™, but given the confusing behaviour (see above) and that there is no tests, I woulnd't feel too confident upgrading the package on a production website which is using either SimpleRichTextBlock or SimpleRichTextField.

It looks like the expected behaviour was:

Restrict the list of features to: paragraphs, bold, italic, unordered lists, ordered lists, links and document links
Allow some attributes on links?
Allow arbitrary html to be pasted in

Assuming we were update it to use the Draftail editor:

Should be achievable with features
Will need investigation
I'm afraid it's not possible at the moment so it might be an issue

ImportError: No module named 'wagtail.wagtailcore'

The package is now named wagtail.core so it needs a fallback.

Tidy Python package management

The package metadata in setup.py can do with a tidy up.

GitHub URL is incorrect
GitHub repository name (wagtailblocks) doesn’t match Python package name (wagtailcommonblocks)
uses BSD license

See https://github.com/springload/wagtaildraftail for best-practice example.