Skip to content

Commit 3d68c28

Browse files
committed
clean up "temporal-fields"
1 parent ef095a4 commit 3d68c28

1 file changed

Lines changed: 9 additions & 10 deletions

File tree

docs/temporal-fields.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
Aardvark has four fields in the "temporal" group. Having multiple temporal fields allows for flexibility in describing the date of a resource, allowing users to easily find records by way of text search, facet filtering, and time slider widgets (an optional customization in the GeoBlacklight software). In some cases, the same value might be used for more than one field.
44

5-
| Field | Obligation |
6-
|:----------------------|:---------|
7-
| [Temporal Coverage](../ogm-aardvark/#temporal-coverage) | Suggested |
8-
| [Date Issued](../ogm-aardvark/#date-issued) | |
9-
| [Index Year](../ogm-aardvark/#index-year) | Suggested |
10-
| [Date Range](../ogm-aardvark/#date-range) | |
5+
| Field | Field Name | Obligation |
6+
|:------|:-----------|:-----------|
7+
| [Temporal Coverage](../ogm-aardvark/#temporal-coverage) | `dct_temporal_sm` | Suggested |
8+
| [Date Issued](../ogm-aardvark/#date-issued) | `dct_issued_s` ||
9+
| [Index Year](../ogm-aardvark/#index-year) | `gbl_indexYear_im` | Suggested |
10+
| [Date Range](../ogm-aardvark/#date-range) | `gbl_dateRange_drsim` ||
1111

1212

1313
## Temporal Coverage
@@ -21,7 +21,7 @@ This is a descriptive, free-text field that is intended to describe the time per
2121
```
2222

2323
## Date Issued
24-
This is an optional field for describing the date of an item's publication. Although optional, this field is often useful when a clear `Temporal Coverage` value is not present. For example, a dataset with uncertain lineage may at least have a date of last update. Generally it should be structured as a single year: `YYYY`, but more precise dates can take the ISO format withtout the time value: `YYYY-MM-DD` or `YYYY-MM`.
24+
his is an optional field for describing the date of an item's publication. Although optional, this field is often useful when a clear temporal coverage value is not present. For example, a dataset with uncertain lineage may at least have a date of last update. Generally it should be structured as a single year: `YYYY`, but more precise dates can take the ISO format withtout the time value: `YYYY-MM-DD` or `YYYY-MM`.
2525

2626
```
2727
"1999"
@@ -31,7 +31,7 @@ This is an optional field for describing the date of an item's publication. Alth
3131
```
3232

3333
## Index Year
34-
This is a suggested field for describing the date depicted in a resource. It is the only integer field in the "temporal" group and is formatted as an array of multiple values. The default GeoBlacklight application uses this field in the "Year" facet, allowing users to filter search results by year. It is also used to power customizable time-slider widgets that rely on integers for dates.
34+
This is a suggested field for describing the date depicted in a resource. It is the only integer field in the temporal group and is formatted as an array of multiple values. The default GeoBlacklight application uses this field in the "Year" facet, allowing users to filter search results by year. It is also used to power customizable time-slider widgets that rely on integers for dates.
3535

3636
```
3737
[1985]
@@ -41,9 +41,8 @@ This is a suggested field for describing the date depicted in a resource. It is
4141
```
4242

4343
## Date Range
44-
4544
This optional field is not yet supported by GeoBlacklight software, but its intent is to power time widgets that use a date range (an optional customization to the software). The field is formatted as a start date and end date in the Solr date range field convention.
4645

4746
```
4847
["1985 TO 1987"]
49-
```
48+
```

0 commit comments

Comments
 (0)