Skip to content

Commit 665d100

Browse files
committed
Tidy prerequisite.md
1 parent 3ec8e9d commit 665d100

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

plone.app.dexterity/prerequisite.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
myst:
33
html_meta:
4-
"description": ""
5-
"property=og:description": ""
6-
"property=og:title": ""
7-
"keywords": ""
4+
"description": "Prerequisites for content types"
5+
"property=og:description": "Prerequisites for content types"
6+
"property=og:title": "Prerequisites for content types"
7+
"keywords": "Plone, content types, prerequisites"
88
---
99

1010
# Prerequisites
1111

12-
This portion of the Dexterity documentation is mainly intended to illuminate Dexterity features.
12+
This portion of the Dexterity documentation mainly intends to illuminate Dexterity features.
1313
If you would like an in-depth, step-by-step approach, we recommend you work through the [Mastering Plone](https://training.plone.org/) training.
1414

1515

@@ -58,7 +58,7 @@ We're going to build a package named `example.conference`.
5858
You may find a completed version of it in the [Collective repository](https://github.com/collective/example.conference).
5959
```
6060

61-
Typically, our content types will live in a separate package to our theme and other customizations.
61+
Typically, our content types will live in a separate package from our theme and other customizations.
6262

6363
To create a new package, we can start with `mrbob` and the `dexterity` template.
6464

@@ -75,13 +75,13 @@ We run the following from the `src/` directory
7575

7676
and specify your target version of Plone and Python.
7777
This will create a directory named `example.conference` inside `./src` with the basic structure of a generic add-on.
78-
Now ["refine"](https://github.com/plone/bobtemplates.plone#provided-subtemplates) it for the creation of a content type
78+
Now ["refine"](https://github.com/plone/bobtemplates.plone#provided-subtemplates) it for the creation of a content type.
7979

8080
```shell
8181
../bin/mrbob bobtemplates.plone:content_type -O example.conference
8282
```
8383

84-
Specify "Program" for your content type name, and "Container" as Dexterity base class (remember that Programs will contain Sessions).
84+
Specify `Program` for your content type name, and `Container` as the Dexterity base class (remember that Programs will contain Sessions).
8585
Choose not to use XML Model for this example.
8686

8787
Now take a look at the `setup.py` file in your new package.
@@ -109,7 +109,7 @@ Now let's take a look at `configure.zcml` in the `examples/conference` directory
109109
Again, we want to note a few parts:
110110

111111
```xml
112-
<configure ...>
112+
<configure>
113113

114114
<i18n:registerTranslations directory="locales" />
115115

@@ -135,8 +135,6 @@ Again, we want to note a few parts:
135135
post_handler=".setuphandlers.uninstall"
136136
/>
137137

138-
...
139-
140138
</configure>
141139
```
142140

@@ -146,7 +144,7 @@ The alternative would be to manually add a line, such as `<include package="plon
146144
The `include package=".browser"` directive loads additional ZCML configuration from the `browser` subdirectory.
147145
In turn, the `browser.resourceDirectory` command in that configuration file creates a directory for static resources that we want to make available through the web.
148146

149-
Finally, we register a GenericSetup profile to make the type installable, which we will build up over the next several sections.
147+
Finally, we register a `GenericSetup` profile to make the type installable, which we will build up over the next several sections.
150148

151149
When you've got your project tuned up, return to your `buildout/instance` directory and edit `buildout.cfg` to add `example.conference` to your eggs list, and `src/example.conference` to your `develop` sources list:
152150

@@ -156,7 +154,7 @@ eggs =
156154

157155
example.conference
158156

159-
...
157+
160158
develop =
161159

162160
src/example.conference

0 commit comments

Comments
 (0)