SayTeX Syntax Specifications¶
As outlined in Philosophy, SayTeX Syntax is a strictly defined language in one-to-one correspondence with LaTeX. In this section, the exact specifications for SayTeX Syntax will be outlined.
A SayTeX Syntax command consists of at most 7 space-separated words. Each word consists only of the letters a-z, or is a number using the digits 0-9. All strings using any other characters do not conform to SayTeX Syntax.
Commands should generally read as if in a sentence. That is, most relations will take the form of verbs instead of nouns, such as “<” being “is less than” rather than just “less than (sign)”. Also, commands should be as succinct as possible when there are two equally valid ways of saying things; for example, “equals” is preferred over “is equal to.”
The specific commands of SayTeX Syntax are specified in json format in multiple files in saytex/saytexsyntax/saytex_dictionary. The different json files will be concatenated by the compiler, and the reason for having multiple ones is purely organizational.
Each of the json files must be a list of dictionaries, where each dictionary contains the following elements: - saytex: a string of the saytex command. Required. - latex: a string of the corresponding latex command. Required. - left_space: an integer indicating space preference. If 0, a space should not be added to its left side, if 1, a space should occasionally be added, and if 2, a space should always be added. Optional; defaults to 1. - right_space: an integer indicating space preference. Same format as left_space. - insert_curly_brackets_right: a boolean indicating whether or not the command (operator) should require the word on its right to be encapsulated in curly braces (used by e.g. ^). Optional; defaults to false.