accumlated updates

geobtaa · Mar 1, 2023 · e957918 · e957918
1 parent c4a980d
commit e957918
Show file tree

Hide file tree

Showing 55 changed files with 1,215 additions and 321 deletions.
diff --git a/docs/GEOMG.md b/docs/GEOMG.md
@@ -24,15 +24,37 @@ Not yet. We are currently working on offering this tool as a plugin for GeoBlack
 
 ## Layout
 
-Dashboard (Home page)
-![](images/geomg-dashboard.png)
+
+**Dashboard (Home page)**
 
 The Dashboard shows a list of all records in the index. These can be selected or filtered. The search functionality mimics the GeoBlacklight interface:
 
 * a search bar at the top: lets a user enter text searches
 * a list of facets on the left: lets a user filter records
 * a Date Range filter above the facets: lets a user select items by Date Created (when they were first added to GEOMG).
 
+![](images/geomg-dashboard.png)
+
+
+----------
+**Form view**
+
+This page is where new records can be manually created and existing records can be edited. Click on the button "View in Geoportal" to open a new tab with the record in the Geoportal. Note: the record is still viewable in the Geoportal via this button, even if it is a Draft or Unpublished.
+
+![](images/formView.png)
+
+
+------------
+**Notifications**
+
+Notifications is where the exported files can be found.
+
+![](images/notifications.png)
+
+
+
+## Selecting records
+
 Use the check boxes to select individual records or click the right arrow to select all records on the page.
 ![](images/checkbox.png)
 
@@ -58,38 +80,75 @@ A user can create records one by one using the form view.
 	* Access Rights
 
 
-### Uploading as a CSV
+### Batch Uploading with a CSV
 
-1. Save edited template as a CSV file
+1. Save edited template to your desktop as a CSV file
 [Use the B1G Template](https://z.umn.edu/b1g-template)
 
 2. Upload the spreadsheet to GEOMG
 
-- Go to Admin Tools and select Imports. Click "New Import".
-- Give a name to the upload and enter details about the source and description. These details are helpful later in tracking imports.
-- Select the CSV file for upload
-- For Type, choose the BTAA CSV. 
-- Click the **Create Import** button
-- Review the _Field Mappings_ page. If the CSV was formatted with column headers spelled the same way as the template, the fields should automatically map to the correct elements. Otherwise, manually choose the crosswalk mapping.
-- Scroll to the bottom and click the button **Create Mapping**
-- On the _Import_ page, check that the number in the CSV Row Count matches your CSV.
-- Click the button **Run Import**
-- The import may take a few minutes. During the process, you can view the Import Results tab. Items in the queue will show up in the first sub-tab ("Failed"), but will transfer to the second tab upon import ("Success").
-- When complete, review any items that did not import in the Failed tab. See Troubleshooting (_coming soon_) for help.
+	- Go to Admin Tools and select Imports. Click **New Import**.
+	- Give a name to the upload and enter details about the source and description. These details are helpful later in tracking imports.
+	- Select the CSV file for upload
+	- For Type, choose **BTAA CSV**. 
+	- Click the **Create Import** button
+	- Review the _Field Mappings_ page. If the CSV was formatted with column headers spelled the same way as the template, the fields should automatically map to the correct elements. Otherwise, manually choose the crosswalk mapping.
+	- Scroll to the bottom and click the button **Create Mapping**
+	- On the _Import_ page, check that the number in the CSV Row Count matches your CSV.
+	- Click the button **Run Import**
+	- The import may take a few minutes. During the process, you can view the Import Results tab. Items in the queue will show up in the first sub-tab ("Failed"), but will transfer to the second tab upon import ("Success").
+	- When complete, review any items that did not import in the Failed tab. See Troubleshooting (_coming soon_) for help.
 
 3. Spot check records for errors and consistency
 
-- The newly uploaded records will be listed as Draft under the Publication State on the main dashboard
-- Select 'Draft' under Publication State and select an item. This will open it in editing view.
-- Click the button **View in Geoportal**
-- Inspect the record and test the links. (note: Metadata and Web Service links will not open while the item is still in Draft)
-- Repeat this process for about 3 records.
+	- The newly uploaded records will be listed as Draft under the Publication State on the main dashboard
+	- Select 'Draft' under Publication State and select an item. This will open it in editing view.
+	- Click the button **View in Geoportal**
+	- Inspect the record and test the links. (note: Metadata and Web Service links will not open while the item is still in Draft)
+	- Repeat this process for about 3 records.
 
 
 4. Convert records from 'Draft' to 'Published'
 
-- If the records are satisfactory, return to the Dashboard view and select all Draft items in the upload. 
-- Select All and then select the text "Select all results that match this search"
-- Click the State button. From the dropdown, select Published.
-- On the _Bulk Action_ page, click the button **Run Bulk Action**
-- Review 3-5 of the published records and test all the links.
+	- If the records are satisfactory, return to the Dashboard view and select all Draft items in the upload. 
+	- Select All and then select the text "Select all results that match this search"
+	- Click the State button. From the dropdown, select Published.
+	- On the _Bulk Action_ page, click the button **Run Bulk Action**
+	- Review 3-5 of the published records and test all the links.
+
+## Secondary tables
+
+There are two metadata fields, `Multiple Download Links` and `Institutional Access Links` that use secondary tables. This occurs when the field needs parts to the value: a label + a link. 
+
+* When using the Form view, these values can be entered directly.
+* For CSV uploads, these values use a separate sheet than for the main import template.
+* Multiple Download Links: 
+	- on the Form view, scroll down to the Multiple Download Links inside the editor
+	- to enter manually, click the New Download URL button
+	- to upload multiple links, click the Import CSV button
+* Institutional Access Links
+	- on the Form view, click the text "Institutional Access Links" on the bottom of the right hand navigation OR go to Admin Tools - Access Links
+	- to enter manually, click the New Access URL button
+	- to upload multiple links, click the Import CSV button
+
+!!! Info "CSV field headers for secondary tables"
+
+    === "Multiple Downloads"
+
+        ``` markdown
+        
+			| friendlier_id       | label            | value      |
+			|---------------------|------------------|------------|
+			| ID of target record |  any string      | the link   |
+        ```
+
+    === "Institutional Access Links"
+
+        ``` markdown
+			| friendlier_id       | institution_code | access_URL |
+			|---------------------|------------------|------------|
+			| ID of target record |  2 digit code    | the link   |
+        ```
+
+
+
diff --git a/docs/b1g-custom-elements.md b/docs/b1g-custom-elements.md
@@ -18,6 +18,7 @@ This pages documents the custom metadata elements for the GeoBTAA Metadata Profi
 | b1g-11 | [GeoNames](#geonames)                       | `b1g_geonames_sm`                  | Optional |
 | b1g-12 | [Publication State](#publication-state)     |`b1g_publication_state_s`                  | Required |
 | b1g-13 | [Language String](#language-string)         |`b1g_language_sm`                  | Required |
+| b1g-14 | [Creator ID](#creator-id)                   |`b1g_creatorID_sm`               |Optional|
 
 ## Code
 
@@ -227,4 +228,20 @@ This pages documents the custom metadata elements for the GeoBTAA Metadata Profi
 | Commentary            | The OGM schema specified using a 3-digit code to indicate lanuage. In order to display this to users, it needs to be translated into a human-readable string. 
 | Controlled Vocabulary | yes                                                                                                                                                          |
 | Example value         | French                                                                                                                          |
+| Element Set           | B1G                                                                                                                                          |
+
+## Creator ID
+
+| Label                 | Creator ID                                                                                                                                                     |
+|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| URI                   | `b1g_creatorID_sm`                                                                                                                                          |
+| Profile ID            | b1g-14                                                                                                                                                       |
+| Obligation            | Optional                                                                                                                                                 |
+| Multiplicity          | 0-*                                                                                                                                                  |
+| Field type            | string |                                                                                                                                     
+| Purpose               | To track the URI of a creator value                                                                                     |
+| Entry Guidelines      | This field is entered as a URI representing an authority record            |
+| Commentary            | These best practices recommend consulting one or two name registries when deciding how to standardize names of creators: the Faceted Application of Subject Terminology (FAST) or the Library of Congress Name Authority File (LCNAF). FAST is a controlled vocabulary based on the Library of Congress Subject Headings (LCSH) that is well-suited to the faceted navigation of the Geoportal. The LCNAF is an authoritative list of names, events, geographic locations and organizations used by libraries and other organizations to collocate authorized creator names to make searching and browsing easier.
+| Controlled Vocabulary | yes                                                                                                                                                          |
+| Example value         | fst02013467                                                                                                                          |
 | Element Set           | B1G                                                                                                                                          |
diff --git a/docs/images/checkbox.png b/docs/images/checkbox.png
diff --git a/docs/images/formView.png b/docs/images/formView.png
diff --git a/docs/images/geomg-dashboard.png b/docs/images/geomg-dashboard.png
diff --git a/docs/images/import.png b/docs/images/import.png
diff --git a/docs/images/notifications.png b/docs/images/notifications.png
diff --git a/docs/images/selectAll.png b/docs/images/selectAll.png
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,22 +1,31 @@
 site_name: GeoBTAA Metadata Handbook
-#site_url: https://geoblacklight.org/docs
-#repo_url: https://github.com/geoblacklight/docs/main
-#edit_uri: https://github.com/geoblacklight/docs/main
+site_author: Big Ten Academic Alliance Geospatial Information Network
+copyright : "2022"
+repo_url: https://github.com/geobtaa/metadata
 theme: 
    name: material
    features:
-     - navigation.instant
-     - navigation.sections
-     - content.tooltips
-#     - navigation.tabs
-#     - navigation.tabs.sticky
- #    - navigation.prune
-#     - navigation.top
-#     - toc.integrate
+#     - navigation.instant
+      - navigation.sections
+      - content.tooltips
+#      - navigation.tabs
+#      - navigation.tabs.sticky
+      - navigation.top
    logo: images/btaa-logo-white.png
+   icon:
+      repo: fontawesome/brands/github
 #    highlightjs: true
 #   titles_only: true
 #   include_homepage_in_sidebar: false
+plugins:
+      - search
+      - with-pdf:
+            output_path: Desktop/b1g-handbook.pdf
+
+#   - pdf-export:
+#       combined: true
+#   - git-revision-date-localized:
+#       enable_creation_date: false
 
 extra_css:
   - stylesheets/extra.css
@@ -40,10 +49,6 @@ markdown_extensions:
   - pymdownx.superfences
   - pymdownx.tabbed:
       alternate_style: true 
-#      custom_fences:
-#        - name: mermaid
-#          class: mermaid
-#          format: !!python/name:pymdownx.superfences.fence_code_format
 
 
 nav: