Kōdōn (κώδων)

φώνημ᾽ ἀκούω καὶ ξυναρπάζω φρενὶ
χαλκοστόμου κώδωνος ὡς Τυρσηνικῆς.

I hear your voice and grasp it in my mind, / like the voice of a bronze-belled Tyrrhenian trumpet. – Sophocles, Ajax ll. 16–17

Part of the Ajax Multi-Commentary project, Kōdōn (Greek for the "bell of a trumpet") is a minimal computing platform for authoring and compiling (multi-)commentaries.

What is a multi-commentary?

A multi-commentary pulls glossae from more than one commentary at once, applying these comments to lemmata in a shared edition of the text. (In future iterations, a multi-commentary might also entail multiple editions of a text.)

By creating a shared edition for all of the comments to cite simultaneously, a multi-commentary enables the reader to explore hundreds of years of a commentary tradition at a glance, gleaning new insights into how the commentaries interact with the critical text and with each other.

How does it work?

The multi-commentary platform works by combining editions, commentaries, and (optionally) translations into a reading environment.

Editions

Editions are TEI XML. Kōdōn will parse properly formatted TEI for canonical references using the <refsDecl> element in the TEI header. For now, because Kōdōn focuses on amplifying commentaries, each canonical reference mainly consists of its CTS URN citation — e.g., for line 17 of Sophocles' Ajax urn:cts:greekLit:tlg0011.tlg003.perseus-grc2:17 — and the plain text reference to the line.

There is, however, rudimentary support for handling TEI's <del> and <add> elements, with plans to support additional markup in the future.

Commentaries

Each commentary consists of a series of glosses that point to canonical references in the editions. Citations to critical editions must be formatted as CTS URNs. For example, to cite the word κώδωνος at Sophocles, Ajax l. 17, you would use the following URN: urn:cts:greekLit:tlg0011.tlg003.perseus-grc2:17@κώδωνος.

TODO: Should we continue to support the slide-based short syntax for per-comment metadata, relying on the YAML block only document-level data? Or should we use a YAML metadata block for each glossa and treat each glossa as a separate markdown document?

Translations

Like commentaries, translations must point to a critical edition of the text.

TODO: Specify how translations should work.

License

Copyright 2024 Matteo Romanello, Ajax Multi-Commentary Project

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

create-svelte

Everything you need to build a Svelte library, powered by create-svelte.

Read more about creating a library in the docs.

Creating a project

If you're seeing this, you've probably already done this step. Congrats!

# create a new project in the current directory
npm create svelte@latest

# create a new project in my-app
npm create svelte@latest my-app

Developing

Once you've created a project and installed dependencies with npm install (or pnpm install or yarn), start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Everything inside src/lib is part of your library, everything inside src/routes can be used as a showcase or preview app.

Building

To build your library:

npm run package

To create a production version of your showcase app:

npm run build

You can preview the production build with npm run preview.

To deploy your app, you may need to install an adapter for your target environment.

Publishing

Go into the package.json and give your package the desired name through the "name" option. Also consider adding a "license" field and point it to a LICENSE file which you can create from a template (one popular option is the MIT license).

To publish your library to npm:

npm publish