Skip to main content

Volto integration add-on for Plone

Project description

kitconcept https://secure.travis-ci.org/kitconcept/kitconcept.volto.png

kitconcept.volto is a helper package to setup a Plone site ready to use with Volto. It installs several convenience packages, Plone configuration and patches to prepare Plone to be ready for support all the Volto features. Drop it in your buildout and then install it. It is used in Volto development itself for testing it.

If you want, take it as base of your own integration package.

Features

kitconcept.volto provides the following features:

Demo home page and Plone site blocks support

It features a hack to make the Plone site Volto blocks-enabled with some demo content. You can take only the hack to enable the blocks on your site.

You can see it in action in the Volto demo: https://volto.kitconcept.com

Install the provided profile to install it by default:

kitconcept.volto:default-homepage

e.g. in your GS metadata.xml along with your other dependencies:

<metadata>
<version>1000</version>
<dependencies>
  <dependency>kitconcept.volto:default-homepage</dependency>
</dependencies>
</metadata>

Volto Pastanaga Editor

It enables the Volto Blocks behavior on the Document content type by default, enabling Volto editor for that content type.

Just use the same pattern to enable your own content types to have blocks.

Document content type

Richtext and table of contents behaviors has been removed from the Document behaviors since it’s confusing for the users if they shows in the form. Both have been superseeded by blocks in the editor.

Disabled content types

It disables (fti) of some default content types since they are not ready or full working yet on Volto side. At this moment only the event content type is disabled.

The event content type will be enabled when the upcoming new dates widget is complete.

CORS profile

A quick helper for enable CORS for development config is also provided in the kitconcept.volto module. So you can call:

<include package="kitconcept.volto.cors" />

from your ZCML while developing.

Enable it on demand, since it’s considered a security issue if you enable CORS in your productions sites.

It’s planned that Volto will feature a development pass-through proxy to the backend in the future. It will be addressed in next sprints.

ZLog patch

p.restapi low level errors are routed through the ancient ZLog and are plone_error enabled, making it difficult to follow since all are marked with a UUID. Specially if using helpers like Sentry. This patch removes the UUID so the same error is categorized all together. This is planned to be addressed in next sprints.

Patch fix for Plone subject field

There are some problems of serialization on special characters derivated from how the current shape of the Plone’s default Dexterity subjects field that has to be addressed in order to make it work properly with Volto (and other systems that are not Plone). This will be fixed in core in upcoming sprints.

Support behaviors

Some behaviors that have proven to be complementary to Volto views. preview_image an image for listings and teasers (different than a lead image). nav_title a field to store titles used in navigation components, teasers or doormats.

Volto blocks enabled LRF

Multilingual support for LRF (Language Root Folders) is supported. Install PAM before installing this package and demo homepages will be created in each enabled language. Currently only support for EN/DE.

Versions compatibility

kitconcept.voltodemo is deprecated in favor of this package as of since March, 5th 2020.

Contributors

Changelog

1.1.0 (2020-03-10)

  • Added a specific IImageScaleFactory for Image content type, to fix SVG handling [sneridagh]

1.0.1 (2020-03-08)

  • Update version numbers in default home page. [sneridagh]

1.0.0 (2020-03-06)

  • Add Zope log patch [sneridagh]
  • Add nav_title and preview_image behaviors [sneridagh]
  • override plone.app.vocabularies.Keywords with a version that uses the unencode subject value as the token. [csenger]
  • Remove versioning behavior from Document type. [timo]
  • Backport all features that were in kitconcept.voltodemo [sneridagh]
  • Patch Password reset tool in Products.CMFPlone to use the optional volto_domain in the e-email which is sent to users, only if the request is made through REST. [fredvd]
  • Add Volto settings control panel with frontend_domain field. [fredvd]
  • Homepage profile for demo purposes [sneridagh]
  • CORS profile [sneridagh]
  • Enable Volto Blocks for Document and LRF [sneridagh]
  • Initial release. [kitconcept]

Project details


Download files

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

Files for kitconcept.volto, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size kitconcept.volto-1.1.0.tar.gz (27.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page