{"id":21029862,"url":"https://github.com/kitconcept/kitconcept.volto","last_synced_at":"2025-05-15T11:32:19.531Z","repository":{"id":40303293,"uuid":"175609810","full_name":"kitconcept/kitconcept.volto","owner":"kitconcept","description":"Backend configuration for Volto","archived":false,"fork":false,"pushed_at":"2022-10-07T07:50:23.000Z","size":42233,"stargazers_count":2,"open_issues_count":10,"forks_count":4,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-05-11T12:11:33.465Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kitconcept.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.rst","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-03-14T11:38:03.000Z","updated_at":"2024-08-14T17:00:04.000Z","dependencies_parsed_at":"2022-08-09T16:51:44.298Z","dependency_job_id":null,"html_url":"https://github.com/kitconcept/kitconcept.volto","commit_stats":null,"previous_names":[],"tags_count":40,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fkitconcept.volto","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fkitconcept.volto/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fkitconcept.volto/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fkitconcept.volto/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kitconcept","download_url":"https://codeload.github.com/kitconcept/kitconcept.volto/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254330806,"owners_count":22053052,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T12:14:44.864Z","updated_at":"2025-05-15T11:32:14.519Z","avatar_url":"https://github.com/kitconcept.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. 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==============================================================================\nkitconcept.volto\n==============================================================================\n\n.. image:: https://kitconcept.com/logo.svg\n   :alt: kitconcept\n   :target: https://kitconcept.com/\n\n\n.. image:: https://github.com/kitconcept/kitconcept.volto/workflows/Basic%20tests/badge.svg\n    :target: https://github.com/kitconcept/kitconcept.volto/actions?query=workflow%3A%22Basic+tests%22\n\nkitconcept.volto is a helper package to set up a Plone site to use with Volto. It\ninstalls several convenience packages, Plone configurations and patches to prepare Plone\nto be ready for support all the Volto features. Drop it in your buildout and then\ninstall it. It is used in Volto development itself for testing it.\n\nIf you want, take it as base of your own integration package.\n\nUsage\n=====\n\nhttps://github.com/plone/volto/blob/master/api/base.cfg#L13\n\nand along with plonesite recipe:\n\nhttps://github.com/plone/volto/blob/master/api/base.cfg#L13\n\nCompatibility\n=============\n\nVolto requires specific versions of kitconcept.volto and plone.restapi:\n\n+---------+------------------------+-----------------------+\n|         |  kitconcept.volto      |  plone.restapi        |\n+---------+------------------------+-----------------------+\n|         |  1.x                   |  6.0.0 and below      |\n+---------+------------------------+-----------------------+\n|         |  2.x                   |  7.0.0 and above      |\n+---------+------------------------+-----------------------+\n\nplone.restapi 7.0.0 is included in Plone 5.3.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. \nVolto only supports the latest plone.restapi branch, therefore it is recommended to always use the latest version in your Volto projects.\n\nFeatures\n========\n\nkitconcept.volto provides the following features:\n\nDemo home page and Plone site blocks support\n--------------------------------------------\n\nIt features a hack to make the Plone site Volto blocks-enabled with some demo\ncontent. You can take only the hack to enable the blocks on your site.\n\nYou can see it in action in the Volto demo: https://volto.kitconcept.com\n\nInstall the provided profile to install it by default:\n\n  kitconcept.volto:default-homepage\n\ne.g. in your GS ``metadata.xml`` along with your other dependencies::\n\n  \u003cmetadata\u003e\n  \u003cversion\u003e1000\u003c/version\u003e\n  \u003cdependencies\u003e\n    \u003cdependency\u003ekitconcept.volto:default-homepage\u003c/dependency\u003e\n  \u003c/dependencies\u003e\n  \u003c/metadata\u003e\n\nVolto Blocks Support\n--------------------\n\nIt enables the Volto Blocks behavior on the ``Document`` content type by default, enabling Volto editor for that content type.\n\nJust use the same pattern to enable your own content types to have blocks.\n\nDocument content type\n---------------------\n\n``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.\n\nCORS profile\n------------\n\nA quick helper for enable CORS for development config is also provided in the\n``kitconcept.volto`` module. So you can call::\n\n  \u003cinclude package=\"kitconcept.volto.cors\" /\u003e\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\nPatch fix for Plone ``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\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   \u003c?xml version=\"1.0\" encoding=\"UTF-8\" ?\u003e\n   \u003cobject i18n:domain=\"fzj.internet\" meta_type=\"Dexterity FTI\" name=\"MyContentType\"\n     xmlns:i18n=\"http://xml.zope.org/namespaces/i18n\"\u003e\n\n     ...\n\n     \u003c!-- Enabled behaviors --\u003e\n     \u003cproperty name=\"behaviors\" purge=\"false\"\u003e\n       ...\n       \u003celement value=\"volto.preview_image\" /\u003e\n     \u003c/property\u003e\n     ...\n   \u003c/object\u003e\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   \u003c?xml version=\"1.0\" encoding=\"UTF-8\" ?\u003e\n   \u003cobject i18n:domain=\"fzj.internet\" meta_type=\"Dexterity FTI\" name=\"MyContentType\"\n     xmlns:i18n=\"http://xml.zope.org/namespaces/i18n\"\u003e\n\n     ...\n\n     \u003c!-- Enabled behaviors --\u003e\n     \u003cproperty name=\"behaviors\" purge=\"false\"\u003e\n       ...\n       \u003celement value=\"volto.navtitle\" /\u003e\n     \u003c/property\u003e\n     ...\n   \u003c/object\u003e\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   \u003c?xml version=\"1.0\" encoding=\"UTF-8\" ?\u003e\n   \u003cobject i18n:domain=\"fzj.internet\" meta_type=\"Dexterity FTI\" name=\"MyContentType\"\n     xmlns:i18n=\"http://xml.zope.org/namespaces/i18n\"\u003e\n\n     ...\n\n     \u003c!-- Enabled behaviors --\u003e\n     \u003cproperty name=\"behaviors\" purge=\"false\"\u003e\n       ...\n       \u003celement value=\"volto.head_title\" /\u003e\n     \u003c/property\u003e\n     ...\n   \u003c/object\u003e\n\nVolto blocks enabled LRF\n------------------------\n\nMultilingual support for LRF (Language Root Folders) is supported. Install PAM before\ninstalling this package and demo homepages will be created in each enabled language.\nCurrently only support for EN/DE.\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\nVersions compatibility\n----------------------\n\nkitconcept.voltodemo is deprecated in favor of this package as of since March, 5th 2020.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitconcept%2Fkitconcept.volto","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkitconcept%2Fkitconcept.volto","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitconcept%2Fkitconcept.volto/lists"}