Testing stuff (from ./source/README)

Sources

• Original GitBook: https://tpatterson.gitbook.io/sametadatacreationguide/
• Current testing repo: https://github.com/hmaier-fws/sa-demo-metadata-guide
• Rendered test site: https://hmaier-fws.github.io/sa-demo-metadata-guide/

HonKit variables test

These work

• honkit.time: Tue Apr 25 2023 13:21:24 GMT-0800 (Alaska Daylight Time)
• file.mtime: Tue Apr 25 2023 13:19:39 GMT-0800 (Alaska Daylight Time)
• gitbook.time: Tue Apr 25 2023 13:21:24 GMT-0800 (Alaska Daylight Time)
• honkit.version: 4.0.7
• gitbook.version: 4.0.7

These don't work

• honkit.description:
• pubdate:
• honkit.pubdate:
• book.pubdate:
• gitbook.pubdate:
• honkit.time:
• book.description:
• this.version:

• title:
• book.title:
• gitbook.title
• this.title
• book.config:

Introduction

Note: This is a working draft that will continue to be edited. Last updated: 15 June 2021. Please refresh this manual every time you open it to ensure you are viewing the most recent version.

If you have questions/concerns regarding this guidance, please contact the FWS SA National Data Steward (sadatasteward@fws.gov) or Tammy Patterson (tpatterson@usgs.gov until August 1).

Introduction

This manual describes the requirements and best practices for the creation of high-quality and consistent metadata records for projects and products for USFWS Science Applications. These metadata requirements conform to the standardized metadata format agreed upon by the SA Data Management Working Group and meets USFWS policy requirements for data management. This metadata drives the unified SA Science Catalog, where SA projects and products are discoverable, accessible, and usable.

USFWS Data Management Integration

Metadata creation is part of the Maintain step of the Data Management Lifecycle. Guidance is also available in the USFWS data management handbook.

Metadata and mdEditor

The metadata editing tool employed to create and support metadata requirements is mdEditor. This tool was an extension of an initiative by the Alaska Data Integration Working Group (ADIwg) and adopted by SA.

This manual refers to the creation of SA metadata specifically. If you want information on the creation of other metadata records using mdEditor, or more information in general, please refer to the mdEditor User Manual.

Who Should Use this Manual

This guide is for anyone creating or updating metadata for SA-related projects and products. The primary purpose is to describe in detail how to develop metadata for items for inclusion in the SA Science Catalog, but the tool can also be used to track any project or funding.

The metadata requirements described here apply to science projects and products that were funded by SA (for more details, see the Project, Products, and Contacts section).

How to Use this Manual

Directly accessing this manual from the internet is the recommended way to use this manual. By doing so, you will guarantee that you are using the current version since it is a live document and any updates can be made instantly. The online version will also have the best functionality and graphical display.

If needed, you can download this manual as a PDF and save a copy to your computer for printing or offline use. If you choose this method, be sure to reference the online version regularly and save a new PDF as updates are made to the online version. Also note that not all of the formatting will be exactly the same as the online version.

Disclaimer

This manual was developed while mdEditor was also being developed. Due to this, there may be minor discrepancies between screenshots in the manual and the current production version of mdEditor.