Commit df890f2d authored by Jennifer Hodgdon's avatar Jennifer Hodgdon
Browse files

Issue #3165909 by jhodgdon, eojthebrave: Make sure entity terminology is consistent in User Guide

parent bc5012ee
Loading
Loading
Loading
Loading
+3 −0
Original line number Diff line number Diff line
@@ -138,6 +138,9 @@ applies to its use in the context of changing the version of software.)

* *email vs. e-mail*: use email

* *entity terminology*: use the terms "entity type", "entity subtype" (not
"sub-type" or "bundle"), and "entity" (not "entity item").

* *website vs. web site*: use website

* *enable vs. add vs. install vs. upload vs. place*:
+2 −2
Original line number Diff line number Diff line
@@ -62,8 +62,8 @@ Content text and files::
  If your site is multilingual, you can configure the content fields on your
  site to be translatable. After creating content in one language, you can
  translate it into other languages. Fields can contain textual information or
  uploaded files, and for each field on each content type, you can configure it
  to be translatable or non-translatable. You need to have the core Content
  uploaded files, and for each field on each entity subtype, you can configure
  it to be translatable or non-translatable. You need to have the core Content
  Translation module installed in order to translate this text.

==== What information will remain in English on my site?
+7 −7
Original line number Diff line number Diff line
@@ -47,13 +47,13 @@ defined by the core software or by modules.

Content entities are grouped into _entity types_, which have different purposes
and are displayed in very different ways on the site. Most entity
types are also divided into _entity sub-types_, which are divisions within an
types are also divided into _entity subtypes_, which are divisions within an
entity type to allow for smaller variations in how the entities are used and
displayed. Here is a table of some common content entity types:

[width="100%",frame="topbot",options="header",grid="rows"]
|=============================================
|Entity type |Entity sub-type |Defining Module |Main uses
|Entity type |Entity subtype |Defining Module |Main uses

|Content item |Content type |Node module
  |Content intended to be the main page area for pages on the site
@@ -99,17 +99,17 @@ displayed. Here is a table of some common content entity types:

==== What is a field?

Within entity items, the data is stored in individual _fields_, each of which
Within entities, the data is stored in individual _fields_, each of which
holds one type of data, such as formatted or plain text, images or other files,
or dates. Field types can be defined by the core software or by modules.

Fields can be added by an administrator on entity sub-types, so that all
entity items of a given entity sub-type have the same collection of fields
Fields can be added by an administrator on entity subtypes, so that all
entities of a given entity subtype have the same collection of fields
available. For example, the Vendor content type in the farmers market example
might have fields for the vendor name, a logo image, website URL, and
description, whereas the _Basic page_ content type might only have fields for
the title and page body. When you create or edit entity items, you are
specifying the values for the fields on the entity item.
the title and page body. When you create or edit entities, you are
specifying the values for the fields on the entity.

==== Related topics

+7 −7
Original line number Diff line number Diff line
@@ -46,22 +46,22 @@ account, and it would not be as easy to later change the ownership of a vendor
page to a different user account.

. Within each content entity type you identified, decide what division into
entity sub-types would make sense. For example, in the farmers market site
entity subtypes would make sense. For example, in the farmers market site
example, you would probably decide that under the Content item entity type,
there should be one content type for basic pages (Home and
About), one for vendor pages, and one for recipe pages.

. For each entity sub-type you decided on, decide what fields are needed. For
. For each entity subtype you decided on, decide what fields are needed. For
instance, the Vendor content type might need fields for the vendor name, web
page URL, image, and description.

. Decide on what entity listings are needed, which could be entire pages or
smaller areas on the page. For each listing, you'll need to determine what
entity items should be listed. Then you'll need to decide in what order and with
smaller areas on the page. For each listing, you'll need to determine which
entities should be listed. Then you'll need to decide in what order and with
what filtering options they should be displayed; for example, you might want to
give the site visitor the option to search by keyword, to filter the list down
to a subset, or to sort the list. You'll also need to decide what information
from the entity items should be shown, which might result in adding to the list
from the entities should be shown, which might result in adding to the list
of fields you determined in the previous step. The farmers market site, for
example, needs to have a Recipes listing page that lists content items of type
Recipe, with the ability to filter by ingredients, so that means that the Recipe
@@ -88,7 +88,7 @@ scenario example site:

[width="100%",frame="topbot",options="header"]
|=============================================
|Entity type |Entity sub-type |Examples |Fields
|Entity type |Entity subtype |Examples |Fields

|Content item |Basic page |Home page, about page |Title, page body

@@ -115,7 +115,7 @@ And here are the listings the site needs:

[width="100%",frame="topbot",options="header"]
|=============================================
|Page or page area |Entity type and sub-type |Filter/sort/pagination |
|Page or page area |Entity type and subtype |Filter/sort/pagination |
  Fields displayed

|Vendors page |Vendor content items |All vendors, alphabetical, paged |
+1 −1
Original line number Diff line number Diff line
@@ -54,7 +54,7 @@ values. Fill in the fields as shown below. Click _Save field settings_.
[width="100%",frame="topbot",options="header"]
|================================
|Field name | Explanation | Value
|Type of item to reference| Option to select the type of referenced item | Content
|Type of item to reference| Option to select the type of referenced entity | Content
| Allowed number of values | Specify the count of values associated with the field | Limited, 1
|================================
+
Loading