\special

yex.keyword.Special(is_long=False, is_outer=False, from_human=True, name=None, doc=None, *args, **kwargs)

Bases: yex.control.control.Unexpandable

An instruction to the output driver.

This creates a whatsit which stores the instruction until it's shipped out. Bear in mind that it may never be shipped out.

The argument is expanded when it's read. It consists of a keyword, followed optionally by a space and arguments to the keyword. The keyword isn't examined until the instruction is run.

TeΧbook: For the syntax of \special, see p276. For the syntax of its argument, see p225.

Source code in yex/control/control.py

def __init__(self,
             is_long: bool = False,
             is_outer: bool = False,
             from_human: bool = True,
             name: Union[str, None] = None,
             doc: Union['yex.Document', None] = None,
             *args, **kwargs):

    self.is_long = is_long
    self.is_outer = is_outer
    self.from_human = from_human
    self.doc = doc

    if name is None:
        self.name = self.__class__.__name__.lower()
    else:
        self.name = name