NEW: metadata (#27)

closes #27
digitallinguistics · Oct 26, 2023 · ea073e2 · ea073e2
1 parent b676f06
commit ea073e2
Show file tree

Hide file tree

Showing 19 changed files with 200 additions and 705 deletions.
diff --git a/README.md b/README.md
@@ -110,7 +110,7 @@ If the input is a string containing only whitespace, an empty string is returned
 
 ## HTML Structure
 
-This section describes the structure of the HTML output by this library, and the classes added to the HTML elements.
+This section describes the structure of the HTML output by this library, and the classes added to the HTML elements. You can see sample HTML output by the program in the `samples/` folder.
 
 Each utterance/example in the original Scription text is wrapped in a `<div class=igl>` element by default. You can customize both the tag that is used for the wrapper and the classes applied to it with the `tag` and `classes` options. For example, to wrap each utterance in `<li class=interlinear>`, you would provide the following options:
 

diff --git a/build/index.js b/build/index.js
@@ -1,4 +1,4 @@
-import convert           from '../index.js'
+import convert           from '../src/index.js'
 import esbuild           from 'esbuild'
 import { fileURLToPath } from 'node:url'
 import path              from 'path'
@@ -13,7 +13,7 @@ const contentTag = `<!-- CONTENT -->`
 
 await esbuild.build({
   bundle:      true,
-  entryPoints: [`index.js`],
+  entryPoints: [path.resolve(__dirname, `../src/index.js`)],
   minify:      true,
   outfile:     `scription2html.js`,
 })
@@ -24,10 +24,13 @@ const template = await readFile(path.resolve(__dirname, `./template.html`), `utf
 const files    = await readdir(path.resolve(__dirname, `../samples/data`))
 
 for (const file of files) {
+
+  if (!file.endsWith(`.txt`)) continue
+
   const scription     = await readFile(path.resolve(__dirname, `../samples/data`, file), `utf8`)
   const filename      = path.basename(file, `.txt`)
   let   content       = `<h1>${ filename }</h1>`
-  const { html }      = convert(scription)
+  const { html }      = convert(scription, { tag: `li` })
   const interlinears  = `<ul>${ html }</ul>`
 
   content += `\n${ interlinears }`

diff --git a/index.js b/index.js
diff --git a/package.json b/package.json
@@ -19,16 +19,15 @@
     "url": "https://danielhieber.info"
   },
   "type": "module",
-  "main": "index.js",
   "repository": {
     "type": "git",
     "url": "https://github.com/digitallinguistics/scription2html.git"
   },
-  "exports": "./index.js",
+  "exports": "./src/index.js",
   "scripts": {
     "build": "node build/index.js",
-    "stop-only": "stop-only --folder . --skip node_modules,.github",
-    "test": "mocha *.test.js"
+    "stop-only": "stop-only --folder src",
+    "test": "mocha src/**/*.test.js"
   },
   "devDependencies": {
     "@digitallinguistics/eslint-config": "^0.3.0",

diff --git a/samples/data/Chitimacha.txt b/samples/data/Chitimacha.txt
@@ -1,12 +1,8 @@
 ---
 abbreviation: A1
-title: How the Indian came (first telling)
+title: Example Story
 ---
-\trs wetkšˊ husˊ na·nča·kamankšˊ wetkˊ hi hokmiʔiˊ.
-\tln He left his brothers.
-
-kunˊ ču·gšˊ ču·gšˊ, še·nink hupˊ hi ničwiʔiˊ.
-He went and went till he came to the edge of a pond.
-
-wetkšˊ we še·ninkˊ hi ničwinkišˊ, weykˊ hi kišutiʔiˊ.
-When he got to the edge of the pond, he swam it.
+waxdungu qasi
+waxt-qungu qasi
+day-one    man
+one day a man
diff --git a/samples/data/Swahili.txt b/samples/data/Swahili.txt
@@ -0,0 +1,4 @@
+ninaenda
+ni-na-end-a
+1SG-PRES-go-IND
+I am going
diff --git a/samples/data/data.js b/samples/data/data.js
@@ -0,0 +1,20 @@
+import { fileURLToPath } from 'node:url'
+import path              from 'node:path'
+import { readFile }      from 'node:fs/promises'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname  = path.dirname(__filename)
+
+const Algonquian   = await readFile(path.resolve(__dirname, `./Algonquian.txt`), `utf8`)
+const Chitimacha   = await readFile(path.resolve(__dirname, `./Chitimacha.txt`), `utf8`)
+const Nuuchahnulth = await readFile(path.resolve(__dirname, `./Nuuchahnulth.txt`), `utf8`)
+const OldLatin     = await readFile(path.resolve(__dirname, `./OldLatin.txt`), `utf8`)
+const Swahili      = await readFile(path.resolve(__dirname, `./Swahili.txt`), `utf8`)
+
+export {
+  Algonquian,
+  Chitimacha,
+  Nuuchahnulth,
+  OldLatin,
+  Swahili,
+}
diff --git a/samples/html/Algonquian.html b/samples/html/Algonquian.html
@@ -9,206 +9,14 @@
 </head>
 <body>
   <h1>Algonquian</h1>
-<ul><div class='igl'>{
-  "metadata": "Menominee",
-  "transcription": {
-    "default": "pemētaehkipew"
-  },
-  "translation": "S/he sits sideways.",
-  "source": "(Bloomfield 1975: 208)",
-  "words": [
-    {
-      "transcription": {
-        "default": ""
-      },
-      "analysis": {
-        "default": "paemet-aehkw-ape"
-      },
-      "gloss": {
-        "gl": "crosswise-face-sit",
-        "en": "initial-medial-final"
-      },
-      "morphemes": [
-        {
-          "transcription": {
-            "default": "paemet"
-          },
-          "gloss": {
-            "gl": "crosswise",
-            "en": "initial"
-          }
-        },
-        {
-          "transcription": {
-            "default": "aehkw"
-          },
-          "gloss": {
-            "gl": "face",
-            "en": "medial"
-          }
-        },
-        {
-          "transcription": {
-            "default": "ape"
-          },
-          "gloss": {
-            "gl": "sit",
-            "en": "final"
-          }
-        }
-      ]
-    }
-  ]
-}</div><div class='igl'>{
-  "metadata": "SW Ojibwe",
-  "transcription": {
-    "default": "ozhaashisagaa"
-  },
-  "translation": "It is a slippery floor.",
-  "source": "(Nichols 2015)",
-  "words": [
-    {
-      "transcription": {
-        "default": ""
-      },
-      "analysis": {
-        "default": "ozhaash-sag-aa"
-      },
-      "gloss": {
-        "gl": "slippery-floor-stat",
-        "en": "initial-medial-final"
-      },
-      "morphemes": [
-        {
-          "transcription": {
-            "default": "ozhaash"
-          },
-          "gloss": {
-            "gl": "slippery",
-            "en": "initial"
-          }
-        },
-        {
-          "transcription": {
-            "default": "sag"
-          },
-          "gloss": {
-            "gl": "floor",
-            "en": "medial"
-          }
-        },
-        {
-          "transcription": {
-            "default": "aa"
-          },
-          "gloss": {
-            "gl": "stat",
-            "en": "final"
-          }
-        }
-      ]
-    }
-  ]
-}</div><div class='igl'>{
-  "metadata": "Delaware",
-  "transcription": {
-    "default": "kwənaskwat"
-  },
-  "translation": "It is long grass.",
-  "source": "(O'Meara 1990: 250)",
-  "words": [
-    {
-      "transcription": {
-        "default": ""
-      },
-      "analysis": {
-        "default": "kwən-askw-at"
-      },
-      "gloss": {
-        "gl": "long-grass-inan",
-        "en": "initial-medial-final"
-      },
-      "morphemes": [
-        {
-          "transcription": {
-            "default": "kwən"
-          },
-          "gloss": {
-            "gl": "long",
-            "en": "initial"
-          }
-        },
-        {
-          "transcription": {
-            "default": "askw"
-          },
-          "gloss": {
-            "gl": "grass",
-            "en": "medial"
-          }
-        },
-        {
-          "transcription": {
-            "default": "at"
-          },
-          "gloss": {
-            "gl": "inan",
-            "en": "final"
-          }
-        }
-      ]
-    }
-  ]
-}</div><div class='igl'>{
-  "metadata": "Blackfoot",
-  "transcription": {
-    "default": "sisáápittakit"
-  },
-  "translation": "shred (the hide) into strips",
-  "source": "(Frantz & Genee 2015)",
-  "words": [
-    {
-      "transcription": {
-        "default": ""
-      },
-      "analysis": {
-        "default": "siso-ap-ittaki"
-      },
-      "gloss": {
-        "gl": "cut-stringlike-by.blade",
-        "en": "initial-medial-final"
-      },
-      "morphemes": [
-        {
-          "transcription": {
-            "default": "siso"
-          },
-          "gloss": {
-            "gl": "cut",
-            "en": "initial"
-          }
-        },
-        {
-          "transcription": {
-            "default": "ap"
-          },
-          "gloss": {
-            "gl": "stringlike",
-            "en": "medial"
-          }
-        },
-        {
-          "transcription": {
-            "default": "ittaki"
-          },
-          "gloss": {
-            "gl": "by.blade",
-            "en": "final"
-          }
-        }
-      ]
-    }
-  ]
-}</div></ul>
+<ul><li class='igl'>
+    <p class=ex-header>Menominee</p>
+  </li><li class='igl'>
+    <p class=ex-header>SW Ojibwe</p>
+  </li><li class='igl'>
+    <p class=ex-header>Delaware</p>
+  </li><li class='igl'>
+    <p class=ex-header>Blackfoot</p>
+  </li></ul>
 </body>
 </html>