diff --git a/content/product_records/extent_tab_product.qmd b/content/product_records/extent_tab_product.qmd index f02f6c2..9cb0f84 100644 --- a/content/product_records/extent_tab_product.qmd +++ b/content/product_records/extent_tab_product.qmd @@ -18,21 +18,21 @@ searching within specific geographic areas. ### Extent Tab | Metadata Field | Product Records | |:------------------------------------|:----------| -| Extent | [Required](#creating-extents)`r req_style` | +| Extent | [Required]`r req_style` | : {.striped .hover .bordered .sm .allborder}
Spatial extents should be included for all applicable products. As a default, products should inherit extents from their parent project. geoJSON files for -specific geographies are available on +specific LCC geographies are available on [ScienceBase](https://www.sciencebase.gov/catalog/item/5bd7c96fe4b0b3fc5ce82d44) -(private DMWG folder that requires ScienceBase login). Download the relevant +(requires ScienceBase login). Download the relevant files and then import the geoJSON files into mdEditor. -:::{.callout-tip} -Tip: You can export, save, and import an extent to use for other projects or +:::{.callout-tip icon=false} +You can export, save, and import an extent to use for other projects or products. ::: -See further information on Extents in the [Project Extent entry guidance](../project_records/extent_tab_project.qmd). +See further information on Extents in the [Project Extent Tab](../project_records/extent_tab_project.qmd). diff --git a/content/product_records/keywords_tab_product.qmd b/content/product_records/keywords_tab_product.qmd index 5bd3d3f..9990217 100644 --- a/content/product_records/keywords_tab_product.qmd +++ b/content/product_records/keywords_tab_product.qmd @@ -228,7 +228,7 @@ the workflow section for more info about using template records. mdEditor uses the term "keywords" while ScienceBase uses the term "tags." -::: {.callout-hint appearance="minimal"} +::: {.callout-hint icon=false} Keywords edited in mdEditor will not overwrite keywords stored in ScienceBase (i.e. sbJSON) because ScienceBase only adds to the list of tags. If you do not want obsolete keywords/tags to show up on ScienceBase, manually delete these in diff --git a/content/product_records/main_tab_product.qmd b/content/product_records/main_tab_product.qmd index cfe213c..0cd5b74 100644 --- a/content/product_records/main_tab_product.qmd +++ b/content/product_records/main_tab_product.qmd @@ -16,30 +16,30 @@ The **Main** tab allows for the creation and/or editing of primary metadata. | Metadata Field | Product Records | |:------------------------------|:-------------| | Basic Information | | -|        Title | [Required](#title)`r req_style` | -|        Status | [Required](#status)`r req_style` | +|        Title | [Required](#title-required)`r req_style` | +|        Status | [Required](#status-required)`r req_style` | | Default Locale | [Required](#default-locale-required)`r req_style` | -| Resource Type | [Required](#resource-types)`r req_style` | +| Resource Type | [Required](#resource-types-required)`r req_style` | | Points of Contact | | -|        Point of Contact | [Required](#point-of-contacts)`r req_style`| -|        Custodian | [Required](#point-of-contacts)`r req_style`| +|        Point of Contact | [Required](#points-of-contact-required)`r req_style`| +|        Custodian | [Required](#points-of-contact-required)`r req_style`| |        Administrator | | -|        Administrative Region | [Required](#point-of-contacts)`r req_style`| -|        Principal Investigator | [If Applicable](#point-of-contacts)`r if_style` | -|        Co-Principal Investigator | [If Applicable](#point-of-contacts-if-applicable)`r if_style` | +|        Administrative Region | [Required](#points-of-contact-required)`r req_style`| +|        Principal Investigator | [If Applicable](#points-of-contact-required)`r if_style` | +|        Co-Principal Investigator | [If Applicable](#points-of-contact-required)`r if_style` | | Citation | | -|        Title | [Required](#title)`r req_style`| -|        Dates (multiple) | [If Applicable](#dates-if-applicable)`r if_style` | +|        Title | [Required](#title-required-1)`r req_style`| +|        Dates (multiple) | [Required](#dates-required)`r req_style` | |        Responsible Parties (multiple) | [Required](#responsible-parties-required)`r req_style` | |        Online Resource | | -|               Name | [If Applicable](#online-resource)`r if_style` | -|               URL | [If Applicable](#online-resource)`r if_style` | -|               Function | [If Applicable](#online-resource)`r if_style` | +|               Name | [If Applicable](#online-resource-if-applicable)`r if_style` | +|               URL | [If Applicable](#online-resource-if-applicable)`r if_style` | +|               Function | [If Applicable](#online-resource-if-applicable)`r if_style` | |        Identifier | | -|               Identifier | [Required](#metadata-identifier-required)`r req_style` | -|               Namespace | [Required](#metadata-namespace-required)`r req_style` | +|               Identifier | [Required](#identifier-required)`r req_style` | +|               Namespace | [Required](#identifier-required)`r req_style` | | Description | | -|        Abstract | [Required](#abstract)`r req_style` | +|        Abstract | [Required](#abstract-required)`r req_style` | | Time Period | | |        Start Date | [If Applicable](#time-period)`r if_style` | |        End Date | [Required](#time-period)`r req_style` | @@ -178,10 +178,15 @@ online resource that data.gov reads so without a URL there, users have no way to access the actual product from data.gov. ::: -#### Identifier +#### Identifier [(Required)]`r req_style` -You may enter as many identifiers as desired, but at least one is -required. If you have internal SA specific IDs for projects, enter them here. +You may enter as many Identifiers as needed, but at least one is +required. Identifiers are unique codes +that identify a metadata records and enable metadata management and cataloging. +An **Identifier** is a unique character string and the **Namespace** describes +the environment (e.g., ScienceBase, ITIS, etc.) or type +(e.g., mapProjection, UUID, etc.) of the identifier. +If you have internal SA specific IDs for projects, enter them here. A Digital Object Identifier (DOI) is the preferred identifier for this. The Archive Folder Name may be included here as well. @@ -246,12 +251,12 @@ Enter comments, if desired. ## Time Period -### Start Date and End Date [(Required)]`r req_style` +### Start Date [(If Applicable)]`r if_style` and End Date [(Required)]`r req_style` **Time Period** refers to when date the product was applicable, For example, the time when a map is valid, date of publication, date of presentation, or -dates when the data was collected. For each product, enter a **Start Date** and -**End Date**. +dates when the data was collected. For each product, enter a **Start Date**, +if available, and **End Date**. ![](../../assets/example_time_period.png) diff --git a/content/product_records/metadata_tab_product.qmd b/content/product_records/metadata_tab_product.qmd index d3ee625..d249c49 100644 --- a/content/product_records/metadata_tab_product.qmd +++ b/content/product_records/metadata_tab_product.qmd @@ -19,30 +19,30 @@ metadata, and metadata repositories. | Metadata Field | Product Records | |:------------------------------|:-------------| | Metadata Status | [Required](#metadata-status-required)`r req_style` | -| Dates | | +| Dates | [Required](#dates-required)`r req_style`| | Metadata Contacts | | |        Author | [Required](#metadata-contacts)`r req_style`| |        Publisher | [Required](#metadata-contacts)`r req_style`| -|        Point of Contact | [Required](#metadata-contacts)`r req_style`| -| Metadata Identifier | [Required](#metadata-identifier)`r req_style`| -| Parent Metadata | [Required](#parent-metadata)`r req_style`| -| Metadata Repositories | [Required](#metadata-repositories)`r req_style`| +|        Point of Contact | [Required](#metadata-contacts-required)`r req_style`| +| Metadata Identifier | [Required](#metadata-identifier-required)`r req_style`| +| Parent Metadata | [Required](#parent-metadata-required)`r req_style`| +| Metadata Repositories | [Required](#metadata-repositories-required)`r req_style`| : {.striped .hover .bordered .sm .allborder}
## Basic Information -### Metadata Status +### Metadata Status [(Required)]`r req_style` Select the appropriate **Status** of the creation of your metadata from the drop-down menu. For example, if you have added all of your metadata, select ***completed***. If you still have metadata to add, select ***onGoing***. -### Dates +### Dates [(Required)]`r req_style` -Enter a **Date** for ***creation*** or ***last updated*** date. At least one of -these dates is required. +Enter a **Date** for ***creation*** or ***last updated*** date. +At least one of these dates is required. ## Metadata Contacts @@ -95,7 +95,7 @@ in [Main/Citation/Identifier](main_tab_product.qmd#identifier). ![Example of identifiers in citation.](../../assets/doi_correct_doi_identifier.png) -## Parent Metadata +## Parent Metadata [(Required)]`r req_style` **Parent Metadata** defines the ScienceBase folder in which the product will be published. The parent metadata tells mdEditor where the product metadata should @@ -126,7 +126,7 @@ the item's URL immediately following "**item/**". For example, ![Example Parent Metadata entry](../../assets/example_sb_parent_metadata_product.png) -## Metadata Repositories +## Metadata Repositories [(Required)]`r req_style` **Metadata Repositories** indicate where the metadata will be sent upon publishing. diff --git a/content/project_records/associated_tab_project.qmd b/content/project_records/associated_tab_project.qmd index 99023ad..aec504d 100644 --- a/content/project_records/associated_tab_project.qmd +++ b/content/project_records/associated_tab_project.qmd @@ -13,11 +13,11 @@ Products can be linked together by using association. Adding associations gives users the ability to find items that relate to each other in the Science Catalog. -:::{.callout-note} +:::{.callout-note icon=false} In ScienceBase, **Associated Records** are referred to as **Item Associations**. ::: -:::{.callout-note} +:::{.callout-note icon=false} Remember: Project-product associations are different than parent-child relationships on ScienceBase. ::: @@ -29,7 +29,7 @@ record. The "Association Type" will define the association from your current record to the linked record. Specifying the "Linked Association Type" will create the association from the other direction. -:::{.callout-note} +:::{.callout-note icon=false} Important: It is recommended you ALWAYS specify the Linked Association Type when you create associations. This will ensure the associations are defined from both directions and be present in the metadata no diff --git a/content/project_records/documents_tab_project.qmd b/content/project_records/documents_tab_project.qmd index 4dbf3f1..aba547e 100644 --- a/content/project_records/documents_tab_project.qmd +++ b/content/project_records/documents_tab_project.qmd @@ -14,7 +14,7 @@ report for a workshop that inspired the project. There are no specific requirements or best practices for documents. -::: {.callout-note} +::: {.callout-note icon=false} ScienceBase has a similar section called "weblinks." These will be populated in the Documents section if sbJSON is imported into mdEditor. diff --git a/content/project_records/extent_tab_project.qmd b/content/project_records/extent_tab_project.qmd index cb25c8f..bc837b2 100644 --- a/content/project_records/extent_tab_project.qmd +++ b/content/project_records/extent_tab_project.qmd @@ -55,28 +55,28 @@ geoJSON files for all FWS regional and state geographies are available on (private DMWG folder that requires ScienceBase login). Download the relevant files and then import into mdEditor. -::: {.callout-note} +::: {.callout-note icon=false} Important: coordinates used must be geographic coordinates, not projected coordinates. {% endhint %} ::: ### Option 2: Draw Spatial Features -::: {.callout-note} +::: {.callout-note icon=false} Tip: It is easier to click "finish" when drawing a polygon instead of trying to close the polygon by clicking on the first point. ::: ### Option 3: Draw Bounding Box -::: {.callout-tip} +::: {.callout-tip icon=false} mdEditor can automatically calculate a bounding box if you have at least one extent in the metadata. ::: ![Example Geographic Extent entry](../../assets/example_geographic_extent.png) -::: {.callout-warning} +::: {.callout-warning icon=false} Bounding boxes will not work across the dateline but you can have more than one extent per project. If your project area crosses the dateline, split the area into multiple extents and create separate bounding @@ -85,7 +85,7 @@ boxes. ## Saving and Exporting Extents -::: {.callout-note} +::: {.callout-note icon=false} Tip: You can export, save, and import an extent to use for other projects or products. ::: diff --git a/content/project_records/funding_tab_project.qmd b/content/project_records/funding_tab_project.qmd index 174ff74..916757b 100644 --- a/content/project_records/funding_tab_project.qmd +++ b/content/project_records/funding_tab_project.qmd @@ -18,16 +18,16 @@ and recipients, enables comparisons, and aggregations across all regions. | Metadata Field | Project Records | |:------------------------------|:-------------| | Allocation | | -|        Amount | [Required](#amount-required)`r req_style`^\*^ | -|        Currency | [Required](#currency-required)`r req_style`^\*^ | -|        Award ID | [Required](#award-id-required)`r req_style`^\*^ | -|        Source | [Required](#source-required)`r req_style`^\*^ | +|        Amount | [Required](#amount-required)`r req_style` | +|        Currency | [Required](#currency-required)`r req_style` | +|        Award ID | [Required](#award-id-required)`r req_style` | +|        Source | [Required](#source-required)`r req_style` | |        Recipient | [Required](#recipient-required)`r req_style` | -|        Other Contacts (multiple) | [Required](#recipient-required)`r req_style`| +|        Other Contacts (multiple) | [Required](#other-contacts-required)`r req_style`| |        Matching and In-kind Funds | [If Applicable](#matching-and-in-kind-funds-if-applicable)`r if_style` | | Time Period | | -|        Fiscal Year | [Required](#dates-required)`r req_style`^\*^ | -| Description (multiple) | [Best Practice](#description)`r best_style` | +|        Fiscal Year | [Required](#dates-required)`r req_style` | +| Description (multiple) | [Best Practice](#description-best-practive)`r best_style` | : {.striped .hover .bordered .sm .allborder}
@@ -127,7 +127,8 @@ Funding Other Contacts. ![Example of organizational fund contact entry](../../assets/example_organizational_contact.png) -![Example of organizational fund entry in Funding metadata entry](../../assets/example_funding_entry.png) +![Example of organizational fund entry in Funding metadata entry](../../assets/example_funding_entry.png) + ### Matching and In-kind Funds ([If applicable]`r if_style`) Project funds or in-kind support that were supplied by a partner (i.e., not @@ -141,11 +142,11 @@ to be included as a separate allocation. ### Dates ([Required]`r req_style`) -For each allocation, enter the fiscal year that funds were awarded (not the time -span of the entire project). There should be a single fiscal year for each -allocation. Adding a time period lets users know when your items were funded, -and lets them find your item when searching for items funded in a similar time -period. +For each allocation, enter the **Fiscal Year** that funds were awarded +(not the time span of the entire project). There should be a single fiscal +year for each allocation. Adding a time period lets users know when your items +were funded, and lets them find your item when searching for items funded in +a similar time period. :::{.callout-tip icon=false} Use the “Pick a Fiscal Year” dropdown to autofill the date fields. diff --git a/content/project_records/keywords_tab_project.qmd b/content/project_records/keywords_tab_project.qmd index 2ea8883..2801316 100644 --- a/content/project_records/keywords_tab_project.qmd +++ b/content/project_records/keywords_tab_project.qmd @@ -11,7 +11,7 @@ setwd("../..") source(file.path(getwd(), "config.R")) ``` -The "Keywords" tab adds keywords to your metadata so the record to be +The **Keywords** tab adds keywords to your metadata so the record to be found later through a search engine, keywords are the way to tag your projects or products.mdEditor is designed using existing thesauruses that contain pre-determined keywords. @@ -21,9 +21,9 @@ pre-determined keywords. |:------------------------------|:---------------| | ISO Topic Category | [Required](#iso-topic-category-required)`r req_style` | | SA Priority Area | [Required](#sa-priority-area-required)`r req_style` | -| SA Science Topic | [Required](#science-topic-required)`r req_style` | -| Conservation Action Open Standard | [If Applicable](#conservation-action-open-standard-required-if-applicable)`r if_style` | -| Global Change Master Directory (GCMD) | [Best Practice](p#gcmd)`r best_style` | +| SA Science Topic | [Required](#sa-science-topic-required)`r req_style` | +| Conservation Action Open Standard | [If Applicable](#conservation-action-open-standard-if-applicable)`r if_style` | +| Global Change Master Directory (GCMD) | [Best Practice](#global-change-master-directory-gcmd-best-practice)`r best_style` | : {.striped .hover .bordered .sm .allborder}
@@ -224,12 +224,12 @@ the workflow section for more info about using template records. mdEditor uses the term "keywords" while ScienceBase uses the term "tags." -:::{.callout-note appearance="minimal"} -Keywords edited in mdEditor will not overwrite keywords -stored in sbJSON on ScienceBase because ScienceBase only adds to the list of -tags. If you want to remove obsolete keywords/tags on ScienceBase, you will need -to manually delete them in ScienceBase. mdJSON and the SA Science Catalog, -however, will reflect the changes made in mdEditor. +::: {.callout-hint icon=false} +Keywords edited in mdEditor will not overwrite keywords stored in ScienceBase +(i.e. sbJSON) because ScienceBase only adds to the list of tags. If you do not +want obsolete keywords/tags to show up on ScienceBase, manually delete these in +ScienceBase. mdJSON and the SA Science Catalog, however, will reflect any +changes made in mdEditor. ::: ### Imported Keywords diff --git a/content/project_records/main_tab_project.qmd b/content/project_records/main_tab_project.qmd index 0312f0b..ba6b19c 100644 --- a/content/project_records/main_tab_project.qmd +++ b/content/project_records/main_tab_project.qmd @@ -18,30 +18,30 @@ The **Main** tab allows for the creation and/or editing of primary metadata. | Metadata Field | Project Records | |:------------------------------| :-------------| | Basic Information | | -|        Title | [Required](#title-required)`r req_style`^\*^ | -|        Status | [Required](#status-required)`r req_style`^\*^ | +|        Title | [Required](#title-required)`r req_style` | +|        Status | [Required](#status-required)`r req_style` | | Default Locale | [Required](#default-locale-required)`r req_style` | | Resource Type | [Required](#resource-types-required)`r req_style` | | Points of Contact | | |        Point of Contact | [Required](#points-of-contact-required)`r req_style` | |        Custodian | [Required](#points-of-contact-required)`r req_style` | -|        Administrator | [Required](#points-of-contact-required)`r req_style`^\*^ | +|        Administrator | [Required](#points-of-contact-required)`r req_style` | |        Administrative Region | [Required](#points-of-contact-required)`r req_style` | -|        Principal Investigator | [If Applicable](#points-of-contact-required)`r if_style`^\*^ | +|        Principal Investigator | [If Applicable](#points-of-contact-required)`r if_style` | |        Co-Principal Investigator | [If Applicable](#points-of-contact-required)`r if_style`| | Citation | | |        Title | [Required](#title-required-1)`r req_style` | |        Dates (multiple) | [Required](#dates-required)`r req_style` | -|        Responsible Parties (multiple) | [Required](#responsible-parties-required)`r req_style`^\*^ | +|        Responsible Parties (multiple) | [Required](#responsible-parties-required)`r req_style` | |        Online Resource | | -|               Name | [If Applicable](#online-resource-if-applicable)`r if_style`| -|               URL | [If Applicable](#identifier-if-applicable)`r if_style`| -|               Function | [If Applicable](#identifier-if-applicable)`r if_style`| +|               Name | [If Applicable](#online-resource-if-applicable)`r if_style`| +|               URL | [If Applicable](#online-resource-if-applicable)`r if_style`| +|               Function | [If Applicable](#online-resource-if-applicable)`r if_style`| |        Identifier | | -|               Identifier | [Required](#metadata-identifier-required)`r req_style` | -|               Namespace | [Required](#metadata-namespace-required)`r req_style` | +|               Identifier | [Required](#identifier-required)`r req_style` | +|               Namespace | [Required](#namespace-required)`r req_style` | | Description | | -|        Abstract | [Required](#abstract)`r req_style` | +|        Abstract | [Required](#abstract-required)`r req_style` | | Time Period | | |        Start Date | [Required](#time-period)`r req_style` | |        End Date | [Required](#time-period)`r req_style` | @@ -161,10 +161,10 @@ in mdEditor. See the [Contacts](../contact_records/contact_records_overview.qmd) section for more information. ::: -| Role | Contact | Requirements | +| Role | Contact | Requirements | |----------------------|----------------------|-------------------| -| principalInvestigator | Project Principal Investigator | [Required]`r req_style` | -| coPrincipalInvestigator | Co-Investigators |[**If applicable**]`r if_style` | +| principalInvestigator | Project Principal Investigator | [Required]`r req_style` | +| coPrincipalInvestigator | Co-Investigators | [If applicable]`r if_style` | : {.striped .hover .bordered .md .allborder}
@@ -176,19 +176,23 @@ if available. ### Identifier [(Required)]`r req_style` -You may enter as many **Identifiers** as desired. The identifier for the -repository is required here. If you have other internal IDs for projects, enter +You may enter as many Identifiers as needed. Identifiers are unique codes +that identify a metadata records and enable metadata management and cataloging. +An **Identifier** is a unique character string and the **Namespace** describes +the environment (e.g., ScienceBase, ITIS, etc.) or type +(e.g., mapProjection, UUID, etc.) of the identifier. The identifier for the metadata repository is +required here. If you have other internal IDs for projects, enter them here. Other optional identifiers for projects include: [Archive](../archiving.qmd) Folder Name. -::: {.callout-note title="Best Practice"} +::: {.callout-note icon=false title="Best Practice"} Create and use internal identifiers that are unique within your region or program for projects and their products. Example: GNLCC2010-11. ::: -::: callout-note -If your item does not have a ScienceBase ID yet, ScienceBase will create one -automatically upon publishing. If you imported your item from ScienceBase +::: {.callout-note icon=false title="ScienceBase ID"} +If your item does not have a ScienceBase ID (SBID) yet, ScienceBase will create +one automatically upon publishing. If you imported your item from ScienceBase originally, then the SBID will already be included in Metadata/Metadata Identifier and you do not need to include it here. Note that if you edit an item that is already on ScienceBase without using its existing ID, a duplicate item @@ -231,13 +235,13 @@ For the **Supplemental Information** enter comments, if desired. ## Time Period -### Start Date and End Date [(Required)]`r if_style` +### Start Date and End Date [(Required)]`r req_style` For each project, add a **Start Date** and **End Date**. If the project spanned a single fiscal year, you can use the “Pick a Fiscal Year” drop-down to autofill the date fields. -::: callout-note +::: {.callout-note icon=false} This set of dates is distinct from the fiscal year of funding. Here you want to indicate the overall project start and end dates. In the Funding section you will specify the fiscal years that funds were allocated. diff --git a/content/project_records/metadata_tab_project.qmd b/content/project_records/metadata_tab_project.qmd index 6d18528..7622a41 100644 --- a/content/project_records/metadata_tab_project.qmd +++ b/content/project_records/metadata_tab_project.qmd @@ -19,11 +19,11 @@ the metadata, and metadata repositories. | Metadata Field | Project Records | |:------------------------------|:-------------| | Metadata Status | [Required](#metadata-status-required)`r req_style` | -| Dates | [Required](#metadata-dates-required)`r req_style` | +| Dates | [Required](#mdates-required)`r req_style` | | Metadata Contacts | | -|        Author | [Required](#metadata-contacts)`r req_style` | -|        Publisher | [Required](#metadata-contacts)`r req_style` | -|        Point of Contact | [Required](#metadata-contacts)`r req_style` | +|        Author | [Required](#contacts-required)`r req_style` | +|        Publisher | [Required](#contacts-required)`r req_style` | +|        Point of Contact | [Required](#contacts-required)`r req_style` | | Metadata Identifier | [Required](#metadata-identifier-required)`r req_style` | | Parent Metadata | [Required](#parent-metadata-required)`r req_style` | | Metadata Repositories | [Required](#repositories-required)`r req_style` |