Skip to content

Commit f408515

Browse files
stevepiercystevepiercy
committed
Tidy widgets.md
1 parent 0197766 commit f408515

File tree

1 file changed

+20
-25
lines changed

1 file changed

+20
-25
lines changed

‎plone.app.dexterity/reference/widgets.md‎

Lines changed: 20 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,32 @@
11
---
22
myst:
33
html_meta:
4-
"description": ""
5-
"property=og:description": ""
6-
"property=og:title": ""
7-
"keywords": ""
4+
"description": "Standard and common third party widgets for content types in Plone"
5+
"property=og:description": "Standard and common third party widgets for content types in Plone"
6+
"property=og:title": "Standard and common third party widgets for content types in Plone"
7+
"keywords": "Plone, standard, common, third party widgets, content types"
88
---
99

1010
# Widgets
1111

12-
**Standard and common third party widgets**
12+
This chapter describes the standard and common third party widgets for content types in Plone.
1313

14-
Most of the time, you will use the standard widgets provided by
15-
*z3c.form*. To learn more about z3c.form widgets, see the [z3c.form
16-
documentation][z3c.form documentation]. To learn about setting custom widgets for Dexterity
17-
content types, see the [schema introduction].
14+
Most of the time, you will use the standard widgets provided by `z3c.form`.
15+
To learn more about `z3c.form` widgets, see the [z3c.form documentation](https://z3cform.readthedocs.io/en/latest/widgets/index.html).
16+
To learn about setting custom widgets for Dexterity content types, see the {ref}`schema introduction <the-schema-label>`.
1817

1918
The table below shows some commonly used custom widgets.
2019

21-
| Widget | Imported from | Field | Description |
20+
| Widget | Imported from | Field | Description |
2221
| ---------------------------- | ----------------------------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
23-
| WysiwygFieldWidget | plone.app.z3cform.wysiwyg | Text | Use Plone’s standard WYSIWYG HTML editor on a standard text field. Note that if you used a *RichText* field, you will get the WYSIWYG editor automatically. |
24-
| RichTextWidget | plone.app.textfield.widget | RichText | Use Plone’s standard WYSIWYG HTML editor on a *RichText* field. This also allows text-based markup such as reStructuredText. |
25-
| AutocompleteFieldWidget | plone.formwidget.autocomplete | Choice | Autocomplete widget based on jQuery Autocomplete. Requires a Choice field with a query source. See [vocabularies]. |
26-
| AutocompleteMultiFieldWidget | plone.formwidget.autocomplete | Collection | Multi-select version of the above. Used for a List, Tuple, Set or Frozenset with a Choice value_type. |
27-
| ContentTreeFieldWidget | plone.formwidget.contenttree | RelationChoice | Content browser. Requires a query source with content objects as values. |
28-
| MultiContentTreeFieldWidget | plone.formwidget.contenttree | RelationList | Content browser. Requires a query source with content objects as values. |
29-
| NamedFileFieldWidget | plone.formwidget.namedfile | NamedFile/NamedBlobFile | A file upload widget |
30-
| NamedImageFieldWidget | plone.formwidget.namedfile | NamedImage/NamedBlobImage | An image upload widget |
31-
| TextLinesFieldWidget | plone.z3cform.textlines | Collection | One-per-line list entry for List, Tuple, Set or Frozenset fields. Requires a value_type of TextLine or ASCIILine. |
32-
| SingleCheckBoxFieldWidget | z3c.form.browser.checkbox | Bool | A single checkbox for true/false. |
33-
| CheckBoxFieldWidget | z3c.form.browser.checkbox | Collection | A set of checkboxes. Used for Set or Frozenset fields with a Choice value_type and a vocabulary. |
34-
35-
[schema introduction]: ../schema-driven-types.html#the-schema
36-
[vocabularies]: ../advanced/vocabularies.html
37-
[z3c.form documentation]: https://z3cform.readthedocs.io/en/latest/widgets/index.html
22+
| WysiwygFieldWidget | plone.app.z3cform.wysiwyg | Text | Use Plone's standard WYSIWYG HTML editor on a standard text field. Note that if you used a `RichText` field, you will get the WYSIWYG editor automatically. |
23+
| RichTextWidget | plone.app.textfield.widget | RichText | Use Plone's standard WYSIWYG HTML editor on a `RichText` field. This also allows text-based markup such as reStructuredText. |
24+
| AutocompleteFieldWidget | plone.formwidget.autocomplete | Choice | Autocomplete widget based on jQuery Autocomplete. Requires a Choice field with a query source. See {doc}`../advanced/vocabularies`. |
25+
| AutocompleteMultiFieldWidget | plone.formwidget.autocomplete | Collection | Multi-select version of the above. Used for a List, Tuple, Set, or Frozenset with a Choice `value_type`. |
26+
| ContentTreeFieldWidget | plone.formwidget.contenttree | RelationChoice | Content browser. Requires a query source with content objects as values. |
27+
| MultiContentTreeFieldWidget | plone.formwidget.contenttree | RelationList | Content browser. Requires a query source with content objects as values. |
28+
| NamedFileFieldWidget | plone.formwidget.namedfile | NamedFile/NamedBlobFile | A file upload widget |
29+
| NamedImageFieldWidget | plone.formwidget.namedfile | NamedImage/NamedBlobImage | An image upload widget |
30+
| TextLinesFieldWidget | plone.z3cform.textlines | Collection | One-per-line list entry for List, Tuple, Set, or Frozenset fields. Requires a `value_type` of TextLine or ASCIILine. |
31+
| SingleCheckBoxFieldWidget | z3c.form.browser.checkbox | Bool | A single checkbox for `True` or `False`. |
32+
| CheckBoxFieldWidget | z3c.form.browser.checkbox | Collection | A set of checkboxes. Used for Set or Frozenset fields with a Choice `value_type` and a vocabulary. |

0 commit comments

Comments
 (0)