Skip to content

Commit 4ee8092

Browse files
jensensstevepiercy
andauthored
Apply suggestions from code review
Co-authored-by: Steve Piercy <[email protected]>
1 parent 90dadcc commit 4ee8092

File tree

1 file changed

+38
-23
lines changed

1 file changed

+38
-23
lines changed

docs/backend/portal-actions.md

Lines changed: 38 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -24,52 +24,58 @@ Portal actions are typically displayed in the site's navigation menu or toolbar
2424
Portal actions are managed using the {guilabel}`Portal Actions` control panel in Plone.
2525
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.
2626

27+
```{note}
28+
We use the terms "Portal actions" and "Actions" in this documentation to mean the same thing.
29+
```
30+
2731
## Anatomy of a Portal action
2832

2933
A portal action in Plone consists of a few settings, including the category, title, description, URL, and control parameters.
3034

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.
3236
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.
3640

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.
3842
This can be an internal page on your site or an external page on another website.
3943

40-
The "Condition" controls whether to show the action or not.
44+
The {guilabel}`Condition` controls whether to show the action or not.
4145

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`.
4348

44-
The permissions chosen also control the visibility of an action.
49+
The {guilabel}`Permissions` chosen also control the visibility of an action.
4550

46-
Visibility can be used to hide actions.
51+
The {guilabel}`Visible?` setting can be used to show or hide actions.
4752
This can be handy to disable default actions or temporarily disable actions.
4853

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`.
5055

5156
Together, these components make up a portal action in Plone.
5257

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.
5459

5560
## Action categories
5661

57-
Several different action categories are used for different purposes.
62+
Several action categories are used for different purposes.
5863
These categories include:
5964

6065
Object Actions
61-
: `Actions that are available when viewing a specific content item.`
66+
: Actions that are available when viewing a specific content item.
6267

6368
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+
6571
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.
6773

6874
Site Actions
69-
: `Actions that are available on every page of your site`
75+
: Actions that are available on every page of your site.
7076

7177
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.
7379

7480
Each of these action categories serves a different purpose and is intended for use in specific areas of the site.
7581
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.
@@ -86,15 +92,24 @@ See issue [Backend > missing chapter Expressions needs content](https://github.c
8692

8793
## Adding or editing portal actions
8894

89-
To add or edit portal actions, you can use the Portal Actions control panel.
90-
To access this, log in to your Plone site as a user with the appropriate permissions, and then go to the {guilabel}`Site Setup` page.
91-
From there, click on the {guilabel}`Portal Actions` link in the {guilabel}`Plone Configuration` section.
95+
To add or edit portal actions, you can use the {guilabel}`Portal actions` control panel.
96+
To access this, log in to your Plone site as a user with the appropriate permissions.
97+
Then select the menu item {menuselection}`[username] > Site Setup`.
98+
From there, click on the {guilabel}`Actions` link in the {guilabel}`General` section.
99+
You can also select {menuselection}`General > Actions` from the Site Setup or any other control panel.
100+
101+
Once you are on the {guilabel}`Portal actions` control panel, you will see a list of all the existing portal actions for your site.
102+
To inspect or edit an existing action's settings, click its {guilabel}`Edit` button.
103+
104+
[insert screenshot from Steve here]
92105

93-
Once you are on the "Actions" control panel, you will see a list of all the existing portal actions for your site.
94106
To add a new action, click on the {guilabel}`Add new action` button at the top of the page.
95-
This will open a form where you can enter the details for your new action, such as the action name, URL, and any additional parameters.
107+
This will open a form where you can enter select its category and enter an arbitrary ID.
108+
Click the {guilabel}`Add` button to add the action.
109+
The new action should now appear in the actions listing under the selected category.
110+
You can now edit its settings by clicking its {guilabel}`Edit` button.
96111

97-
To edit an existing action, click on the action name in the list to open the action's details page.
112+
To edit an existing action's settings, click its {guilabel}`Edit` button.
98113
From there, you can edit the action's properties, such as the name, URL, and parameters.
99114

100115
It's important to note that the ability to add or edit portal actions is only available to users with the appropriate permissions.

0 commit comments

Comments
 (0)