You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/classic-ui/mockup.md
+12-14Lines changed: 12 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -54,20 +54,20 @@ plonecli -l
54
54
55
55
## Create a custom pattern
56
56
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`:
58
58
59
59
```shell
60
60
cd project.addon
61
61
plonecli add mockup_pattern
62
62
```
63
63
64
-
Now enter your pattern name without *pat-* prefix:
64
+
Next, enter your pattern name without the `pat-` prefix.
65
65
66
66
```shell
67
67
--> Pattern name (without “pat-” prefix) [my-pattern]: testpattern
68
68
```
69
69
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.
71
71
72
72
```text
73
73
...
@@ -85,22 +85,22 @@ This creates the necessary JS resources and webpack configuration for you:
85
85
...
86
86
```
87
87
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.
90
90
91
-
Next step is to install the npm packages (yarn recommended):
91
+
Next, install the npm packages using {term}`yarn`.
92
92
93
93
```shell
94
94
yarn install
95
95
```
96
96
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.
98
98
99
99
```shell
100
100
yarn build
101
101
```
102
102
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.
104
104
105
105
```text
106
106
...
@@ -117,16 +117,14 @@ This creates the webpack chunks and the JS bundle files in your addon package:
117
117
| | | | | | ├── addon.min.js.map
118
118
```
119
119
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.
122
121
123
122
```{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.
126
124
```
127
125
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.
Copy file name to clipboardExpand all lines: docs/glossary.md
+11Lines changed: 11 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -437,6 +437,17 @@ Mockup
437
437
Mockup provides the JavaScript stack for Classic UI.
438
438
[View Mockup's patterns](https://plone.github.io/mockup/), based on Patternslib.
439
439
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
440
451
Patterns
441
452
Patternslib
442
453
[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