Introduction
============
Adds the new HTML-formatable textfield ``richdescription`` content types can use.
There are two behaviors provided:
``collective.richdescription``
The single ``richdescription`` field.
``collective.richdescription.basic``
A drop-in replacement for ``plone.basic``. This is what you usually want: Disable plone Basic and enable this.
``collective.richdescription.optionaltitle``
A special replacement for ``plone.basic``, but with an non-required title. To be used i.e. with file and image.
- When the field is saved, the contents are also stored in the classic dublincore ``description`` field, but without html-formatting.
- A metadata index is provided, so that ``richdescription`` can be read directly from catalog brains.
- A module global ``collective.richdescription.behavior.PATTERN_OPTIONS`` is used to configure the widget,
It comes with a reduced set of features and can be patched if more are needed.
There is no control panel yet (contributions are welcome).
There is **no** ``folder_listing`` or similar template yet.
If you want to have HTML formatted descriptions in ``folder_listing`` use something like this:
.. code-block:: XML
<tal:block
tal:define="item_description item/richdescription|nothing;
item_description python:item_description or item.Description;">
<p class="akaDescription"
tal:condition="item_description"
tal:content="structure item_description">DESCRIPTION</p>
</tal:block>
Warning
=======
Although there are no big issues with this package, use it at your own risk!
The description field wasn't meant to hold HTML data.
People may tend to write long essays in the description field, which is not what you want, probably.
Some use cases require this functionality though, so have fun.
Migration?
==========
There should be no need for a specific migration step.
When no richdescription field is available for a content type, it falls back to the normal description field.
When saving a content type, the richdescription field is set and the catalog's metadata richdescription column is filled.
Compatibility
=============
Tested with Plone 6
Author
======
Johannes Raggam <johannes@raggam.co.at>
Peter Holzer <peter.holzer@agitator.com>
Jens Klein <jk@kleinundaprtner.at>
Source Code and Contributions
=============================
If you want to help with the development (reporting, improvement, update, bug-fixing, ...) of ``collective.richdescription`` this is a great idea!
Please file any issues or ideas for enhancement at the `issue tracker <https://github.com/collective/collective.richdescription/issues>`_.
The code is located in the `github collective <https://github.com/collective/collective.richdescription>`_.
You can clone it or `get access to the github-collective <http://collective.github.com/>`_ and work directly on the project.
Maintainer is Johannes Raggam and the BlueDynamics Alliance developer team.
We appreciate any contribution and if a release is needed to be done on pypi, please just contact one of us `dev@bluedynamics dot com <mailto:dev@bluedynamics.com>`_
Changelog
=========
3.0.2 (2024-01-19)
------------------
- Fix the customized `@@description` view which wasn't applied.
The marker interface for IRichDescription behaviors was recently changed.
This fix shows the applie richdescription view where it is needed.
[thet]
- Configure and cleanup with plone/meta.
[thet]
3.0.1 (2023-10-19)
------------------
- Add textindexer for title and description.
[agitator]
- Update pattern options for tinymce 5.10.2 in Plone 6.
[agitator]
3.0.0 (2022-03-23)
------------------
- Add ``collective.richdescription.title`` as a drop in replacement for ``plone.basic``.
Also add ``collective.richdescription.optionaltitle`` as a variant for file/image.
[jensens]
- Add patchable ``PATTERN_OPTIONS`` global to ``collective.richdescription.behavior`` in order to be able to set reduced options here (default).
[jensens]
- Python 3 compatibility - remove Archetypes support.
[agitator]
2.0 (2014-11-11)
----------------
- Cleaning up.
[jensens]
- Add Dexterity support.
[thet]
- Refactoring.
[thet]
1.0.1 (2014-06-13)
------------------
- Metadata update.
[thet]
1.0 (2012-11-07)
----------------
- Initial release
[thet]
1.0pre
------
- When no description is set, return a BaseUnit as fallback. Fixes
AttributeError, where original_encoding was tried to accessed on a string
value.
[thet]
- Register the skins folder for any theme.
[thet]
- Initial version on 2010-10-05 for sfd.at.
Raw data
{
"_id": null,
"home_page": "https://github.com/collective/collective.richdescription",
"name": "collective.richdescription",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "plone richtext dublincore",
"author": "Johannes Raggam",
"author_email": "raggam-nl@adm.at",
"download_url": "https://files.pythonhosted.org/packages/54/65/ec33ddac104fdea5a2d454960f45fb0cf37230bdddc5d282be22826b7453/collective.richdescription-3.0.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\nAdds the new HTML-formatable textfield ``richdescription`` content types can use.\n\nThere are two behaviors provided:\n\n``collective.richdescription``\n The single ``richdescription`` field.\n\n``collective.richdescription.basic``\n A drop-in replacement for ``plone.basic``. This is what you usually want: Disable plone Basic and enable this.\n\n``collective.richdescription.optionaltitle``\n A special replacement for ``plone.basic``, but with an non-required title. To be used i.e. with file and image.\n\n- When the field is saved, the contents are also stored in the classic dublincore ``description`` field, but without html-formatting.\n- A metadata index is provided, so that ``richdescription`` can be read directly from catalog brains.\n- A module global ``collective.richdescription.behavior.PATTERN_OPTIONS`` is used to configure the widget,\n It comes with a reduced set of features and can be patched if more are needed.\n There is no control panel yet (contributions are welcome).\n\nThere is **no** ``folder_listing`` or similar template yet.\nIf you want to have HTML formatted descriptions in ``folder_listing`` use something like this:\n\n.. code-block:: XML\n\n <tal:block\n tal:define=\"item_description item/richdescription|nothing;\n item_description python:item_description or item.Description;\">\n <p class=\"akaDescription\"\n tal:condition=\"item_description\"\n tal:content=\"structure item_description\">DESCRIPTION</p>\n </tal:block>\n\n\nWarning\n=======\n\nAlthough there are no big issues with this package, use it at your own risk!\nThe description field wasn't meant to hold HTML data.\nPeople may tend to write long essays in the description field, which is not what you want, probably.\nSome use cases require this functionality though, so have fun.\n\n\nMigration?\n==========\n\nThere should be no need for a specific migration step.\nWhen no richdescription field is available for a content type, it falls back to the normal description field.\nWhen saving a content type, the richdescription field is set and the catalog's metadata richdescription column is filled.\n\n\nCompatibility\n=============\n\nTested with Plone 6\n\n\nAuthor\n======\n\nJohannes Raggam <johannes@raggam.co.at>\nPeter Holzer <peter.holzer@agitator.com>\nJens Klein <jk@kleinundaprtner.at>\n\n\nSource Code and Contributions\n=============================\n\nIf you want to help with the development (reporting, improvement, update, bug-fixing, ...) of ``collective.richdescription`` this is a great idea!\n\nPlease file any issues or ideas for enhancement at the `issue tracker <https://github.com/collective/collective.richdescription/issues>`_.\n\nThe code is located in the `github collective <https://github.com/collective/collective.richdescription>`_.\n\nYou can clone it or `get access to the github-collective <http://collective.github.com/>`_ and work directly on the project.\n\nMaintainer is Johannes Raggam and the BlueDynamics Alliance developer team.\nWe appreciate any contribution and if a release is needed to be done on pypi, please just contact one of us `dev@bluedynamics dot com <mailto:dev@bluedynamics.com>`_\n\n\nChangelog\n=========\n\n3.0.2 (2024-01-19)\n------------------\n\n- Fix the customized `@@description` view which wasn't applied.\n The marker interface for IRichDescription behaviors was recently changed.\n This fix shows the applie richdescription view where it is needed.\n [thet]\n\n- Configure and cleanup with plone/meta.\n [thet]\n\n\n3.0.1 (2023-10-19)\n------------------\n\n- Add textindexer for title and description.\n [agitator]\n\n- Update pattern options for tinymce 5.10.2 in Plone 6.\n [agitator]\n\n\n3.0.0 (2022-03-23)\n------------------\n\n- Add ``collective.richdescription.title`` as a drop in replacement for ``plone.basic``.\n Also add ``collective.richdescription.optionaltitle`` as a variant for file/image.\n [jensens]\n\n- Add patchable ``PATTERN_OPTIONS`` global to ``collective.richdescription.behavior`` in order to be able to set reduced options here (default).\n [jensens]\n\n- Python 3 compatibility - remove Archetypes support.\n [agitator]\n\n\n2.0 (2014-11-11)\n----------------\n\n- Cleaning up.\n [jensens]\n\n- Add Dexterity support.\n [thet]\n\n- Refactoring.\n [thet]\n\n1.0.1 (2014-06-13)\n------------------\n\n- Metadata update.\n [thet]\n\n1.0 (2012-11-07)\n----------------\n\n- Initial release\n [thet]\n\n1.0pre\n------\n\n- When no description is set, return a BaseUnit as fallback. Fixes\n AttributeError, where original_encoding was tried to accessed on a string\n value.\n [thet]\n\n- Register the skins folder for any theme.\n [thet]\n\n- Initial version on 2010-10-05 for sfd.at.\n",
"bugtrack_url": null,
"license": "GPLv2",
"summary": "Turns the Plone 'Description' field into Richtext/HTML",
"version": "3.0.2",
"project_urls": {
"Homepage": "https://github.com/collective/collective.richdescription"
},
"split_keywords": [
"plone",
"richtext",
"dublincore"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "063da8571d1d71f6de3edcb70a6f63cf13ba118b33c0b3af8b26b515cfb175f9",
"md5": "7ae6541b6783aa2a9905d182243a06c8",
"sha256": "9b4a9d350c33fcaa2908771163057701521a12543bae7d30267ebb1ae87178be"
},
"downloads": -1,
"filename": "collective.richdescription-3.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7ae6541b6783aa2a9905d182243a06c8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 13725,
"upload_time": "2024-01-18T23:46:42",
"upload_time_iso_8601": "2024-01-18T23:46:42.444891Z",
"url": "https://files.pythonhosted.org/packages/06/3d/a8571d1d71f6de3edcb70a6f63cf13ba118b33c0b3af8b26b515cfb175f9/collective.richdescription-3.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5465ec33ddac104fdea5a2d454960f45fb0cf37230bdddc5d282be22826b7453",
"md5": "1df3cb60aa5bae94d7dc5e5f32429bc4",
"sha256": "d7ca2a64d11332abc1126ff33a1f9d7fb69489809a66225c94b3eb2b70bb1e59"
},
"downloads": -1,
"filename": "collective.richdescription-3.0.2.tar.gz",
"has_sig": false,
"md5_digest": "1df3cb60aa5bae94d7dc5e5f32429bc4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 22540,
"upload_time": "2024-01-18T23:46:43",
"upload_time_iso_8601": "2024-01-18T23:46:43.788401Z",
"url": "https://files.pythonhosted.org/packages/54/65/ec33ddac104fdea5a2d454960f45fb0cf37230bdddc5d282be22826b7453/collective.richdescription-3.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-18 23:46:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "collective",
"github_project": "collective.richdescription",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "collective.richdescription"
}
JSON
