Helper package to setup a RedTurtle's Plone site ready to work with Volto.
Project description
.. 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.
=============== redturtle.volto
This is an helper package that setup a RedTurtle's Plone site ready to work with Volto.
Features
Content-types
- Disabled Collection
- Document, News Item and Event are folderish types (thanks to collective.folderishtypes.dx)
- News Item and Event can only contain Links, Images and Files
- Plone Site is a DX content
- Revert News Item and Event to be non-folderish (collective.folderishtypes.dx makes them folderish)
Blocks
volto.blocks behavior is enabled by default for these content-types:
- Document
- News Item
- Event
Custom blocks transformers
There are custom transformers for serializer and deserializer to better manage resolveuids.
@context-navigation endpoint
plone.restapi's @navigation endpoint always return the navigation tree from the site root.
There is a @context-navigation endpoint that returns the contextual navigation tree:
> curl -i http://localhost:8080/Plone/folder?context-navigation -H 'Accept: application/json'
This is the result::
{
'@id': 'http://localhost:8080/Plone/folder',
'items': [
{'@id': 'http://localhost:8080/Plone/folder/folder-a',
'description': '',
'title': 'Folder A'},
{'@id': 'http://localhost:8080/Plone/folder/folder-b',
'description': '',
'title': 'Folder B'},
{'@id': 'http://localhost:8080/Plone/folder/folder-c',
'description': '',
'title': 'Folder C'}
]
}
By default only first level is shown. You can pass an expand.navigation.depth parameter to set the depth::
> curl -i http://localhost:8080/Plone/folder?context-navigation?expand.navigation.depth=2 -H 'Accept: application/json'
And this is the result::
{
'@id': 'http://localhost:8080/Plone/folder',
'items': [
{
'@id': 'http://localhost:8080/Plone/folder/folder-a',
'description': '',
'items': [
{
'@id': 'http://localhost:8080/Plone/folder/folder-a/folder-aa',
'description': '',
'title': 'Folder AA',
},
{
'@id': 'http://localhost:8080/Plone/folder/folder-a/folder-ab',
'description': '',
'title': 'Folder AB',
},
],
'title': 'Folder A',
},
{
'@id': 'http://localhost:8080/Plone/folder/folder-b',
'description': '',
'title': 'Folder B',
},
{
'@id': 'http://localhost:8080/Plone/folder/folder-c',
'description': '',
'title': 'Folder C',
},
],
}
@site-search endpoint
This endpoint works exactly like @search but take care of types not searchable settings.
@sitemap-settings
Endpoint that returns sitemap settings for anonymous users (that can't access registry entries).
Returns a data structure like this:
{
'depth': 3
}
Keywords vocabulary patch
We copied the patch from kitconcept.volto_ for special characters in keywords vocabulary (used for example in Subjects field).
.. _kitconcept.volto: https://github.com/kitconcept/kitconcept.volto/blob/master/src/kitconcept/volto/vocabularies/subject.py
Fixed dependencies versions
There are some dependencies fixed in setup.py file. When Plone 5.2 will be released, we can remove these:
- waitress >= 1.4.3
- plone.app.contenttypes >= 2.1.6
- plone.rest >= 1.6.1
- plone.dexterity >= 2.9.5
- Products.ZCatalog >= 5.1
- plone.namedfile >= 5.4.0
- Products.PloneHotfix20200121 == 1.0
Installation
Install redturtle.volto by adding it to your buildout::
[buildout]
...
eggs =
redturtle.volto
and then running bin/buildout
Contribute
- Issue Tracker: https://github.com/RedTurtle/redturtle.volto/issues
- Source Code: https://github.com/RedTurtle/redturtle.volto
License
The project is licensed under the GPLv2.
Authors
This product was developed by RedTurtle Technology team.
.. image:: https://avatars1.githubusercontent.com/u/1087171?s=100&v=4 :alt: RedTurtle Technology Site :target: http://www.redturtle.it/
Contributors
- RedTurtle Technology, sviluppo@redturtle.it
Changelog
0.1.6 (unreleased)
- Nothing changed yet.
0.1.5 (2020-10-20)
- Remove resolveuid serializer/deserializer for blocks: now they are integrated in plone.restapi. [cekk]
- Add custom transformers for blocks to handle link in generic blocks. [cekk]
- Enable Editor and Contributor to access Plone vocabularies with restapi. [cekk]
- Add @sitemap-settings endpoint. [cekk]
0.1.4 (2020-07-16)
- Add keywords vocabulary patch. [cekk]
0.1.3 (2020-06-22)
- Added default homepages [nzambello]
- Added blocks behavior to LRF [nzambello]
- Made editable and viewable Plone Site with blocks behavior [nzambello]
- Remove richtext behavior from News Items, Events and Documents. [cekk]
- News Item and Event are folderish and can only contain Links, Images and Files. [cekk]
0.1.2 (2020-05-25)
- Revert to Event and News Item default behaviors. [cekk]
0.1.1 (2020-05-22)
- Install also collective.volto.cookieconsent. [cekk]
0.1.0 (2020-05-22)
- Initial release. [cekk]
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
