Controls in yex

Control keywords

Keyword	Group	Notes	Purpose
_Input	io	👻	This is where the input streams live.
_Output	io	👻	This is where the output streams live.
$	math	🤸👽	Switches inline maths mode on or off.
/	font	🤸👽	Adds an italic correction.
\-	other	👽	?
\above	math	👽	?
\abovedisplayshortskip	Glue		?
\abovedisplayskip	Glue		?
\abovewithdelims	math	👽	?
\accent	other	👽	?
\adjdemerits	Number		?
\advance	arithmetic		Adds two quantities.
\afterassignment	other	👽	?
\aftergroup	other	👽	?
\atop	math	👽	?
\atopwithdelims	math	👽	?
\badness	Number		How badly the most recent line of text was set.
\baselineskip	Glue		?
\batchmode	debug	👽	?
\begingroup	other	🪗👽	?
\belowdisplayshortskip	Glue		?
\belowdisplayskip	Glue		?
\binoppenalty	Number		?
\botmark	box	👽	?
\boxmaxdepth	Dimen		?
\brokenpenalty	Number		?
\char	other		?
\chardef	register	🪗	?
\cleaders	box	👽	?
\closein	io	👽	?
\closeout	io	👽	?
\clubpenalty	Number		?
\columns	tab	👽	?
\countdef	register	🪗	?
\cr	tab	👽	?
\crcr	tab	👽	?
\csname	other	👽	?
\day	Number		?
\deadcycles	Number		?
\def	macro	🪗	?
\defaulthyphenchar	Number		?
\defaultskewchar	Number		?
\delimiter	math	👽	?
\delimiterfactor	Number		?
\delimitershortfall	Dimen		?
\dimendef	register	🪗	?
\discretionary	other	👽	?
\displayindent	Dimen		?
\displaylimits	math	👽	?
\displaystyle	math	👽	?
\displaywidowpenalty	Number		?
\displaywidth	Dimen		?
\divide	arithmetic		Divides two quantities.
\doublehyphendemerits	Number		?
\dp	box		?
\dump	debug	👽	?
\edef	macro	🪗	?
\else	conditional	🪗	?
\emergencystretch	Dimen		?
\end	other	👽	?
\endcsname	other	👽	?
\endgroup	other	🪗👽	?
\endinput	io	👽	?
\endlinechar	Number		?
\eqno	math	👽	?
\errhelp	Tokenlist		?
\errmessage	string	🪗	?
\errorcontextlines	Number		?
\errorstopmode	debug	👽	?
\escapechar	Number		?
\everycr	Tokenlist		?
\everydisplay	Tokenlist		?
\everyhbox	Tokenlist		?
\everyjob	Tokenlist		?
\everymath	Tokenlist		?
\everypar	Tokenlist		?
\everyvbox	Tokenlist		?
\exhyphenpenalty	Number		?
\expandafter	other	👽	?
\fam	Number		?
\fi	conditional	🪗	?
\finalhyphendemerits	Number		?
\firstmark	box	👽	?
\floatingpenalty	Number		?
\font	font		?
\fontdimen	font		Gets and sets various details of a font.
\fontname	font	👽	Inserts the name of the current font.
\futurelet	other	👽	?
\gdef	macro	🪗	?
\global	macro	🪗	?
\globaldefs	Number		?
\halign	other	👽	?
\hangafter	Number		?
\hangindent	Dimen		?
\hbadness	Number		?
\hbox	box		?
\hfil	box		Skips horizontally by zero, but with infinite stretchability and shrinkability.
\hfill	box		?
\hfilll	box		Skips horizontally by zero, but with even more infinite stretchability.
\hfilneg	box		Cancels the stretchability of a previous hfil.
\hfuzz	Dimen		?
\hoffset	Dimen		?
\holdinginserts	Number		?
\hrule	box		Adds a horizontal rule.
\hsize	Dimen		?
\hskip	box		Adds a horizontal leader.
\hss	box		Skips horizontally by zero, but with infinite stretchability and shrinkability.
\ht	box		?
\hyphenation	hyphen	👽	?
\hyphenchar	font		Sets the character used for hyphenation.
\hyphenpenalty	Number		?
\if	conditional	🪗	?
\ifcase	conditional	🪗	?
\ifcat	conditional	🪗	?
\ifdim	conditional	🪗	?
\ifeof	conditional	🪗	?
\iffalse	conditional	🪗	?
\ifhbox	conditional	🪗	?
\ifhmode	conditional	🪗	?
\ifinner	conditional	🪗	?
\ifmmode	conditional	🪗	?
\ifnum	conditional	🪗	?
\ifodd	conditional	🪗	?
\iftrue	conditional	🪗	?
\ifvbox	conditional	🪗	?
\ifvmode	conditional	🪗	?
\ifvoid	conditional	🪗	?
\ifx	conditional	🪗	?
\ignorespaces	other	👽	?
\immediate	io		?
\indent	other		?
\input	io	👽	?
\inputlineno	Number		?
\insert	other	👽	?
\insertpenalties	Number		?
\interlinepenalty	Number		?
\jobname	Tokenlist		?
\kern	gismo		?
\language	Number		?
\lastbox	box		?
\lastkern	Dimen		?
\lastpenalty	Number		?
\lastskip	Glue		?
\leaders	box	👽	?
\left	math	👽	?
\lefthyphenmin	Number		?
\leftskip	Glue		?
\leqno	math	👽	?
\let	other		TODO
\limits	math	👽	?
\linepenalty	Number		?
\lineskip	Glue		?
\lineskiplimit	Dimen		?
\long	macro	🪗	?
\looseness	Number		?
\lower	box		?
\lowercase	other	🪗	?
\mag	Number		?
\mark	box	👽	?
\mathaccent	math	👽	?
\mathbin	math	👽	?
\mathchar	math	👽	?
\mathchardef	register	🪗	?
\mathchoice	math	👽	?
\mathclose	math	👽	?
\mathinner	math	👽	?
\mathop	math	👽	?
\mathopen	math	👽	?
\mathord	math	👽	?
\mathpunct	math	👽	?
\mathrel	math	👽	?
\mathsurround	Dimen		?
\maxdeadcycles	Number		?
\maxdepth	Dimen		?
\meaning	other	👽	?
\medmuskip	Muglue		?
\message	string	🪗	?
\mkern	gismo	👽	?
\month	Number		?
\moveleft	box		?
\moveright	box		?
\mskip	math	👽	?
\multiply	arithmetic		Multiplies two quantities.
\muskipdef	register	🪗	?
\newlinechar	Number		?
\noalign	other	👽	?
\noboundary	other	👽	?
\noexpand	other	🪗	The argument is not expanded.
\noindent	other		?
\nolimits	math	👽	?
\nonscript	math	👽	?
\nonstopmode	debug	👽	?
\nulldelimiterspace	Dimen		?
\nullfont	font		Selects the null font, which contains no characters.
\number	other	👽	?
\omit	tab	👽	?
\openin	io	👽	?
\openout	io	👽	?
\or	conditional	🪗	?
\outer	macro	🪗	?
\output	Tokenlist		?
\outputpenalty	Number		?
\over	math	👽	?
\overfullrule	Dimen		?
\overline	math	👽	?
\overwithdelims	math	👽	?
\pagedepth	Dimen		?
\pagefilllstretch	Dimen		?
\pagefillstretch	Dimen		?
\pagefilstretch	Dimen		?
\pagegoal	Dimen		?
\pageshrink	Dimen		?
\pagestretch	Dimen		?
\pagetotal	Dimen		?
\par	other		Add a paragraph break.
\parfillskip	Glue		The amount of space to add at the end of a paragraph.
\parindent	Dimen		?
\parshape	other	🪗	?
\parskip	Glue		?
\patterns	hyphen	👽	?
\pausing	Number		?
\penalty	other		?
\postdisplaypenalty	Number		?
\predisplaypenalty	Number		?
\predisplaysize	Dimen		?
\pretolerance	Number		?
\prevdepth	Dimen		?
\prevgraf	Number		?
\radical	math	👽	?
\raise	box		?
\read	io	👽	?
\relax	other		Does nothing.
\relpenalty	Number		?
\right	math	👽	?
\righthyphenmin	Number		?
\rightskip	Glue		?
\romannumeral	other	👽	?
\scriptscriptstyle	math	👽	?
\scriptspace	Dimen		?
\scriptstyle	math	👽	?
\scrollmode	debug	👽	?
\setbox	box		?
\setlanguage	hyphen	👽	?
\settabs	tab	👽	?
\shipout	other		Sends a box to the output.
\show	other	👽	?
\showbox	box		?
\showboxbreadth	Number		?
\showboxdepth	Number		?
\showlists	other	🪗	?
\showthe	other	👽	?
\skewchar	font		?
\skipdef	register	🪗	?
\spacefactor	Number		?
\spaceskip	Glue		?
\span	tab	👽	?
\special	gismo	👽	?
\splitbotmark	box	👽	?
\splitfirstmark	box	👽	?
\splitmaxdepth	Dimen		?
\splittopskip	Glue		?
\string	other		?
\tabskip	Glue		?
\textstyle	math	👽	?
\the	other		Takes an argument, one of many kinds (see the TeXbook p212ff) and returns a representation of that argument.
\thickmuskip	Muglue		?
\thinmuskip	Muglue		?
\time	Number		?
\toksdef	register	🪗	?
\tolerance	Number		?
\topmark	box	👽	?
\topskip	Glue		?
\tracingcommands	log		Commands before they are executed
\tracinglostchars	log		Characters not in the font
\tracingmacros	log		Macros, as they are expanded
\tracingonline	log		If positive, logs go to stdout; otherwise they go to the logfile.
\tracingoutput	log		Boxes that are shipped out
\tracingpages	log		Page-break calculations
\tracingparagraphs	log		Line-break calculations
\tracingrestores	log		Deassignments when groups end
\tracingstats	log		Statistics about memory usage
\uchyph	Number		?
\underline	math	👽	?
\unhbox	other	👽	?
\unhcopy	other	👽	?
\unkern	box	👽	?
\unpenalty	box	👽	?
\unskip	box	👽	?
\unvbox	other	👽	?
\unvcopy	other	👽	?
\uppercase	other	🪗	?
\vadjust	other	👽	?
\valign	other	👽	?
\vbadness	Number		?
\vbox	box		?
\vcenter	box		?
\vfil	box		Skips vertically by zero, but with infinite stretchability.
\vfill	box		Skips vertically by zero, but with more infinite stretchability.
\vfilneg	box		Cancels the stretchability of a previous vfil.
\vfuzz	Dimen		?
\voffset	Dimen		?
\vrule	box		Adds a vertical rule.
\vsize	Dimen		?
\vskip	box		Adds a vertical leader.
\vsplit	box		?
\vss	box		Skips vertically by zero, but with infinite stretchability and shrinkability.
\vtop	box		?
\wd	box		?
\widowpenalty	Number		?
\write	io	🪗	?
\xdef	macro	🪗	?
\xleaders	box	👽	?
\xspaceskip	Glue		?
\year	Number		?
\␣	other		Add an unbreakable space.

Parameters are listed with their type name in the group column, in italics.

Key

Symbol	Meaning
🤸	Active character. Whenever the character appears in ordinary text, this routine will be called.
🪗	Expandable control. These controls work at a low level, because they deal with the flow of control. For example, \if falls into this group. Unless you’re messing with the parser, you may never run into these.
👻	Appears in the controls table, but is not visible from TeX code.
👽	Not currently implemented. Eventually, everything will be implemented, but at present this isn’t. (Parameters are not marked.)

class yex.control.C_Control(is_long=False, is_outer=False, name=None, *args, **kwargs)

Bases: object

Superclass of all controls.

A control has:

• a name, which is a string. If you don’t pass one in,

  we default to the name of the class in lowercase.

• a __call__() method, which causes it to run

• the flags is_long and is_outer, which affect

  where it can be called

Each control is usually referred to by at least one yex.parse.Control object in a given Document. But those objects are symbols, and these are procedures; don’t get them confused.

A Document keeps track of many controls. The control doesn’t know which doc it’s in, but when it’s called, it can find it by looking in the doc field of tokens.

Some controls (such as the superclass) have names beginning with C_. This is so that they can’t be called from TeX code; TeX identifiers can’t contain underscores. If they began with a plain underscore, Python wouldn’t export them from their modules.

property identifier

A good string to use for looking up this control in a document.

In practice, it could be stored under a different string as well, or instead, or it might not be stored at all. But this is often a reasonable shot.

“.. list-table:: Control keywordsn” ” :header-rows: 1n” “n” ” * - Keywordn” ” - Groupn” ” - Notesn” ” - Purposen”