Skip to content

Commit 3e371fd

Browse files
committed
starting to work on relations field page
1 parent a18f65f commit 3e371fd

4 files changed

Lines changed: 35 additions & 2 deletions

File tree

7.95 KB
Loading
7.17 KB
Loading

docs/relations-fields.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Relations Fields
2+
3+
There are seven fields for describing how records relate to each other. All of these fields are designed to store the [ID(s)](https://opengeometadata.org/ogm-aardvark/#id) of related records. Their multi-valued setting allows multiple records to be listed within each relationship type.
4+
5+
Starting in GeoBlacklight version 4.0, these fields are used to populate relationship widgets in the application sidebar, allowing users to easily explore related records and understand how they are connected. The relationship widgets are customizable in the `geoblacklight.en.yml` and `settings.yml` files in GeoBlacklight.
6+
7+
8+
| Field | Field Name | Obligation |
9+
|:------|:-----------|:-----------|
10+
| [Relation](../ogm-aardvark/#relation) | `dct_relation_sm` | Optional |
11+
| [Member Of](../ogm-aardvark/#member-of)| `pcdm_memberOf_sm` | Optional |
12+
| [Is Part Of](../ogm-aardvark/#is-part-of) | `dct_isPartOf_sm` | Optional |
13+
| [Source](../ogm-aardvark/#source) | `dct_source_sm` | Optional |
14+
| [Is Version Of](../ogm-aardvark/#is-version-of) | `dct_isVersionOf_sm` | Optional |
15+
| [Replaces](../ogm-aardvark/#replaces) | `dct_replaces_sm` | Optional |
16+
| [Is Replaced By](../ogm-aardvark/#is-replaced-by) | `dct_isReplacedBy_sm` | Optional |
17+
18+
## Relation
19+
Use this field to link to records that are related in a general or non-specific way. IDs entered in this field will populate a "Related Records" widget in the application sidebar.
20+
21+
```
22+
["the-related-record"]
23+
```
24+
![related records](images/rel-related-records.png)
25+
26+
## Member Of
27+
This field lists the collection(s) to which an item belongs. A collection record must be created separately, then the collection record's ID is entered here. IDs entered in this field will populate a "Belongs to collection..." widget.
28+
29+
```
30+
["the-related-record"]
31+
```
32+
![member of](images/rel-belongs-to-collection.png)

mkdocs.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,8 @@ nav:
123123
- 'About OGM Repositories': 'about-ogm-repositories.md'
124124
- Metadata:
125125
- 'About OGM Aardvark': 'about-ogm-aardvark.md'
126-
- 'Spatial Fields': 'spatial-fields.md'
127-
- 'Temporal Fields': 'temporal-fields.md'
128126
- 'JSON Format': 'JSON-format.md'
127+
- 'Temporal Fields': 'temporal-fields.md'
128+
- 'Spatial Fields': 'spatial-fields.md'
129+
- 'Relations Fields': 'relations-fields.md'
129130
- 'Further Reading': 'further-reading.md'

0 commit comments

Comments
 (0)