Skip to content

Commit

Permalink
docs: distinct between "vocabulary" and "section"
Browse files Browse the repository at this point in the history
  • Loading branch information
brotkrueml committed Jan 5, 2025
1 parent 103f896 commit 523da83
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion Documentation/Developer/Api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ have to create the schema model:

The schema type `Person` maps to the model
:php:`\Brotkrueml\Schema\Model\Type\Person`. You can use every accepted type
from the core vocabulary of `schema.org`_. Also have a look into the
from the core section of `schema.org`_. Also have a look into the
:file:`Classes\\Model\\Type` folder of this extension to get a general idea
of the available types.

Expand Down
10 changes: 5 additions & 5 deletions Documentation/Developer/ExtendingVocabulary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Introduction
============

The TYPO3 schema extension ships :ref:`type models <api>` and :ref:`view helpers
<view-helpers>` with their properties from the core vocabulary of the schema.org
<view-helpers>` with their properties from the core section of the schema.org
definitions. However, there are several extensions, like
`Health and lifesciences`_ or `Autos`_. There are also `pending types and
properties`_ available that enable schema.org to introduce terms on an
Expand All @@ -33,7 +33,7 @@ if you only want to add only a few terms you are encouraged to add them on your
own, especially pending terms.

Pending terms are experimental, after a certain time a term will be incorporated
into the core vocabulary or dropped. This depends on the usage, adoption and
into the core section or dropped. This depends on the usage, adoption and
discussions. To maintain backward-compatibility and to not break any pages,
pending types are also not supplied by this extension.

Expand All @@ -55,7 +55,7 @@ how to register additional properties in detail.
About 1-2 times a year a new version of the schema.org definition is
`released`_. The extension adopts these changes in future releases. If you
register a pending property for a type, this property can be included in the
core vocabulary in a later version of this extension. However, it doesn't do
core section in a later version of this extension. However, it doesn't do
any harm to register a property that already exists.


Expand Down Expand Up @@ -126,15 +126,15 @@ was quickly adopted by Google. The type can be used as `location`_ in the
= 'MyVendor\\MyExtension\\ViewHelpers\\Schema';
This way you don't have to think about which namespace to use. And if the
pending type is moved to the core vocabulary you have no need to touch your
pending type is moved to the core section you have no need to touch your
Fluid templates. Of course, feel free to use another namespace.

.. attention::
Add the schema extension as a dependency to your extension. This ensures that
your class models take precedence over the delivered models from the schema
extension. This may be necessary, if you define a pending type with pending
properties (which you also use) to avoid breaks when the type is included
into the core vocabulary but some properties aren't.
into the core section but some properties aren't.

.. tip::
Have a look into the `schema_virtuallocation`_ extension. It serves as a
Expand Down
4 changes: 2 additions & 2 deletions Documentation/Introduction/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Schema.org is a set of extensible schemas that enables webmasters to embed
structured data on their web pages for use by search engines and other
applications. The vocabulary is divided into different sections:

* The **core** vocabulary provides all default types and properties, like
* The **core** section provides all default types and properties, like
`Person` or `Organization`.
* The **pending** section is a staging area for work-in-progress terms which
have yet to be accepted into the core vocabulary. `Pending terms`_ are subject
Expand All @@ -56,7 +56,7 @@ applications. The vocabulary is divided into different sections:
`health and lifesciences`_.

.. note::
This TYPO3 schema extension provides the terms for the core vocabulary. To
This TYPO3 schema extension provides the terms for the core section. To
use terms from other sections you can extend the vocabulary on your own as
described in the :ref:`according chapter <extending-vocabulary>` or use one
of the additional TYPO3 extensions provided by the author of this extension:
Expand Down

0 comments on commit 523da83

Please sign in to comment.