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
Copy file name to clipboardExpand all lines: docs/backend/portal-actions.md
+38-23Lines changed: 38 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,52 +24,58 @@ Portal actions are typically displayed in the site's navigation menu or toolbar
24
24
Portal actions are managed using the {guilabel}`Portal Actions` control panel in Plone.
25
25
This control panel allows you to add, edit, and delete actions, as well as organize them into categories and control where they are available on your site.
26
26
27
+
```{note}
28
+
We use the terms "Portal actions" and "Actions" in this documentation to mean the same thing.
29
+
```
30
+
27
31
## Anatomy of a Portal action
28
32
29
33
A portal action in Plone consists of a few settings, including the category, title, description, URL, and control parameters.
30
34
31
-
The action title is the text that is displayed for the action in the site's navigation menu or toolbar.
35
+
The action {guilabel}`Title` is the text that is displayed for the action in the site's navigation menu or toolbar.
32
36
This text should be descriptive and indicate what the action does.
33
-
The description is used as an additional text shown when hovering over the link.
34
-
The title and description can be translated using the translation system of Plone.
35
-
Therefore the i18n domain can be set here.
37
+
The {guilabel}`Description` is used as an additional text shown when hovering over the link.
38
+
The {guilabel}`Title` and {guilabel}`Description` can be translated using the translation system of Plone.
39
+
Therefore the {guilabel}`I18n domain` can be set here.
36
40
37
-
The Action URL is the address of the page or feature that the action will access when it is clicked.
41
+
The {guilabel}`Action URL` is the address of the page or feature that the action will access when it is clicked.
38
42
This can be an internal page on your site or an external page on another website.
39
43
40
-
The "Condition" controls whether to show the action or not.
44
+
The {guilabel}`Condition` controls whether to show the action or not.
41
45
42
-
You can use expressions in the URL of an action to make the action more dynamic and flexible. Expressions are also used for the "Condition".
46
+
You can use expressions in the URL of an action to make the action more dynamic and flexible.
47
+
Expressions are also used for the {guilabel}`Condition`.
43
48
44
-
The permissions chosen also control the visibility of an action.
49
+
The {guilabel}`Permissions` chosen also control the visibility of an action.
45
50
46
-
Visibility can be used to hide actions.
51
+
The {guilabel}`Visible?` setting can be used to show or hide actions.
47
52
This can be handy to disable default actions or temporarily disable actions.
48
53
49
-
The "Position" is used to order action within their category and is numbered starting with "1".
54
+
The {guilabel}`Position` setting is used to order actions within their category, and is numbered starting with `1`.
50
55
51
56
Together, these components make up a portal action in Plone.
52
57
53
-
You can use the "Portal Actions" control panel to manage and organize your site's actions.
58
+
You can use the {guilabel}`Portal actions` control panel to manage and organize your site's actions.
54
59
55
60
## Action categories
56
61
57
-
Several different action categories are used for different purposes.
62
+
Several action categories are used for different purposes.
58
63
These categories include:
59
64
60
65
Object Actions
61
-
: `Actions that are available when viewing a specific content item.`
66
+
: Actions that are available when viewing a specific content item.
62
67
63
68
Object Buttons
64
-
: `Actions that are displayed as buttons when viewing a specific content item.`
69
+
: Actions that are displayed as buttons when viewing a specific content item.
70
+
65
71
Portal Tabs
66
-
: `Actions that are displayed as tabs on the top of the page.`
72
+
: Actions that are displayed as tabs on the top of the page.
67
73
68
74
Site Actions
69
-
: `Actions that are available on every page of your site`
75
+
: Actions that are available on every page of your site.
70
76
71
77
User Actions
72
-
: `Actions that are available to users when they are logged in to your site`
78
+
: Actions that are available to users when they are logged in to your site.
73
79
74
80
Each of these action categories serves a different purpose and is intended for use in specific areas of the site.
75
81
For example, object actions are intended for actions that are specific to a particular content item, while site actions are intended for actions that are available on every page of your site.
0 commit comments