The xd Crossword Corpus

Editorial conventions

What goes in a .xd file and how its fields are used.

Companion documents:

Each convention below is marked:

Principles

  1. A .xd file holds the puzzle and nothing else. [established] The same puzzle from any source should yield the same grid, clues and headers, byte for byte (see CONTRIBUTING.md, “Versions of a puzzle” for what to do when they don’t). The notes are the exception: they carry what a reader needs to know about the puzzle (text published with it, errata, corrections to what was published), so two otherwise identical files can differ there. Where a puzzle came from and how it was made (sources, OCR, who reviewed it) go in receipts.tsv and the source archive’s NOTES.md. They don’t go in the .xd.
  2. The puzzle as the publisher meant it. [practice] The clues, grid and headings are the publisher’s. Obvious mistakes (a typo, a misprinted answer letter, damage in transfer) are corrected to what was meant; anything the publisher did on purpose (wordplay, a gimmick) stays.
  3. Corrections that change what was published are noted; bookkeeping is not. [practice] When the .xd corrects an answer or grid letter the publisher got wrong, or applies published errata, the notes say what was published and what it became. Fixes to our own copy (transfer damage, a better scan, markup) and typo fixes in clue text are recorded only in the commit that makes them (see CONTRIBUTING.md, “Editing puzzles already in the corpus”).
  4. The originals are never edited. [established] Fixes go in the .xd files (or overrides.tsv). Files in a source archive stay exactly as they were received.

Characters and typography

Headers

Identifiers and file names

How a puzzle’s xdid, file name and shelf are chosen is defined in CONTRIBUTING.md, “xdids” and “Shelving”.

Clues and grid

Notes

The spec’s free-form final section (Section 4) holds the notes. Some imports use a Notes: header instead. [practice] Section 4 is preferred, and is an open question for the corpus.

What goes in the notes: [practice]

What does not go in the notes:

Incomplete puzzles

Scope

Which puzzles we collect is in COLLECTION.md.

Open questions