Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@ evidence/
coverage/
*.tsbuildinfo
.DS_Store
.gstack/
1 change: 1 addition & 0 deletions CONTENT_LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ To the extent copyright exists, original literary commentary and the original st

- `editions/odyssey/research/**/*.md`
- `editions/odyssey/{foundations,comparison,motif-index,reading-method}.md`
- Original commentary in `editions/odyssey/culture.json`; images and museum records retain their separate terms below.
- `editions/starter/*.md` and `editions/starter/*.txt`

[License summary](https://creativecommons.org/licenses/by/4.0/) · [Full legal terms](https://creativecommons.org/licenses/by/4.0/legalcode)
Expand Down
16 changes: 16 additions & 0 deletions DESIGN.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,22 @@ A passage is a ruled figure with a larger blockquote in the selected reading fac

The leaf holds the chapter heading, source disclosure and prose. Evidence labels remain inline sans-serif distinctions. The original-text view has an edition note and source-preserving paragraphs. Its opening paragraph uses the same text size as the rest of the prose. Source disclosures use native details/summary behavior and a rotated chevron in the open state.

### Art gallery

Whole artworks sit on the existing wash surface with quiet artist/date captions, Literata titles and short descriptions. The featured work leads into a gallery filtered by artwork type and a native book selector. Type buttons expose their pressed state; a status line reports the result count. An empty result offers Show all works. Hover changes the title to the reading accent and moves its arrow slightly; the images retain their own colors and proportions.

### Artwork detail

A large uncropped image precedes the reading essay. Its caption retains medium, collection, accession when supplied, and linked image credits and rights. The facts area connects the work to chapters and collection sources, explicitly distinguishing an episode depiction from a cultural comparison. The essay separates historical context, close looking, a labeled interpretation and a concluding question. Related works link onward without interrupting the essay.

### Cultural themes and book connections

Ruled native details/summary disclosures present a Literata theme title, muted lead and rotating chevron. Opening one reveals prose, chapter links and sources. The book-by-book entries use the same rules and typographic hierarchy, linking directly to the complete text and any associated artworks. Collection titles and introductions come from culture data; chapter labels follow the active edition.

### Artwork enlargement

Enlarge artwork opens a native modal on the reading leaf with a dimmed blue backdrop, caption and rights links. It starts with the whole image fitted to the available space and focuses the close button. Zoom in switches to an image at 200% of the stage width inside a scrollable, keyboard-focusable region; Fit to screen restores the fitted view. The toggle exposes its pressed state. The close button, Escape and a click on the dialog background dismiss it. Entry motion is brief and removed for reduced motion; zoom is an immediate state change.

## Do's and Don'ts

### Do:
Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ A quiet, open-source reading edition for novels and epics. Read the original tex

[Read the Odyssey edition](https://ithaca-odyssey.vercel.app) · [Make an edition](docs/authoring.md) · [Deploy](docs/deployment.md)

[The Odyssey in art](https://ithaca-odyssey.vercel.app/culture) brings twelve paintings, prints and ancient objects into conversation with the poem. Each work has a credited image, collection sources, close-looking notes and chapter connections. Eight cultural essays and a guide to all 24 books connect the gallery to the whole story.

The included edition has all 24 books of Homer's *Odyssey* in Samuel Butler's translation, all 18 episodes of James Joyce's *Ulysses*, 42 chapter commentaries, five reading companions and 156 source-checked quotations. A small original story demonstrates how to replace this collection without changing React code.

## Start locally
Expand All @@ -24,7 +26,7 @@ npm run build
npm run preview
```

The generated `dist/` directory is the deployable site. Keep a fallback to `index.html` for `/read/*` and `/about` routes; [Vercel configuration](vercel.json) is included.
The generated `dist/` directory is the deployable site. Keep a fallback to `index.html` for `/read/*`, `/culture/*`, `/culture` and `/about` routes; [Vercel configuration](vercel.json) is included.

## Make it yours

Expand All @@ -48,6 +50,7 @@ To publish your edition, set `READER_EDITION` to its manifest path in your hosti
- Chapter bookmarks, saved quotations and a remembered reading position.
- Literata, Georgia and Manrope reading options, four sizes, day and night themes.
- Commentary search and a global Texts menu.
- An optional art and culture companion with whole-image views, filters, sources and chapter links.
- Keyboard navigation, visible focus, reduced-motion support and responsive layouts.
- Local-only preferences: no reader account, analytics script or cross-device sync.

Expand Down
21 changes: 21 additions & 0 deletions THIRD_PARTY_NOTICES.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,24 @@ The source works above are offered by Project Gutenberg as public domain in the
The source records in `editions/odyssey/sources/manifest.md` identify editions and segmentation. The quotation ledger records selected passages; it does not grant rights beyond those of the source. The linked scholarship remains with its respective authors and publishers.

Georgia is a system-font option, not a bundled font. Other npm dependencies retain their respective package licenses. No Pinterest image is distributed in this repository.

## Odyssey art and culture collection

Images in `public/images/culture/` are resized without cropping and converted to WebP; `-small` files are thumbnails. Sources, rights evidence and the distributed files’ SHA-256 checksums are recorded in `editions/odyssey/culture-sources.json`. The original image providers retain their own site and catalogue-text terms. All essays and close-looking notes in the reader are newly written.

| Work | Collection and image terms |
| --- | --- |
| Joseph Mallord William Turner, *Ulysses deriding Polyphemus – Homer’s Odyssey*, 1829 (NG508) | [National Gallery, London](https://www.nationalgallery.org.uk/paintings/joseph-mallord-william-turner-ulysses-deriding-polyphemus-homer-s-odyssey). National Gallery, London, via Wikimedia Commons. [Public domain](https://commons.wikimedia.org/wiki/File:Turner_-_Ulysses_deriding_Polyphemus_1829.jpg). |
| Attributed to the Persephone Painter · Greek, Attic, *Terracotta calyx-krater (bowl for mixing wine and water)*, ca. 440 BCE (41.83) | [The Metropolitan Museum of Art, New York](https://www.metmuseum.org/art/collection/search/253627). The Metropolitan Museum of Art, New York. Gift of Amelia E. White, 1941. [The Met Open Access · CC0](https://creativecommons.org/publicdomain/zero/1.0/). |
| Gerard de Lairesse, *Odysseus and Calypso*, c. 1680 (SK-A-211) | [Rijksmuseum, Amsterdam](https://www.rijksmuseum.nl/en/collection/object/Odysseus-and-Calypso--6bfcc507d5625d026e8be4acd9c52b75). Rijksmuseum, Amsterdam, via Wikimedia Commons. [CC0 / public domain](https://commons.wikimedia.org/wiki/File:Lairesse_-_Odysseus_bij_Calypso_Rijksmuseum_SK-A-211.jpg). |
| Attributed to the Amasis Painter · Greek, Attic, *Terracotta lekythos (oil flask)*, ca. 550–530 BCE (31.11.10) | [The Metropolitan Museum of Art, New York](https://www.metmuseum.org/art/collection/search/253348). The Metropolitan Museum of Art, New York. Fletcher Fund, 1931. [The Met Open Access · CC0](https://creativecommons.org/publicdomain/zero/1.0/). |
| Joachim von Sandrart the Elder, *Odysseus and Nausicaa*, c. 1630–1688 (SK-A-4278) | [Rijksmuseum, Amsterdam](https://www.rijksmuseum.nl/en/collection/object/Odysseus-and-Nausicaa--36d44d38106f0cc843b11a1b12dc5c09). Rijksmuseum, Amsterdam, via Wikimedia Commons. [Public domain](https://commons.wikimedia.org/wiki/File:Joachim_von_Sandrart_-_Odysseus_und_Nausikaa_(Rijksmuseum_Amsterdam).jpg). |
| Unknown maker · Greek, Melian, *Terracotta plaque*, ca. 460–450 BCE (30.11.9) | [The Metropolitan Museum of Art, New York](https://www.metmuseum.org/art/collection/search/253053). The Metropolitan Museum of Art, New York. Fletcher Fund, 1930. [The Met Open Access · CC0](https://creativecommons.org/publicdomain/zero/1.0/). |
| Giovanni Benedetto Castiglione, *Circe with the Companions of Ulysses Changed into Animals*, 1650–1651 (RP-P-OB-12.200) | [Rijksmuseum, Amsterdam](https://www.rijksmuseum.nl/en/collection/object/Circe-met-de-in-dieren-veranderde-reisgenoten-van-Odysseus--2fc8beaf14360d90f5350a14da9dc730). Rijksmuseum, Amsterdam, via Wikimedia Commons. [CC0 / public domain](https://commons.wikimedia.org/wiki/File:Circe_met_de_in_dieren_veranderde_reisgenoten_van_Odysseus,_RP-P-OB-12.200.jpg). |
| Unknown maker · Greek, Eastern Mediterranean, *Glass phiale (libation bowl)*, late 5th–early 4th century BCE (69.11.6) | [The Metropolitan Museum of Art, New York](https://www.metmuseum.org/art/collection/search/255281). The Metropolitan Museum of Art, New York. Purchase, Arthur Darby Nock Bequest, in honor of Gisela Richter, 1969. [The Met Open Access · CC0](https://creativecommons.org/publicdomain/zero/1.0/). |
| Unknown printmaker after Annibale Carracci, *Odysseus and the Sirens*, 17th century (RP-P-1890-A-15254) | [Rijksmuseum, Amsterdam](https://www.rijksmuseum.nl/en/collection/object/Odysseus-en-de-sirenen--ffcba44976c5d7e039f8500945a1cbcb). Rijksmuseum, Amsterdam, via Wikimedia Commons. [CC0 / public domain](https://commons.wikimedia.org/wiki/File:Odysseus_en_de_sirenen,_RP-P-1890-A-15254.jpg). |
| Attributed to the Workshop of New York MMA 34.11.2 · Greek, Attic, *Terracotta krater*, ca. 775 BCE (34.11.2) | [The Metropolitan Museum of Art, New York](https://www.metmuseum.org/art/collection/search/253422). The Metropolitan Museum of Art, New York. Fletcher Fund, 1934. [The Met Open Access · CC0](https://creativecommons.org/publicdomain/zero/1.0/). |
| Theodoor van Thulden, after Francesco Primaticcio and Nicolò dell’Abate, *Odysseus and Penelope on Their Way to Bed*, 1633 (BI-1883-1235-50) | [Rijksmuseum, Amsterdam](https://www.rijksmuseum.nl/en/collection/object/Odysseus-en-Penelope-op-weg-naar-bed--600886f3a19288d769027143cd7dbe99). Rijksmuseum, Amsterdam, via Wikimedia Commons. [CC0 / public domain](https://commons.wikimedia.org/wiki/File:Odysseus_en_Penelope_op_weg_naar_bed_Les_Travaux_d%27Ulysse_(serietitel)_De_werken_van_Odysseus_(serietitel),_BI-1883-1235-50.jpg). |
| Unknown scribe · Greek, Ptolemaic, *Papyrus fragment with lines from Homer's Odyssey*, ca. 285–250 BCE (09.182.50) | [The Metropolitan Museum of Art, New York](https://www.metmuseum.org/art/collection/search/248134). The Metropolitan Museum of Art, New York. Gift of Egypt Exploration Fund, 1909. [The Met Open Access · CC0](https://creativecommons.org/publicdomain/zero/1.0/). |

The six Met photographs are provided through [The Met Open Access](https://www.metmuseum.org/hubs/open-access) under [CC0](https://creativecommons.org/publicdomain/zero/1.0/). The linked collection records identify the photographs as Public Domain. This does not apply CC0 to museum interpretive essays. Rijksmuseum and Turner reproductions use the specific Commons rights records linked above.
11 changes: 11 additions & 0 deletions docs/authoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,21 @@ Keep IDs and `site.storageKey` stable once readers have saved their place. A new
| `works[].endLink` | Final chapter destination with `href`, `label` |
| `sectionLabels` | Map full note headings to shorter menu labels |
| `frontispiece` | Optional image, caption, title, description, href and linkLabel |
| `culture` | Optional path to an art and culture JSON file; see below |
| `downloads` | Array of `{file, filename, label}`; generated under `/texts/` |

Place artwork in `public/images/`, reference it as `/images/name.jpg`, and add provenance and terms to both the edition's About page and `THIRD_PARTY_NOTICES.md`. Remove unused default artwork if you do not want to distribute it. The supplied Content Security Policy expects images and fonts on the same origin.

### Optional art and culture companion

Set `"culture": "culture.json"` in the manifest to enable `/culture`, individual artwork pages and chapter links. Omit the field to keep an edition entirely text-based. The starter does not require this feature.

Use `editions/odyssey/culture.json` as an example and `src/culture-types.ts` as the field reference. The file contains `title`, `description`, introductory paragraphs, a `featured` artwork ID, an `artworks` array, `themes` and a `chapters` guide. Artwork IDs are stable URL slugs. Every artwork needs an artist/maker, date, medium, collection, local image with dimensions and alt text, a summary, historical context, close-looking notes, literary interpretation, a question, chapter IDs, collection sources and image rights. `kind` is `painting` (including prints) or `object`; `relationship` distinguishes an episode depiction from a contextual comparison.

Themes have original paragraphs, source links and chapter connections. Each guide entry connects an existing chapter ID to a cultural prompt and theme IDs. The compiler rejects missing rights, duplicate IDs, invalid images and unknown chapter/theme references. It does not validate historical accuracy or establish permission to publish an image. Review the actual image, collection record and rights notice together. Keep uncertainty explicit and distinguish the object's date from the era of the story.

Store optimized images in `public/images/` and optional thumbnails alongside them; preserve the whole work when resizing. The Odyssey's `culture-sources.json` records image provenance, transformations and checksums. Add equivalent records and update credits when adapting the collection. Remove the default assets if your edition does not use them.

## 3. Add the original text

Use UTF-8 `.txt` files with blank lines between paragraphs. The compiler joins line wraps within prose paragraphs, preserves blocks whose every line is indented by at least two spaces as verse, and renders `_underscores_` as emphasis. Source HTML is escaped.
Expand Down
6 changes: 6 additions & 0 deletions editions/odyssey/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,12 @@ These notes are a reading companion, not a Greek-language critical edition. A ch

Literata by TypeTogether is designed for sustained reading on screens. Manrope supplies navigation and the Clear reading option. Georgia is a system-serif option. The bundled fonts are self-hosted under the SIL Open Font License: [Literata license](/licenses/literata-license.txt) and [Manrope license](/licenses/manrope-license.txt).

## Art & cultural context {#culture}

[The Odyssey in art](/culture) brings together twelve paintings, prints, and ancient objects, eight cultural essays, and a guide through all 24 books. Each artwork page links to its museum record and image rights. The six Met images are [Open Access photographs](https://www.metmuseum.org/hubs/open-access), released under CC0. The other reproductions come from Wikimedia Commons with their public-domain or CC0 notices. Images are resized without cropping.

Historical facts follow the cited museum and scholarly sources. Close-looking notes describe the selected image; connections to Homer are AI-assisted interpretations. A later painting is a response to the poem, while an ancient object may illuminate a practice without illustrating any episode. The collection contains full-story spoilers. [Complete image notices](https://github.com/siddath/ithaca-reader/blob/main/THIRD_PARTY_NOTICES.md) and [image provenance](https://github.com/siddath/ithaca-reader/blob/main/editions/odyssey/culture-sources.json) are available in the public repository.

## Your place, kept locally {#privacy}

Reading position, appearance, chapter bookmarks and saved quotations live in your browser. There is no account, tracking script, or cross-device synchronisation. Clearing this site’s browser data removes the saved material. The hosting provider receives normal page requests.
Expand Down
Loading
Loading