Merge pull request #96 from cu-mkp/dev

Fixed placement of react-markdown dependency, updated READMEs
cu-mkp · Apr 19, 2024 · fe11d68 · fe11d68
2 parents 3e96b66 + 23dc554
commit fe11d68
Show file tree

Hide file tree

Showing 6 changed files with 1,089 additions and 1,582 deletions.
diff --git a/README.md b/README.md
@@ -26,6 +26,7 @@ import EditionCrafter from '@cu-mkp/editioncrafter'
     tl: 'Translation (EN)'
   }}
   iiifManifest='https://cu-mkp.github.io/editioncrafter-data/fr640_3r-3v-example/iiif/manifest.json'
+  glossaryURL='https://cu-mkp.github.io/editioncrafter-data/fr640_3r-3v-example/glossary.json'
 />
 ```
 
@@ -43,7 +44,8 @@ To include EditionCrafter in your HTML website, you need to create a `div` somew
      EditionCrafter.viewer({
          id: 'ec',
          documentName: 'BnF Ms. Fr. 640',
-         iiifManifest='https://cu-mkp.github.io/editioncrafter-data/fr640_3r-3v-example/iiif/manifest.json',
+         iiifManifest: 'https://cu-mkp.github.io/editioncrafter-data/fr640_3r-3v-example/iiif/manifest.json',
+         glossaryURL: 'https://cu-mkp.github.io/editioncrafter-data/fr640_3r-3v-example/glossary.json',
          transcriptionTypes: {
            tc: 'Diplomatic (FR)',
            tcn: 'Normalized (FR)',
@@ -89,6 +91,35 @@ Required. (Note: This is required even in the case that you have also included a
 
 A *string* giving the name of the document(s). 
 
+### glossaryURL
+
+Optional. A URL pointing to a JSON file containing glossary information. The glossary should have the following format:
+```
+{
+  "title": "[a subheader, written in markdown]",
+  "citation": "[information on how to cite the glossary, written in markdown]",
+  "entries": {
+    "[Term]": {
+      "headword": "...",
+      "alternateSpellings": "...",
+      "meanings": [
+        {
+          "partOfSpeech": "...",
+          "meaning": "...",
+          "references": "..."
+        }
+        ...
+      ],
+      "modernSpelling: "...",
+      "antonym": "...",
+      "synonym": "...",
+      "seeAlso": "..."
+    },
+    ...
+  }
+}
+```
+
 ### iiifManifest
 
 Required if no `documentInfo` prop specified.

diff --git a/editioncrafter-umd/README.md b/editioncrafter-umd/README.md
@@ -26,6 +26,7 @@ import EditionCrafter from '@cu-mkp/editioncrafter'
     tl: 'Translation (EN)'
   }}
   iiifManifest='https://cu-mkp.github.io/editioncrafter-data/fr640_3r-3v-example/iiif/manifest.json'
+  glossaryURL='https://cu-mkp.github.io/editioncrafter-data/fr640_3r-3v-example/glossary.json'
 />
 ```
 
@@ -43,7 +44,8 @@ To include EditionCrafter in your HTML website, you need to create a `div` somew
      EditionCrafter.viewer({
          id: 'ec',
          documentName: 'BnF Ms. Fr. 640',
-         iiifManifest='https://cu-mkp.github.io/editioncrafter-data/fr640_3r-3v-example/iiif/manifest.json',
+         iiifManifest: 'https://cu-mkp.github.io/editioncrafter-data/fr640_3r-3v-example/iiif/manifest.json',
+         glossaryURL: 'https://cu-mkp.github.io/editioncrafter-data/fr640_3r-3v-example/glossary.json',
          transcriptionTypes: {
            tc: 'Diplomatic (FR)',
            tcn: 'Normalized (FR)',
@@ -89,6 +91,35 @@ Required. (Note: This is required even in the case that you have also included a
 
 A *string* giving the name of the document(s). 
 
+### glossaryURL
+
+Optional. A URL pointing to a JSON file containing glossary information. The glossary should have the following format:
+```
+{
+  "title": "[a subheader, written in markdown]",
+  "citation": "[information on how to cite the glossary, written in markdown]",
+  "entries": {
+    "[Term]": {
+      "headword": "...",
+      "alternateSpellings": "...",
+      "meanings": [
+        {
+          "partOfSpeech": "...",
+          "meaning": "...",
+          "references": "..."
+        }
+        ...
+      ],
+      "modernSpelling: "...",
+      "antonym": "...",
+      "synonym": "...",
+      "seeAlso": "..."
+    },
+    ...
+  }
+}
+```
+
 ### iiifManifest
 
 Required if no `documentInfo` prop specified.