diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..b71a409 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,35 @@ +name: 🐞 Bug +description: File a bug/issue +title: '
Sorry, but the page you were trying to view does not exist.
+ +
+ ____________
+< Sorry, 404 >
+ ------------
+ \ ^__^
+ \ (oo)\_______
+ (__)\ )\/\
+ ||----w |
+ || ||
+
+
diff --git a/CITATION.cff b/CITATION.cff
new file mode 100644
index 0000000..75ad992
--- /dev/null
+++ b/CITATION.cff
@@ -0,0 +1,25 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+title: "CollectionBuilder-CSV"
+type: software
+authors:
+ - family-names: Williamson
+ given-names: Evan Peter
+ orcid: https://orcid.org/0000-0002-7990-9924
+ - family-names: Becker
+ given-names: Devin
+ orcid: https://orcid.org/0000-0002-0974-9064
+ - family-names: Wikle
+ given-names: Olivia
+ orcid: https://orcid.org/0000-0001-8122-4169
+repository-code: 'https://github.com/CollectionBuilder/collectionbuilder-csv'
+url: 'https://collectionbuilder.github.io/'
+license: MIT
+version: 1+
+date-released: '2021-04-25'
+abstract: >-
+ CollectionBuilder is an open source tool for
+ creating digital collection and exhibit websites
+ that are driven by metadata and powered by modern
+ static web technology.
+license: MIT
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..a718cb9
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,76 @@
+# Code of Conduct
+
+## Our Pledge
+
+A primary goal of the CollectionBuilder community is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As community participants, we pledge to make participation in our project and community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We invite all those who participate in the CollectionBuilder project and community to help us create safe and positive experiences for everyone.
+
+## Scope
+
+This code of conduct outlines our expectations for everyone who participates in our community, as well as the consequences for unacceptable behavior.
+
+We expect all community participants (community organizers; project maintainers; contributors, paid or otherwise; sponsors; and others) to abide by this Code of Conduct, which applies in all community venues, online and in-person; in one-on-one or group communications pertaining to community business; and within project spaces and in public spaces when an individual is representing the project or its community.
+Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+Representation of a project may be further defined and clarified by community organizers.
+
+Participants are also expected to uphold the [GitHub Community Guidelines](https://help.github.com/en/articles/github-community-guidelines) for all behavior and content on the platform.
+
+## Expected Behavior
+
+The following behaviors are expected of all community participants:
+
+- Using inclusive, respectful, and welcoming language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+## Unacceptable Behavior
+
+The following behaviors are unacceptable within our community:
+
+- Violence, threats of violence, or violent language directed against another person
+- Sexist, racist, homophobic, transphobic, ableist, or otherwise discriminatory jokes and language
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Posting or displaying sexually explicit or violent material
+- Publishing or threatening to publish others' private information, such as a physical or electronic address, without explicit permission ("doxing")
+- Public or private harassment
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Community organizers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+## Consequences for Unacceptable Behavior
+
+Unacceptable behavior from any community member, including sponsors and those with decision-making authority, will not be tolerated.
+
+Anyone asked to stop unacceptable behavior is expected to comply immediately.
+
+Community organizers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban (temporarily or permanently) any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful without warning (and without refund in the case of a paid event).
+
+## Reporting Guidelines
+
+If you are subject to or witness unacceptable behavior, or have any other concerns, please notify community organizers as soon as possible at collectionbuilder.team@gmail.com which is maintained by evanwill, dcnb, owikle, and juliastone0729.
+If these are not appropriate contacts, please consider [reporting directly to GitHub](https://github.com/contact/report-abuse) or an administrative contact in the project's home at [University of Idaho Library](https://www.lib.uidaho.edu/about/directory.html).
+
+All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances.
+Community organizers are obligated to uphold confidentiality with regard to the reporter of an incident.
+
+Additionally, any abuse, harassment, and other harmful behavior taking place on GitHub can be reported directly:
+https://github.com/contact/report-abuse
+
+## Contact info
+
+- email: collectionbuilder.team@gmail.com
+- [CollectionBuilder GitHub organization](https://github.com/CollectionBuilder)
+- [CollectionBuilder home page](https://collectionbuilder.github.io/)
+
+## Attribution
+
+This Code of Conduct is adapted from two sources:
+
+1. The [Contributor Covenant](https://www.contributor-covenant.org/), version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html. For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq.
+2. The Citizen Code of Conduct, Revision 2.3 2017, which is distributed by [Stumptown Syndicate](http://stumptownsyndicate.org/) under a [Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/3.0/). Portions of text from the Citizen Code of Conduct are derived from the [Django Code of Conduct](https://www.djangoproject.com/conduct/) and the [Geek Feminism Anti-Harassment Policy](http://geekfeminism.wikia.com/wiki/Conference_anti-harassment/Policy).
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..285471b
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,52 @@
+# How to Contribute to CollectionBuilder
+
+Thank you for contributing to CollectionBuilder!
+
+CollectionBuilder prioritizes pragmatic, sustainable, and simplified approaches to infrastructure to ensure the tool is "do-able" and approachable for digital knowledge workers in libraries and museums, empowering them to take control of their web systems.
+The core team is *not* full time developers--we are librarians.
+Thus, we are focused on creating a supportive, inclusive community with low barriers to contributing (please see our [Code of Conduct](https://github.com/CollectionBuilder/collectionbuilder-csv/blob/main/CODE_OF_CONDUCT.md)).
+
+Honestly, we do a lot of stuff the slow/old/inefficient/wrong way... but we make it work and invite you to learn/teach with us!
+
+## Project resources
+
+- Email contact: This digital collection is built with CollectionBuilder, an open source framework for creating digital collection and exhibit websites that is developed by faculty librarians at the University of Idaho Library following the Lib-Static methodology.
+ +Using the CollectionBuilder-CSV template and the static website generator Jekyll, this project creates an engaging interface to explore driven by metadata.
+{{ site.tagline }}
{% endif %} ++ + {% unless include.caption == false %}{{ audio_caption }}{% endunless %} +
diff --git a/_includes/feature/blockquote.html b/_includes/feature/blockquote.html new file mode 100644 index 0000000..d94cd65 --- /dev/null +++ b/_includes/feature/blockquote.html @@ -0,0 +1,19 @@ +{% comment %} + + Block quote + + E.G. --> {% include feature/blockquote.html quote="Knowledge comes, but wisdom lingers" speaker="Alfred Lord Tennyson" source="Locksley Hall" %} + + Options: + - "quote" = quote text, can use Markdown + - "speaker" = name of the person who said the quote + - "source" = title of the quote's source + - "source-link" = link to source + +{%- endcomment -%} + diff --git a/_includes/feature/button.html b/_includes/feature/button.html new file mode 100644 index 0000000..b8ab52d --- /dev/null +++ b/_includes/feature/button.html @@ -0,0 +1,19 @@ +{% comment %} + + Bootstrap button link, https://getbootstrap.com/docs/5.1/components/buttons/ + + E.G. --> {% include feature/button.html text="Example Button Link" link="https://example.com" color="success" %} + + Options: + - "text" = main button text + - "link" = button link + - "color" = a bootstrap color (primary, secondary, success, danger, warning, info, light, dark) + - "size" = optional btn size, choose from "lg", "sm" (defaults to normal size) + - "width" = will use Bootstrap sizing to set the % size, choose from "25", "50", "75", or "100" + - "centered" = give "true" to add the button to a div and center on page + - "float" = will use Bootstrap float utility to add float, choose from "start" (left) or "end" (right) (not recommended) + +{%- endcomment -%} +{% if include.centered %}{{ include.text | default: site.tagline }}
{% endunless %} ++ Contents: {% for section in sections %}{{ section }} {% unless forloop.last %}| {% endunless %}{% endfor %}{% if page.credits == true %}| Tech{% endif %} +
diff --git a/_includes/feature/pdf.html b/_includes/feature/pdf.html new file mode 100644 index 0000000..c07c9f9 --- /dev/null +++ b/_includes/feature/pdf.html @@ -0,0 +1,43 @@ +{% comment %} + + Item PDF embed from objectid or external link. + This include adds a PDF embed to the page using html5 "object" element. + + E.G. --> {% include feature/pdf.html objectid="demo_002" %} + + It requires an "objectid" with the include, which is used to find the object details. Alternatively, a URL to an external pdf can be used in "objectid". + By default no height is necessary as it uses 1x1 Bootstrap ratio style, https://getbootstrap.com/docs/5.1/helpers/ratio/ + + Options: + - "objectid" = several options below (required) + 1. an objectid of a PDF item in this collection, e.g. "demo_004" + 2. an external link to a PDF file hosted elsewhere, e.g. "https://www.lib.uidaho.edu/digital/pdfs/cloudtypes.pdf" + 3. a relative link to a PDF file somewhere else in this repository, e.g. "/assets/pdfs/sometrees.pdf" + - "caption" = by default the figure include automatically adds the title of the item from your metadata. The caption option allows you to manually add a different caption, or give the value false for none. (optional) + - "width" = will use responsive sizing to set the % size on desktop (will be 100% on mobile), choose from "25", "50", "75", or "100" (optional) + - "height" = set embed object height in px (rather than responsive size), e.g. "800px" (optional) + - "ratio" = use Bootstrap embed ratio options "21x9", "16x9", "4x3", or "1x1" to customize the responsive aspect ratio if not using height. 1x1 is default. (optional) + + Note: if you have issues make sure the item is a PDF file! + +{%- endcomment -%} +{% if include.objectid contains "/" %} +{%- capture src -%}{{ include.objectid | relative_url }}{%- endcapture -%} +{%- capture pdf_link -%}{{ src }}{%- endcapture -%} +{%- capture pdf_caption -%}{{ include.caption }}{%- endcapture -%} +{% else %} +{%- assign item = site.data[site.metadata] | where: "objectid", include.objectid | first -%} +{%- capture src -%}{{ item.object_location | relative_url }}{% endcapture %} +{%- capture pdf_link -%}{{ '/items/' | relative_url }}{% if item.parentid %}{{ item.parentid }}.html#{{ item.objectid }}{% else %}{{ item.objectid }}.html{% endif %}{%- endcapture -%} +{%- capture pdf_caption -%}{% if include.caption %}{{ include.caption }}{% else %}{{ item.title }}{% endif %}{%- endcapture -%} +{% endif %} ++ Metadata CSV + Metadata JSON + {% if stubs contains "subject" %} + Subjects JSON + Subjects CSV + {% endif %} + {% if stubs contains "map" %} + Geodata JSON + {% endif %} + {% if stubs contains "location" %} + Locations CSV + Locations JSON + {% endif %} + {% if stubs contains "timeline" %} + Timeline JSON + {% endif %} + {% if site.data.theme.metadata-facets-fields %} + Facets JSON + {% endif %} + Source Code +
++ {% for s in topTerms %} + {{ s | strip }}{% endfor %} +
+
+ {% for t in types %}
+ {%- assign count = templates | where_exp: 'item','item contains t' | size -%}
+ {% if count > 0 %}
+ {{ count }}
+ {% case t %}
+ {% when 'image' %}
+ Image{% if count > 1 %}s{% endif %}
+ {% when 'audio' %}
+ Audio File{% if count > 1 %}s{% endif %}
+ {% when 'video' %}
+ Video{% if count > 1 %}s{% endif %}
+ {% when 'pdf' %}
+ PDF{% if count > 1 %}s{% endif %}
+ {% when 'panorama' %}
+ Panorama{% if count > 1 %}s{% endif %}
+ {% when 'record' %}
+ Record{% if count > 1 %}s{% endif %}
+ {% when 'compound_object' %}
+ Compound Object{% if count > 1 %}s{% endif %}
+ {% when 'multiple' %}
+ Multiple{% if count > 1 %}s{% endif %}
+ {% else %}
+ File{% if count > 1 %}s{% endif %}
+ {%- endcase -%}
+ {%- endif -%}
+ {%- endfor -%}
+ View table
+
{{ date-range | first }} to {{ date-range | last }}
+
View Timeline
+
{{ f }} | + {% endfor %} +Link | +
---|