Skip to content

Commit dcac5fb

Browse files
committed
clean up "view-solr-metadata"
1 parent 46bb655 commit dcac5fb

1 file changed

Lines changed: 12 additions & 13 deletions

File tree

docs/view-solr-metadata.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,36 @@
11
# View Solr Metadata in GeoBlacklight
22

3-
GeoBlacklight will display the raw metadata for a published item. Just append one of the following extensions to the end of an item's show page URL:
3+
GeoBlacklight can display the raw metadata for a published item by appending one of the following extensions to the end of an item's show page URL:
44

55
### `url.xml`
66

7-
* Produces a Dublin Core XML document in the [OAI_DC schema](https://www.openarchives.org/OAI/2.0/oai_dc.xsd). The fields for this document can be adjusted in the `solr_document.rb`, which is found here: `app/models/solr_document.rb`.
7+
* Produces a Dublin Core XML document in the [OAI_DC schema](https://www.openarchives.org/OAI/2.0/oai_dc.xsd).
8+
* The fields for this document can be adjusted in the `solr_document.rb`, which is found here: `app/models/solr_document.rb`.
89

910
!!! example
10-
11+
1112
[https://geo.btaa.org/catalog/145055E1-87EF-4D13-B138-4DC3907F3677.xml](https://geo.btaa.org/catalog/145055E1-87EF-4D13-B138-4DC3907F3677.xml)
1213

1314
### `url.json`
1415

1516
Depending on your version, this will produce either:
1617

17-
* a nested JSON document of the metadata that appears on the item page. This document can be harvested by the [JSON:API](https://jsonapi.org/) protocol.
18+
* A nested JSON document of the metadata that appears on the item page (this document can be harvested by the [JSON:API](https://jsonapi.org/) protocol), OR
1819

19-
* a full metadata file for the item as a flat JSON document (GeoBlacklight until version 1.9: .
20+
* A full metadata file for the item as a flat JSON document (up to GeoBlacklight version 1.9).
2021

2122
!!! example
22-
23+
2324
[https://geo.btaa.org/catalog/145055E1-87EF-4D13-B138-4DC3907F3677.json](https://geo.btaa.org/catalog/145055E1-87EF-4D13-B138-4DC3907F3677.json)
2425

2526

2627
### `url/raw`
2728

28-
* only available for GeoBlacklight versions 2.0+
29-
* displays the full metadata file for the item as a flat JSON document
29+
* Only available for GeoBlacklight versions 2.0+.
30+
* Displays the full metadata file for the item as a flat JSON document.
3031

3132
!!! example
32-
33+
3334
[https://geo.btaa.org/catalog/145055E1-87EF-4D13-B138-4DC3907F3677/raw](https://geo.btaa.org/catalog/145055E1-87EF-4D13-B138-4DC3907F3677/raw)
3435

3536

@@ -38,14 +39,12 @@ Depending on your version, this will produce either:
3839
=== "GBL versions 2.0 and beyond"
3940

4041
* `url.xml`: Dublin Core XML document
41-
* `url.json`: nested JSON document of only the metadata that appears on the item page.
42+
* `url.json`: nested JSON document of only the metadata that appears on the item page
4243
* `url/raw`: flat JSON document of all metadata associated with the item
4344

4445

4546

4647
=== "GBL < versions 1.9"
47-
48+
4849
* `url.xml`: Dublin Core XML document
4950
* `url.json`: flat JSON document of all metadata associated with the item
50-
51-

0 commit comments

Comments
 (0)