Translit docs

One spelling for every Hebrew and Yiddish term in a text, in the house style you choose.

These pages explain Translit the way I'd explain it to a colleague looking over my shoulder: what each screen is for, what the buttons do, and why it makes the choices it makes. If you're new, read "What is Translit?" and then "Checking a text", which is most of what you need. "The house styles and the terms" is the page to keep open when you're wondering why a word came out the way it did. The page under "Under the hood" is for changing Translit itself, and you only need it if you're working on the code or the term list.

Getting started

• What is Translit? — what it does, who it's for, where it works and what stays on your device

Using Translit

• Checking a text — pasting or opening a text, the four house styles, the Findings cards, your picks, English forms and capitals
• Proofing and fixing — the marked-up proof, stet, applying the changes, copying, downloading and the list of changes
• Style sheets and client styles — the printable style sheet, Markdown and CSV, saving a client's style, your own terms, export and import

Reference

• The house styles and the terms — the rule behind each style, the term list and its groups, how the matching works, and the words it leaves alone on purpose

Under the hood

• Developing — the files, the term list format, adding a term, the tests and deploying

Something wrong, or missing?

If a term is spelled in a way you wouldn't, a word you need isn't in the list, or something doesn't work the way these pages say, open an issue on the GitHub repo (https://github.com/franz-rosenzweig/translit) and say what you expected and what happened. A sentence from the text that tripped it up helps a lot.