| Name | collective-collectionepilog JSON |
| Version |
0.1.0a6
JSON |
| download |
| home_page | None |
| Summary | Provides a behavior for collections to add epilog RichText field under the collection results. |
| upload_time | 2025-07-23 13:33:33 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | None |
| keywords |
cms
plone
python
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# collective.collectionepilog
Provides a behavior for collections to add epilog RichText field under the collection results.
The content of the epilog will be added to the collection views via `collection-epilog` viewlet below the content.
## Installation
Install collective.collectionepilog with
`pip`:
```shell
pip install collective.collectionepilog
```
or `uv`:
```shell
uv add collective.collectionepilog
```
## Contribute
- [Issue tracker](https://github.com/collective/collective.collectionepilog/issues)
- [Source code](https://github.com/collective/collective.collectionepilog/)
### Prerequisites ✅
- An [operating system](https://6.docs.plone.org/install/create-project-cookieplone.html#prerequisites-for-installation) that runs all the requirements mentioned.
- [uv](https://6.docs.plone.org/install/create-project-cookieplone.html#uv)
- [Git](https://6.docs.plone.org/install/create-project-cookieplone.html#git)
### Development 🔧
1. Clone this repository, then change your working directory.
```shell
git clone git@github.com:collective/collective.collectionepilog
cd collective.collectionepilog
```
### Add features using `plonecli` or `bobtemplates.plone`
This package provides markers as strings (`<!-- extra stuff goes here -->`) that are compatible with [`plonecli`](https://github.com/plone/plonecli) and [`bobtemplates.plone`](https://github.com/plone/bobtemplates.plone).
These markers act as hooks to add all kinds of subtemplates, including behaviors, control panels, upgrade steps, or other subtemplates from `plonecli`.
To run `plonecli` with configuration to target this package, run the following command.
```shell
plonecli add <template_name>
```
For example, you can add a content type to your package with the following command.
```shell
plonecli add content_type
```
You can add a behavior with the following command.
```shell
plonecli add behavior
```
```{seealso}
You can check the list of available subtemplates in the [`bobtemplates.plone` `README.md` file](https://github.com/plone/bobtemplates.plone/?tab=readme-ov-file#provided-subtemplates).
See also the documentation of [Mockup and Patternslib](https://6.docs.plone.org/classic-ui/mockup.html) for how to build the UI toolkit for Classic UI.
```
## License
The project is licensed under GPLv2.
## Credits and acknowledgements 🙏
A special thanks to all contributors and supporters!
Raw data
{
"_id": null,
"home_page": null,
"name": "collective-collectionepilog",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "CMS, Plone, Python",
"author": null,
"author_email": "\"Maik Derstappen - md@derico.de\" <md@derico.de>",
"download_url": "https://files.pythonhosted.org/packages/df/3f/ed68fe0ef3852fbb6184c8144dcc8731d84aca72449eb454a4436a1d8c35/collective_collectionepilog-0.1.0a6.tar.gz",
"platform": null,
"description": "# collective.collectionepilog\n\nProvides a behavior for collections to add epilog RichText field under the collection results.\nThe content of the epilog will be added to the collection views via `collection-epilog` viewlet below the content.\n\n## Installation\n\nInstall collective.collectionepilog with\n\n`pip`:\n\n```shell\npip install collective.collectionepilog\n```\n\nor `uv`:\n\n```shell\nuv add collective.collectionepilog\n```\n\n## Contribute\n\n- [Issue tracker](https://github.com/collective/collective.collectionepilog/issues)\n- [Source code](https://github.com/collective/collective.collectionepilog/)\n\n### Prerequisites \u2705\n\n- An [operating system](https://6.docs.plone.org/install/create-project-cookieplone.html#prerequisites-for-installation) that runs all the requirements mentioned.\n- [uv](https://6.docs.plone.org/install/create-project-cookieplone.html#uv)\n- [Git](https://6.docs.plone.org/install/create-project-cookieplone.html#git)\n\n### Development \ud83d\udd27\n\n1. Clone this repository, then change your working directory.\n\n ```shell\n git clone git@github.com:collective/collective.collectionepilog\n cd collective.collectionepilog\n ```\n\n\n### Add features using `plonecli` or `bobtemplates.plone`\n\nThis package provides markers as strings (`<!-- extra stuff goes here -->`) that are compatible with [`plonecli`](https://github.com/plone/plonecli) and [`bobtemplates.plone`](https://github.com/plone/bobtemplates.plone).\nThese markers act as hooks to add all kinds of subtemplates, including behaviors, control panels, upgrade steps, or other subtemplates from `plonecli`.\n\nTo run `plonecli` with configuration to target this package, run the following command.\n\n```shell\nplonecli add <template_name>\n```\n\nFor example, you can add a content type to your package with the following command.\n\n```shell\nplonecli add content_type\n```\n\nYou can add a behavior with the following command.\n\n```shell\nplonecli add behavior\n```\n\n```{seealso}\nYou can check the list of available subtemplates in the [`bobtemplates.plone` `README.md` file](https://github.com/plone/bobtemplates.plone/?tab=readme-ov-file#provided-subtemplates).\nSee also the documentation of [Mockup and Patternslib](https://6.docs.plone.org/classic-ui/mockup.html) for how to build the UI toolkit for Classic UI.\n```\n\n## License\n\nThe project is licensed under GPLv2.\n\n## Credits and acknowledgements \ud83d\ude4f\n\nA special thanks to all contributors and supporters!\n",
"bugtrack_url": null,
"license": null,
"summary": "Provides a behavior for collections to add epilog RichText field under the collection results.",
"version": "0.1.0a6",
"project_urls": {
"Homepage": "https://github.com/collective/collective.collectionepilog",
"PyPI": "https://pypi.org/project/collective.collectionepilog",
"Source": "https://github.com/collective/collective.collectionepilog",
"Tracker": "https://github.com/collective/collective.collectionepilog/issues"
},
"split_keywords": [
"cms",
" plone",
" python"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "70547e3e7559cbe7866781b4a727ef49bc06490ddb8d9ab5655d9283429ef0b3",
"md5": "169bffb8e0e745b46781450bacf591ee",
"sha256": "0e97273c6e7341641decd6c407ad944e08e14af06b3c2093526b2c28ce3e62d6"
},
"downloads": -1,
"filename": "collective_collectionepilog-0.1.0a6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "169bffb8e0e745b46781450bacf591ee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 28499,
"upload_time": "2025-07-23T13:33:31",
"upload_time_iso_8601": "2025-07-23T13:33:31.723769Z",
"url": "https://files.pythonhosted.org/packages/70/54/7e3e7559cbe7866781b4a727ef49bc06490ddb8d9ab5655d9283429ef0b3/collective_collectionepilog-0.1.0a6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "df3fed68fe0ef3852fbb6184c8144dcc8731d84aca72449eb454a4436a1d8c35",
"md5": "8d2e4ee49d40dff91b62048520559576",
"sha256": "38f7b80affdcda78292b5829e2fdc518ed7a8e1e58881fd2d0eb3d7941a6049b"
},
"downloads": -1,
"filename": "collective_collectionepilog-0.1.0a6.tar.gz",
"has_sig": false,
"md5_digest": "8d2e4ee49d40dff91b62048520559576",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 141577,
"upload_time": "2025-07-23T13:33:33",
"upload_time_iso_8601": "2025-07-23T13:33:33.452619Z",
"url": "https://files.pythonhosted.org/packages/df/3f/ed68fe0ef3852fbb6184c8144dcc8731d84aca72449eb454a4436a1d8c35/collective_collectionepilog-0.1.0a6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-23 13:33:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "collective",
"github_project": "collective.collectionepilog",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "collective-collectionepilog"
}
