collective.volto.blocksfield


Namecollective.volto.blocksfield JSON
Version 2.1.0 PyPI version JSON
download
home_pagehttps://github.com/collective/collective.volto.blocksfield
SummaryField that allows to use blocks instead rich text
upload_time2024-08-09 09:56:00
maintainerNone
docs_urlNone
authorRedTurtle Technology
requires_python>3.6
licenseGPL version 2
keywords python plone
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage
            ============================
collective.volto.blocksfield
============================

Custom z3c.form field that allows to use Volto blocks.

This field can replace RichText fields in your custom content-types.

Features
--------

- store a json object with all blocks informations (data and order)
- restapi serializer/deserializer to manage internal links
- registered custom indexer for `collective.dexteritytextindexer` (if installed)

How to use
----------

Import it and use as a normal field::

    from collective.volto.blocksfield.field import BlocksField

    class IMySchema(Interface):

        my_field = BlocksField(
            title="A field with blocks",
        )


Installation
------------

Install collective.volto.blocksfield by adding it to your buildout::

    [buildout]

    ...

    eggs =
        collective.volto.blocksfield


and then running ``bin/buildout``

You don't need to install it.

TODO
----

- Tests

Contribute
----------

- Issue Tracker: https://github.com/collective/collective.volto.blocksfield/issues
- Source Code: https://github.com/collective/collective.volto.blocksfield


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
=========

2.1.0 (2024-08-09)
------------------
- Add serializers and deserializer for slate blocks.
  [cekk]
- Add indexer for slate blocks.
  [cekk]

2.0.0 (2023-07-03)
------------------

- Drop support for Plone 5.2 and collective.dexteritytextindexer; in Plone6
  we use core functions in plone.app.dexterity.textindexer
  [lucabel]

1.0.3 (2022-05-31)
------------------

- Fix required python version.
  [cekk]

1.0.2 (2022-05-25)
------------------

- add check if value is a dict in SearchableText indexer.
  [eikichi18]


1.0.1 (2021-03-25)
------------------

- Register standard blocks serializers/deserializer for IDexterityContent. Otherwise they don't work.
  [cekk]


1.0.0 (2021-02-24)
------------------

- Initial release.
  [cekk]

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/collective/collective.volto.blocksfield",
    "name": "collective.volto.blocksfield",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">3.6",
    "maintainer_email": null,
    "keywords": "Python Plone",
    "author": "RedTurtle Technology",
    "author_email": "sviluppo@redturtle.it",
    "download_url": "https://files.pythonhosted.org/packages/93/71/eb0b2b4406c5a17fe4e685791418dc2af5825f6ef438d4e0e36c7afecbb5/collective.volto.blocksfield-2.1.0.tar.gz",
    "platform": null,
    "description": "============================\ncollective.volto.blocksfield\n============================\n\nCustom z3c.form field that allows to use Volto blocks.\n\nThis field can replace RichText fields in your custom content-types.\n\nFeatures\n--------\n\n- store a json object with all blocks informations (data and order)\n- restapi serializer/deserializer to manage internal links\n- registered custom indexer for `collective.dexteritytextindexer` (if installed)\n\nHow to use\n----------\n\nImport it and use as a normal field::\n\n    from collective.volto.blocksfield.field import BlocksField\n\n    class IMySchema(Interface):\n\n        my_field = BlocksField(\n            title=\"A field with blocks\",\n        )\n\n\nInstallation\n------------\n\nInstall collective.volto.blocksfield by adding it to your buildout::\n\n    [buildout]\n\n    ...\n\n    eggs =\n        collective.volto.blocksfield\n\n\nand then running ``bin/buildout``\n\nYou don't need to install it.\n\nTODO\n----\n\n- Tests\n\nContribute\n----------\n\n- Issue Tracker: https://github.com/collective/collective.volto.blocksfield/issues\n- Source Code: https://github.com/collective/collective.volto.blocksfield\n\n\nLicense\n-------\n\nThe project is licensed under the GPLv2.\n\nAuthors\n-------\n\nThis product was developed by **RedTurtle Technology** team.\n\n.. image:: https://avatars1.githubusercontent.com/u/1087171?s=100&v=4\n   :alt: RedTurtle Technology Site\n   :target: http://www.redturtle.it/\n\n\nContributors\n============\n\n- RedTurtle Technology, sviluppo@redturtle.it\n\n\nChangelog\n=========\n\n2.1.0 (2024-08-09)\n------------------\n- Add serializers and deserializer for slate blocks.\n  [cekk]\n- Add indexer for slate blocks.\n  [cekk]\n\n2.0.0 (2023-07-03)\n------------------\n\n- Drop support for Plone 5.2 and collective.dexteritytextindexer; in Plone6\n  we use core functions in plone.app.dexterity.textindexer\n  [lucabel]\n\n1.0.3 (2022-05-31)\n------------------\n\n- Fix required python version.\n  [cekk]\n\n1.0.2 (2022-05-25)\n------------------\n\n- add check if value is a dict in SearchableText indexer.\n  [eikichi18]\n\n\n1.0.1 (2021-03-25)\n------------------\n\n- Register standard blocks serializers/deserializer for IDexterityContent. Otherwise they don't work.\n  [cekk]\n\n\n1.0.0 (2021-02-24)\n------------------\n\n- Initial release.\n  [cekk]\n",
    "bugtrack_url": null,
    "license": "GPL version 2",
    "summary": "Field that allows to use blocks instead rich text",
    "version": "2.1.0",
    "project_urls": {
        "Homepage": "https://github.com/collective/collective.volto.blocksfield",
        "PyPI": "https://pypi.python.org/pypi/collective.volto.blocksfield",
        "Source": "https://github.com/collective/collective.volto.blocksfield",
        "Tracker": "https://github.com/collective/collective.volto.blocksfield/issues"
    },
    "split_keywords": [
        "python",
        "plone"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a212177cd24eb52910f2dfeba93fb6fde130be41810477d733fa77efe9d08be9",
                "md5": "21691995c2b068e49a4413958f16c384",
                "sha256": "b79a93c24604c265843bb8348e92091d6548dfaf71798d026dc4c126c6b1a26d"
            },
            "downloads": -1,
            "filename": "collective.volto.blocksfield-2.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "21691995c2b068e49a4413958f16c384",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">3.6",
            "size": 25356,
            "upload_time": "2024-08-09T09:55:58",
            "upload_time_iso_8601": "2024-08-09T09:55:58.498645Z",
            "url": "https://files.pythonhosted.org/packages/a2/12/177cd24eb52910f2dfeba93fb6fde130be41810477d733fa77efe9d08be9/collective.volto.blocksfield-2.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9371eb0b2b4406c5a17fe4e685791418dc2af5825f6ef438d4e0e36c7afecbb5",
                "md5": "af7eab34e1f33772b418f9491fa169a1",
                "sha256": "735022476095efab2818d1bee12cd7bca4f085ccaded4bc564663b5ec81a40c0"
            },
            "downloads": -1,
            "filename": "collective.volto.blocksfield-2.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "af7eab34e1f33772b418f9491fa169a1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">3.6",
            "size": 23142,
            "upload_time": "2024-08-09T09:56:00",
            "upload_time_iso_8601": "2024-08-09T09:56:00.234387Z",
            "url": "https://files.pythonhosted.org/packages/93/71/eb0b2b4406c5a17fe4e685791418dc2af5825f6ef438d4e0e36c7afecbb5/collective.volto.blocksfield-2.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-09 09:56:00",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "collective",
    "github_project": "collective.volto.blocksfield",
    "travis_ci": true,
    "coveralls": true,
    "github_actions": false,
    "requirements": [],
    "lcname": "collective.volto.blocksfield"
}
        
Elapsed time: 3.43803s