Skip to content

Commit ea07260

Browse files
committed
Updated glossary with GCI team input
1 parent eeed819 commit ea07260

File tree

1 file changed

+76
-26
lines changed

1 file changed

+76
-26
lines changed

docs/introduction/glossary.rst

Lines changed: 76 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5,55 +5,105 @@ Arches Glossary
55
The Arches project uses a number of specialized terms. The following glossary provides definitions to Arches terminology as well as links to relevant parts of the documentation relevant to different terms.
66

77

8-
* **Arches Designer** A user interface for facilitating database design, i.e. the creation of Resource Models. The Arches Designer consists of many different tools, such as the Graph Designer and Card Manager, each of which helps build a different facet of Resource Model creation.
8+
Glossary
9+
--------
910

10-
* **Basemaps** Underlying map layers which include, by default, aerial imagery, streetmaps, or terrain. You can also add your own basemaps through the same process as adding overlays.
11+
The Arches project uses a number of specialized terms. The following glossary provides definitions to Arches terminology as well as links to relevant parts of the documentation relevant to different terms.
1112

12-
* **Branch** Branches are building blocks that aid in the creation of resource models. When you add a branch to a resource model, its contents are copied into the resource model. This allows you to further customize the resource model while leaving the original branch unaltered.
13+
- **Arches Application**:
14+
A discrete Python package that can be integrated into one or more Arches projects. Arches Applications help to reduce development and sustainability costs for customizing Arches and adding specialized features. (See :ref:`Arches Applications`)
1315

14-
* **Business Data** In Arches, "business data" refers to instances of records that conform to the graphs you defined. Records of resource instances and tile data all qualify as business data (see more Resource Data). Like graphs, business data are stored as records in the Arches PostgreSQL database.
16+
- **Arches Designer**:
17+
A user interface for facilitating database design, i.e., the creation of Resource Models. The Arches Designer consists of many different tools, such as the Graph Designer, Card Designer, and Permissions, each of which helps build a different facet of Resource Model creation. (See :ref:`Arches Designer`)
1518

16-
* **Card** Cards are used to configure the data entry representation of a branch's graph; they define how information will be collected for each nodegroup. In some cases a complex branch may have multiple cards, which will be aggregated into a card container. Cards contain widgets, and determined how the widgets are ordered in the user interface.
19+
- **Arches Package**:
20+
A package is an external collection of Arches data (resource models, business data, concepts, collections) and customization files (widgets, datatypes, functions, system settings) that you can load into an Arches project. (See :ref:`Understanding Packages`)
1721

18-
* **Concept** A vocabulary term that is used throughout the Arches database to define resource. A concept has a preferred label ("house") and may have any number of alternative labels ("domicile", "townhouse"). When searching your database, a search for "domicile" would automatically use the "house" concept.
22+
- **Basemaps**:
23+
Underlying map layers which include, by default, aerial imagery, streetmaps, or terrain. You can also add your own basemaps through the same process as adding overlays.
1924

20-
* **Concept Collections** Concepts are grouped into collections. An example would be the concepts "Eastlake", "Italianate", and "Queen Anne", all of which would be grouped in an "Architectural Style" concept collection.
25+
- **Branch**:
26+
Branches are building blocks that aid in the creation of resource models. When you add a branch to a resource model, its contents are copied into the resource model. This allows you to further customize the resource model while leaving the original branch unaltered. (See: :ref:`Arches Database Theory`)
2127

22-
* **Datatype** A defined type of business data, such as a number or a date. Each node has a datatype.
28+
- **Business Data**:
29+
In Arches, "business data" refers to instances of records that conform to the graphs you defined. Records of resource instances and tile data all qualify as business data (see more Resource Data). Like graphs, business data are stored as records in the Arches PostgreSQL database.
2330

24-
* **Enterprise-level software** Computer software, such as Arches, that is designed for deployment in organizational contexts with both needs and capabilities beyond those typical of an individual person.
31+
- **Card**:
32+
Cards are used to configure the data entry representation through the Arches user interface of a branch's graph; they define how information will be collected for each nodegroup. In some cases, a complex branch may have multiple cards, which will be aggregated into a card container. Cards contain widgets and determine how the widgets are ordered in the user interface. (See: :ref:`Cards Tab`)
2533

26-
* **Graph** A network of nodes, connected by edges, that defines the set of attributes for either a Branch or a Resource Model. If an ontology is enforced on the graph, each node will belong to an ontological class and only certain types of edges may be used to connect them. (See :ref:`Graph Definition`)
34+
- **CIDOC Conceptual Reference Model (CRM)**:
35+
An ontology developed by the International Committee for Documentation (CIDOC) of the International Council of Museums (ICOM) to model cultural heritage information. The `CIDOC CRM <https://cidoc-crm.org/>`_ has been adopted by the International Organization for Standardization (ISO) as an international standard.
2736

28-
* **Instance** a specific example of a class or category of things-e.g., my dog Cubby is an instance of the class dogs.
37+
- **Concept, Arches**:
38+
A vocabulary term that is used throughout the Arches database to define resources. A concept has a preferred label (e.g., "house") and may have any number of alternative labels (e.g., "domicile", "townhouse"). When searching your database, a search for "domicile" would automatically return the "house" concept. (See: :ref:`Reference Data Manager (RDM)`)
2939

30-
* **Instance, Arches** one individual implementation of Arches- i.e., the specific Arches code, configuration options, models, RDM, workflows, and data accessible.
40+
- **Concept Collections**:
41+
Concepts are grouped into collections. An example would be the concepts "Craftsman," "Art Deco," and "Queen Anne," all of which would be grouped in an "Architectural Style" concept collection. (See: :ref:`Reference Data Manager (RDM)`)
3142

32-
* **Instance, Resource** an instance of an Arches resource model (see below)- e.g., Westminster Abbey is an instance of an Arches resource model for historic buildings- i.e., one particular resource.
43+
- **Datatype**:
44+
A defined type of business data, such as a number or a date. Each node must be assigned a datatype. (See: :ref:`Core Arches Datatypes`)
3345

34-
* **Menu** Menus are groupings of cards associated with a given resource model. They allow for an organized, thematic approach to data entry.
46+
- **Edge**:
47+
Edges represent the connections or relationships between nodes and can be defined by semantic properties. (See: :ref:`Edge`)
3548

36-
* **Node** The smallest unit of a graph, a node will have a name and datatype. If the graph participates in an ontology, the node must also have a CRM class, and a defined relationship (edge) between it and the node upstream of it. (See :ref:`Graph Definition`)
49+
- **Enterprise-level software**:
50+
Computer software, such as Arches, that is designed for deployment in organizational contexts with both needs and capabilities beyond those typical of an individual person. Enterprise software is typically installed on a physical server or through cloud-based server services.
3751

38-
* **Nodegroup** Within graphs, nodes are aggregated into nodegroups. An example of a nodegroup would be Name and Name Type. Edit permissions are enforced at the nodegroup level. (See :ref:`Graph Definition`)
52+
- **Graph**:
53+
A network of nodes, connected by edges, that defines the set of attributes for either a Branch or a Resource Model. If an ontology is enforced on the graph, each node will belong to an ontological class and only certain types of edges may be used to connect them. (See :ref:`Graph Definition`)
3954

40-
* **Ontology** A set of rules the govern the way nodes are defined and connected in a graph. Arches comes pre-loaded with the CIDOC CRM, an ontology developed by ICOM to model cultural heritage.
55+
- **Implementation, Arches**:
56+
A specific deployment of Arches software that is installed, managed, and maintained by an individual, a team, or an organization. Arches implementations can be hosted on hardware owned by an individual or organization, or, alternatively, Arches implementations can run on cloud-computing services.
4157

42-
* **Overlays** Static map layers that can be added to Arches. These could be historic maps, administrative boundaries, or existing map services published elsewhere.
58+
- **Instance**:
59+
A specific example of a class or category of things, e.g., my dog Cubby is an instance of the class dogs.
4360

44-
* **Reference Data Manager (RDM)** User interface for managing all of the concepts and word lists in your Arches database.
61+
- **Instance, Arches**:
62+
One individual implementation of Arches, i.e., the specific Arches code, configuration options, models, RDM, workflows, and data accessible.
4563

46-
* **Resource Layers** Map layers that are created from your Arches database. There is one resource layer for each node with datatype "geojson-feature-collection" that is stored across all resource models.
64+
- **Instance, Resource**:
65+
An Arches data record that expresses a particular Arches resource model (see below), e.g., the Arches data record for Westminster Abbey is a resource instance of the Arches for HERs Monument resource model.
4766

48-
* **Resource Model** Resource Models are top-level categories for resources in your database. When creating new resources, a data entry user must decide which resource model to use, thereby defining what information is collected for the resource. The entire Arches Designer exists to facilitate the creation and customization of resource models.
67+
- **Menu**:
68+
Menus are groupings of Arches user interface cards associated with a given resource model. They allow for an organized, thematic approach to data entry.
4969

50-
* **Resource Relationships** Arches provides the ability to relate one resource to another by creating resource relationships. Resource relationships are directional and will have an associated concept, such as "contains / is contained in".
70+
- **Node**:
71+
The smallest unit of a graph, a node will have a name and datatype. If the graph participates in an ontology, the node must also have an ontology class and a defined relationship (edge) between it and the node upstream of it. (See :ref:`Graph Definition`)
5172

52-
* **Resource Report** A resource’s report shows all of the saved information for a resource. Templates for reports are associated with each resource models.
73+
- **Nodegroup**:
74+
Within graphs, nodes are aggregated into nodegroups. An example of a nodegroup would be the grouping of Name and Name Type. Edit permissions in Arches are enforced at the nodegroup level. (See :ref:`Graph Definition`)
5375

54-
* **Tile Data** Arches stores descriptive information about resource instances as tile data. Each Tile stores one instance of all of the attributes of a given NodeGroup for a given resource instance. Tile data is a type of business data stored by Arches. See :ref:`TileModel`
76+
- **Ontology**:
77+
A set of rules that governs the way nodes are defined and connected in a graph. Arches comes pre-loaded with the CIDOC Conceptual Reference Model (CRM). (See the CIDOC CRM Entry above)
5578

56-
* **Time Wheel** A graphical interface used to support advanced time-based visualization and search of your database.
79+
- **Overlays**:
80+
Static map layers that can be added to Arches. These could be historic maps, administrative boundaries, or existing map services published elsewhere. (See :ref:`Managing Map Layers`)
81+
82+
- **Reference Data Manager (RDM)**:
83+
User interface for managing all of the concepts and word lists in your Arches database. (See: :ref:`Reference Data Manager (RDM)`)
84+
85+
- **Resource Layers Map**:
86+
Geospatial layers that are created from your Arches database. There is one resource layer for each node with datatype "geojson-feature-collection" that is stored across all resource models. (See :ref:`Managing Map Layers`)
87+
88+
- **Resource Model**:
89+
Resource Models are top-level categories for resources in your database. When creating a new resource, a data entry user must decide which resource model to use, thereby defining what information is collected for the resource. The Arches Designer provides for the creation and customization of resource models. (See: :ref:`Arches Database Theory`)
90+
91+
- **Resource Relationships**:
92+
Arches provides the ability to create and define relationships between resources. Resource relationships can be defined by the inherited semantic property or by the label of a concept and are bi-directional.
93+
94+
- **Resource Report**:
95+
A resource's report shows all, or a determined set, of the saved information for a resource. Templates for reports are associated with each resource model.
96+
97+
- **Tile Data**:
98+
Arches stores descriptive information about resource instances as tile data. Each Tile stores one instance of all of the attributes of a given NodeGroup for a given resource instance. Tile data is a type of business data stored by Arches. (See :ref:`TileModel`)
99+
100+
- **Time Wheel**:
101+
A graphical interface used to support advanced time-based visualization and search of information within your Arches database. (See :ref:`Time Wheel Configuration`)
102+
103+
- **Widget**:
104+
A user interface input element designed to manage form input of a specific datatype. Each widget represents one node, and widgets for all nodes in a nodegroup are contained in a single card. (See :ref:`Widgets`)
105+
106+
- **Workflows, Arches**:
107+
Workflows are a type of Plugin that can simplify the data entry process. A workflow is composed of one or more cards from a resource model, placing them in a step-through set of forms. (See :ref:`Workflows`)
57108

58-
* **Widget** An input element designed to manage form input of a specific datatype. Each widget represents one node, and widgets for all nodes in a nodegroup are contained in a single card.
59109

0 commit comments

Comments
 (0)