Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added aria-live='polite' to results table. #5636

Closed
wants to merge 11 commits into from
6 changes: 3 additions & 3 deletions docs/source/client/actions/actions.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Actions

Plone has the concept of configurable actions called `portal_actions`.
Plone has the idea of configurable actions called `portal_actions`.
Each action defines an `id`, a `title`, the required permissions, and a condition that will be checked to decide whether the action will be available for a user.
Actions are sorted by categories.

Actions can be used to build user interface elements that adapt to the available actions.
An example is the Plone toolbar where the `object_tabs` (view, edit, folder contents, sharing) and the `user_actions` (login, logout, preferences) are used to display to the user only those actions that are allowed for the currently logged in user.
Plone's toolbar displays permissible actions like `object_tabs` (view, edit, folder contents, sharing) and `user_actions` (login, logout, preferences) for the logged-in user's access.

The available actions for the currently logged in user can be retrieved by calling the `@actions` endpoint on a specific context.
This also works for unauthenticated users.

## Get Actions
## Get actions

### Query function

Expand Down
12 changes: 6 additions & 6 deletions docs/source/client/actions/addons.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Add-ons

Add-on product records can be addressed through the `@addons` endpoint in a Plone site.
In order to address a specific record, the profile ID has to be passed as a path segment, such as `/plone/@addons/plone.session`.
To address a specific record, the profile ID has to be passed as a path segment, such as `/plone/@addons/plone.session`.

Reading or writing add-ons metadata requires the `cmf.ManagePortal` permission.

Expand All @@ -27,7 +27,7 @@ Use the `useGetAddon` hook to get an add-on at a given path.

### Parameters

- **addonId**: string
- **`addonId`**: string

- **Required**: Yes

Expand All @@ -43,7 +43,7 @@ Use the `useInstallAddon` hook to install an add-on at a given path.

### Parameters

- **addonId**: string
- **`addonId`**: string

- **Required**: Yes

Expand All @@ -59,7 +59,7 @@ Use the `useUninstallAddon` hook to uninstall an add-on at a given path.

### Parameters

- **addonId**: string
- **`addonId`**: string

- **Required**: Yes

Expand All @@ -75,7 +75,7 @@ Use the `useInstallProfileAddon` hook to install an add-on profile at a given pa

### Parameters

- **addonId**: string
- **`addonId`**: string

- **Required**: Yes

Expand All @@ -95,6 +95,6 @@ Use the `useUpgradeAddon` hook to upgrade an add-on at a given path.

### Parameters

- **addonId**: string
- **`addonId`**: string

- **Required**: Yes
134 changes: 37 additions & 97 deletions docs/source/client/actions/aliases.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,124 +2,64 @@

A mechanism to redirect old URLs to new ones.

When an object is moved (renamed or cut/pasted into a different location), the redirection storage will remember the old path. It is smart enough to deal with transitive references (if we have a -> b and then add b -> c, it is replaced by a reference a -> c) and circular references (attempting to add a -> a does nothing).
When an object is moved (renamed or cut-and-pasted into a different location), the redirection storage will remember the old path.
It handles transitive references intelligently (for example a -> b, b -> c becomes a -> c), ignoring circular ones (for example attempting a -> a has no effect).

## Get Aliases List
## Get aliases list

### Query function
```{js:function} getAliasesListQuery

Use the `getAliasesListQuery` function to get the query for fetching the aliases list.

### Hook
:hook: `useGetAliasesList`
```

Use the `useGetAliasesList` hook to get the aliases list.
## Get aliases

## Get Aliases

### Query function
```{js:function} getAliasesQuery(path)

Use the `getAliasesQuery` function to get the query for fetching the aliases for a page.

### Hook

Use the `useGetAliases` hook to get the aliases for a page.

### Parameters

- **path**: string

- **Required:** Yes

## Add Aliases for Multiple Pages

### Mutation function

Use the `createAliasesMutation` function to get the mutation for adding aliases for multiple pages.

### Hook

Use the `useCreateAliases` hook to add aliases for multiple pages.
:arg string path: Description of the `path` parameter.
:hook: `useGetAliases`
```

### Parameters
## Add aliases for many pages

- **data**: object
```{js:function} createAliasesMutation(data)

- **Required:** Yes
- It can have the following fields:
Use the `createAliasesMutation` function to get the mutation for adding aliases for many pages.

`items: object[]`:
:arg array data: It can have the following fields:
- items: An array of objects with the following fields:
- path: string
- redirect_to: string
- [datetime]: string
:hook: `useCreateAliases`
```

- **Required:** Yes
- An array of objects with the following fields:
## Add aliases for a page

`path: string`

- **Required:** Yes

`datetime: string`

- **Required:** No

`redirect_to: string`

- **Required:** Yes

## Add Aliases for a Page

### Mutation function
```{js:function} createAliasesMutation(path, data)

Use the `createAliasesMutation` function to get the mutation for adding aliases for a page.

### Hook

Use the `useCreateAliases` hook to add aliases for a page.

### Parameters
:arg string path: Description of the `path` parameter.
:arg object data: It can have the following fields:
-items: An array of objects with the following fields:
-path: string
:hook: `useCreateAliases`
```

- **path**: string
## Delete aliases

- **Required:** Yes

- **data**: object

- **Required:** Yes
- It can have the following fields:

`items: object[]`:

- **Required:** Yes
- An array of objects with the following fields:

`path: string`

- **Required:** Yes

## Delete Aliases

### Mutation function
```{js:function} deleteAliasesMutation(path, data)

Use the `deleteAliasesMutation` function to get the mutation for deleting aliases for a page.

### Hook

Use the `useDeleteAliases` hook to delete aliases for a page.

### Parameters

- **path**: string

- **Required:** Yes

- **data**: object

- **Required:** Yes
- It can have the following fields:

`items: object[]`:

- **Required:** Yes
- An array of objects with the following fields:

`path: string`

- **Required:** Yes
:arg string path: Description of the `path` parameter.
:arg object data: It can have the following fields:
-items: An array of objects with the following fields:
-path: string
:hook: `useDeleteAliases`
```
2 changes: 1 addition & 1 deletion docs/source/client/actions/breadcrumbs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Breadcrumbs

## Get Breadcrumbs
## Get breadcrumbs

### Query function

Expand Down
14 changes: 7 additions & 7 deletions docs/source/client/actions/comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Commenting can be enabled globally for specific content types and for single con

When commenting is enabled on your content object, you can retrieve a list of all existing comments, add new comments, reply to existing comments, or delete a comment.

## Get Comments List
## Get comments list

### Query function

Expand All @@ -22,7 +22,7 @@ Use the `useGetCommentsList` hook to get the comments list for a page.

- **Required:** Yes

## Add Comment
## Add comment

### Mutation function

Expand All @@ -38,7 +38,7 @@ Use the `useCreateComment` hook to add a comment for a page.

- **Required:** Yes

- **reply_id**: string
- **`reply_id`**: string

- **Required:** No
- The id of the comment to which you want to reply
Expand All @@ -53,7 +53,7 @@ Use the `useCreateComment` hook to add a comment for a page.
- **Required:** Yes
- The content of the comment.

## Update Comment
## Update comment

### Mutation function

Expand All @@ -69,7 +69,7 @@ Use the `useUpdateComment` hook to update a comment for the given id and path.

- **Required:** Yes

- **comment_id**: string
- **`comment_id`**: string

- **Required:** Yes

Expand All @@ -83,7 +83,7 @@ Use the `useUpdateComment` hook to update a comment for the given id and path.
- **Required:** Yes
- The content of the comment.

## Delete Comment
## Delete comment

### Mutation function

Expand All @@ -99,6 +99,6 @@ Use the `useDeleteComment` hook to delete a comment for the given id and path.

- **Required:** Yes

- **comment_id**: string
- **`comment_id`**: string

- **Required:** Yes
12 changes: 6 additions & 6 deletions docs/source/client/actions/content.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Get the data for a specific content given its path.

## Get Content
## Get content

### Query options function

Expand All @@ -26,15 +26,15 @@ Use the `useGetContent` hook to get the content at a given path.

- **Required:** No

- **fullObjects:** boolean
- **`fullObjects`:** `boolean`

- **Required:** No

- **expand:** string[]

- **Required:** No

## Add Content
## Add content

### Mutation options function

Expand Down Expand Up @@ -152,7 +152,7 @@ Use the `useCreateContent` hook to add content at a given path.

- **Required:** No

## Update Content
## Update content

### Mutation function

Expand Down Expand Up @@ -258,7 +258,7 @@ Use the `useUpdateContent` hook to update content at a given path.

- **Required**: No

## Delete Content
## Delete content

### Mutation function

Expand All @@ -280,7 +280,7 @@ Use the `useDeleteContent` hook to delete content at a given path.

(relatedobject)=

#### RelatedObject
#### `RelatedObject`

`@id: string`

Expand Down
6 changes: 3 additions & 3 deletions docs/source/client/actions/contextnavigation.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Context Navigation
# Context navigation

The `@contextnavigation` endpoint uses the same semantics as the classic Plone navigation portlet. Instead of storing the portlet configuration in a portlet assignment storage, you can pass these as parameters to the service or expand the component.
The `@contextnavigation` endpoint uses the same semantics as the classic Plone navigation `portlet`. Instead of storing the `portlet` configuration in a `portlet` assignment storage, you can pass these as parameters to the service or expand the part.

## Get Context Navigation
## Get context navigation

### Query function

Expand Down
Loading
Loading