Merge branch 'master' of https://github.com/perseids-publications/tre…

…ebank-template

.github/FUNDING.yml

@@ -0,0 +1 @@
+custom: ["https://tuftsgiving.org/giving-form.html?id=7&showarea=AR001037&areaid=601&recurring=true", "https://www.paypal.me/alpheiosproject"]

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in the Perseids Project and
+its associated 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.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive 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
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers 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.
+
+Project maintainers 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.
+
+## Scope
+
+This Code of Conduct applies within project spaces and when
+an individual is officially 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 project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at perseids@tufts.edu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

README.md

@@ -21,8 +21,13 @@ git push -u origin master
 * Copy all your trees into `public/xml`
 * Update the `src/config.json` file
 * Update `name` and `homepage` in `package.json`
+* Set the version in `package.json` to `1.0.0`
 * Update the information in `.env`
 
+### Configuration
+
+See [docs/CONFIG.md](docs/CONFIG.md) for more information about the format of `src/config.json`.
+
 ### Updating
 
 * `git pull source master`
@@ -69,6 +74,53 @@ If you want to deploy it at `www.example.com/lexica/lsj` then run
 
 `yarn deploy`
 
+## Zenodo DOI
+
+The instructions below are for uploading a collection of treebanks to Zenodo.
+The Treebank Template repository itself is uploaded to Zenodo but the steps are slightly different
+(the version of the Treebank Template application is used for the version, the upload type is software, the contributors are different, and the license is MIT instead of CC BY-SA)
+
+### Zenodo
+
+* Visit [Zenodo](https://zenodo.org/deposit/new), log in, and create a new upload
+* Click the "Reserve DOI" button in the "Basic information" section
+* Keeping the window open, open your command line/console and navigate to the repository
+
+### Git
+
+* In `src/config.json`, add or update the `doi` field to the DOI generated in the above step (preceded by `https://dx.doi.org/`)
+* Update the version in `package.json` (try to use [SemVer](https://semver.org/))
+* Push the code to `master`
+* Keeping the Zenodo window open, in another tab or window open the repository on GitHub
+
+### GitHub
+
+* Make a new release titled "Release vA.B.C" where "A.b.C" is the version in `package.json` and use the same string ("vA.B.C") in the "Tag Version" field
+* Enter a description then click "Publish release"
+* Download the release as a `tar.gz` file
+* Go back to the Zenodo window or tab
+
+### Zenodo
+
+* Add the `tar.gz` file to the upload
+* Fill in the following fields:
+  * Communities: add the `perseids-project` community and any others that may be relevant
+  * Upload type: Dataset
+  * Basic information:
+    * Title: the title of the treebank collection
+    * Authors: the author(s) who contributed to the treebanks
+    * Description: a description of the dataset
+    * Version: the version in `package.json`
+  * License:
+    * Access right: Open Access
+    * License: Creative Commons Attribution 4.0 International
+  * Fill in any other fields that are relevant
+* Click "Publish"
+
+## Alpheios Integration
+
+For instructions on how to make your trees available in the [Alpheios Reading Tools](https://alpheios.net) visit [https://perseids-publications.github.io/treebank-template/examples/alpheios-integration](https://perseids-publications.github.io/treebank-template/examples/alpheios-integration).
+
 ## Licenses
 
 The code is licensed under the MIT license (see `LICENSE` file).

docs/CONFIG.md

@@ -0,0 +1,159 @@
+# Configuration
+
+Most configuration is done through the `./src/config.json` file.
+This file contains an annotated version of the sample `config.json` in the Treebank Template repository.
+
+## JSON
+
+```javascript
+{
+  // Title of the collection: displayed on the homepage and in the header
+  "title": "Treebank Publication Template",
+
+  // Subtitle (optional): shown below the title on the homepage; accepts Markdown 
+  "subtitle": "Template for publishing collections of treebanks. See the [repository](https://github.com/perseids-publications/treebank-template/) for more information and documentation. If you would like to create a template with your own treebanks, send us a [message](https://docs.google.com/forms/d/e/1FAIpQLSf8yf6B3xlV31x0JKquRuIdXd6LVuX0V7I7id7ZLXbMwDo-UA/viewform).",
+
+  // Digital Object Identifier (optional): a DOI link; displayed in footer
+  "doi": "https://dx.doi.org/10.5281/zenodo.3827931",
+
+  // Copyright or ownership notice (optional): displayed in the footer; if not supplied, defaults to "The Perseids Project"
+  "copyright": "The Perseids Project",
+
+  // Report link (optional): link to where users report issues; usually the GitHub issues page
+  "report": "https://github.com/perseids-publications/treebank-template/issues",
+
+  // GitHub link (optional): link to the GitHub repository; if not supplied, defaults to "https://github.com/perseids-project"; to remove the icon set it to ""
+  "github": "https://github.com/perseids-publications/treebank-template/",
+
+  // Twitter link (optional): link to a Twitter account; if not supplied, defaults to "https://twitter.com/PerseidsProject"; to remove the icon set it to ""
+  "twitter": "https://twitter.com/PerseidsProject",
+
+  // Collections: the array of collections must have one or more members
+  // Each collection must have a title as well as text or an array of publications (or both)
+  "collections": [
+    {
+      // Title: displayed above the collection content
+      "title": "Information",
+
+      // Text: text describing the collection; accepts Markdown
+      "text": "The Treebank Template is maintained by the Perseids Project. Visit [our homepage](https://www.perseids.org) to learn more."
+    },
+    {
+      // Title: displayed above the collection content
+      "title": "Collection 1", 
+
+      // Publications: the array of publications
+      // Each publication represents one work (e.g. Lysias' On the Murder of Eratosthenes) and can contain multiple treebanks
+      "publications": [
+        {
+          // Path: the URL path used for the publication (must be unique)
+          "path": "on-the-murder-of-eratosthenes",
+
+          // Author: author of the publication
+          "author": "Lysias",
+
+          // Work: name of the work
+          "work": "On the Murder of Eratosthenes",
+
+          // Editors: editor(s) for the treebank; can be either a string or an array (see Philippic 1 below for an example of an array)
+          "editors": "Vanessa Gorman",
+
+          // Sections: array of treebanks
+          "sections": [
+            {
+              // Locus: loci covered by this particular treebank
+              "locus": "1-50",
+
+              // Path: URL path used for this treebank (must be unique)
+              "path": "on-the-murder-of-eratosthenes-1-50",
+
+              // XML: the path to the XML file in the "public/xml" directory
+              "xml": "lysias-1-1-50.xml",
+
+              // Link (optional): a link to more information about the treebank
+              "link": "https://www.example.com",
+
+              // Notes (optional): notes about the treebank; accepts Markdown
+              "notes": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
+
+              // Chunks: the "id" attributes of the "<sentence>" elements in the XML
+              // It can either contain a "start" and "end" if the "id"s are a sequence of integers or it can be an array (see Philippic 1 below for an example of an array)
+              "chunks": { "start": 1, "end": 134 }
+            }
+          ]
+        },
+        {
+          "path": "on-the-crown",
+          "author": "Demosthenes",
+          "work": "On the Crown",
+          "editors": "Vanessa Gorman",
+          "sections": [
+            {
+              "locus": "1-50",
+              "path": "on-the-crown-1-50",
+              "xml": "demosthenes-18-1-50.xml",
+              "notes": "Lorem ipsum dolor sit amet, *consectetur* adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
+              "chunks": { "start": 1, "end": 160 }
+            },
+            {
+              "locus": "51-100",
+              "path": "on-the-crown-51-100",
+              "xml": "demosthenes-18-51-100.xml",
+              "chunks": { "start": 1, "end": 149 }
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "title": "Collection 2",
+      "publications": [
+        {
+          "path": "histories",
+          "author": "Herodotus",
+          "work": "The Histories",
+          "editors": "Vanessa Gorman",
+          "sections": [
+            {
+              "locus": "40-59",
+              "path": "histories-40-59",
+              "xml": "herodotus-1-40-59.xml",
+              "chunks": { "start": 1, "end": 100 }
+            },
+            {
+              "locus": "60-79",
+              "path": "histories-60-79",
+              "xml": "herodotus-1-60-79.xml",
+              "chunks": { "start": 1, "end": 166 }
+            },
+            {
+              "locus": "80-99",
+              "path": "histories-80-99",
+              "xml": "herodotus-1-80-99.xml",
+              "notes": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
+              "chunks": { "start": 1, "end": 185 }
+            }
+          ]
+        },
+        {
+          "path": "philippic",
+          "author": "Demosthenes",
+          "work": "Philippic 1",
+          "editors": [
+            "Robert Gorman",
+            "Vanessa Gorman"
+          ],
+          "sections": [
+            {
+              "locus": "1-51",
+              "path": "philippic-1-51",
+              "xml": "demosthenes-4-phil1-bu1.xml",
+              "chunks": { "numbers": ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48", "49", "50", "51", "52", "53", "54", "55", "56", "57", "58", "59", "60", "61", "62", "63", "64", "65", "66", "67", "68", "69", "70", "71", "72", "73", "74", "75", "76", "77", "78", "79", "80", "81", "82", "83", "84", "85", "86", "87", "88", "89", "90", "91", "92", "93", "94", "95", "96", "97", "98", "99", "100", "101", "102", "103", "104", "105", "106", "107", "108", "109", "110", "111", "112", "113", "114", "115", "116", "117", "118", "119", "120", "121", "122", "123", "124", "125", "126", "127", "128", "129", "130", "131", "132", "133", "134", "135", "136", "137", "138", "139", "140", "141", "142", "143", "144", "145", "146", "147", "148", "149", "150", "151", "152", "153", "154", "155", "156", "157", "158", "159"] }
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}
+```

package.json

@@ -1,23 +1,27 @@
 {
   "name": "cst-trees",
-  "version": "2.0.0",
+  "version": "1.0.0",
+  "treebank-template": {
+    "version": "3.0.2"
+  },
   "private": true,
   "homepage": "https://perseids-publications.github.io/cst-trees/",
   "dependencies": {
     "@primer/octicons-react": "^9.6.0",
     "alpheios-messaging": "https://github.com/alpheios-project/alpheios-messaging",
+    "arethusa-widget": "^2.0.0",
     "bootstrap": "^4.4.1",
     "eslint-config-airbnb": "^18.1.0",
     "eslint-plugin-jest": "^23.8.2",
     "gh-pages": "^2.2.0",
-    "perseids-react-components": "^0.2.1",
+    "perseids-react-components": "^1.0.0",
     "prop-types": "^15.6.2",
-    "query-string": "^6.11.1",
+    "query-string": "^6.12.1",
     "react": "^16.13.1",
     "react-dom": "^16.13.1",
     "react-markdown": "^4.3.1",
     "react-router-dom": "^5.1.2",
-    "react-scripts": "3.4.0",
+    "react-scripts": "3.4.1",
     "react-test-renderer": "^16.13.1"
   },
   "scripts": {

public/arethusa

@@ -0,0 +1 @@
+../node_modules/arethusa-widget/dist/arethusa