Skip to content

Commit 0e1a75d

Browse files
committed
Wording: Use relations-widget as human-readable name.
1 parent b9a5b92 commit 0e1a75d

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

docs/backend/relations.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -94,12 +94,14 @@ directives.widget(
9494

9595
(relations-configure-the-relateditemsfieldwidget-label)=
9696

97-
### Configure the `RelatedItemsFieldWidget`
97+
### Configure the relations-widget
9898

9999
```{note}
100100
These settings only have an effect in Plone 6 Classic UI.
101101
```
102102

103+
`RelatedItemsFieldWidget` is the python-class of the default widget used by relation fields.
104+
103105
With `pattern_options` you can further configure the widget.
104106

105107
In the following example, you can specify `pattern_options`:
@@ -122,7 +124,7 @@ directives.widget(
122124
"relationlist_field",
123125
RelatedItemsFieldWidget,
124126
pattern_options={
125-
"basePath": ",
127+
"basePath": "",
126128
"closeOnSelect": False, # Leave dropdown open for multiple selection
127129
},
128130
)
@@ -154,7 +156,7 @@ directives.widget(
154156

155157
(relations-using-the-search-mode-of-the-related-items-widget-label)=
156158

157-
### Using the search mode of the Related Items Widget
159+
### Using the search mode of the relations-widget
158160

159161
```{note}
160162
These settings only have an effect in Plone 6 Classic UI.
@@ -168,7 +170,7 @@ This makes it very flexible for limiting relatable items by type, path, date, an
168170

169171
Setting the mode of the widget to `search` makes it easier to select from the content that results from your catalog query instead of having to navigate through your content tree.
170172

171-
The problem is that, in the default mode of the Related Items widget, items that are in containers are not shown unless you add these types of containers to the query.
173+
The problem is that, in the default mode of the relations-widget, items that are in containers are not shown unless you add these types of containers to the query.
172174

173175
Therefore, it is recommended to use `CatalogSource` only in `search` mode.
174176

@@ -366,9 +368,9 @@ directives.widget(
366368
The field should then look like this:
367369

368370
```{figure} /_static/relation_select.png
369-
:alt: RelationList field with select widget
371+
:alt: RelationChoice field with select widget
370372
371-
RelationList field with select widget
373+
RelationChoice field with select widget
372374
```
373375

374376
Another example is the `AjaxSelectFieldWidget` that only queries the catalog for results if you start typing:

0 commit comments

Comments
 (0)