Skip to content

Commit 7557f9a

Browse files
committed
Add glossary terms and Vale spellings Public UI and CMSUI.
See #7385. plone/documentation#1975 must be merged before this PR, so that it can pull in the glossary terms via Intersphinx
1 parent 8c14634 commit 7557f9a

File tree

5 files changed

+20
-19
lines changed

5 files changed

+20
-19
lines changed

docs/conceptual-guides/add-on-styles-loader.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,23 @@ myst:
1010
# Add-ons styles loader
1111

1212
Add-ons that are compatible with the `@plone/registry` may declare styles that should be loaded by the app.
13-
Currently the loader loads styles for both the end user interface (public UI) part, which displays content to both authenticated and anonymous users, and the content management system user interface (CMS UI) part of the app.
13+
Currently the loader loads styles for both the end user interface (Public UI) part, which displays content to both authenticated and anonymous users, and the content management system user interface (CMSUI) part of the app.
1414

1515
## Public UI styles
1616

17-
To load public UI styles, create a file {file}`styles/main.css` at the root of your add-on package to serve as the entry point.
18-
This file is a `.css` file containing the styles that you want your app to load for the public UI.
17+
To load Public UI styles, create a file {file}`styles/main.css` at the root of your add-on package to serve as the entry point.
18+
This file is a `.css` file containing the styles that you want your app to load for the Public UI.
1919

20-
## CMS UI styles
20+
## CMSUI styles
2121

22-
Similar to the public UI, you can create a file {file}`styles/cmsui.css` at the root of your add-on package to serve as the entry point for the CMS UI styles.
23-
This file is also a CSS file containing the styles that you want your app to load for the CMS UI.
22+
Similar to the Public UI, you can create a file {file}`styles/cmsui.css` at the root of your add-on package to serve as the entry point for the CMSUI styles.
23+
This file is also a CSS file containing the styles that you want your app to load for the CMSUI.
2424

2525
`@plone/registry` has a helper utility `createAddonsStyleLoader` which generates an add-ons loader file.
2626
That file contains the aggregated files from all the registered add-ons, keeping the order in which they were defined.
2727

2828
This loader is also a `.css` file and is placed in the root of your application.
29-
By default, it's called {file}`publicui.css` for the public UI and {file}`cmsui.css` for the CMS UI.
29+
By default, it's called {file}`publicui.css` for the Public UI and {file}`cmsui.css` for the CMSUI.
3030

3131
```{important}
3232
This file is generated and maintained by `@plone/registry`.

docs/how-to-guides/routes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ The following diagram illustrates the file structure of the `@plone/cmsui` edit
202202

203203
In `@plone/cmsui/`, each of the files shown in the above diagram performs a specific function.
204204

205-
- {file}`routes/layout.tsx` serves as a shared layout used as a base for CMS UI views.
205+
- {file}`routes/layout.tsx` serves as a shared layout used as a base for CMSUI views.
206206
- {file}`routes/edit.tsx` is the component used for `/edit` and all its subpaths.
207207
- {file}`index.ts` is where the default configuration loader of the add-on calls `config.registerRoute()`.
208208

docs/reference/conventions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ We follow the mantra, "If it works, don't change it."
2222

2323
This document highlights the differences and additions compared to Volto conventions.
2424

25-
## Separate builds for public and CMSUI
25+
## Separate builds for Public UI and CMSUI
2626

27-
We are aiming for the possibility of having two separate builds: one for the public theme and another for the CMS UI.
27+
We are aiming for the possibility of having two separate builds: one for the public theme called {term}`Public UI` and another for the {term}`CMSUI`.
2828
Thus, we need to ensure that the codebase can support this separation and have this in mind when developing new features.
2929
This will impose some constraints, such as avoiding the use of Tailwind CSS classes in structural components, since the public theme might not use Tailwind CSS.
30-
Also, the public UI cannot rely on any CMSUI-specific styles or components.
30+
Also, the Public UI cannot rely on any CMSUI-specific styles or components.
3131

3232
## Storybook
3333

@@ -74,7 +74,7 @@ These styles are very simple ("vanilla") and easy to override with your own styl
7474
You can also use these in Volto projects by installing the `@plone/components` package.
7575

7676
The Tailwind-based components are meant for public themes that also use Tailwind CSS, like the default Seven theme (`@plone/agave`).
77-
They're also used in the CMS UI, which is based on Tailwind CSS.
77+
They're also used in the CMSUI, which is based on Tailwind CSS.
7878

7979
Check out the Storybook for this package at [@plone/components Storybook](https://plone-components.readthedocs.io/latest/?path=/docs/introduction--docs).
8080

packages/registry/docs/conceptual-guides/add-on-styles-loader.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,23 @@ myst:
1010
# Add-ons styles loader
1111

1212
Add-ons that are compatible with the `@plone/registry` may declare styles that should be loaded by the app.
13-
Currently the loader loads styles for both the end user interface (public UI) part, which displays content to both authenticated and anonymous users, and the content management system user interface (CMS UI) part of the app.
13+
Currently, the loader loads styles for both the end user interface (Public UI) part, which displays content to both authenticated and anonymous users, and the content management system user interface (CMSUI) part of the app.
1414

1515
## Public UI Styles
1616

17-
To load public UI styles, create a file {file}`styles/main.css` at the root of your add-on package to serve as the entry point.
18-
This file is a `.css` file containing the styles that you want your app to load for the public UI.
17+
To load Public UI styles, create a file {file}`styles/main.css` at the root of your add-on package to serve as the entry point.
18+
This file is a `.css` file containing the styles that you want your app to load for the Public UI.
1919

20-
## CMS UI Styles
20+
## CMSUI Styles
2121

22-
Similar to the public UI, you can create a file {file}`styles/cmsui.css` at the root of your add-on package to serve as the entry point for the CMS UI styles.
23-
This file is also a CSS file containing the styles that you want your app to load for the CMS UI.
22+
Similar to the Public UI, you can create a file {file}`styles/cmsui.css` at the root of your add-on package to serve as the entry point for the CMSUI styles.
23+
This file is also a CSS file containing the styles that you want your app to load for the CMSUI.
2424

2525
`@plone/registry` has a helper utility `createAddonsStyleLoader` which generates an add-ons loader file.
2626
That file contains the aggregated files from all the registered add-ons, keeping the order in which they were defined.
2727

2828
This loader is also a `.css` file and is placed in the root of your application.
29-
By default, it's called {file}`publicui.css` for the public UI and {file}`cmsui.css` for the CMS UI.
29+
By default, it's called {file}`publicui.css` for the Public UI and {file}`cmsui.css` for the CMSUI.
3030

3131
```{important}
3232
This file is generated and maintained by `@plone/registry`.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Use `Public UI` and `CMSUI` as official spellings. @stevepiercy

0 commit comments

Comments
 (0)