.. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features.
If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide.html
This text does not appear on pypi or github. It is a comment.
.. image:: https://img.shields.io/pypi/v/plone.volto.svg
:target: https://pypi.python.org/pypi/plone.volto
.. image:: https://github.com/plone/plone.volto/actions/workflows/tests.yml/badge.svg
:target: https://github.com/plone/plone.volto/actions/workflows/tests.yml
==============================================================================
plone.volto
==============================================================================
plone.volto configures Plone to work with `Volto <https://www.npmjs.com/package/@plone/volto>`_, the new default frontend for Plone 6.
Installation
============
Install plone.volto by adding it to your buildout::
[buildout]
...
[instance]
...
eggs =
plone.volto
...
Compatibility
=============
plone.volto currently works for both Plone 5.2 and Plone 6 (pre-alpha and alpha).
It support Python 3.7, 3.8 and 3.9.
Though, Volto requires specific versions of plone.volto and plone.restapi:
+---------------------------+-----------------------+-------------------------------------------------------------------------------------------------+
| plone.volto | plone.restapi | Reason |
+---------------------------+-----------------------+-------------------------------------------------------------------------------------------------+
| 3.1.x | 8.13.0 and above | Requires new JSONSummarySerializerMetadata serializer added in plone.restapi 8.13.0 |
+---------------------------+-----------------------+-------------------------------------------------------------------------------------------------+
| 2.x (kitconcept.volto) | 7.0.0 and above | New image scales |
+---------------------------+-----------------------+-------------------------------------------------------------------------------------------------+
| 1.x (kitconcept.volto) | 6.0.0 and below | New transforms and features |
+---------------------------+-----------------------+-------------------------------------------------------------------------------------------------+
plone.restapi 7.x.x is included in Plone 5.2.4 (and later).
You can still use 2.x in p.restapi 7.0.0 based installations but the transforms included won't work.
Volto only supports the latest plone.restapi branch, therefore it is recommended to always use the latest version in your Volto projects.
Plone 6 Architecture
====================
Architectural Diagram of Plone 6::
Frontend
┌──────────────────────────────┐
│ │
│ Volto │
│ │
└────────┬────────────┬────────┘
│ ▲
│ HTTP │
Backend ▼ │
┌────────┴────────────┴────────┐
│┌────────────────────────────┐│
││ plone.restapi ││
│└────────────────────────────┘│
│┌────────────────────────────┐│
││ plone.volto ││
│└────────────────────────────┘│
│┌────────────┐ ┌─────────────┐│
││ Plone │ │ Add-Ons ││
│└────────────┘ └─────────────┘│
└──────────────────────────────┘
Features
========
plone.volto provides the following features:
Volto Blocks Support
--------------------
plone.volto enables the new Volto Blocks editor on ``Document``, ``Language Root Folder`` and ``Site Root``.
Multilingual Support
--------------------
plone.volto supports multilingual websites.
Install PAM before installing this package and demo homepages will be created in each enabled language.
Currently only support for EN/DE.
Volto Blocks for Plone Site Root
--------------------------------
plone.volto contains 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://6.demo.plone.org
Install the provided profile to install it by default:
plone.volto:default-homepage
e.g. in your GS ``metadata.xml`` along with your other dependencies::
<metadata>
<version>1000</version>
<dependencies>
<dependency>plone.volto:default-homepage</dependency>
</dependencies>
</metadata>
**NOTE**: The default block for creating the default content in the root (or
corresponding Language Root Folders) is "draftJS" text block. ``plone.volto`` provides a
profile if you want to create Slate blocks: you need to use the ``default-homepage-slate``
profile.
Document Content Type
---------------------
plone.volto disables the ``Richtext`` and ``Table of Contents`` behaviors for the ``Document`` content type.
Rich Text functionality is provided by the new Volto Blocks editor.
The ``Table of Contents`` functionality is provided by the ``Table of Contents Block`` in Volto.
CORS Profile
------------
A quick helper for enable CORS for development config is also provided in the
``plone.volto`` module. So you can call::
<include package="plone.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 for ``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.
Preview Image Behavior
----------------------
The preview image behavior makes content types provide a preview_image field that can store a preview image that Volto views can pick up.
This is especially userful for listings (e.g. listing block customizations) and teaser elements (e.g. teaser blocks such as [volto-blocks-grid](https://github.com/kitconcept/volto-blocks-grid)).
The "volto.preview_image behavior can be enabled in the generic setup XML definition of a content type (e.g. "/profiles/default/types/MyContentType.xml")::
<?xml version="1.0" encoding="UTF-8" ?>
<object i18n:domain="fzj.internet" meta_type="Dexterity FTI" name="MyContentType"
xmlns:i18n="http://xml.zope.org/namespaces/i18n">
...
<!-- Enabled behaviors -->
<property name="behaviors" purge="false">
...
<element value="volto.preview_image" />
</property>
...
</object>
Navigation Title Behavior
-------------------------
The navigation title makes content types provide a nav_title field that is used by Volto in the main navigation, the breadcrumbs and the navigation portlet.
The "volto.navtitle behavior can be enabled in the generic setup XML definition of a content type (e.g. "/profiles/default/types/MyContentType.xml")::
<?xml version="1.0" encoding="UTF-8" ?>
<object i18n:domain="fzj.internet" meta_type="Dexterity FTI" name="MyContentType"
xmlns:i18n="http://xml.zope.org/namespaces/i18n">
...
<!-- Enabled behaviors -->
<property name="behaviors" purge="false">
...
<element value="volto.navtitle" />
</property>
...
</object>
Head Title Behavior
-------------------
The headtitle makes content types provide a headtitle field that can be used by Volto in teasers and alikes.
The "volto.head_title" behavior can be enabled in the generic setup XML definition of a content type (e.g. "/profiles/default/types/MyContentType.xml")::
<?xml version="1.0" encoding="UTF-8" ?>
<object i18n:domain="fzj.internet" meta_type="Dexterity FTI" name="MyContentType"
xmlns:i18n="http://xml.zope.org/namespaces/i18n">
...
<!-- Enabled behaviors -->
<property name="behaviors" purge="false">
...
<element value="volto.head_title" />
</property>
...
</object>
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.**
Credits and History
-------------------
.. image:: https://kitconcept.com/logo.svg
:width: 150px
:alt: kitconcept
:target: https://kitconcept.com/
The code of plone.volto has been under active development and is used in production since 2018.
First as kitconcept.voltodemo (deprecated since March, 5th 2020), then as kitconcept.volto.
In September 2021 kitconcept.volto has been renamed to plone.volto and has been contributed to the Plone core as part of `PLIP #2703
<https://github.com/plone/Products.CMFPlone/issues/2703>`_.
Contributors
============
.. note::
place names and roles of the people who contribute to this package
in this file, one to a line, like so, please add your name at the end:
- Timo Stollenwerk, Original Author
- Victor Fernandez de Alba, Original Author
- Érico Andrei
- Carsten Senger
- Roberto Diaz
- Rodrigo Ferreira de Souza
- Alin Voinea
Changelog
=========
.. You should *NOT* be adding new change log entries to this file.
You should create a file in the news directory instead.
For helpful instructions, please see:
https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst
.. towncrier release notes start
4.0.0a6 (2022-06-25)
--------------------
Bug fixes:
- Re-release 4.0.0a5/4.0.0a5.dev0
[tisto] (#72)
4.0.0a5 (2022-06-25)
--------------------
New features:
- Add form ``@@migrate_richtext`` to migrate ``html-richtext`` to slate blocks or draftjs blocks
[pbauer] (#47)
- Add ``@@migrate_to_volto`` to prepare existing sites for Volto.
[pbauer] (#55)
Bug fixes:
- Update test to 6.0.0a4 and new pip practices.
[sneridagh] (#51)
- Conditional custom ``IImageScaleFactory`` adapter for Plone < 6 (svg are now handled in `plone.namedfile <https://github.com/plone/plone.namedfile/commit/b4f80204759703aa812d1db35589cd92e89ea108>`_).
[cekk] (#60)
- Fixed code quality configuration.
Removed unused imports and variables and sorted the imports.
[maurits] (#71)
4.0.0a4 (2022-04-08)
--------------------
- Fix deprecated import of isDefaultPage
[pbauer]
4.0.0a3 (2022-02-04)
--------------------
- Fix Multilingual profile, revert to use draftJS (until slate is integrated into Volto)
[sneridagh]
4.0.0a2 (2022-01-25)
--------------------
- Bring back the draftJS as default, until Slate is integrated in full in Volto
[sneridagh]
4.0.0a1 (2022-01-25)
--------------------
Breaking:
- Use Slate blocks for the default pages
[sneridagh]
- Add ``volto.blocks`` behavior to Plone Site GS types info.
[sneridagh]
- Remove ``Collection`` from types in GS types info.
[sneridagh]
- Remove ``plone.richtext`` behavior from Plone Site, Document, News Item, Events
[sneridagh]
- Add blocks behavior on Event and NewsItem
[nzambello]
- Add preview_image to Event
[nzambello]
Internal:
- Code cleanup, remove some outdated and unused helpers in ``setuptools.py``
[sneridagh]
- Workaround a test fixture isolation issue with the `IVoltoSettings.frontend_domain`
setting.
[rpatterson]
3.1.0a9 (2022-01-15)
--------------------
Breaking:
- Remove c.folderishtypes dependency
New Feature:
- Add new field in the coresandbox: not constrained by vocabulary field but the vocabulary defined in the widget.
[sneridagh]
3.1.0a8 (2022-01-12)
--------------------
- Computed copyright dates for content demo pages
[sneridagh]
3.1.0a7 (2021-12-11)
--------------------
New Feature:
- Added coresandbox fixture for Volto's cypress tests
[sneridagh]
Internal:
- Test with Plone 6.0.0a2
[ericof]
3.1.0a6 (2021-11-22)
--------------------
New Feature:
- Add Basque and Spanish translations
[erral]
- Add Italian translations
[cekk]
Bug fix:
- Update German translations
[timo]
- Fix translation files
[cekk, timo]
3.1.0a5 (2021-11-07)
--------------------
New Feature:
- Use new metadata utility for adding the ``image_field`` to the default serialization. This feature requires the JSONSummarySerializerMetadata serializer that has been added with plone.restapi 8.13.0.
[ericof]
Internal:
- Use plone/setup-plone github action.
[ericof]
3.1.0a4 (2021-10-29)
--------------------
Internal:
- Initial support and tests using Github Actions for Plone with pip installations.
[ericof]
3.1.0a3 (2021-10-25)
--------------------
Breaking:
- Explicitly require Python 3.7 or superior.
[ericof]
Internal:
- Remove ``jq`` from dependencies and remove old ``blocksremoveserver.py`` script.
[ericof]
- Remove ``z3c.jbot`` from dependencies
[ericof]
- Remove ``requests`` from dependencies
[ericof]
3.1.0a2 (2021-10-14)
--------------------
Bug fix:
- Fixed install on Windows, `issue 14 <https://github.com/plone/plone.volto/issues/14>`_.
[maurits]
3.1.0a1 (2021-10-11)
--------------------
Feature:
- Add new ``image_field`` metadata for image detection in catalog
[sneridagh]
Internal:
- Add Plone 6.0.0-pre-alpha configuration.
[tisto]
- Upgrade to Plone 5.2.5
[tisto]
- Change GS setup profile label to "Plone 6 Frontend (plone.volto)".
[tisto]
3.0.0a1 (2021-09-25)
--------------------
Breaking Change:
- Rename kitconcept.volto to plone.volto.
[tisto]
2.5.3 (2021-09-13)
------------------
- Fix condition of the guard for the multilingual fixture in the docker image.
[sneridagh]
2.5.2 (2021-09-13)
------------------
- Fix multilingual fixture for docker image, the guard seems not to work there, for some reason the blocks and blocks_layout are not set yet (?)
[sneridagh]
2.5.1 (2021-09-12)
------------------
- "More agnostic and simplify GS profile for Plone Site definition" (https://github.com/kitconcept/kitconcept.volto/pull/38)
[sneridagh]
2.5.0 (2021-09-12)
------------------
- Support pip-based Plone installation by explicitly including dependencies on configure.zcml
[ericof]
- Add Lock-Token to default CORS allow_headers
[avoinea]
- Add guard for not overwrite blocks in default home pages (if PAM enabled) if they are already set
[sneridagh]
2.4.0 (2021-07-19)
------------------
- Fix German translation for "Navigation title" ("Navigation titel" -> "Navigationstitel")
[timo]
- Fix and complete upgrade step from Volto 12 to Volto 13
[sneridagh]
- Add helper scripts
[sneridagh]
- Add preview_image to transforms
[sneridagh]
- Add headtitle behavior
[sneridagh]
- Guard for setuphandlers disablecontenttype
[sneridagh]
- Fix audit script
[sneridagh]
- Add support for subblocks in the custom transforms for ``volto-blocks-grid``
[sneridagh]
2.3.0 (2021-05-19)
------------------
- Add upgrade step facility
- Add upgrade step from Volto 12 to Volto 13
[sneridagh]
2.2.1 (2021-04-21)
------------------
- Better multilingual profile
[sneridagh]
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 plone.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]
Raw data
{
"_id": null,
"home_page": "https://github.com/plone/plone.volto",
"name": "plone.volto",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Python Plone CMS",
"author": "Plone Foundation",
"author_email": "tisto@plone.org",
"download_url": "https://files.pythonhosted.org/packages/62/8b/44804afbfcf215783b8ffcd7d03828100a27f1927773379e52e2f90f7d52/plone.volto-4.0.0a6.tar.gz",
"platform": null,
"description": ".. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features.\n If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide.html\n This text does not appear on pypi or github. It is a comment.\n\n.. image:: https://img.shields.io/pypi/v/plone.volto.svg\n :target: https://pypi.python.org/pypi/plone.volto\n\n.. image:: https://github.com/plone/plone.volto/actions/workflows/tests.yml/badge.svg\n :target: https://github.com/plone/plone.volto/actions/workflows/tests.yml\n\n==============================================================================\nplone.volto\n==============================================================================\n\nplone.volto configures Plone to work with `Volto <https://www.npmjs.com/package/@plone/volto>`_, the new default frontend for Plone 6.\n\n\nInstallation\n============\n\nInstall plone.volto by adding it to your buildout::\n\n [buildout]\n ...\n\n [instance]\n ...\n\n eggs =\n plone.volto\n ...\n\n\nCompatibility\n=============\n\nplone.volto currently works for both Plone 5.2 and Plone 6 (pre-alpha and alpha).\nIt support Python 3.7, 3.8 and 3.9.\n\nThough, Volto requires specific versions of plone.volto and plone.restapi:\n\n+---------------------------+-----------------------+-------------------------------------------------------------------------------------------------+\n| plone.volto | plone.restapi | Reason |\n+---------------------------+-----------------------+-------------------------------------------------------------------------------------------------+\n| 3.1.x | 8.13.0 and above | Requires new JSONSummarySerializerMetadata serializer added in plone.restapi 8.13.0 |\n+---------------------------+-----------------------+-------------------------------------------------------------------------------------------------+\n| 2.x (kitconcept.volto) | 7.0.0 and above | New image scales |\n+---------------------------+-----------------------+-------------------------------------------------------------------------------------------------+\n| 1.x (kitconcept.volto) | 6.0.0 and below | New transforms and features |\n+---------------------------+-----------------------+-------------------------------------------------------------------------------------------------+\n\nplone.restapi 7.x.x is included in Plone 5.2.4 (and later).\n\nYou can still use 2.x in p.restapi 7.0.0 based installations but the transforms included won't work.\n\nVolto only supports the latest plone.restapi branch, therefore it is recommended to always use the latest version in your Volto projects.\n\nPlone 6 Architecture\n====================\n\nArchitectural Diagram of Plone 6::\n\n Frontend\n \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n \u2502 \u2502\n \u2502 Volto \u2502\n \u2502 \u2502\n \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u252c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u252c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n \u2502 \u25b2\n \u2502 HTTP \u2502\n Backend \u25bc \u2502\n \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n \u2502\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\u2502\n \u2502\u2502 plone.restapi \u2502\u2502\n \u2502\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\u2502\n \u2502\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\u2502\n \u2502\u2502 plone.volto \u2502\u2502\n \u2502\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\u2502\n \u2502\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\u2502\n \u2502\u2502 Plone \u2502 \u2502 Add-Ons \u2502\u2502\n \u2502\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\u2502\n \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n\n\nFeatures\n========\n\nplone.volto provides the following features:\n\n\nVolto Blocks Support\n--------------------\n\nplone.volto enables the new Volto Blocks editor on ``Document``, ``Language Root Folder`` and ``Site Root``.\n\n\nMultilingual Support\n--------------------\n\nplone.volto supports multilingual websites.\nInstall PAM before installing this package and demo homepages will be created in each enabled language.\nCurrently only support for EN/DE.\n\n\nVolto Blocks for Plone Site Root\n--------------------------------\n\nplone.volto contains a hack to make the Plone site Volto blocks-enabled with some demo content.\nYou can take only the hack to enable the blocks on your site.\n\nYou can see it in action in the Volto demo: https://6.demo.plone.org\n\nInstall the provided profile to install it by default:\n\n plone.volto:default-homepage\n\ne.g. in your GS ``metadata.xml`` along with your other dependencies::\n\n <metadata>\n <version>1000</version>\n <dependencies>\n <dependency>plone.volto:default-homepage</dependency>\n </dependencies>\n </metadata>\n\n**NOTE**: The default block for creating the default content in the root (or\ncorresponding Language Root Folders) is \"draftJS\" text block. ``plone.volto`` provides a\nprofile if you want to create Slate blocks: you need to use the ``default-homepage-slate``\nprofile.\n\nDocument Content Type\n---------------------\n\nplone.volto disables the ``Richtext`` and ``Table of Contents`` behaviors for the ``Document`` content type.\nRich Text functionality is provided by the new Volto Blocks editor.\nThe ``Table of Contents`` functionality is provided by the ``Table of Contents Block`` in Volto.\n\n\nCORS Profile\n------------\n\nA quick helper for enable CORS for development config is also provided in the\n``plone.volto`` module. So you can call::\n\n <include package=\"plone.volto.cors\" />\n\nfrom your ZCML while developing.\n\nEnable it on demand, since it's considered a security issue if you enable CORS in your\nproductions sites.\n\nIt's planned that Volto will feature a development pass-through proxy to the backend in\nthe future. It will be addressed in next sprints.\n\nZLog Patch\n----------\n\np.restapi low level errors are routed through the ancient ZLog and are ``plone_error``\nenabled, making it difficult to follow since all are marked with a UUID. Specially if\nusing helpers like Sentry. This patch removes the UUID so the same error is categorized\nall together. This is planned to be addressed in next sprints.\n\n\nPatch for ``subject`` Field\n---------------------------\n\nThere are some problems of serialization on special characters derivated from how the\ncurrent shape of the Plone's default Dexterity ``subjects`` field that has to be\naddressed in order to make it work properly with Volto (and other systems that are not\nPlone). This will be fixed in core in upcoming sprints.\n\n\nPreview Image Behavior\n----------------------\n\nThe preview image behavior makes content types provide a preview_image field that can store a preview image that Volto views can pick up.\nThis is especially userful for listings (e.g. listing block customizations) and teaser elements (e.g. teaser blocks such as [volto-blocks-grid](https://github.com/kitconcept/volto-blocks-grid)).\n\nThe \"volto.preview_image behavior can be enabled in the generic setup XML definition of a content type (e.g. \"/profiles/default/types/MyContentType.xml\")::\n\n <?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n <object i18n:domain=\"fzj.internet\" meta_type=\"Dexterity FTI\" name=\"MyContentType\"\n xmlns:i18n=\"http://xml.zope.org/namespaces/i18n\">\n\n ...\n\n <!-- Enabled behaviors -->\n <property name=\"behaviors\" purge=\"false\">\n ...\n <element value=\"volto.preview_image\" />\n </property>\n ...\n </object>\n\n\nNavigation Title Behavior\n-------------------------\n\nThe navigation title makes content types provide a nav_title field that is used by Volto in the main navigation, the breadcrumbs and the navigation portlet.\n\nThe \"volto.navtitle behavior can be enabled in the generic setup XML definition of a content type (e.g. \"/profiles/default/types/MyContentType.xml\")::\n\n <?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n <object i18n:domain=\"fzj.internet\" meta_type=\"Dexterity FTI\" name=\"MyContentType\"\n xmlns:i18n=\"http://xml.zope.org/namespaces/i18n\">\n\n ...\n\n <!-- Enabled behaviors -->\n <property name=\"behaviors\" purge=\"false\">\n ...\n <element value=\"volto.navtitle\" />\n </property>\n ...\n </object>\n\n\nHead Title Behavior\n-------------------\n\nThe headtitle makes content types provide a headtitle field that can be used by Volto in teasers and alikes.\n\nThe \"volto.head_title\" behavior can be enabled in the generic setup XML definition of a content type (e.g. \"/profiles/default/types/MyContentType.xml\")::\n\n <?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n <object i18n:domain=\"fzj.internet\" meta_type=\"Dexterity FTI\" name=\"MyContentType\"\n xmlns:i18n=\"http://xml.zope.org/namespaces/i18n\">\n\n ...\n\n <!-- Enabled behaviors -->\n <property name=\"behaviors\" purge=\"false\">\n ...\n <element value=\"volto.head_title\" />\n </property>\n ...\n </object>\n\n\nImage Scales\n------------\n\nThis package introduces new Plone image scales in Plone and redefines a couple of\nexisting ones. These are know to work well with Volto layout and grid system::\n\n icon 32:32\n tile 64:64\n thumb 128:128\n mini 200:65536\n preview 400:65536\n teaser 600:65536\n large 800:65536\n larger 1000:65536\n great 1200:65536\n huge 1600:65536\n\n**This change is opinionated and may collide with your previously defined ones, so make\nsure your add-on's profiles are applied AFTER this one.**\n\n\nCredits and History\n-------------------\n\n.. image:: https://kitconcept.com/logo.svg\n :width: 150px\n :alt: kitconcept\n :target: https://kitconcept.com/\n\nThe code of plone.volto has been under active development and is used in production since 2018.\nFirst as kitconcept.voltodemo (deprecated since March, 5th 2020), then as kitconcept.volto.\nIn September 2021 kitconcept.volto has been renamed to plone.volto and has been contributed to the Plone core as part of `PLIP #2703\n<https://github.com/plone/Products.CMFPlone/issues/2703>`_.\n\n\nContributors\n============\n\n.. note::\n place names and roles of the people who contribute to this package\n in this file, one to a line, like so, please add your name at the end:\n\n- Timo Stollenwerk, Original Author\n- Victor Fernandez de Alba, Original Author\n- \u00c9rico Andrei\n- Carsten Senger\n- Roberto Diaz\n- Rodrigo Ferreira de Souza\n- Alin Voinea\n\n\nChangelog\n=========\n\n.. You should *NOT* be adding new change log entries to this file.\n You should create a file in the news directory instead.\n For helpful instructions, please see:\n https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst\n\n.. towncrier release notes start\n\n4.0.0a6 (2022-06-25)\n--------------------\n\nBug fixes:\n\n\n- Re-release 4.0.0a5/4.0.0a5.dev0\n [tisto] (#72)\n\n\n4.0.0a5 (2022-06-25)\n--------------------\n\nNew features:\n\n\n- Add form ``@@migrate_richtext`` to migrate ``html-richtext`` to slate blocks or draftjs blocks\n [pbauer] (#47)\n- Add ``@@migrate_to_volto`` to prepare existing sites for Volto.\n [pbauer] (#55)\n\n\nBug fixes:\n\n\n- Update test to 6.0.0a4 and new pip practices.\n [sneridagh] (#51)\n- Conditional custom ``IImageScaleFactory`` adapter for Plone < 6 (svg are now handled in `plone.namedfile <https://github.com/plone/plone.namedfile/commit/b4f80204759703aa812d1db35589cd92e89ea108>`_).\n [cekk] (#60)\n- Fixed code quality configuration.\n Removed unused imports and variables and sorted the imports.\n [maurits] (#71)\n\n\n4.0.0a4 (2022-04-08)\n--------------------\n\n- Fix deprecated import of isDefaultPage\n [pbauer]\n\n4.0.0a3 (2022-02-04)\n--------------------\n\n- Fix Multilingual profile, revert to use draftJS (until slate is integrated into Volto)\n [sneridagh]\n\n\n4.0.0a2 (2022-01-25)\n--------------------\n\n- Bring back the draftJS as default, until Slate is integrated in full in Volto\n [sneridagh]\n\n\n4.0.0a1 (2022-01-25)\n--------------------\n\nBreaking:\n\n- Use Slate blocks for the default pages\n [sneridagh]\n\n- Add ``volto.blocks`` behavior to Plone Site GS types info.\n [sneridagh]\n\n- Remove ``Collection`` from types in GS types info.\n [sneridagh]\n\n- Remove ``plone.richtext`` behavior from Plone Site, Document, News Item, Events\n [sneridagh]\n\n- Add blocks behavior on Event and NewsItem\n [nzambello]\n\n- Add preview_image to Event\n [nzambello]\n\nInternal:\n\n- Code cleanup, remove some outdated and unused helpers in ``setuptools.py``\n [sneridagh]\n\n- Workaround a test fixture isolation issue with the `IVoltoSettings.frontend_domain`\n setting.\n [rpatterson]\n\n\n3.1.0a9 (2022-01-15)\n--------------------\n\nBreaking:\n\n- Remove c.folderishtypes dependency\n\nNew Feature:\n\n- Add new field in the coresandbox: not constrained by vocabulary field but the vocabulary defined in the widget.\n [sneridagh]\n\n\n3.1.0a8 (2022-01-12)\n--------------------\n\n- Computed copyright dates for content demo pages\n [sneridagh]\n\n3.1.0a7 (2021-12-11)\n--------------------\n\nNew Feature:\n\n- Added coresandbox fixture for Volto's cypress tests\n [sneridagh]\n\nInternal:\n\n- Test with Plone 6.0.0a2\n [ericof]\n\n\n3.1.0a6 (2021-11-22)\n--------------------\n\nNew Feature:\n\n- Add Basque and Spanish translations\n [erral]\n\n- Add Italian translations\n [cekk]\n\nBug fix:\n\n- Update German translations\n [timo]\n\n- Fix translation files\n [cekk, timo]\n\n\n3.1.0a5 (2021-11-07)\n--------------------\n\nNew Feature:\n\n- Use new metadata utility for adding the ``image_field`` to the default serialization. This feature requires the JSONSummarySerializerMetadata serializer that has been added with plone.restapi 8.13.0.\n [ericof]\n\nInternal:\n\n- Use plone/setup-plone github action.\n [ericof]\n\n\n3.1.0a4 (2021-10-29)\n--------------------\n\nInternal:\n\n- Initial support and tests using Github Actions for Plone with pip installations.\n [ericof]\n\n3.1.0a3 (2021-10-25)\n--------------------\n\nBreaking:\n\n- Explicitly require Python 3.7 or superior.\n [ericof]\n\nInternal:\n\n- Remove ``jq`` from dependencies and remove old ``blocksremoveserver.py`` script.\n [ericof]\n\n- Remove ``z3c.jbot`` from dependencies\n [ericof]\n\n- Remove ``requests`` from dependencies\n [ericof]\n\n\n3.1.0a2 (2021-10-14)\n--------------------\n\nBug fix:\n\n- Fixed install on Windows, `issue 14 <https://github.com/plone/plone.volto/issues/14>`_.\n [maurits]\n\n\n3.1.0a1 (2021-10-11)\n--------------------\n\nFeature:\n\n- Add new ``image_field`` metadata for image detection in catalog\n [sneridagh]\n\nInternal:\n\n- Add Plone 6.0.0-pre-alpha configuration.\n [tisto]\n\n- Upgrade to Plone 5.2.5\n [tisto]\n\n- Change GS setup profile label to \"Plone 6 Frontend (plone.volto)\".\n [tisto]\n\n\n3.0.0a1 (2021-09-25)\n--------------------\n\nBreaking Change:\n\n- Rename kitconcept.volto to plone.volto.\n [tisto]\n\n\n2.5.3 (2021-09-13)\n------------------\n\n- Fix condition of the guard for the multilingual fixture in the docker image.\n [sneridagh]\n\n\n2.5.2 (2021-09-13)\n------------------\n\n- Fix multilingual fixture for docker image, the guard seems not to work there, for some reason the blocks and blocks_layout are not set yet (?)\n [sneridagh]\n\n2.5.1 (2021-09-12)\n------------------\n\n- \"More agnostic and simplify GS profile for Plone Site definition\" (https://github.com/kitconcept/kitconcept.volto/pull/38)\n [sneridagh]\n\n2.5.0 (2021-09-12)\n------------------\n\n- Support pip-based Plone installation by explicitly including dependencies on configure.zcml\n [ericof]\n\n- Add Lock-Token to default CORS allow_headers\n [avoinea]\n\n- Add guard for not overwrite blocks in default home pages (if PAM enabled) if they are already set\n [sneridagh]\n\n2.4.0 (2021-07-19)\n------------------\n\n- Fix German translation for \"Navigation title\" (\"Navigation titel\" -> \"Navigationstitel\")\n [timo]\n\n- Fix and complete upgrade step from Volto 12 to Volto 13\n [sneridagh]\n\n- Add helper scripts\n [sneridagh]\n\n- Add preview_image to transforms\n [sneridagh]\n\n- Add headtitle behavior\n [sneridagh]\n\n- Guard for setuphandlers disablecontenttype\n [sneridagh]\n\n- Fix audit script\n [sneridagh]\n\n- Add support for subblocks in the custom transforms for ``volto-blocks-grid``\n [sneridagh]\n\n2.3.0 (2021-05-19)\n------------------\n\n- Add upgrade step facility\n- Add upgrade step from Volto 12 to Volto 13\n [sneridagh]\n\n\n2.2.1 (2021-04-21)\n------------------\n\n- Better multilingual profile\n [sneridagh]\n\n\n2.2.0 (2021-04-21)\n------------------\n\n- Add multilingual test fixture for Cypress tests\n [sneridagh]\n\n\n2.1.3 (2021-03-26)\n------------------\n\n- Add ``requests`` as dependency\n [sneridagh]\n\n\n2.1.2 (2021-03-07)\n------------------\n\n- Add a demo home page for demo site\n [sneridagh]\n\n\n2.1.1 (2021-03-06)\n------------------\n\n- Add demo site profile\n [sneridagh]\n\n\n2.1.0 (2021-02-23)\n------------------\n\n- Remove Images and Files from types_use_view_action_in_listings since in Volto it's no used at all.\n [sneridagh]\n\n\n2.0.0 (2021-02-20)\n------------------\n\n- [Breaking] Define good known to work well with Volto image scales in ``registry.xml``\n GenericSetup profile. When this add-on is installed or the profile is applied, it will\n overwrite the existing scales in your Plone site. If you are using specific scales for\n your project, make sure they are installed after this addon's profile.\n\n This scales have been tested in real production projects and work well with Volto's\n layout and responsive viewports.\n [timo, sneridagh]\n\n\n1.7.2 (2021-01-26)\n------------------\n\n- Nothing changed yet.\n\n\n1.7.1 (2021-01-25)\n------------------\n\n- Fix first level tabs and add nav_title to them\n [sneridagh]\n\n\n1.7.0 (2021-01-21)\n------------------\n\n- Add ``breadcrumbs_view`` override to include ``nav_title``\n [sneridagh]\n\n\n1.6.0 (2021-01-14)\n------------------\n\n- Added indexers for `preview_image`, it allows the Volto object browser widget to access it\n [sneridagh]\n\n\n1.5.2 (2020-12-14)\n------------------\n\n- Missing ZCML for translations\n [sneridagh]\n\n\n1.5.1 (2020-12-14)\n------------------\n\n- Add zest.pocompile\n [sneridagh]\n\n- Add missing .mo\n [sneridagh]\n\n\n1.5.0 (2020-12-09)\n------------------\n\n- Fix locales default in German\n [sneridagh]\n\n\n1.4.0 (2020-07-29)\n------------------\n\n- Add volto.preview_image behavior to Page type.\n [timo]\n\n\n1.3.2 (2020-05-17)\n------------------\n\n- Make sure that the enable_pam helper does its job.\n [sneridagh]\n\n\n1.3.1 (2020-05-12)\n------------------\n\n- Fix LRF global allow and ensure default behaviors\n [sneridagh]\n\n\n1.3.0 (2020-05-11)\n------------------\n\n- Add registry navigation setting for not show the current item in navigations\n [sneridagh]\n\n- New enable_pam setuphandlers helper\n [sneridagh]\n\n- New enable_pam_consistency setuphandlers helper\n [sneridagh]\n\n\n1.2.0 (2020-04-17)\n------------------\n\n- Bring back the event type, since it's fully working in Volto now\n [sneridagh]\n\n- fix typo in behavior name ``navttitle`` -> ``navtitle``\n [sneridagh]\n\n\n1.1.0 (2020-03-10)\n------------------\n\n- Added a specific IImageScaleFactory for ``Image`` content type, to fix SVG handling\n [sneridagh]\n\n\n1.0.1 (2020-03-08)\n------------------\n\n- Update version numbers in default home page.\n [sneridagh]\n\n\n1.0.0 (2020-03-06)\n------------------\n\n- Add Zope log patch\n [sneridagh]\n\n- Add nav_title and preview_image behaviors\n [sneridagh]\n\n- override plone.app.vocabularies.Keywords with a version that\n uses the unencode subject value as the token.\n [csenger]\n\n- Remove versioning behavior from Document type.\n [timo]\n\n- Backport all features that were in plone.voltodemo\n [sneridagh]\n\n- Patch Password reset tool in Products.CMFPlone to use the optional volto_domain in the\n e-email which is sent to users, only if the request is made through REST.\n [fredvd]\n\n- Add Volto settings control panel with frontend_domain field.\n [fredvd]\n\n- Homepage profile for demo purposes\n [sneridagh]\n\n- CORS profile\n [sneridagh]\n\n- Enable Volto Blocks for Document and LRF\n [sneridagh]\n\n- Initial release.\n [kitconcept]\n\n\n",
"bugtrack_url": null,
"license": "GPL version 2",
"summary": "Volto integration add-on for Plone",
"version": "4.0.0a6",
"split_keywords": [
"python",
"plone",
"cms"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "ee8905c7416a0556694cc5a37940ab2e",
"sha256": "991288c92823ad2d17de00744961a9c6ce3f39bc0fc02e671e266a2b1c17699f"
},
"downloads": -1,
"filename": "plone.volto-4.0.0a6.tar.gz",
"has_sig": false,
"md5_digest": "ee8905c7416a0556694cc5a37940ab2e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 71961,
"upload_time": "2022-06-25T05:11:22",
"upload_time_iso_8601": "2022-06-25T05:11:22.924966Z",
"url": "https://files.pythonhosted.org/packages/62/8b/44804afbfcf215783b8ffcd7d03828100a27f1927773379e52e2f90f7d52/plone.volto-4.0.0a6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-06-25 05:11:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "plone",
"github_project": "plone.volto",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "setuptools",
"specs": [
[
"==",
"54.0.0"
]
]
},
{
"name": "zc.buildout",
"specs": [
[
"==",
"3.0.0b2"
]
]
},
{
"name": "pip",
"specs": [
[
"==",
"21.0.1"
]
]
},
{
"name": "pywin32",
"specs": []
},
{
"name": "certifi",
"specs": []
}
],
"lcname": "plone.volto"
}
JSON
