Skip to content

Commit 7b65051

Browse files
stevepiercystevepiercy
committed
Added some spit and polish around the excellent content that we have needed for over two years. Thank you, and amen, @davisagli!
- Add note about migration between UIs. - Explain purpose of this document. - Switch MyST markup from colon to backtick to support colon-based options. - Eliminated spacing around and between the two columns. - Set breakpoints to display columns side-by-side on only widest displays, else it gets smooshed up into an illegible mess. - Added a target to make the images clickable so they can be viewed in all their glory. - Update Glossary with missing terms and add references.
1 parent 033e160 commit 7b65051

File tree

2 files changed

+47
-36
lines changed

2 files changed

+47
-36
lines changed

‎docs/conceptual-guides/choose-user-interface.md

Lines changed: 36 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,67 @@
11
---
22
myst:
33
html_meta:
4-
"description": "Explanation of how to choose between Plone's user interfaces, Volto and Classic UI"
5-
"property=og:description": "Explanation of how to choose between Plone's user interfaces, Volto and Classic UI"
4+
"description": "Explanation of how to choose between Plone's two user interfaces, Volto and Classic UI"
5+
"property=og:description": "Explanation of how to choose between Plone's two user interfaces, Volto and Classic UI"
66
"property=og:title": "Choose a user interface"
7-
"keywords": "Plone 6, Conceptual guides, UI, frontend, Volto, Classic UI, distribution"
7+
"keywords": "Plone 6, Conceptual guides, UI, user interface, frontend, Volto, Classic UI, distribution"
88
---
99

1010
# Choose a user interface
1111

12-
Plone 6 offers two different user interfaces: Volto and Classic UI.
12+
This guide explains the differences between Plone's two user interfaces, Volto and Classic UI, to help inform you to choose one when developing your new project in Plone, or whether to migrate from Classic UI to Volto.
13+
There is no migration path available from Volto to Classic UI.
1314

1415
The choice of user interface has implications for editors, admins, and developers.
1516

16-
::::{grid} 2
17-
:::{grid-item-card} Volto
17+
`````{grid} 1 1 1 2
18+
:gutter: 1
19+
:margin: 0
20+
:padding: 0
1821
22+
````{grid-item-card} Volto
1923
```{image} /_static/volto-ui.png
20-
:alt: Plone homepage in Volto
24+
:alt: Plone home page in Volto
25+
:target: /_static/volto-ui.png
2126
```
2227
2328
For editors and other end users:
2429
25-
* The user interface is a fast, modern single-page web application.
26-
* Editors create a page by arranging blocks of different types into a layout.
27-
* There is not a comprehensive User Manual yet.
30+
- The user interface is a fast, modern, single-page web application.
31+
- Editors create a page by arranging {term}`blocks` of different types into a layout.
32+
- There is not a comprehensive {doc}`/volto/user-manual/index` yet, and only a few pages exist.
2833
2934
For developers and integrators:
3035
31-
* The frontend is a {term}`React`-based application written in JavaScript and TypeScript.
32-
* The backend is a Python process which provides a REST API for the frontend.
33-
* Python skills are not required, but can be helpful for extending the backend.
34-
* Content is stored as structured JSON.
35-
* Customization of themes is well-documented and relatively easy for developers who have experience with React.
36+
- The frontend is a {term}`React`-based application written in JavaScript and TypeScript.
37+
- The backend is a Python process which provides a {term}`REST API` for the frontend.
38+
- Python skills are not required, but can be helpful for extending the backend.
39+
- Content is stored as structured JSON.
40+
- Customization of themes is well-documented and relatively easy for developers who have experience with React.
3641
42+
````
3743
38-
:::
39-
:::{grid-item-card} Classic UI
40-
44+
````{grid-item-card} Classic UI
4145
```{image} /_static/classic-ui.png
42-
:alt: Plone homepage in Classic UI
46+
:alt: Plone home page in Classic UI
47+
:target: /_static/classic-ui.png
4348
```
4449
4550
For editors and other end users:
4651
47-
* The user interface is similar to Plone 5.
48-
* Editors create a page using a WYSIWYG editor (TinyMCE).
49-
* Additional widgets can be added to predefined locations, using {term}`portlets`.
50-
* There is a comprehensive User Manual for Plone 5, but it has not been updated for Plone 6.
52+
- The user interface is similar to Plone 5.
53+
- Editors create a page using a {term}`WYSIWYG` editor, {term}`TinyMCE`.
54+
- Additional widgets can be added to predefined locations, using {term}`portlets`.
55+
- There is a comprehensive [User Manual for Plone 5](https://5.docs.plone.org/working-with-content/index.html), but it has not been updated for Plone 6.
5156
5257
For developers and integrators:
5358
54-
* The frontend and backend run in a single Python process, so hosting is a bit simpler.
55-
* The frontend is implemented as server-side templates using the {term}`ZPT` language.
56-
* Interactive functionality is implemented in JavaScript using {term}`Mockup`.
57-
* The visual design is based on the {term}`Barceloneta` theme from Plone 5, but updated to use Bootstrap 5.
58-
* Content is stored as HTML.
59-
* Customization of themes is not well-documented.
59+
- The frontend and backend run in a single Python process, so hosting is a bit simpler.
60+
- The frontend is implemented as server-side templates using the {term}`ZPT` language.
61+
- Interactive functionality is implemented in JavaScript using {term}`Mockup`.
62+
- The visual design is based on the {term}`Barceloneta` theme from Plone 5, but updated to use Bootstrap 5.
63+
- Content is stored as HTML.
64+
- Customization of themes is not well-documented.
6065
61-
:::
62-
::::
66+
````
67+
`````

‎docs/glossary.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,9 @@ pm2
104104
[PM2](https://pm2.keymetrics.io/) is a daemon process manager.
105105
106106
REST API
107-
```{todo}
108-
REST API in general. REST API of Plone.
109-
```
107+
A REST API (also called a RESTful API or RESTful web API) is an application programming interface (API) that conforms to the design principles of the representational state transfer (REST) architectural style.
108+
REST APIs provide a flexible, lightweight way to integrate applications and to connect components in microservices architectures.
109+
Plone uses [`plone.restapi`](https://github.com/plone/plone.restapi/) for its REST API.
110110
111111
S3
112112
[Amazon Web Services S3](https://aws.amazon.com/s3/).
@@ -445,11 +445,17 @@ Patternslib
445445
Accessibility, SEO, and well-structured HTML are core values of Patterns.
446446
447447
Slate
448-
[Slate.js](https://docs.slatejs.org/) is a highly customizable platform for creating rich-text editors, also known as `WYSIWYG` editors.
448+
[Slate.js](https://docs.slatejs.org/) is a highly customizable platform for creating rich-text editors, also known as {term}`WYSIWYG` editors.
449449
It enables you to create powerful, intuitive editors similar to those you've probably used in Medium, Dropbox Paper, or Google Docs.
450450
451451
`volto-slate`
452-
`volto-slate` is an interactive default text editor for Volto, developed on top of {term}`Slate`, offering enhanced WYSIWYG functionality and behavior.
452+
`volto-slate` is an interactive default text editor for Volto, developed on top of {term}`Slate`, offering enhanced {term}`WYSIWYG` functionality and behavior.
453+
454+
WYSIWYG
455+
WYSIWYG is an acronym for "what you see is what you get", referring to software that allows content to be edited in a form that resembles its appearance when printed or displayed as a finished product.
456+
457+
TinyMCE
458+
The rich text {term}`WYSIWYG` editor used in {term}`Classic UI`.
453459
454460
elementEditor
455461
A generic {term}`volto-slate` plugin architecture that can be used to create other editor interactions that follow the pattern of having a button that toggles a format (an inline element).

0 commit comments

Comments
 (0)