Skip to content

Commit 5805380

Browse files
committed
Tidy up mockup.md.
- Add more glossary terms and references.
1 parent 846dd52 commit 5805380

File tree

2 files changed

+23
-14
lines changed

2 files changed

+23
-14
lines changed

docs/classic-ui/mockup.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -54,20 +54,20 @@ plonecli -l
5454

5555
## Create a custom pattern
5656

57-
To create a custom pattern in your addon use the `mockup_pattern` bobtemplate:
57+
To create a custom {term}`pattern` in your add-on, use the `mockup_pattern` {term}`bobtemplate`:
5858

5959
```shell
6060
cd project.addon
6161
plonecli add mockup_pattern
6262
```
6363

64-
Now enter your pattern name without *pat-* prefix:
64+
Next, enter your pattern name without the `pat-` prefix.
6565

6666
```shell
6767
--> Pattern name (without “pat-” prefix) [my-pattern]: testpattern
6868
```
6969

70-
This creates the necessary JS resources and webpack configuration for you:
70+
This creates the necessary JavaScript resources and webpack configuration for you, as shown in the following file system tree diagram.
7171

7272
```text
7373
...
@@ -85,22 +85,22 @@ This creates the necessary JS resources and webpack configuration for you:
8585
...
8686
```
8787

88-
All your pattern JS code goes into `resources/pat-testpattern/testpattern.js`.
89-
SCSS files can be imported too since webpack provides the `sass-loader` module.
88+
All your pattern JavaScript code goes into {file}`resources/pat-testpattern/testpattern.js`.
89+
SCSS files can be imported, too, since webpack provides the `sass-loader` module.
9090

91-
Next step is to install the npm packages (yarn recommended):
91+
Next, install the npm packages using {term}`yarn`.
9292

9393
```shell
9494
yarn install
9595
```
9696

97-
When you have finished your JS code you have to build the bundle with:
97+
When you finish writing your JavaScript code, you have to build the bundle with the following command.
9898

9999
```shell
100100
yarn build
101101
```
102102

103-
This creates the webpack chunks and the JS bundle files in your addon package:
103+
This creates the webpack chunks and the JavaScript bundle files in your add-on package.
104104

105105
```text
106106
...
@@ -117,16 +117,14 @@ This creates the webpack chunks and the JS bundle files in your addon package:
117117
| | | | | | ├── addon.min.js.map
118118
```
119119

120-
Note that `plonecli` also creates a XML file in `src/project/addon/profiles/default/registry/bundles.xml`
121-
which registers the `addon-remote.min.js` in the resources registry.
120+
Note that `plonecli` also creates an XML file in {file}`src/project/addon/profiles/default/registry/bundles.xml`, which registers the {file}`addon-remote.min.js` file in the resource registry.
122121

123122
```{important}
124-
You have to re-import your profile with an upgrade step if you have installed
125-
your addon in Plone before adding the pattern.
123+
You must re-import your profile with an upgrade step if you installed your add-on in Plone before adding the pattern.
126124
```
127125

128-
You can test your pattern now with the browser view `@@addon-pattern-demo` (see /src/project/addon/browser/pattern-demo.pt)
129-
or implement it in your own templates by adding the CSS class `pat-testpattern` to a tag.
126+
You can test your pattern now with the browser view `@@addon-pattern-demo` (see {file}`/src/project/addon/browser/pattern-demo.pt`)
127+
Alternatively you can implement it in your own templates by adding the CSS class `pat-testpattern` to a tag.
130128

131129

132130
## References

docs/glossary.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -437,6 +437,17 @@ Mockup
437437
Mockup provides the JavaScript stack for Classic UI.
438438
[View Mockup's patterns](https://plone.github.io/mockup/), based on Patternslib.
439439
440+
bobtemplate
441+
bobtemplates
442+
bobtemplates.plone
443+
`bobtemplates.plone` provides {term}`mr.bob` templates to generate packages for Plone projects.
444+
The {term}`plonecli` command line client provides a developer-friendly interface to `bobtemplates.plone`.
445+
446+
mr.bob
447+
[`mr.bob`](https://mrbob.readthedocs.io/en/latest/) is a tool that takes a directory skeleton, copies over its directory structure to a target folder, and can use the Jinja2 (or some other) templating engine to dynamically generate the files.
448+
Additionally, it can ask you questions needed to render the structure, or provide a configuration file to answer them.
449+
450+
Pattern
440451
Patterns
441452
Patternslib
442453
[Patterns](https://patternslib.com/), or Patternslib, is a toolkit that enables designers to build rich interactive prototypes without the need for writing any JavaScript.

0 commit comments

Comments
 (0)