Skip to content

Commit 8ade56c

Browse files
committed
add viewlet managers with assigned viewlets, add note how to move viewlet to another manager
1 parent 79dd578 commit 8ade56c

File tree

1 file changed

+51
-10
lines changed

1 file changed

+51
-10
lines changed

docs/classic-ui/viewlets.md

Lines changed: 51 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,26 +27,58 @@ Similar to Views, Viewlets are usually a combination of:
2727
.. graphviz::
2828
:align: center
2929
30-
digraph viewstructure {
30+
digraph viewletstructure {
3131
{
3232
node [margin=5,shape=box]
3333
}
3434
ZCML -> {Python, Template};
3535
}
3636
```
3737

38+
3839
Each viewlet is associated with a {ref}`classic-ui-viewlets-viewletmanager-label`.
3940

40-
Common viewlet managers are:
41+
Common viewlet managers and it's viewlets are:
42+
43+
- **plone.abovecontent**
44+
45+
- plone.path_bar
46+
- plone.lockinfo
47+
48+
- **plone.globalstatusmessage**
49+
50+
- plone.globalstatusmessage
51+
52+
- **plone.abovecontenttitle**
53+
54+
- plone.socialtags
55+
- contentleadimage
56+
57+
- **plone.belowcontenttitle**
58+
59+
- plone.documentbyline
60+
61+
- **plone.abovecontentbody**
62+
63+
- plone.tableofcontents
64+
65+
- **plone.belowcontentbody**
66+
67+
- plone.contributors
68+
- plone.rights
69+
- plone.keywords
70+
- plone.relateditems
71+
72+
- **plone.belowcontent**
73+
74+
- plone.documentactions
75+
- plone.nextprevious
76+
- plone.comments
77+
78+
- **plone.toolbar**
79+
80+
- plone.contentviews
4181

42-
- plone.abovecontent
43-
- plone.globalstatusmessage
44-
- plone.abovecontenttitle
45-
- plone.belowcontenttitle
46-
- plone.abovecontentbody
47-
- plone.belowcontentbody
48-
- plone.belowcontent
49-
- plone.toolbar
5082

5183
To get an overview of all `viewlet manager` and Viewlets in the current context, you can use the `@@manage-viewlets` view.
5284

@@ -89,6 +121,14 @@ To set the order of a viewlet inside it's viewlet manager, use the following `Ge
89121
</order>
90122
```
91123

124+
```{note}
125+
You cannot move viewlets between viewlet managers.
126+
Hide the concerning viewlets in one manager using /@@manage-viewlets and viewlets.xml
127+
export, then re-register the same viewlet to a new manager.
128+
You also have to change the {ref}`classic-ui-viewlets-viewletmanager-label` class in the ``ZCML`` registration of the viewlet.
129+
See {ref}`classic-ui-viewlets-registering-viewlet-zcml-label`.
130+
```
131+
92132
### Hiding viewlets
93133

94134
Hiding a viewlet is also done from the `viewlets.xml` with the `<hidden />` node which is at same level as `<order />`, and is done per skin selection.
@@ -246,6 +286,7 @@ Then a sample page template (like.pt). You can use TAL template variable *view*
246286
</iframe>
247287
```
248288

289+
(classic-ui-viewlets-registering-viewlet-zcml-label)=
249290

250291
### Registering a viewlet using ZCML
251292

0 commit comments

Comments
 (0)