Skip to content

Commit

Permalink
Fix navigation for archived documents
Browse files Browse the repository at this point in the history
* New sidebar in _quarto.yml
* archivedocs sidebar referenced in archive/_metadata.yml
* Removed broken history links on book.qmd pages
* new "Archived" category
  • Loading branch information
gremau committed Nov 18, 2024
1 parent 398bb7c commit 1d3e00d
Show file tree
Hide file tree
Showing 5 changed files with 78 additions and 62 deletions.
130 changes: 72 additions & 58 deletions _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,64 +38,78 @@ website:
text: EDIorg GitHub repository

sidebar:
id: alldocs
style: floating
title: "Guides"
collapse-level: 1
contents:
- section: "EML Best Practices"
href: guide-eml-bp/book.qmd
contents:
- href: guide-eml-bp/chapter-01-introduction-to-eml.qmd
text: "1. Introduction to EML"
- href: guide-eml-bp/chapter-02-metadata-and-dataset-design-principles.qmd
text: "2. Metadata and dataset design principles"
- href: guide-eml-bp/chapter-03-general-dataset-information.qmd
text: "3. General dataset information"
- href: guide-eml-bp/chapter-04-people-and-organizations-responsibleparty.qmd
text: "4. People and organizations (ResponsibleParty)"
- href: guide-eml-bp/chapter-05-the-project-tree.qmd
text: "5. The project tree"
- href: guide-eml-bp/chapter-06-data-access-and-usage-rights.qmd
text: "6. Data access and usage rights"
- href: guide-eml-bp/chapter-07-keywords-coverage-and-annotations.qmd
text: "7. Keywords, coverage and annotations"
- href: guide-eml-bp/chapter-08-citations-and-references.qmd
text: "8. Citations and references"
- href: guide-eml-bp/chapter-09-methods.qmd
text: "9. Methods"
- href: guide-eml-bp/chapter-10-data-entities.qmd
text: "10. Data entities"
- href: guide-eml-bp/chapter-11-variable-descriptions-attributes.qmd
text: "11. Variable descriptions (Attributes)"
- href: guide-eml-bp/chapter-12-additional-metadata.qmd
text: "12. Additional metadata"
- href: guide-eml-bp/appendix-a-specialized-elements.qmd
- href: guide-eml-bp/appendix-b-xml-schemas-and-eml.qmd
- href: guide-eml-bp/appendix-c-known-issues-and-gotchas.qmd
- section: "Dataset Design for Special Cases"
href: guide-special-cases/book.qmd
contents:
- href: guide-special-cases/code.qmd
text: "1. Code"
- href: guide-special-cases/model-based.qmd
text: "2. Model-based datasets"
- href: guide-special-cases/images-and-docs.qmd
text: "3. Images and documents as data"
- href: guide-special-cases/spatial-data.qmd
text: "4. Spatial data"
- href: guide-special-cases/moving-platforms.qmd
text: "5. Data gathered with small moving platforms"
- href: guide-special-cases/other-repositories.qmd
text: "6. Data in other repositories"
- href: guide-special-cases/large-offline.qmd
text: "7. Large datasets"
- section: "Domain-Specific Guides"
href: guide-domain-specific/about-domain-specific.qmd
contents:
- guide-domain-specific/ecocom.qmd
- guide-domain-specific/hymet.qmd
- guide-domain-specific/soil-carbon.qmd
- id: alldocs
style: floating
title: "Guides"
collapse-level: 1
contents:
- section: "EML Best Practices"
href: guide-eml-bp/book.qmd
contents:
- href: guide-eml-bp/chapter-01-introduction-to-eml.qmd
text: "1. Introduction to EML"
- href: guide-eml-bp/chapter-02-metadata-and-dataset-design-principles.qmd
text: "2. Metadata and dataset design principles"
- href: guide-eml-bp/chapter-03-general-dataset-information.qmd
text: "3. General dataset information"
- href: guide-eml-bp/chapter-04-people-and-organizations-responsibleparty.qmd
text: "4. People and organizations (ResponsibleParty)"
- href: guide-eml-bp/chapter-05-the-project-tree.qmd
text: "5. The project tree"
- href: guide-eml-bp/chapter-06-data-access-and-usage-rights.qmd
text: "6. Data access and usage rights"
- href: guide-eml-bp/chapter-07-keywords-coverage-and-annotations.qmd
text: "7. Keywords, coverage and annotations"
- href: guide-eml-bp/chapter-08-citations-and-references.qmd
text: "8. Citations and references"
- href: guide-eml-bp/chapter-09-methods.qmd
text: "9. Methods"
- href: guide-eml-bp/chapter-10-data-entities.qmd
text: "10. Data entities"
- href: guide-eml-bp/chapter-11-variable-descriptions-attributes.qmd
text: "11. Variable descriptions (Attributes)"
- href: guide-eml-bp/chapter-12-additional-metadata.qmd
text: "12. Additional metadata"
- href: guide-eml-bp/appendix-a-specialized-elements.qmd
- href: guide-eml-bp/appendix-b-xml-schemas-and-eml.qmd
- href: guide-eml-bp/appendix-c-known-issues-and-gotchas.qmd
- section: "Dataset Design for Special Cases"
href: guide-special-cases/book.qmd
contents:
- href: guide-special-cases/code.qmd
text: "1. Code"
- href: guide-special-cases/model-based.qmd
text: "2. Model-based datasets"
- href: guide-special-cases/images-and-docs.qmd
text: "3. Images and documents as data"
- href: guide-special-cases/spatial-data.qmd
text: "4. Spatial data"
- href: guide-special-cases/moving-platforms.qmd
text: "5. Data gathered with small moving platforms"
- href: guide-special-cases/other-repositories.qmd
text: "6. Data in other repositories"
- href: guide-special-cases/large-offline.qmd
text: "7. Large datasets"
- section: "Domain-Specific Guides"
href: guide-domain-specific/about-domain-specific.qmd
contents:
- guide-domain-specific/ecocom.qmd
- guide-domain-specific/hymet.qmd
- guide-domain-specific/soil-carbon.qmd
- id: archivedocs
style: floating
title: "Archived Guides"
collapse-level: 2
contents:
- section: "EML Best Practices v3 (Archived)"
href: guide-eml-bp/archive/book.qmd
contents:
- href: guide-eml-bp/archive/preface.qmd
text: "Preface"
- href: guide-eml-bp/archive/introduction.qmd
text: "1. Introduction"
- href: guide-eml-bp/archive/content-recommendations.qmd
text: "2. Content recommendations"

execute:
freeze: auto
Expand Down
2 changes: 2 additions & 0 deletions guide-eml-bp/archive/_metadata.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# For archived docs
sidebar: archivedocs
4 changes: 2 additions & 2 deletions guide-eml-bp/archive/book.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ author:
affiliation: Various
roles: [conceptualization, editing]
abstract: This book presents "best practice" recommendations for creating metadata documents in the Ecological Metadata Language (EML), a widely accepted standard for research metadata exchange in the environmental sciences. The document focuses the most common use-cases for EML and recommends content and formatting for its most important and frequently-used metadata elements. As such, these recommendations can be applied to most research datasets that include EML metadata. There are also recommendations specific to the U.S. LTER Network and Environmental Data Initiative (EDI) repository. This is Version 3 of the book, updated in 2017 by the EML Best Practices working group of the LTER Network Information Management Committee.
description: These recommendations for creating EML metadata documents can be applied to most research datasets. This is Version 3 (2017), written by the LTER/EDI EML Best Practices Working Group. Find earlier versions [here](../../history.qmd).
description: These recommendations for creating EML metadata documents can be applied to most research datasets. This is Version 3 (2017), written by the LTER/EDI EML Best Practices Working Group.
license: CC BY
keywords:
- data
Expand All @@ -54,6 +54,6 @@ keywords:
citation:
container-title: Environmental Data Initiative
doi: n/a
categories: draft
categories: archived
image: ../../img/book.svg
---
2 changes: 1 addition & 1 deletion guide-eml-bp/book.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ author:
affiliation: Various
roles: [conceptualization, editing]
abstract: This book presents "best practice" recommendations for creating metadata documents in the Ecological Metadata Language (EML), a widely accepted standard for research metadata exchange in the environmental sciences. The document focuses on the most common use-cases for EML, and recommends content and formatting for its most important and frequently-used metadata elements. As such, these recommendations can be applied to most research datasets that include EML metadata. There are also recommendations specific to the U.S. LTER Network and Environmental Data Initiative (EDI) repository. This is Version 4 of the book, updated in 2024 by the EML Best Practices Working Group of the LTER Network Information Management Committee.
description: These recommendations for creating EML metadata documents can be applied to most research datasets. This is Version 4 (2024), written by the LTER/EDI EML Best Practices Working Group. Find earlier versions [here](../history.qmd).
description: These recommendations for creating EML metadata documents can be applied to most research datasets. This is Version 4 (2024), written by the LTER/EDI EML Best Practices Working Group.
license: CC BY
keywords:
- data
Expand Down
2 changes: 1 addition & 1 deletion index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ toc: false
listing:
id: guide-listing
include:
categories: [draft, published]
categories: [archived, draft, published]
sort:
- "categories desc"
- "date desc"
Expand Down

0 comments on commit 1d3e00d

Please sign in to comment.