Skip to content

Commit ac99e53

Browse files
committed
continuing work on relation fields
1 parent 3e371fd commit ac99e53

9 files changed

Lines changed: 51 additions & 8 deletions
11.2 KB
Loading
-7.95 KB
Binary file not shown.
27.6 KB
Loading

docs/images/rel-has-part.png

22.2 KB
Loading

docs/images/rel-is-part-of.png

10.5 KB
Loading
12.5 KB
Loading
10.6 KB
Loading
-7.17 KB
Binary file not shown.

docs/relations-fields.md

Lines changed: 51 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Relations Fields
22

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.
3+
Fields in the "relations" group are used to describe how records relate to each other. All these fields are designed to store the [ID(s)](https://opengeometadata.org/ogm-aardvark/#id) of related records. More than one record can be listed within each relationship type.
44

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.
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.
66

77

88
| Field | Field Name | Obligation |
@@ -16,17 +16,60 @@ Starting in GeoBlacklight version 4.0, these fields are used to populate relatio
1616
| [Is Replaced By](../ogm-aardvark/#is-replaced-by) | `dct_isReplacedBy_sm` | Optional |
1717

1818
## 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.
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 on the item's show page, as well as on the related record's show page. Nothing needs to be entered in the related record's metadata.
2020

2121
```
22-
["the-related-record"]
22+
"dct_relation_sm": ["nyu_2451_34636"]
2323
```
24-
![related records](images/rel-related-records.png)
24+
25+
**Item's show page**
26+
27+
![related records widget - source](images/rel-related-record-source.png)
28+
29+
**Related record's show page**
30+
31+
![related records widget - link](images/rel-related-record-link.png)
2532

2633
## 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.
34+
35+
!!! tip
36+
37+
To link items in a book or atlas, use "Is Part Of" instead.
38+
39+
This field links an item to its collection(s). The first step is to create a separate collection record and assign it a unique ID. Then, enter the collection record's ID in the *member item's* metadata.
40+
41+
IDs entered in this field in the *member item's* metadata will populate a "Belongs to collection..." widget on the member item's show page and a "Collection records..." widget on the collection's show page. Nothing needs to be entered in the collection record's metadata.
42+
43+
```
44+
"pcdm_memberOf_sm": ["umass-macconnell-1951"]
45+
```
46+
47+
**Member item's show page**
48+
49+
![belongs to collection widget](images/rel-belongs-collection.png)
50+
51+
**Collection's show page**
52+
53+
![collection records widget](images/rel-collection-records.png)
54+
55+
## Is Part Of
56+
57+
!!! tip
58+
59+
To link items in a collection, use "Member Of" instead.
60+
61+
This field is similar to "Member Of" but is intended to link to items that are a subset of another item, like a book or atlas. The first step is to create a separate parent record and assign it a unique ID. Then, enter the parent record's ID in the *member item's* metadata.
62+
63+
IDs entered in this field in the *member item's* metadata will populate a "Is part of..." widget on the member item's show page and a "Has part..." widget on the parent's show page. Nothing needs to be entered in the parent record's metadata.
2864

2965
```
30-
["the-related-record"]
66+
"dct_isPartOf_sm": ["88cc9b19-3294-4da9-9edd-775c81fb1c59"]
3167
```
32-
![member of](images/rel-belongs-to-collection.png)
68+
69+
**Member item's show page**
70+
71+
![is part of widget](images/rel-is-part-of.png)
72+
73+
**Parent's show page**
74+
75+
![has part widget](images/rel-has-part.png)

0 commit comments

Comments
 (0)