You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Fix broken markdown link in the frontend README caused by a missing
blank line after the badge HTML block
- Complete the frontend installation instructions with the required
`addons` registration
- Add a Usage section describing the keyword control panel
- Add a License section covering both packages
- Split Requirements into backend and frontend
- Add the Cookieplone attribution to the root credits
- Add documentation news fragments for all three towncrier scopes
Refs #3
Copy file name to clipboardExpand all lines: README.md
+64-3Lines changed: 64 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,28 @@
1
-
# Keyword Manager for Plone
1
+
<divalign="center">
2
+
3
+
<h1align="center">Keyword Manager for Plone</h1>
4
+
5
+
</div>
6
+
7
+
<divalign="center">
2
8
3
9
[](https://github.com/plone/cookieplone-templates/)
The **Keyword Manager** is a Plone 6 add-on that lets content editors keep their site's keywords (also called subjects or tags) clean and consistent — without needing developer support. From a dedicated control panel, editors can rename, merge, and delete keywords, and every content item on the site is updated automatically.
8
27
9
28
> [!WARNING]
@@ -27,19 +46,42 @@ The **Keyword Manager** is a Plone 6 add-on that lets content editors keep their
27
46
28
47
## Requirements
29
48
49
+
### Backend
50
+
30
51
- Plone 6.1 or 6.2
31
52
- Python 3.11, 3.12, or 3.13
32
-
- Volto (Plone's React-based frontend)
53
+
54
+
### Frontend
55
+
56
+
- Volto 18 or later (Plone's React-based frontend)
57
+
- Node.js 24
58
+
- pnpm
33
59
-[volto-light-theme](https://github.com/kitconcept/volto-light-theme) (recommended; see warning above)
34
60
35
61
## Installation 🔧
36
62
37
63
1. Frontend package:
38
64
65
+
Add the package to your Volto project.
66
+
39
67
```shell
40
68
pnpm add @kitconcept/volto-keywordmanager
41
69
```
42
70
71
+
Then register it as an add-on in your project's `package.json`.
72
+
73
+
```json
74
+
"addons": [
75
+
"@kitconcept/volto-keywordmanager"
76
+
],
77
+
"dependencies": {
78
+
"@kitconcept/volto-keywordmanager": "*"
79
+
}
80
+
```
81
+
82
+
> [!IMPORTANT]
83
+
> Installing the package without adding it to the `addons` array will not enable the control panel.
84
+
43
85
1. Backend package:
44
86
45
87
```shell
@@ -52,6 +94,14 @@ The **Keyword Manager** is a Plone 6 add-on that lets content editors keep their
52
94
pip install kitconcept.keywordmanager
53
95
```
54
96
97
+
Then install the add-on in your Plone site from the **Add-ons** control panel.
98
+
99
+
## Usage
100
+
101
+
Once installed, the Keyword Manager is available in the Plone site control panel.
102
+
Start by selecting the keyword field you want to manage, then sort, filter, rename, merge, or delete individual keywords.
103
+
Every content item using an affected keyword is updated automatically.
104
+
55
105
## Configuration
56
106
57
107
This package allows for some configuration.
@@ -140,6 +190,15 @@ km = getUtility(IKeywordManager)
140
190
141
191
Contributions are welcome! Please read [CONTRIBUTING.md](./CONTRIBUTING.md).
142
192
193
+
## License
194
+
195
+
This repository contains two packages, each under its own license.
|`@kitconcept/volto-keywordmanager`|[frontend/](./frontend/)| MIT |
201
+
143
202
## Credits and acknowledgements 🙏
144
203
145
204
This add-on is based on code from Products.PloneKeywordManager, adapted and extended for Plone 6 & Volto.
@@ -159,3 +218,5 @@ Building on that foundation, this package was created by the kitconcept GmbH to
159
218
There is an ongoing effort to bring keyword-management functionality into Plone core itself, tracked as [PLIP: Keyword Manager](https://github.com/plone/volto/issues/5300). This add-on is intended as a step toward that goal, a working, up-to-date implementation that can inform (and hopefully eventually be folded into) that core integration. Getting there will require several steps: stabilizing the add-on for Plone 6, gathering community feedback, aligning with the Volto/core UI patterns, and going through the PLIP review process. Contributions and feedback toward that end are welcome.
160
219
161
220
Thanks to Maik Jablonski and everyone who has contributed to Products.PloneKeywordManager over the years for the original work this builds on.
221
+
222
+
Generated using [Cookieplone (2.0.0a3)](https://github.com/plone/cookieplone) and [cookieplone-templates (cda10db)](https://github.com/plone/cookieplone-templates/commit/cda10db886223a9aa9be1b1368484296418bb880) on 2026-05-29 11:44:37.855709. A special thanks to all contributors and supporters!
The backend package for Keyword Manager for Plone — a Plone 6 add-on that lets content editors rename, merge, and delete keywords (subjects/tags) across a site, with all content updated automatically. See also the frontend package [@kitconcept/volto-keywordmanager](https://www.npmjs.com/package/@kitconcept/volto-keywordmanager).
4
28
@@ -144,36 +168,6 @@ km = getUtility(IKeywordManager)
144
168
make install
145
169
```
146
170
147
-
148
-
### Add features using `plonecli` or `bobtemplates.plone`
149
-
150
-
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).
151
-
These markers act as hooks to add all kinds of features through subtemplates, including behaviors, control panels, upgrade steps, or other subtemplates from `bobtemplates.plone`.
152
-
`plonecli` is a command line client for`bobtemplates.plone`, adding autocompletion and other features.
153
-
154
-
To add a feature as a subtemplate to your package, use the following command pattern.
155
-
156
-
```shell
157
-
make add <template_name>
158
-
```
159
-
160
-
For example, you can add a content type to your package with the following command.
161
-
162
-
```shell
163
-
make add content_type
164
-
```
165
-
166
-
You can add a behavior with the following command.
167
-
168
-
```shell
169
-
make add behavior
170
-
```
171
-
172
-
```{seealso}
173
-
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).
174
-
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.
The frontend package for Keyword Manager for Plone — a Plone 6 add-on that lets content editors rename, merge, and delete keywords (subjects/tags) across a site, with all content updated automatically. See also the backend package [kitconcept.keywordmanager](https://pypi.org/project/kitconcept.keywordmanager/).
8
20
9
21
## Features 🔥
@@ -162,3 +174,7 @@ Contributions are welcome! Please read [CONTRIBUTING.md](https://github.com/kitc
162
174
## License
163
175
164
176
The project is licensed under the MIT license.
177
+
178
+
## Credits and acknowledgements 🙏
179
+
180
+
Generated using [Cookieplone (2.0.0a3)](https://github.com/plone/cookieplone) and [cookieplone-templates (cda10db)](https://github.com/plone/cookieplone-templates/commit/cda10db886223a9aa9be1b1368484296418bb880) on 2026-05-29 11:44:37.855709. A special thanks to all contributors and supporters!
0 commit comments