Skip to main content

Volto integration add-on for Plone

Project description

kitconcept https://github.com/kitconcept/kitconcept.volto/workflows/Basic%20tests/badge.svg

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.

Usage

https://github.com/plone/volto/blob/master/api/base.cfg#L13

and along with plonesite recipe:

https://github.com/plone/volto/blob/master/api/base.cfg#L13

Compatibility

kitconcept.volto

plone.restapi

1.x

6.0.0 and below

2.x

7.0.0 and above

plone.restapi 7.0.0 is included in Plone 5.3.4 (and above).

You can still use 2.x in p.restapi 7.0.0 based installations but the transforms included won’t work. It is recommeneded that you always use the latest plone.restapi release in your projects.

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.

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.

Image Scales

This package introduces new Plone image scales in Plone and redefines a couple of existing ones. These are know to work well with Volto layout and grid system.

icon 32:32 tile 64:64 thumb 128:128 mini 200:65536 preview 400:65536 teaser 600:65536 large 800:65536 larger 1000:65536 great 1200:65536 huge 1600:65536

This change is opinionated and may collide with your previously defined ones, so make sure your add-on’s profiles are applied AFTER this one.

Versions compatibility

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

Contributors

Changelog

2.2.0 (2021-04-21)

  • Add multilingual test fixture for Cypress tests [sneridagh]

2.1.3 (2021-03-26)

  • Add requests as dependency [sneridagh]

2.1.2 (2021-03-07)

  • Add a demo home page for demo site [sneridagh]

2.1.1 (2021-03-06)

  • Add demo site profile [sneridagh]

2.1.0 (2021-02-23)

  • Remove Images and Files from types_use_view_action_in_listings since in Volto it’s no used at all. [sneridagh]

2.0.0 (2021-02-20)

  • [Breaking] Define good known to work well with Volto image scales in registry.xml GenericSetup profile. When this add-on is installed or the profile is applied, it will overwrite the existing scales in your Plone site. If you are using specific scales for your project, make sure they are installed after this addon’s profile.

    This scales have been tested in real production projects and work well with Volto’s layout and responsive viewports. [timo, sneridagh]

1.7.2 (2021-01-26)

  • Nothing changed yet.

1.7.1 (2021-01-25)

  • Fix first level tabs and add nav_title to them [sneridagh]

1.7.0 (2021-01-21)

  • Add breadcrumbs_view override to include nav_title [sneridagh]

1.6.0 (2021-01-14)

  • Added indexers for preview_image, it allows the Volto object browser widget to access it [sneridagh]

1.5.2 (2020-12-14)

  • Missing ZCML for translations [sneridagh]

1.5.1 (2020-12-14)

  • Add zest.pocompile [sneridagh]

  • Add missing .mo [sneridagh]

1.5.0 (2020-12-09)

  • Fix locales default in German [sneridagh]

1.4.0 (2020-07-29)

  • Add volto.preview_image behavior to Page type. [timo]

1.3.2 (2020-05-17)

  • Make sure that the enable_pam helper does its job. [sneridagh]

1.3.1 (2020-05-12)

  • Fix LRF global allow and ensure default behaviors [sneridagh]

1.3.0 (2020-05-11)

  • Add registry navigation setting for not show the current item in navigations [sneridagh]

  • New enable_pam setuphandlers helper [sneridagh]

  • New enable_pam_consistency setuphandlers helper [sneridagh]

1.2.0 (2020-04-17)

  • Bring back the event type, since it’s fully working in Volto now [sneridagh]

  • fix typo in behavior name navttitle -> navtitle [sneridagh]

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.

Source Distribution

kitconcept.volto-2.2.0.tar.gz (44.1 kB view hashes)

Uploaded Source

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