README.md

RiTa: tools for generative natural language

RiTa is implemented in Java and JavaScript, with a common API for both, and is free/libre/open-source via the GPL license.

Features in v2.0

• Smart lexicon search for words matching part-of-speech, syllable, stress and rhyme patterns
• Fast, heuristic algorithms for inflection, conjugation, stemming, tokenization, and more
• Letter-to-sound engine for feature analysis of arbitrary words (with/without lexicon)
• Integration of the RiScript scripting language, designed for writers
• Powerful new options for generation via grammars and Markov chains

This repo contains the website, documentation, and examples for RiTa. For the code, see

• the JavaScript repo, or use it with npm or unpkg
• the Java repo, or add it to your project via maven

Note: Version 2.0 contains breaking changes! Please check the release notes...

API

RiTa		RiMarkov	RiGrammar
RiTa.addTransform() RiTa.alliterations() RiTa.analyze() RiTa.concordance() RiTa.conjugate() RiTa.evaluate() RiTa.grammar() RiTa.hasWord() RiTa.isAbbrev() RiTa.isAdjective() RiTa.isAdverb() RiTa.isAlliteration() RiTa.isNoun() RiTa.isPunct() RiTa.isQuestion() RiTa.isStopWord() RiTa.isRhyme() RiTa.isVerb() RiTa.kwic() RiTa.markov()	RiTa.pastPart() RiTa.phones() RiTa.pos() RiTa.posInline() RiTa.presentPart() RiTa.pluralize() RiTa.randomOrdering() RiTa.randomSeed() RiTa.randomWord() RiTa.rhymes() RiTa.search() RiTa.sentences() RiTa.singularize() RiTa.soundsLike() RiTa.spellsLike() RiTa.stem() RiTa.stresses() RiTa.syllables() RiTa.tokenize() RiTa.untokenize()	addText() completions() generate() probability() probabilities() size() toString() toJSON() fromJSON()	addRule() addRules() expand() removeRule() toJSON() toString() fromJSON()

RiScript

RiScript is a writer-focused scripting language integrated with RiTa. It enables simple generative primitives within plain text for dynamic expansion at runtime. RiScript primitives can be used as part of any RiTa grammar or executed directly using RiTa.evaluate(). For documentation, see this interactive notebook.

Developers

The website in this repo is generated via the ./scripts/make-site.sh script.

Static pages

The best way to make updates to static pages is to do the following:

$ git clone [email protected]:dhowe/rita.git
$ cd rita
$ sh ./scripts/watch-site.sh

• then make your changes in /rita/www
• then refresh and check /rita/pub/index.html in the browser

When ready, create a PR with only the files you have changed (in www and pub).

Reference pages

To make updates to the reference pages, follow the instructions above,
but instead make updates to the JSON files in /rita/docgen/data.

Contributors

Code Contributors

This project exists only because of the people who contribute. Thank you!

Financial Contributors