Skip to content

Commit aca3bf2

Browse files
authored
Merge pull request #57 from jonnitto/fix/typos
Fix: Typos in readme
2 parents a5d603b + 402ba0a commit aca3bf2

1 file changed

Lines changed: 19 additions & 19 deletions

File tree

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,26 @@
66

77
* Martin Ficzel - ficzel@sitegeist.de
88

9-
*The development and the public-releases of this package is generously sponsored by our employer http://www.sitegeist.de.*
9+
*The development and the public releases of this package is generously sponsored by our employer http://www.sitegeist.de.*
1010

1111
## About
1212

13-
If taxonomies are defined as documents in the `/sites` subtree of the Neos ContentRepository things tend to get
13+
If taxonomies are defined as documents in the `/sites` subtree of the Neos ContentRepository, things tend to get
1414
complicated:
1515

16-
- If the meaning of an item is determined by its position in a hierarchy it is complicated to add more than one
16+
- If the meaning of an item is determined by its position in a hierarchy, it is complicated to add more than one
1717
relation or relations for different contexts.
1818
- Mixing Taxonomies (meaning) with content (presentation) leads to a complicated structure that often is hard to
1919
comprehend for editors.
2020
- It is hard to share taxonomies across multiple sites.
21-
- It is hard to ensure taxonomies exist in all needed dimensions since this affects the site structure as well.
22-
- Limit the read and write-access to taxonomies inside sites is possible but not trivial.
21+
- It is hard to ensure taxonomies exist in all needed dimensions since this also affects the site structure.
22+
- Limiting read and write access to taxonomies inside sites is possible but not trivial.
2323

24-
Sitegeist.Taxonomies stores vocabularies and taxonomies as nodes outside of the `/sites` hierarchy in the content
25-
repository. This way the meaning of the taxonomy relations can be expressed better, taxonomies can be used across
24+
Sitegeist.Taxonomies store vocabularies and taxonomies as nodes outside of the `/sites` hierarchy in the content
25+
repository. This way, the meaning of the taxonomy relations can be expressed better, taxonomies can be used across
2626
multiple sites and the taxonomy documents can be defined without interfering with the taxonomy meaning.
2727

28-
it also provides a separate backend module for managing vocabularies and taxonmies.
28+
It also provides a separate backend module for managing vocabularies and taxonomies.
2929

3030

3131
## Storing vocabularies and taxonomies in the ContentRepository
@@ -34,27 +34,27 @@ Sitegeist.Taxonomy defines three basic node types:
3434

3535
- `Sitegeist.Taxonomy:Root` - The root node at the path `/taxonomies`, allows only vocabulary nodes as children
3636
- `Sitegeist.Taxonomy:Vocabulary` - The root of a hierarchy of meaning, allows only taxonomies nodes as children
37-
- `Sitegeist.Taxonomy:Taxonomy` - Item in the hierarchy that represents a specific meaning, allows only taxonomy
37+
- `Sitegeist.Taxonomy:Taxonomy` - An item in the hierarchy that represents a specific meaning allows only taxonomy
3838
nodes as children
3939

40-
If you have to enforce the existence of a specific vocabulary or taxonomy you can use a derived node type:
40+
If you have to enforce the existence of a specific vocabulary or taxonomy, you can use a derived node type:
4141

4242
```YAML
43-
Vendor.Site.Taxonomy.Root:
43+
Vendor.Site:Taxonomy.Root:
4444
superTypes:
4545
Sitegeist.Taxonomy:Root: TRUE
4646
childNodes:
4747
animals:
4848
type: 'Sitegeist.Taxonomy:Vocabulary'
4949
```
5050
51-
And configure the taxonomy-package to use this root node type instead of the default:
51+
And configure the taxonomy package to use this root node type instead of the default:
5252
5353
```YAML
5454
Sitegeist:
5555
Taxonomy:
5656
contentRepository:
57-
rootNodeType: 'Vendor.Site.Taxonomy.Root'
57+
rootNodeType: 'Vendor.Site:Taxonomy.Root'
5858
vocabularyNodeType: 'Sitegeist.Taxonomy:Vocabulary'
5959
taxonomyNodeType: 'Sitegeist.Taxonomy:Taxonomy'
6060
```
@@ -76,7 +76,7 @@ Since taxonomies are nodes, they are simply referenced via `reference` or `refer
7676
placeholder: 'assign Taxonomies'
7777
```
7878

79-
If you want to limit the selectable taxons to a vocalbulary or even a taxonomy then you can configure a more specific
79+
If you want to limit the selectable taxons to a vocabulary or even a taxonomy, then you can configure a more specific
8080
startingPoint:
8181

8282
```YAML
@@ -89,13 +89,13 @@ startingPoint:
8989

9090
## Content-Dimensions
9191

92-
Vocabularies and Taxonomies will always be created in all base-dimensions. This way it is ensured that they can
92+
Vocabularies and Taxonomies will always be created in all base dimensions. This way, it is ensured that they can
9393
always be referenced. The title and description of a taxons and vocabularies can be translated as is required for
9494
the project.
9595

9696
## CLI Commands
9797

98-
The taxonomy package includes some cli commands for managing the taxonomies.
98+
The taxonomy package includes some CLI commands for managing the taxonomies.
9999

100100
- `taxonomy:list` List all taxonomy vocabularies
101101
- `taxonomy:import` Import taxonomy content, expects filename + vocabulary-name (with globbing)
@@ -104,10 +104,10 @@ The taxonomy package includes some cli commands for managing the taxonomies.
104104

105105
## Privileges
106106

107-
Sitegeist.Taxonomy brings the following privilege targets to allow you to restrict read access, mangement and editing
107+
Sitegeist.Taxonomy brings the following privilege targets to allow you to restrict read access, management and editing
108108
of taxonomies:
109109

110-
- `Sitegeist.Taxonomy:Module.Show` Show the backend Module and explore the existing taxonomies. By default granted to Editors.
110+
- `Sitegeist.Taxonomy:Module.Show` Show the backend Module and explore the existing taxonomies by default granted to Editors.
111111
- `Sitegeist.Taxonomy:Module.ManageVocabularyActions` Add, edit and delete vocabularies. By default granted to Administrators.
112112
- `Sitegeist.Taxonomy:Module.ManageTaxonomyActions` Add, edit and delete taxons. By default granted to Administrators.
113113

@@ -118,7 +118,7 @@ Reading and referencing taxonomies from other nodes is currently not limited.
118118
Sitegeist.Taxonomy is available via packagist. `"sitegeist/taxonomy" : "^1.0"` to the require section of the composer.json
119119
or run `composer require sitegeist/taxonomy`.
120120

121-
We use semantic-versioning so every breaking change will increase the major-version number.
121+
We use semantic-versioning, so every breaking change will increase the major version number.
122122

123123
## Contribution
124124

0 commit comments

Comments
 (0)