| 1 | # Glossary
|
| 2 |
|
| 3 | This document intends to define terms that are used across the project
|
| 4 | and the contexts in which they might be used in.
|
| 5 |
|
| 6 | ### (cotype-) server
|
| 7 |
|
| 8 | The generic implementation of the cotype backend.
|
| 9 | It's intended to be configured by a [CMS](#a-single-cms).
|
| 10 |
|
| 11 | ### (cotype-) client
|
| 12 |
|
| 13 | A generic frontend that uses the admin API of the [server](#cotype-server).
|
| 14 |
|
| 15 | ### (A single) CMS
|
| 16 |
|
| 17 | A piece of software that configures the [server](#cotype-server) for a
|
| 18 | specific use case.
|
| 19 |
|
| 20 | ### (The) Demo
|
| 21 |
|
| 22 | The example [CMS](#a-single-cms) in this repository.
|
| 23 |
|
| 24 | ### Model
|
| 25 |
|
| 26 | A model describes the shape of a [data-set](#data-set) and holds meta information
|
| 27 | about it.
|
| 28 |
|
| 29 | Models are used to configure the [CMS](#a-single-cms).
|
| 30 |
|
| 31 | The [server](#cotype-server) has internal [model types](#model-type) like
|
| 32 | settings and media but also supports [content models](#content-model) that are
|
| 33 | defined by the [CMS](#a-single-cms).
|
| 34 |
|
| 35 | ### Model Type
|
| 36 |
|
| 37 | All custom [models](#model) used to configure the server are of type "content".
|
| 38 | But the server also uses other types like "setting" or "media".
|
| 39 |
|
| 40 | ### Model Name
|
| 41 |
|
| 42 | Unique name of a [model](#model), used to tie a [data-set](#data-set) to a
|
| 43 | specific [model](#model).
|
| 44 |
|
| 45 | ### Content Model
|
| 46 |
|
| 47 | A [model](#model) of [type](#model-type) "content". Which can be implicit since
|
| 48 | all custom models defined by the [CMS](#a-single-cms) are of type content.
|
| 49 |
|
| 50 | ### Data(-Set)
|
| 51 |
|
| 52 | Generic name for any data entity.
|
| 53 |
|
| 54 | ### Data(-set) Type
|
| 55 |
|
| 56 | Same as [model name](#model-name) but in the context of a [data-set](#data-set).
|
| 57 | A [data-set](#data-set) has a type that connects it to a single [model](#model).
|
| 58 |
|
| 59 | ### Content
|
| 60 |
|
| 61 | A content is a specific [data-set](#data-set) that is modeled after one of the
|
| 62 | [content models](#content-model).
|
| 63 |
|
| 64 | ### Content type
|
| 65 |
|
| 66 | Alias for [data-set type](#data-set-type) in the context of a [content](#content).
|
| 67 |
|
| 68 | ### Setting
|
| 69 |
|
| 70 | A setting is a specific [data-set](#data-set) that is modeled after the
|
| 71 | [servers](#cotype-server) internal setting [model](#model). Or in other words,
|
| 72 | a [data-set](#data-set) with the [modelType](#model-type) "setting".
|
| 73 |
|
| 74 | ### Media (Entity)
|
| 75 |
|
| 76 | A media entity is a specific [data-set](#data-set) that is modeled after the
|
| 77 | [servers](#cotype-server) internal media [model](#model). Or in other words,
|
| 78 | a [data-set](#data-set) with the [modelType](#model-type) "media".
|
| 79 |
|
| 80 | ### Field
|
| 81 |
|
| 82 | Fields are defined by a [model](#model). When creating a [data-set](#data-set),
|
| 83 | the user of a [CMS](#a-single-cms) fills this fields with custom data.
|