Update documentation and permalinks for consistency and clarity
- Changed references in markup.md to update "data.html" to "data/" for clarity. - Updated metadata.md to correct the link to the general documentation. - Modified navbar.md to ensure stub values match the new permalink structure. - Adjusted tables.md to reflect the new permalink for the table visualization page. - Updated about.md to change the permalink from "/about.html" to "/about/" and revised content for clarity and impact. - Changed browse.md permalink from "/browse.html" to "/browse/" for consistency. - Added copyright.md page with copyright information and terms of use. - Updated data.md to change permalink from "/data.html" to "/data/" and added introductory content. - Created donate.md page to facilitate donations and acknowledge supporters. - Updated locations.md permalink from "/locations.html" to "/locations/" for consistency. - Changed map.md permalink from "/map.html" to "/map/" for uniformity. - Added erasure.md page discussing the historical context of Black queer Kansas Citians. - Updated out-there.md to correct the link to Lea Hopkins' interview. - Changed subjects.md permalink from "/subjects.html" to "/subjects/" for consistency. - Updated timeline.md permalink from "/timeline.html" to "/timeline/" for uniformity.
This commit is contained in:
Nasir Anthony Montalvo
@@ -24,7 +24,7 @@ The settings also create matching data outputs in the "/assets/data/" folder.
|
||||
If `subjects-fields` or `locations-fields` is blank or commented out, the template will not build out the related cloud page or data, which saves build time.
|
||||
If you are developing a particularly large collection, you can comment out these options to make rebuild much quicker.
|
||||
|
||||
Keep in mind these page stubs (`/subjects.html`, `/locations.html`) will also have to be present in "config-nav.csv" to show up in your navigation, and to have the data files to show up in data download options.
|
||||
Keep in mind these page stubs (`/subjects/`, `/locations.html`) will also have to be present in "config-nav.csv" to show up in your navigation, and to have the data files to show up in data download options.
|
||||
|
||||
## Cloud Layout and Front matter
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ A link to the source code repository will be included if `source-code` is set in
|
||||
The data found in `/assets/data/` can be seen as a "datapackage" containing all the derivatives related to the collection.
|
||||
This data is described by two markup standards.
|
||||
|
||||
First, the Data page (`/data.html`) contains [schema.org Dataset](https://schema.org/Dataset) markup embedded on the page in json+ld format (written in the `_includes/data-download-modal.html` file).
|
||||
First, the Data page (`/data/`) contains [schema.org Dataset](https://schema.org/Dataset) markup embedded on the page in json+ld format (written in the `_includes/data-download-modal.html` file).
|
||||
This markup is [required by Google](https://developers.google.com/search/docs/data-types/dataset) to be indexed into their datasets search engine.
|
||||
|
||||
Second, `/assets/data/` contains `datapackage.json` as described by the Frictionless Data [Data Package Spec](https://specs.frictionlessdata.io/data-package/).
|
||||
|
||||
@@ -30,7 +30,7 @@ The resulting front matter might look like:
|
||||
---
|
||||
title: About
|
||||
layout: about
|
||||
permalink: /about.html
|
||||
permalink: /about/
|
||||
custom-foot: js/example.html;js/another_example.html
|
||||
---
|
||||
```
|
||||
|
||||
@@ -54,13 +54,13 @@ The map page supports parsing a query string to set the center and display an It
|
||||
If the url includes a query string, it will be parsed and set as the map view box with full zoom and open the popup.
|
||||
|
||||
Item pages that have lat/long will generate a "View on Map" button link.
|
||||
These link to the "map.html" page with a query string created from their lat long and objectid.
|
||||
These link to the "map/" page with a query string created from their lat long and objectid.
|
||||
|
||||
For example:
|
||||
`/map.html?location=46.726113,-117.015671&marker=example_004`
|
||||
`/map/?location=46.726113,-117.015671&marker=example_004`
|
||||
|
||||
This can be created using the Liquid:
|
||||
`{{ '/map.html?location=' | append: page.latitude | append: ',' | append: page.longitude | append: '&marker=' | append: page.objectid | relative_url }}`
|
||||
`{{ '/map/?location=' | append: page.latitude | append: ',' | append: page.longitude | append: '&marker=' | append: page.objectid | relative_url }}`
|
||||
|
||||
## Customizing the Base Map
|
||||
|
||||
|
||||
@@ -92,8 +92,8 @@ If the config-nav contains the following "stub", the following data files will b
|
||||
- "timeline", timelinejs.json
|
||||
|
||||
This may not be accurate for all use cases.
|
||||
An easy way to manually set the downloads, is to create a list based on the stub values shown above, and edit the "stubs" assigned on the data.html layout.
|
||||
For example, if I want to show all data downloads, even though I don't have the pages in the navigation or have named them something different, edit the "assign stubs" line on data.html like this:
|
||||
An easy way to manually set the downloads, is to create a list based on the stub values shown above, and edit the "stubs" assigned on the data/ layout.
|
||||
For example, if I want to show all data downloads, even though I don't have the pages in the navigation or have named them something different, edit the "assign stubs" line on data/ like this:
|
||||
|
||||
`{%- assign stubs = "subject;map;location;timeline" -%}`
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Metadata Standards for CB-CSV
|
||||
|
||||
See general documentation: <https://collectionbuilder.github.io/cb-docs/docs/metadata/>
|
||||
See general documentation: <https://collectionbuilder.github.io/cb-docs/docs/metadata.html>
|
||||
|
||||
## Required fields
|
||||
|
||||
|
||||
@@ -12,8 +12,8 @@ config-nav allows you to easily control which pages will show up in your navbar
|
||||
Removing an item does not delete the page, but will make the page invisible to users.
|
||||
Each item in the nav is one row of config-nav, including the columns `display_name`, `stub`, and `dropdown_parent`:
|
||||
|
||||
- `display_name` will be the word(s) used on the navbar. Generally you will want these to be single words that are easy for users to understand--typically: Home, Browse, Subjects, Locations, Map, Timeline, Data, About. Modifying this value allows you to quickly change the display name without needing to update the file names or titles. e.g. for some collections a label such as "Creators" might replace "Subjects", while still pointing to the /subjects.html page.
|
||||
- `stub` is the relative url of the page in this project. To properly link to a page, the `stub` value will match the `permalink` value of a specific page file. e.g. "browse.md" has `permalink: /browse.html`, thus in config-nav has a stub value of `/browse.html`. These will be converted into relative links in the navbar. The `stub` value will be empty for items that are parents for a dropdown menu (see below).
|
||||
- `display_name` will be the word(s) used on the navbar. Generally you will want these to be single words that are easy for users to understand--typically: Home, Browse, Subjects, Locations, Map, Timeline, Data, About. Modifying this value allows you to quickly change the display name without needing to update the file names or titles. e.g. for some collections a label such as "Creators" might replace "Subjects", while still pointing to the /subjects/ page.
|
||||
- `stub` is the relative url of the page in this project. To properly link to a page, the `stub` value will match the `permalink` value of a specific page file. e.g. "browse.md" has `permalink: /browse/`, thus in config-nav has a stub value of `/browse/`. These will be converted into relative links in the navbar. The `stub` value will be empty for items that are parents for a dropdown menu (see below).
|
||||
- `dropdown_parent` is only used when adding dropdowns to your navbar, and should be empty for any normal nav item. For items that should appear inside a dropdown, the value will match the `display_name` of the parent item (see below).
|
||||
|
||||
## Dropdown menus
|
||||
@@ -29,7 +29,7 @@ For example, a dropdown with two pages under the label About would look like:
|
||||
```
|
||||
display_name,stub,dropdown_parent
|
||||
About,,
|
||||
About the Collection,/about.html,About
|
||||
About the Collection,/about/,About
|
||||
CollectionBuilder,/tech.html,About
|
||||
```
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ The table will be sorted by the second column (typically "Date").
|
||||
|
||||
The config-table options drive the creation of:
|
||||
|
||||
- table viz page (`/data.html`)
|
||||
- table viz page (`/data/`)
|
||||
- `/assets/js/metadata.min.json` is the table data in an optimized format specifically intended for the consumption by the table viz page in this project. Each item is a list of values without keys and links are relative.
|
||||
|
||||
Since the fields listed will become columns of the web table, it is best to not select too many.
|
||||
|
||||
Reference in New Issue
Block a user