Package: collective.richdescription
IntroductionAdds the new HTML-formatable textfieldrichdescriptioncontent types can use.There are two behaviors provided:collective.richdescriptionThe singlerichdescriptionfield.collective.richdescription.basicA drop-in replacement forplone.basic. This is what you usually want: Disable plone Basic and enable this.collective.richdescription.optionaltitleA special replacement forplone.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 dublincoredescriptionfield, but without html-formatting.A metadata index is provided, so thatrichdescriptioncan be read directly from catalog brains.A module globalcollective.richdescription.behavior.PATTERN_OPTIONSis 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 isnofolder_listingor similar template yet.
If you want to have HTML formatted descriptions infolder_listinguse something like this:<tal:blocktal:define="item_description item/richdescription|nothing;
              item_description python:item_description or item.Description;"><pclass="akaDescription"tal:condition="item_description"tal:content="structure item_description">DESCRIPTION</p></tal:block>WarningAlthough 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.CompatibilityTested with Plone 6AuthorJohannes Raggam <johannes@raggam.co.at>
Peter Holzer <peter.holzer@agitator.com>
Jens Klein <jk@kleinundaprtner.at>Source Code and ContributionsIf you want to help with the development (reporting, improvement, update, bug-fixing, …) ofcollective.richdescriptionthis is a great idea!Please file any issues or ideas for enhancement at theissue tracker.The code is located in thegithub collective.You can clone it orget access to the github-collectiveand 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 usdev@bluedynamics dot comChangelog3.0.2 (2024-01-19)Fix the customized@@descriptionview 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)Addcollective.richdescription.titleas a drop in replacement forplone.basic.
Also addcollective.richdescription.optionaltitleas a variant for file/image.
[jensens]Add patchablePATTERN_OPTIONSglobal tocollective.richdescription.behaviorin 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.0preWhen 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.