Summary
Further information about the commands or environments summarised here may be obtained from: the package or class documentation via texdoc ⟨name⟩ (for class or package commands or environments); The TeXbook [46] (for TeX primitives); the LaTeX2e source documentation via texdoc source2e (for LaTeX Kernel commands or environments); the PDFTeX documentation via texdoc pdftex (for PDFTeX primitives); the eTeX documentation via texdoc etex (for eTeX primitives). If you use an up-to-date version of PDFLaTeX you will be able to use all the primitives described here. Older versions of LaTeX may not have some of the PDFTeX or eTeX primitives.
Logical not. § 1.2 ⁑Arara
Used in \resizebox to maintain aspect ratio. § 10.3 ⁑The leaflet Class
Used in colour specifications to indicate colour mixtures or percentages. § 12.1 ⁑Flow Charts
Replacement text for argument ⟨digit⟩. (See Volume 1.) § 2.1.1 ⁂Macro Definitions
Replacement text for argument ⟨digit⟩ when the command definition is included in the definition of another command. § 2.7.5 ⁂Iteration Tips and Tricks
Switches in and out of in-line math mode. (See Volume 1.) § 2.2.1 ⁑Loading Data From a CSV File
calc library.When used with the tikz calc library this is used to indicate co-ordinate calculations. § 10.3 ⁑The leaflet Class
Comment character used to ignore everything up to and including the EOL character in the source code. This is often used to suppress unwanted space caused by the EOL in source code. Sometimes comments are used to provide information to applications that build your document, such as arara. See also Volume 1. § 1. ⁎Introduction
--> § 1.2 ⁑Arara
Non-short-circuit logical and. § 1.2 ⁑Arara
Alignment tab. § 2.2.1 ⁑Loading Data From a CSV File
Logical and. § 1.2 ⁑Arara
Closing quote or apostrophe ’ symbol in text mode or prime symbol ′ in math mode. § 4.3 ⁂Building Your Own Invoice using longtable and datatool
Closing double quote ” symbol in text mode or double prime ″ in math mode. § 2.7.2 ⁂Iterating Over a Comma-Separated List
En-dash – symbol. (Normally used for number ranges.) § 2.1.3 ⁂Arithmetic
tikzpicture environment.Used within the path specifications to indicate that a straight line should be drawn between two positions. § 12.1 ⁑Flow Charts
Em-dash — symbol. (Normally used to indicate omissions or interruptions or to highlight a parenthetical element.) § 2.9 ⁑Null and Boolean Values
Continuation from previous line. § 1.2 ⁑Arara
tikzpicture environment.Start arrow tip § 12.1 ⁑Flow Charts
Used in tabular-like environment column specifiers before
l, r, c, p, m or
b to insert ⟨decl⟩ directly in front of the entry
for that column. § 4.3 ⁂Building Your Own Invoice using longtable and
datatool
Argument Summary:
- ⟨decl⟩ The code to insert at the start of the column.
tikzpicture environment.End arrow tip § 12.1 ⁑Flow Charts
Used in the argument of tabular-like
environments to specify text to insert
between columns. Since ⟨text⟩ replaces the usual
inter-column space, this may also be used with an empty argument
to simply suppress that space. § 10.3 ⁑The leaflet Class
Argument Summary:
- ⟨text⟩ Text to insert between columns
Used when a sentence ends with a capital letter. This command should be placed after the letter and before the punctuation mark. § Glossary
Indicates a sectioning command has just been used, so the next paragraph should have its indentation suppressed. § 6.5.2 ⁂Non-Hierarchical Paragraph Numbering
Identifies the output stream for the document's auxiliary file. § 9.4 ⁂Using the datatool Package for Exams or Assignment Sheets
The name of the current environment. § 2.1.1 ⁂Macro Definitions
TeX count register that keeps track of the current
enumerate level. § 6.5.1.1 ⁂Delving Deeper
Just does the first argument and discards the second argument.
See also \@secondoftwo. § 11.1 ⁂Writing a Class File for a Form
Argument Summary:
- ⟨first⟩ The first argument.
- ⟨second⟩ The second argument (discarded).
Iterates through the comma-separated list and assigns the control
sequence ⟨cs⟩ to the current item in the list so that it can be
used as a placeholder in ⟨body⟩. The xfor package
extends the functionality of this command, allowing you to terminate
the loop at the end of the current iteration via
\@endfortrue. § 2.7.2 ⁂Iterating Over a Comma-Separated List
Argument Summary:
- ⟨cs⟩ The control sequence that can be used in ⟨body⟩ to reference the current item in the list.
- ⟨list⟩ The comma-separated list.
- ⟨body⟩ The code to perform at each iteration.
Determines if the control sequence given by ⟨cs-name⟩
(without the leading backslash) is undefined (or \relax). § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cs-name⟩ The control sequence name.
- ⟨true-part⟩ The code to perform if the given
control sequence is undefined (or identical to
\relax). - ⟨false-part⟩ The code to perform if the given control sequence is defined.
Defines the control sequence given by ⟨cs-name⟩ (without the leading backslash). § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cs-name⟩ The control sequence name.
- ⟨arg-syntax⟩ The argument syntax (as for
commands like
\def). - ⟨definition⟩ The definition.
Uses the control sequence given by ⟨cs-name⟩ (without the leading backslash). § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cs-name⟩ The control sequence name.
Just does the second argument and discards the first argument.
See also \@firstoftwo. § 11.1 ⁂Writing a Class File for a Form
Argument Summary:
- ⟨first⟩ The first argument (discarded).
- ⟨second⟩ The second argument.
Generates a “Too deeply nested” error. § 6.5.1.1 ⁂Delving Deeper
Open delimiter of an optional argument. (See Volume 1.) § 1. ⁎Introduction
Umlaut over ⟨c⟩. Example:
\"{o} produces ö. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨c⟩ The character that requires an umlaut over it.
Hash # symbol. § 2.2.1 ⁑Loading Data From a CSV File
Dollar $ symbol. § 2.2.1 ⁑Loading Data From a CSV File
Percent % symbol. § 2.2.1 ⁑Loading Data From a CSV File
Ampersand & symbol. § 2.2.1 ⁑Loading Data From a CSV File
Acute accent over ⟨c⟩. Example:
\'{o} produces ó. § 5.1 ⁎The currvita Package
Argument Summary:
- ⟨c⟩ The character that requires an acute accent over it.
Thin space. § 4.3 ⁂Building Your Own Invoice using longtable and datatool
Starts an unnumbered single-line of displayed maths. § 9.3 ⁑The probsoln Package
Starts a new row in environments that have a concept of rows rather than paragraphs (such as the tabular-style environments). This may have a starred version and/or an optional argument. § 4.1 ⁑Writing an Invoice Using the isodoc Class
Ends an unnumbered single-line of displayed maths. § 9.3 ⁑The probsoln Package
Underscore _ symbol. § 2.2.1 ⁑Loading Data From a CSV File
Left brace { character. In math mode may be used as a delimiter. § 2.2.1 ⁑Loading Data From a CSV File
Right brace { character. In math mode may be used as a delimiter. § 2.2.1 ⁑Loading Data From a CSV File
(Backslash followed by space character.) Horizontal spacing command. § 7.4 ⁂Parsing and Displaying Times
Closing delimiter of an optional argument. (See Volume 1.) § 1. ⁎Introduction
Displays its argument as a superscript. § 2.2.1 ⁑Loading Data From a CSV File
Argument Summary:
- ⟨maths⟩ The superscript.
Displays its argument as a subscript. § 2.2.1 ⁑Loading Data From a CSV File
Argument Summary:
- ⟨maths⟩ The subscript.
Open quote ‘ symbol. § 4.3 ⁂Building Your Own Invoice using longtable and datatool
Open double quote “ symbol. § 2.7.2 ⁂Iterating Over a Comma-Separated List
Marks the beginning of a group. (See Volume 1.) § 1. ⁎Introduction
Non-short-circuit logical or. § 1.2 ⁑Arara
Logical or. § 1.2 ⁑Arara
Marks the end of a group. (See Volume 1.) § 1. ⁎Introduction
Unbreakable space. (See Volume 1.) § 2.2.1 ⁑Loading Data From a CSV File
For use within the pressrelease environment,
this environment contains information about the company. § 6.2 ⁎Press Releases
Generates a table containing the account information needed to pay the invoice. § 4.1 ⁑Writing an Invoice Using the isodoc Class
Indicates that the given text has been added. § 13.1 ⁑Change Markup
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨text⟩ The new text.
Adds a plot to the current image. § 12.5 ⁑Plots
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨plot specs⟩ The plot specifications.
Enable the point-totalling commands. § 9.1 ⁑The exam Class
Specifies the sender's address. § 3.1 ⁎Writing a Letter Using the letter Class
Argument Summary:
- ⟨text⟩ The sender's address.
Specifies the sender's address. § 3.3 ⁑Writing a Letter Using the newlfm Class
Argument Summary:
- ⟨address⟩ The sender's address.
Specifies the recipient's address. § 3.3 ⁑Writing a Letter Using the newlfm Class
Argument Summary:
- ⟨address⟩ The recipient's address
Indicates picture code to place on the page given by ⟨page-number⟩.
The starred version refers to the sheet number instead. § 10.3 ⁑The leaflet Class
Argument Summary:
- ⟨page-number⟩ The page or sheet number.
- ⟨picture-code⟩ The picture code.
\addtolength{⟨register⟩}{⟨dimension⟩}
Adds ⟨dimension⟩ to the value of the given length register. § 6.5.1.1 ⁂Delving Deeper
Argument Summary:
- ⟨register⟩ The name of the length register (for
example
\parindent). - ⟨dimension⟩ The dimension to add to the length.
\advance⟨register⟩ by ⟨value⟩
Increments the value stored in ⟨register⟩ by ⟨value⟩. The by keyword may be omitted. § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨register⟩ The TeX register whose value needs incrementing.
- ⟨value⟩ The increment.
Displays counter value as an upper case letter. (A, B, C, …, Z) § 6.5.1 ⁑Hierarchical Paragraph Numbering
Argument Summary:
- ⟨counter⟩ The name of the counter.
Displays counter value as a lower case letter. (a, b, c, …, z) § 6.5.1 ⁑Hierarchical Paragraph Numbering
Argument Summary:
- ⟨counter⟩ The name of the counter.
Used to separate authors in \author § 8. ⁎Presentations (The beamer Class)
Appends the given text to the contents of a dynamic frame. § 10.5 ⁂The flowfram Package and the flowframtk Application
Argument Summary:
- ⟨id⟩ The frame's index for the unstarred version or the label for the starred version.
- ⟨text⟩ The text to be appended to the frame's contents.
Appends ⟨code⟩ to the definition of the control sequence
⟨cs⟩. Use \gappto for a global assignment. § 2.1.2 ⁂Hook Management
Argument Summary:
- ⟨cs⟩ The control sequence to modify
- ⟨code⟩ The code to append
Displays counter value as an Arabic number. (1, 2, 3, …) § 6.5.1 ⁑Hierarchical Paragraph Numbering
Argument Summary:
- ⟨counter⟩ The name of the counter.
A list like environment to format an argument. § 6.3.2 ⁑The minutes Package
Specifies code that should be performed at the beginning
of the document environment. This command
has a cumulative effect. § 7.3 ⁂Displaying a Date
Argument Summary:
- ⟨code⟩ Code to perform at the beginning of the document.
Specifies the document author (or authors). This command doesn't
display any text so may be used in the preamble, but if it's not
in the preamble it must be placed before \maketitle. Some
classes, such as beamer, provide an optional argument for
this command. § 2.3 ⁑Security
Argument Summary:
- ⟨name⟩ The name (or names) of the document author (or authors).
Create a plot with normal Cartesian axes. § 12.5 ⁑Plots
Argument Summary:
- ⟨options⟩ A key=value list of options.
Sets the background options. § 6.4.2.1 ⁎The background Package
Argument Summary:
- ⟨options⟩ A key=value list of options.
A TeX primitive that stores the minimum space from the bottom of one line to the bottom of the next line in a paragraph. This is recalculated whenever the font changes. § 3.6 ⁑Envelopes
For use within the bchart environment, this draws a bar
with the given value. § 12.3.1 ⁑The bchart Package
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨value⟩ The bar's value.
The font declaration used for the bar chart labels. § 12.3.1 ⁑The bchart Package
Creates a bar chart. § 12.3.1 ⁑The bchart Package
Argument Summary:
- ⟨options⟩ A key=value list of options.
For use within the bchart environment, this inserts
a “free” label at the current position within the chart. § 12.3.1 ⁑The bchart Package
Argument Summary:
- ⟨text⟩ The label text.
For use within the bchart environment, this inserts
a gap of the given length. § 12.3.1 ⁑The bchart Package
Argument Summary:
- ⟨length⟩ The size of the gap
For use within the bchart environment, this sets the
x-axis label. § 12.3.1 ⁑The bchart Package
Argument Summary:
- ⟨text⟩ The label text.
Starts an environment. (Must have a matching \end.
See Volume 1.)
§ 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨env-name⟩ The name of the environment. (No backslash.)
- ⟨env-option⟩ An optional argument that may be passed to the environment. Not all environments have optional arguments.
- ⟨env-arg-1⟩…⟨env-arg-n⟩ Any mandatory arguments required by the environment. Not all environments require arguments.
Switches to the bold weight in the current font family. See Volume 1. § 10.3 ⁑The leaflet Class
Indicates the background should be displayed on the current page. (For use with the some pages option.) § 6.4.2.1 ⁎The background Package
Prints the bibliographic entry for citation ⟨key⟩. § 5.2.2 ⁑Sections and Publication Lists
Argument Summary:
- ⟨key⟩ The key identifying the required citation.
Indicates the start of a new reference in the bibliography. May
only be used inside the contents of thebibliography environment § 5.2.2 ⁑Sections and Publication Lists
Argument Summary:
- ⟨tag⟩ If present, overrides the marker at the start of the reference.
- ⟨key⟩ A unique key that identifies this reference so
it can be cited elsewhere in the document using
\cite.
\bibliography{⟨bib-list⟩}
Inputs the .bbl file (if it exists) and identifies the name(s) of the bibliography database files where the citations are defined. § 1.2 ⁑Arara
Argument Summary:
- ⟨bib-list⟩ A comma-separated list of database names (without the .bib extension).
Specifies the bibliography style to be used by bibtex. § 1.2 ⁑Arara
Argument Summary:
- ⟨style-name⟩ the name of the bibliography style (corresponds to a file called ⟨style-name⟩.bst).
geometry option.Produces a large open circle. § 11.1 ⁂Writing a Class File for a Form
Inserts a large vertical space. The size is given by
the length \bigskipamount. § 10.3 ⁑The leaflet Class
Redacts ⟨text⟩, which can consist of one or more paragraphs. § 6.4.1 ⁎Redaction: The censor Package
Argument Summary:
- ⟨text⟩ The text to be redacted.
Puts its contents in a titled block. § 8. ⁎Presentations (The beamer Class)
Argument Summary:
- ⟨title⟩ The title of the block.
Like \part but indicates the points are bonus marks. § 9.1 ⁑The exam Class
Argument Summary:
- ⟨points⟩ The number of bonus points.
Like \question but indicates the points are bonus marks. § 9.1 ⁑The exam Class
Argument Summary:
- ⟨points⟩ The number of bonus points.
Like \subpart but indicates the points are bonus marks. § 9.1 ⁑The exam Class
Argument Summary:
- ⟨points⟩ The number of bonus points.
Like \subsubpart but indicates the points are bonus marks. § 9.1 ⁑The exam Class
Argument Summary:
- ⟨points⟩ The number of bonus points.
Displays the total number of bonus points. (Requires two LaTeX runs to ensure it's up to date.) The starred version omits the unit. § 9.2 ⁑The exsheets Package
Like \titledquestion but indicates the points are bonus marks. § 9.1 ⁑The exam Class
Argument Summary:
- ⟨title⟩ The question title.
- ⟨points⟩ The number of bonus points.
May be used in the first argument of \ifthenelse to
test the state of the named boolean variable. § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨name⟩ The name of the boolean variable.
Sets the given boolean variable's state to false. § 9.4 ⁂Using the datatool Package for Exams or Assignment Sheets
Argument Summary:
- ⟨name⟩ The name of the boolean variable.
Sets the given boolean variable's state to true. § 9.4 ⁂Using the datatool Package for Exams or Assignment Sheets
Argument Summary:
- ⟨name⟩ The name of the boolean variable.
\bottomrule[⟨wd⟩]
Horizontal rule for the bottom of a tabular environment. § 2.6 ⁑Displaying Tabulated Data
Argument Summary:
- ⟨wd⟩ Thickness of the rule (dimension).
Changes the points format to use square brackets instead of the default parentheses. § 9.1 ⁑The exam Class
Inserts the caption for a float such as a figure or table. § 2.6 ⁑Displaying Tabulated Data
Argument Summary:
- ⟨short-caption⟩ If provided, an abbreviated caption to go in the list of figures/tables etc.
- ⟨caption-text⟩ The caption contents.
letter environment.Used to indicate the additional recipients of the letter. § 3.1 ⁎Writing a Letter Using the letter Class
Argument Summary:
- ⟨cc info⟩ The list of additional recipients.
Specifies the distribution list. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨names⟩ The list of names of people who should receive a copy of the minutes.
Sets distribution list. § 3.3 ⁑Writing a Letter Using the newlfm Class
Argument Summary:
- ⟨text⟩ The CC list
Redacts ⟨text⟩ by replacing the text with a filled black rectangle of the same size. § 6.4.1 ⁎Redaction: The censor Package
Argument Summary:
- ⟨text⟩ The text to be redacted.
Alternative to \censor when the sensitive text
should be omitted from the document source. § 6.4.1 ⁎Redaction: The censor Package
Argument Summary:
- ⟨size⟩ The width (in ex) of the omitted text.
Redacts ⟨contents⟩ (a box, such as a tabular
environment) by replacing the contents with a filled black
rectangle of the same size. § 6.4.1 ⁎Redaction: The censor Package
Argument Summary:
- ⟨declarations⟩ Any declarations to be made at
the start of the
box that affect the size of an ex or the value of
\baselineskip. - ⟨contents⟩ The contents to be redacted.
Alternative to \censorbox when the sensitive text
should be omitted from the document source. § 6.4.1 ⁎Redaction: The censor Package
Argument Summary:
- ⟨declarations⟩ Any declarations made within the
box that affect the size of an ex or the value of
\baselineskip. - ⟨width⟩ The width (in ex) of the omitted box.
- ⟨height⟩ The height (in multiples of
\baselineskip) of the omitted box. - ⟨depth⟩ The depth (in multiples of
\baselineskip) of the omitted box.
Centres its contents and places a small vertical gap above and
below the environment. This gap can interfere with the
vertical spacing in figure or table
environments, so the use of center within a float is
considered inappropriate. It can, however, be used outside a float
where the gap may be useful to separate its contents from the
previous and following paragraphs. § 3. ⁎Correspondence
Switches the paragraph alignment to centred. (See Volume 1.) § 2.6 ⁑Displaying Tabulated Data
Sets the name of the chair (for use within \setmembers and
\setpresent). § 6.3.1 ⁑The meetingmins Class
Argument Summary:
- ⟨name⟩ The chair's name.
Evaluates to true if the given file has changed. The argument ⟨ref⟩ may either be
a string "⟨extension⟩" which indicates the file extension
or a file reference toFile("filename"). § 1.2 ⁑Arara
Argument Summary:
- ⟨ref⟩ The file extension or a file reference.
Inserts a chapter heading. § 6.5.2 ⁂Non-Hierarchical Paragraph Numbering
Argument Summary:
- ⟨short-title⟩ An abbreviated form of the title to go in the table of contents or the page header.
- ⟨title⟩ The title.
A check box (for use within the Form environment.) § 11.2 ⁑Electronic PDF Forms
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨label⟩ A textual label.
A list environment with checkbox choices as the items in the list. Items are specified via
\choice. § 9.1 ⁑The exam Class
Produces a square with a tick in it ☑. § 11.1 ⁂Writing a Class File for a Form
For use in one of the choices or checkboxes environments,
this commands starts a new choice. Use \CorrectChoice
instead of \choice to indicate the correct choice. § 9.1 ⁑The exam Class
A list menu, popup menu, combo menu or set of radio buttons (for use within the Form environment.) § 11.2 ⁑Electronic PDF Forms
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨label⟩ A textual label.
- ⟨choices⟩ A list of choices.
A list environment with labelled choices as the items in the list. Items are specified via
\choice. § 9.1 ⁑The exam Class
For use in the argument of \put, this command
draws a circle with the given diameter (specified in terms
of \unitlength. The starred version fills the circle. § 10.1 ⁑The picture Environment
Argument Summary:
- ⟨diameter⟩ The diameter of the circle.
Inserts the citation markers of each reference identified in the
key list. A second run is required to ensure the reference is
correct. Some packages redefine \cite to have two
optional arguments. (See Volume 2.) § 1.2 ⁑Arara
Argument Summary:
- ⟨text⟩ Additional text to insert into the citation (such as the chapter number, or a particular page or page range within the citation).
- ⟨key list⟩ A comma-separated list of keys identifying the citations.
Displays an error message for the given class. § 11.1 ⁂Writing a Class File for a Form
Argument Summary:
- ⟨class-name⟩ The class name.
- ⟨error-message⟩ The error message.
- ⟨help-message⟩ The message to show if the user types “h” in interactive mode.
The closing text. § 3.3 ⁑Writing a Letter Using the newlfm Class
Argument Summary:
- ⟨text⟩ The closing text, such as “Yours sincerely”.
letter environment.Typesets the signing off text at the end of the letter. § 3.1 ⁎Writing a Letter Using the letter Class
Argument Summary:
- ⟨sign-off text⟩ The signing off text at the end of the letter, such as “Yours sincerely”.
\Collect@Body⟨cs⟩
As amsmath's \collect@body but allows paragraph
breaks within the environment. § 11.1 ⁂Writing a Class File for a Form
Argument Summary:
- ⟨cs⟩ A long command that takes the environment contents as its argument.
\collect@body⟨cs⟩
Collects the contents of the current environment and passes it to the command ⟨cs⟩ which should take an argument. The environment contents may not contain any paragraph breaks. § 11.1 ⁂Writing a Class File for a Form
Argument Summary:
- ⟨cs⟩ A command that takes the environment contents as its argument.
Collects the body of the environment and stores ⟨before⟩⟨body⟩⟨after⟩ in the given macro. § 11.1 ⁂Writing a Class File for a Form
Argument Summary:
- ⟨macro⟩ The macro in which to store the information.
- ⟨before⟩ Code to insert at the start of the macro.
- ⟨after⟩ Code to insert at the end of the macro.
A declaration that switches the current foreground colour to the given specification. § 12.2.1 ⁑The datapie Package
Argument Summary:
- ⟨model⟩ The colour model, for example rgb or named.
- ⟨specs⟩ The colour specification for the given model. For example, if the rgb model is chosen, ⟨specs⟩ must be a comma-separated list of three numbers each between 0 and 1.
Produces a box containing ⟨text⟩ with the background given by ⟨specs⟩ for the given colour model. § 10.5 ⁂The flowfram Package and the flowframtk Application
Argument Summary:
- ⟨model⟩ The colour model.
- ⟨specs⟩ The colour specification for the given model or the colour name if no model is given.
- ⟨text⟩ The contents of the box.
Gets the co-ordinate of the left edge of the even numbered pages relative to the typeblock and stores it in the supplied control sequence. § 11. ⁑Forms
Argument Summary:
- ⟨cs⟩ A control sequence in which to store the result.
Gets the co-ordinate of the left edge of the odd numbered pages relative to the typeblock and stores it in the supplied control sequence. § 11. ⁑Forms
Argument Summary:
- ⟨cs⟩ A control sequence in which to store the result.
For use within the Argumentation environment,
this indicates the start of an important item against the argument. § 6.3.2 ⁑The minutes Package
For use within the Argumentation environment,
this indicates the start of an item against the argument. § 6.3.2 ⁑The minutes Package
Used instead of \choice to indicate the correct choice. § 9.1 ⁑The exam Class
For use within the textenum, this command may be used
in place of \item to indicate a correct choice. If the
solutions aren't displayed this command behaves the same as
\item. § 9.3 ⁑The probsoln Package
The format used by \correctitem. § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨marker⟩ The item marker.
Typesets cos function name. § 9.1 ⁑The exam Class
Contains material to go before the start of the exam. § 9.1 ⁑The exam Class
As \appto but requires the name (without the leading
backslash) of the control sequence. Use \csgappto for a global assignment. § 2.1.2 ⁂Hook Management
Argument Summary:
- ⟨cs-name⟩ The name of the control sequence to modify
- ⟨code⟩ The code to append
This is analogous to \def except that the name of the
control sequence (without the initial backslash) is supplied. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cs-name⟩ The name of the new command being defined.
- ⟨arg-syntax⟩ The command syntax where each parameter is referenced using #⟨n⟩ in order
- ⟨definition⟩ The command definition.
As \eappto but requires the name (without the leading
backslash) of the control sequence. Use \csxappto for a global assignment. § 2.1.2 ⁂Hook Management
Argument Summary:
- ⟨cs-name⟩ The name of the control sequence to modify
- ⟨code⟩ The code to append
This is analogous to \edef except that the name of the
control sequence (without the initial backslash) is supplied. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cs-name⟩ The name of the new command being defined.
- ⟨arg-syntax⟩ The command syntax where each parameter is referenced using #⟨n⟩ in order
- ⟨definition⟩ The command definition.
As \epreto but requires the name (without the leading
backslash) of the control sequence. Use \csxpreto
for a global assignment. § 2.1.2 ⁂Hook Management
Argument Summary:
- ⟨cs-name⟩ The name of the control sequence to modify
- ⟨code⟩ The code to prepend
As \gappto but requires the name (without the leading
backslash) of the control sequence. § 2.1.2 ⁂Hook Management
Argument Summary:
- ⟨cs-name⟩ The name of the control sequence to modify
- ⟨code⟩ The code to append
This is analogous to \gdef except that the name of the
control sequence (without the initial backslash) is supplied. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cs-name⟩ The name of the new command being defined.
- ⟨arg-syntax⟩ The command syntax where each parameter is referenced using #⟨n⟩ in order
- ⟨definition⟩ The command definition.
Global version of \cspreto. § 2.1.2 ⁂Hook Management
Argument Summary:
- ⟨cs-name⟩ The name of the control sequence to modify
- ⟨code⟩ The code to prepend
Analogous to \let except that the name of the
control sequence (without the initial backslash) is supplied
for the first argument. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cs⟩ The name of the new control sequence.
- ⟨cs-name⟩ The original control sequence.
Analogous to \let except that the names of the
control sequences (without the initial backslash) are supplied. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨new cs-name⟩ The name of the new control sequence.
- ⟨org cs-name⟩ The name of the original control sequence.
\csname ⟨cs-name⟩\endcsname
Expands to the control sequence whose name (without the leading
backslash) is given by ⟨cs-name⟩. If the control sequence isn't
already defined, TeX will first define it to \relax before
using it. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cs-name⟩ The control sequence name.
As \preto but requires the name (without the leading
backslash) of the control sequence. Use \csgpreto
for a global assignment. § 2.1.2 ⁂Hook Management
Argument Summary:
- ⟨cs-name⟩ The name of the control sequence to modify
- ⟨code⟩ The code to prepend
Executes the control sequence whose name (without the leading backslash) is given by ⟨cs-name⟩. If the command doesn't exist, this expands to an empty string. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cs-name⟩ The control sequence name.
Iterates through the comma-separated list using a handler macro provided in the
optional argument. If none is provided, the command \do is
used. The list may explicitly be a comma-separated list or it may be
a macro that expands to a list, unless the starred form is used.
There are other variants to this command not described here. See the
etextools documentation for further details. § 2.7.2 ⁂Iterating Over a Comma-Separated List
Argument Summary:
- ⟨auxiliary commands⟩ Indicates what should be
done at each iteration. If omitted
\dois assumed. - ⟨list⟩ The comma-separated list to iterate over.
As \xappto but requires the name (without the leading
backslash) of the control sequence. § 2.1.2 ⁂Hook Management
Argument Summary:
- ⟨cs-name⟩ The name of the control sequence to modify
- ⟨code⟩ The code to append
This is analogous to \xdef except that the name of the
control sequence (without the initial backslash) is supplied. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cs-name⟩ The name of the new command being defined.
- ⟨arg-syntax⟩ The command syntax where each parameter is referenced using #⟨n⟩ in order
- ⟨definition⟩ The command definition.
Global version of \csepreto. § 2.1.2 ⁂Hook Management
Argument Summary:
- ⟨cs-name⟩ The name of the control sequence to modify
- ⟨code⟩ The code to prepend
Refers to the current option when used in the argument of
\DeclareOption* § 11.1 ⁂Writing a Class File for a Form
Indicates that a cut line should be drawn to the left of the given page number. The starred version only draws a dotted line. The unstarred version draws a dotted line and a pair of scissors. § 10.3 ⁑The leaflet Class
Argument Summary:
- ⟨page-number⟩ The page number.
The body of the CV. § 5.1 ⁎The currvita Package
Argument Summary:
- ⟨heading⟩ The heading text.
A headed list-like structure for use within the cv
environment. § 5.1 ⁎The currvita Package
Argument Summary:
- ⟨heading⟩ The heading text.
Specifies the location where the CV was written. § 5.1 ⁎The currvita Package
Argument Summary:
- ⟨location⟩ The location.
picture environment.
Similar to \framebox but produces a dashed frame. § 10.1 ⁑The picture Environment
Argument Summary:
- ⟨dash length⟩ The length of the dashes.
- ⟨w⟩ The width of the box.
- ⟨h⟩ The height of the box.
- ⟨align⟩ The alignment of the text. This may be one or two letters that specify the alignment. The letters may be one of: l (left), r (right), t (top) or b (bottom). If omitted, the default centres the text horizontally and vertically.
Specifies the document date. This command doesn't
display any text so may be used in the preamble, but if it's not
in the preamble it must be placed before \maketitle. If omitted, most
classes assume the current date. Some
classes, such as beamer, provide an optional argument for
this command. § 5.1 ⁎The currvita Package
Argument Summary:
- ⟨text⟩ The document date.
Sets the date. § 3.3 ⁑Writing a Letter Using the newlfm Class
Argument Summary:
- ⟨date⟩ The date.
The current day of the month. § 7.2 ⁂The pgfcalendar Package Utility Commands
For use with \DTLforeachbibentry or \gDTLforeachbibentry, this expands to the name
of the current cite key. § 5.2.2 ⁑Sections and Publication Lists
For use with \DTLforeachbibentry or \gDTLforeachbibentry, this expands to the name
of the current entry type (for example, book). § 5.2.2 ⁑Sections and Publication Lists
Specifies a decision, which is added to the list of decisions. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨theme⟩ The decision theme.
- ⟨short-description⟩ A short description about the decision.
- ⟨long-description⟩ An optional longer description about the decision.
Specifies a decision, which isn't added to the list of decisions. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨theme⟩ The decision theme.
- ⟨short-description⟩ A short description about the decision.
- ⟨long-description⟩ An optional longer description about the decision.
Defines a decision theme which will be added to the list of decisions. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨theme⟩ The decision theme
- ⟨title⟩ The decision title
Declares an option for a class or package. § 11.1 ⁂Writing a Class File for a Form
Argument Summary:
- ⟨option⟩ The option name.
- ⟨code⟩ The code to perform if the given option is requested.
Declares the code for an unknown option. You can refer to the
option within ⟨code⟩ using \CurrentOption. § 11.1 ⁂Writing a Class File for a Form
Argument Summary:
- ⟨code⟩ The code to perform for any unknown options.
This locally defines the command ⟨cs⟩ that has the given
syntax. Use \gdef for global definitions. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cs⟩ The new command being defined.
- ⟨arg-syntax⟩ The command syntax where each parameter is referenced using #⟨n⟩ in order
- ⟨definition⟩ The command definition.
The default height of check boxes. § 11.2 ⁑Electronic PDF Forms
The default height of choice boxes. § 11.2 ⁑Electronic PDF Forms
The default height of the reset button. § 11.2 ⁑Electronic PDF Forms
The default height of the submit button. § 11.2 ⁑Electronic PDF Forms
The default height of single-lined text fields. § 11.2 ⁑Electronic PDF Forms
The default height of multi-lined text fields. § 11.2 ⁑Electronic PDF Forms
The default width of check boxes. § 11.2 ⁑Electronic PDF Forms
The default width of choice boxes. § 11.2 ⁑Electronic PDF Forms
The default width of the reset button. § 11.2 ⁑Electronic PDF Forms
The default width of the submit button. § 11.2 ⁑Electronic PDF Forms
The default width of text fields. § 11.2 ⁑Electronic PDF Forms
Defines a tracked author. § 13.1 ⁑Change Markup
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨id⟩ A label identifying the author.
Defines a new problem. (The contents may include the
onlysolution environment for the solution.) § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨n⟩ The number of arguments (default: 0).
- ⟨default-args⟩ The default arguments.
- ⟨label⟩ The label uniquely identifying this problem.
- ⟨option⟩ May be used to set the
fragileboolean key.
Indicates that the given text has been deleted. § 13.1 ⁑Change Markup
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨text⟩ The deleted text.
Greek upper case delta 𝛥. § 9.3 ⁑The probsoln Package
The font declaration used by the item labels in the
description environment. § 10.3 ⁑The leaflet Class
Labelled list. § 10.3 ⁑The leaflet Class
\dimexpr⟨dimension expression⟩
Expands to the value given by the dimension expression. § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨dimension expression⟩ A dimension expression involving + (addition) - (subtraction) * (multiplication) and / (division). Parentheses may also be used.
Inserts PostScript ZapfDingbats character with code ⟨n⟩, which must be an integer. § 2.9 ⁑Null and Boolean Values
Argument Summary:
- ⟨n⟩ The decimal code of the required character.
A list where the item marker is given by character ⟨number⟩ in the Zapf Dingbats font. § 10.5 ⁂The flowfram Package and the flowframtk Application
Argument Summary:
- ⟨number⟩ The character code for the item marker.
For use within the invoice environment, this command
is used to specify a discount. § 4.2 ⁑Writing an Invoice Using the invoice Package
Argument Summary:
- ⟨description⟩ A description of the discount.
- ⟨amount⟩ The amount of the discount in terms of the base currency unit.
\divide⟨register⟩ by ⟨value⟩
Divides the value stored in ⟨register⟩ by ⟨value⟩. The by keyword may be omitted. § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨register⟩ The TeX register whose value needs incrementing.
- ⟨value⟩ The divisor.
Handler macro used by commands like \docsvlist and
\csvloop. The argument is the item
in the current iteration of the list. § 2.7.2 ⁂Iterating Over a Comma-Separated List
Argument Summary:
- ⟨item⟩ The item from the current iteration.
Loops over the given comma-separated list and executes the command
\do for every item in the list, using the item as the
argument of \do. It's up to the user to define
\do as appropriate. § 2.7.2 ⁂Iterating Over a Comma-Separated List
Argument Summary:
- ⟨item1,item2,…⟩ Comma-separated list of items to iterate over.
The body of the document. § 7.3 ⁂Displaying a Date
Loads the document class file, which sets up the type of document you wish to write. (See Volume 1.) § 1. ⁎Introduction
Argument Summary:
- ⟨option-list⟩ A comma-separated list of options to pass to the class file or any packages that will later be loaded.
- ⟨class-name⟩ The name of the document class. This corresponds to a file called ⟨class-name⟩.cls, which must be installed.
Iterates over a randomly selected ⟨n⟩ items in a comma-separated list. At each iteration, ⟨cs⟩ is defined to be the currently selected item and ⟨body⟩ is performed. § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨n⟩ The number of items to randomly select.
- ⟨cs⟩ A control sequence used to store the currently selected item.
- ⟨list⟩ The comma-separated list of items.
- ⟨body⟩ The code to perform at each iteration.
Similar to \dolistloop except the name (without the preceding
backslash) of the list control sequence is used. § 2.7.3 ⁑Iteration With etoolbox's Internal Lists
Argument Summary:
- ⟨list-csname⟩ The name of the control sequence used to store the list.
Iterates over all items in the list macro ⟨list-cs⟩ and
performs \do{⟨item⟩} for each item. § 2.7.3 ⁑Iteration With etoolbox's Internal Lists
Argument Summary:
- ⟨list-cs⟩ The control sequence used to store the list.
Fills the remaining space with a dotted line. § 10.3 ⁑The leaflet Class
\draw ⟨specification⟩;
For use within the tikzpicture environment.
Draws the path with the given specification using the
current path stroking operations. § 12.1 ⁑Flow Charts
Argument Summary:
- ⟨specification⟩ A stream of path operations indicating how the path should be built.
Prints the question points. This command should only occur at the
end of a paragraph or between paragraphs. (Used with
\pointsdroppedatright.) § 9.1 ⁑The exam Class
Computes the absolute value of ⟨number⟩ and
stores the result in ⟨cs⟩, which must be a control sequence.
The number should be formatted according to the current locale (set
via \DTLsetnumberchars) and may optionally be prefixed with a
known currency identifier. See the datatool documentation for
further details. § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨cs⟩ Control sequence in which to store the result.
- ⟨number⟩ The original number.
Computes the absolute value of ⟨number⟩ and stores the result in ⟨cs⟩, which must be a control sequence. The number must be a plain decimal number (a full stop as a decimal point, no number grouping and no currency prefix). § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨cs⟩ Control sequence in which to store the result.
- ⟨number⟩ The original number.
Adds ⟨number1⟩ to ⟨number2⟩ and
stores the result in ⟨cs⟩, which must be a control sequence.
The number should be formatted according to the current locale (set
via \DTLsetnumberchars) and may optionally be prefixed with a
known currency identifier. See the datatool documentation for
further details. § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨cs⟩ Control sequence in which to store the result.
- ⟨number1⟩ The first number.
- ⟨number2⟩ The second number.
Adds ⟨number1⟩ to ⟨number2⟩ and stores the result in ⟨cs⟩, which must be a control sequence. The number must be a plain decimal number (a full stop as a decimal point, no number grouping and no currency prefix). § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨cs⟩ Control sequence in which to store the result.
- ⟨number1⟩ First number.
- ⟨number2⟩ Second number.
Applies the assignment list, which has the same format as for
\DTLforeach and \DTLforeach*, to the given row.
Row indexes start from 1. § 2.8 ⁑Fetching Data From a Given Row
Argument Summary:
- ⟨db-name⟩ The label identifying the data.
- ⟨row-idx⟩ The row index.
- ⟨assign-list⟩ The assignment list in the form ⟨cs⟩=⟨col-label⟩.
Finds the first row in the database ⟨db-name⟩ where entry in the column
identified by the label ⟨col-label⟩ matches ⟨value⟩
and applies the assignment list, which has the same format as for
\DTLforeach and \DTLforeach*. Note that no expansion
is performed on ⟨value⟩. See also \xDTLassignfirstmatch. § 2.8 ⁑Fetching Data From a Given Row
Argument Summary:
- ⟨db-name⟩ The label identifying the data.
- ⟨col-label⟩ The label identifying the column.
- ⟨value⟩ The value to be matched.
- ⟨assign-list⟩ The assignment list in the form ⟨cs⟩=⟨another column label⟩.
Hook used by \DTLbarchart or \DTLmultibarchart at
the start of the tikzpicture environment. § 12.3.2 ⁑The databar Package
Hook used by \DTLbarchart or \DTLmultibarchart at
the start of the tikzpicture environment. § 12.3.2 ⁑The databar Package
Generates a bar chart from a column of the datatool database called ⟨db-name⟩. § 12.3.2 ⁑The databar Package
Argument Summary:
- ⟨condition⟩ Condition to apply to each row to determine if the row should be processed.
- ⟨settings⟩ A key=value list of settings.
- ⟨db-name⟩ The database name.
- ⟨assign-list⟩ A comma-separated list of ⟨cmd⟩=⟨col-label⟩ pairs that assigns a command ⟨cmd⟩ to the entry in the current row identified by the column label ⟨col-label⟩.
A length register storing the total length of the y-axis. § 12.3.2 ⁑The databar Package
A length register storing the offset between the x-axis and the lower bar label. § 12.3.2 ⁑The databar Package
A macro that expands to the colour used to draw the bar outlines. § 12.3.2 ⁑The databar Package
A length register that stores the width of the bar outline. A zero width indicates that the outline shouldn't be drawn. § 12.3.2 ⁑The databar Package
A length register storing the width of each bar. § 12.3.2 ⁑The databar Package
(For use within the final argument of \DTLforeachbibentry
or \gDTLforeachbibentry.)
This command displays the value of entry in the column whose label is given by
⟨field-name⟩. § 5.2.2 ⁑Sections and Publication Lists
Argument Summary:
- ⟨field-name⟩ The column label.
(For use within the final argument of \DTLforeachbibentry
or \gDTLforeachbibentry.)
This command assigns the value of entry in the column whose label is given by
⟨field-name⟩ to the control sequence ⟨cs⟩. § 5.2.2 ⁑Sections and Publication Lists
Argument Summary:
- ⟨cs⟩ The control sequence in which to store the value.
- ⟨field-name⟩ The column label.
When used in the body of commands like \DTLforeach,
this signifies that the loop should be terminated at the
end of the current iteration. § 2.7.1 ⁑Iterating Through a Database
A case-sensitive comparison handler for use with \dtlsort. § 2.4 ⁑Sorting Data
Argument Summary:
- ⟨register⟩ A count register in which to store the result of the comparison.
- ⟨text1⟩ The first string to be compared.
- ⟨text2⟩ The second string to be compared.
This command is analogous to
\bibitem[⟨label⟩]{⟨key⟩} except it uses
⟨marker code⟩ instead of \item[⟨label⟩]. § 5.2.2 ⁑Sections and Publication Lists
Argument Summary:
The prefix to use when generating a default column label. § 2.2.1 ⁑Loading Data From a CSV File
Hook after the header row in \DTLdisplaydb and
\DTLdisplaylongdb. § 2.6 ⁑Displaying Tabulated Data
Displays the database identified by ⟨db-name⟩ in a
tabular environment. § 2.2.1 ⁑Loading Data From a CSV File
Argument Summary:
- ⟨omit-list⟩ Comma-separated list of columns to omit, identified by their key.
- ⟨db-name⟩ The database label.
Hook used at the end of \DTLdisplaydb and
\DTLdisplaylongdb. § 2.6 ⁑Displaying Tabulated Data
Displays the database identified by ⟨db-name⟩ in a
longtable environment. § 2.6 ⁑Displaying Tabulated Data
Argument Summary:
- ⟨options⟩ A key=value list options.
- ⟨db-name⟩ The database label.
Hook used at the start of \DTLdisplaydb and
\DTLdisplaylongdb. § 2.6 ⁑Displaying Tabulated Data
Computes ⟨number1⟩ divided by ⟨number2⟩ and
stores the result in ⟨cs⟩, which must be a control sequence.
The number should be formatted according to the current locale (set
via \DTLsetnumberchars) and may optionally be prefixed with a
known currency identifier. See the datatool documentation for
further details. § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨cs⟩ Control sequence in which to store the result.
- ⟨number1⟩ The first number.
- ⟨number2⟩ The second number.
Computes ⟨number1⟩ divided by ⟨number2⟩ and stores the result in ⟨cs⟩, which must be a control sequence. The number must be a plain decimal number (a full stop as a decimal point, no number grouping and no currency prefix). § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨cs⟩ Control sequence in which to store the result.
- ⟨number1⟩ First number.
- ⟨number2⟩ Second number.
Sets the current text colour to the colour of the ⟨n⟩th bar. § 12.3.2 ⁑The databar Package
Argument Summary:
- ⟨n⟩ The bar index (starting from 1).
As \DTLdopiesegmentcolor but for the current segment. § 12.2.1 ⁑The datapie Package
Switches the current text colour to that of the ⟨n⟩th segment. § 12.2.1 ⁑The datapie Package
Argument Summary:
- ⟨n⟩ The segment index (starting from 1).
For use within the definition of \DTLeverybarhook, this
can be used to reference the end of the bar. § 12.3.2 ⁑The databar Package
Hook used by \DTLbarchart or \DTLmultibarchart at
each bar. § 12.3.2 ⁑The databar Package
Switches on the value expansion when using \DTLnewdbentry § 9.4 ⁂Using the datatool Package for Exams or Assignment
Sheets
Iterates through each row of the database identified by ⟨db-name⟩ and does ⟨body⟩ if ⟨condition⟩ is met for that row. § 2.7.1 ⁑Iterating Through a Database
Argument Summary:
- ⟨condition⟩ Condition to apply to each row to determine if the row should be processed.
- ⟨db-name⟩ The label identifying the database.
- ⟨assign-list⟩ A comma-separated list of ⟨cmd⟩=⟨col-label⟩ pairs that assigns a command ⟨cmd⟩ to the entry in the current row identified by the column label ⟨col-label⟩.
- ⟨body⟩ What should be done for each row where the condition is met. The commands defined in the assignment list may be used in ⟨body⟩ as placeholders.
A read-only version of \DTLforeach. If no modifications
need to be made to the database, this is the better version to use
as it's quicker. (How much quicker depends on the size of the
database.) § 2.7.1 ⁑Iterating Through a Database
Argument Summary:
- ⟨condition⟩ Condition to apply to each row to determine if the row should be processed.
- ⟨db-name⟩ The label identifying the database.
- ⟨assign-list⟩ A comma-separated list of ⟨cmd⟩=⟨col-label⟩ pairs that assigns a command ⟨cmd⟩ to the entry in the current row identified by the column label ⟨col-label⟩.
- ⟨body⟩ What should be done for each row where the condition is met. The commands defined in the assignment list may be used in ⟨body⟩ as placeholders.
Iterates through the database (loaded by \DTLloadbbl)
called ⟨db-name⟩, and performs ⟨body⟩ on each row where
⟨condition⟩ is met. The starred version is read-only. § 5.2.2 ⁑Sections and Publication Lists
Argument Summary:
- ⟨condition⟩ The condition to apply on each iteration.
- ⟨db-name⟩ The database name.
- ⟨body⟩ The code to perform on each iteration where the condition is met.
(For use within the final argument of \DTLforeachbibentry or \gDTLforeachbibentry.)
This command displays the current row according to the format for
its given entry type. § 5.2.2 ⁑Sections and Publication Lists
Similar to \DTLformatbibentry but can be used outside
\DTLforeachbibentry/\gDTLforeachbibentry
to format the referenced identified by
⟨key⟩ in the database ⟨db-name⟩. § 5.2.2 ⁑Sections and Publication Lists
Argument Summary:
- ⟨key⟩ The key identifying this citation.
Global version of \DTLabs § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨cs⟩ Control sequence in which to store the result.
- ⟨number⟩ The original number.
Global version of \DTLadd § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨cs⟩ Control sequence in which to store the result.
- ⟨number1⟩ The first number.
- ⟨number2⟩ The second number.
Global version of \DTLdiv § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨cs⟩ Control sequence in which to store the result.
- ⟨number1⟩ The first number.
- ⟨number2⟩ The second number.
Global version of \DTLmul § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨cs⟩ Control sequence in which to store the result.
- ⟨number1⟩ The first number.
- ⟨number2⟩ The second number.
Global version of \DTLneg § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨cs⟩ Control sequence in which to store the result.
- ⟨number⟩ The original number.
Global version of \DTLround § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨cs⟩ Control sequence in which to store the result.
- ⟨number⟩ Plain decimal number.
- ⟨num-digits⟩ Number of digits to round to.
Global version of \DTLsub § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨cs⟩ Control sequence in which to store the result.
- ⟨number1⟩ The first number.
- ⟨number2⟩ The second number.
A case-insensitive comparison handler for use with \dtlsort. § 2.4 ⁑Sorting Data
Argument Summary:
- ⟨register⟩ A count register in which to store the result of the comparison.
- ⟨text1⟩ The first string to be compared.
- ⟨text2⟩ The second string to be compared.
(For use within the final argument of \DTLforeachbibentry or \gDTLforeachbibentry.)
Does ⟨true-part⟩ if the entry in the column whose label is given by
⟨field-name⟩ is non-null. Otherwise does ⟨false-part⟩. § 5.2.2 ⁑Sections and Publication Lists
Argument Summary:
- ⟨field-name⟩ The column label.
- ⟨true-part⟩ The code to perform if the field exists.
- ⟨false-part⟩ The code to perform if the field doesn't exist.
Checks if the datatool internal database called ⟨db-name⟩ is empty. § 5.2.2 ⁑Sections and Publication Lists
Argument Summary:
- ⟨db-name⟩ The label uniquely identifying the database.
- ⟨true-part⟩ The code to perform if the database is empty.
- ⟨false-part⟩ The code to perform if the database isn't empty.
Provided for use in the ⟨body⟩ part of \DTLforeach
this does ⟨true⟩ if it's on the iteration is on the first row
otherwise it does ⟨false⟩. § 2.7.5 ⁂Iteration Tips and Tricks
Argument Summary:
- ⟨true⟩ Stuff to do on the first row.
- ⟨false⟩ Stuff to do on the other rows.
Checks if the given item is in the given comma-separated list. A one-level expansion is performed on ⟨list⟩ but not on ⟨item⟩. § 2.7.2 ⁂Iterating Over a Comma-Separated List
Argument Summary:
- ⟨item⟩ The item to look for.
- ⟨list⟩ The comma-separated list.
- ⟨true⟩ The code to perform if the item is found in the list.
- ⟨false⟩ The code to perform if the item isn't found in the list.
Provided for use in the ⟨body⟩ part of \DTLforeach
this does ⟨true⟩ if it's on the iteration is on the last row
otherwise it does ⟨false⟩. § 2.7.5 ⁂Iteration Tips and Tricks
Argument Summary:
- ⟨true⟩ Stuff to do on the last row.
- ⟨false⟩ Stuff to do on the other rows.
If the control sequence ⟨cs⟩ is null (as defined by datatool) this does ⟨true⟩ otherwise this does ⟨false⟩. § 2.9 ⁑Null and Boolean Values
Argument Summary:
- ⟨cs⟩ Control sequence being tested.
- ⟨true⟩ Stuff to do if ⟨cs⟩ is null.
- ⟨false⟩ Stuff to do if ⟨cs⟩ isn't null.
This is a combination of \DTLifnull and \ifdefempty.
If the control sequence ⟨cs⟩ is null (as defined by
datatool) or empty
this does ⟨true⟩ otherwise this does ⟨false⟩. § 2.9 ⁑Null and Boolean Values
Argument Summary:
- ⟨cs⟩ Control sequence being tested.
- ⟨true⟩ Stuff to do if ⟨cs⟩ is null or empty.
- ⟨false⟩ Stuff to do if ⟨cs⟩ isn't null and isn't empty.
Checks if ⟨number1⟩ equals ⟨number2⟩ and does ⟨true⟩ if true, otherwise does ⟨false⟩. The numbers may be integers or decimals § 9.4 ⁂Using the datatool Package for Exams or Assignment Sheets
Argument Summary:
- ⟨number1⟩ The first number.
- ⟨number2⟩ The second number.
- ⟨true⟩ The code to perform if ⟨number1⟩ is equal to ⟨number2⟩.
- ⟨false⟩ The code to perform if ⟨number1⟩ isn't equal to ⟨number2⟩.
When you load a .dbtex file, this command is set to the label associated with the data in that file. § 2.2.2 ⁑Loading Data From a .dbtex File
A letter-ordering comparison handler for use with \dtlsort. § 2.4 ⁑Sorting Data
Argument Summary:
- ⟨register⟩ A count register in which to store the result of the comparison.
- ⟨text1⟩ The first string to be compared.
- ⟨text2⟩ The second string to be compared.
Loads bibliography data from the .bbl file given by ⟨bbl⟩ and stores it in the datatool internal database called ⟨db-name⟩. This also sets the bibliography style to databib.bst and identifies the list of .bib files where the bibliography data is defined. § 5.2.2 ⁑Sections and Publication Lists
Argument Summary:
- ⟨bbl file⟩ The name of the .bbl file
(defaults to
\jobname.bbl). - ⟨db-name⟩ The name of the new datatool database.
- ⟨bib-list⟩ A comma-separated list of .bib files without the .bib extension.
Loads the data given in the CSV file ⟨filename⟩ and stores it in a datatool database called ⟨db-name⟩. § 2.2.1 ⁑Loading Data From a CSV File
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨db-name⟩ The name by which the database can be referenced in the document.
- ⟨filename⟩ The name of the CSV file.
Inputs the datatool (.dbtex) fileand assigns the database name to the command ⟨cs⟩ § 2.2.2 ⁑Loading Data From a .dbtex File
Argument Summary:
- ⟨cs⟩ Control sequence in which to store the data base name.
- ⟨filename⟩ The name of the .dbtex file.
As \DTLloaddb but maps nine of the ten special characters
to LaTeX commands that display the relevent symbol. § 2.2.1 ⁑Loading Data From a CSV File
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨db-name⟩ The name by which the database can be referenced in the document.
- ⟨filename⟩ The name of the CSV file.
Changes the category code of the tab separator to 10 (space). § 2.2.1 ⁑Loading Data From a CSV File
For use within the definition of \DTLeverybarhook, this
can be used to reference the mid point of the bar. § 12.3.2 ⁑The databar Package
Displays the month name for the month given by ⟨number⟩. § 5.2.2 ⁑Sections and Publication Lists
Argument Summary:
- ⟨number⟩ The month index (starting with 1 for January).
Computes ⟨number1⟩ multiplied by ⟨number2⟩ and
stores the result in ⟨cs⟩, which must be a control sequence.
The number should be formatted according to the current locale (set
via \DTLsetnumberchars) and may optionally be prefixed with a
known currency identifier. See the datatool documentation for
further details. § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨cs⟩ Control sequence in which to store the result.
- ⟨number1⟩ The first number.
- ⟨number2⟩ The second number.
Computes ⟨number1⟩ multiplied by ⟨number2⟩ and stores the result in ⟨cs⟩, which must be a control sequence. The number must be a plain decimal number (a full stop as a decimal point, no number grouping and no currency prefix). § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨cs⟩ Control sequence in which to store the result.
- ⟨number1⟩ First number.
- ⟨number2⟩ Second number.
Generates a bar chart with grouped data from columns of the datatool database called ⟨db-name⟩. § 12.3.2 ⁑The databar Package
Argument Summary:
- ⟨condition⟩ Condition to apply to each row to determine if the row should be processed.
- ⟨settings⟩ A key=value list of settings.
- ⟨db-name⟩ The database name.
- ⟨assign-list⟩ A comma-separated list of ⟨cmd⟩=⟨col-label⟩ pairs that assigns a command ⟨cmd⟩ to the entry in the current row identified by the column label ⟨col-label⟩.
Negates ⟨number⟩ and
stores the result in ⟨cs⟩, which must be a control sequence.
The number should be formatted according to the current locale (set
via \DTLsetnumberchars) and may optionally be prefixed with a
known currency identifier. See the datatool documentation for
further details. § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨cs⟩ Control sequence in which to store the result.
- ⟨number⟩ The original number.
Negates ⟨number⟩ and stores the result in ⟨cs⟩, which must be a control sequence. The number must be a plain decimal number (a full stop as a decimal point, no number grouping and no currency prefix). § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨cs⟩ Control sequence in which to store the result.
- ⟨number⟩ The original number.
Creates a new database called ⟨db-name⟩. § 9.4 ⁂Using the datatool Package for Exams or Assignment Sheets
Argument Summary:
- ⟨db-name⟩ The name by which the database can be referenced in the document.
Adds an entry to the current row of the named database. § 9.4 ⁂Using the datatool Package for Exams or Assignment Sheets
Argument Summary:
- ⟨db-name⟩ The database name.
- ⟨col-label⟩ The column label.
- ⟨value⟩ The new value.
Adds a new row to the database. This new row becomes the current row when adding new entries. § 9.4 ⁂Using the datatool Package for Exams or Assignment Sheets
Argument Summary:
- ⟨db-name⟩ The database name.
Counts the number of non-empty items in the given comma-separated list and stores the result in ⟨cs⟩. A one-level expansion is performed on ⟨list⟩. § 2.7.2 ⁂Iterating Over a Comma-Separated List
Argument Summary:
- ⟨list⟩ The list to be counted.
- ⟨cs⟩ The control sequence to assign the result.
Hook performed at the start of \DTLpiechart. § 12.2.1 ⁑The datapie Package
Hook performed at the end of \DTLpiechart. § 12.2.1 ⁑The datapie Package
Creates a pie chart from the data given in the database ⟨db-name⟩. § 12.2.1 ⁑The datapie Package
Argument Summary:
- ⟨condition⟩ The same as for the optional
argument of
\DTLforeach. - ⟨settings⟩ A key=value list of settings.
- ⟨db-name⟩ The database name.
- ⟨assign-list⟩ A comma-separated list of
⟨cmd⟩=⟨col-label⟩ pairs, the same as the penultimate
argument of
\DTLforeach
May be used in the inner or outer label to access the percentage value of the
pie chart variable. § 12.2.1 ⁑The datapie Package
May be used in the inner or outer label to access the value of the
pie chart variable. § 12.2.1 ⁑The datapie Package
Like \DTLsaverawdb but works with databases that contain
fragile commands. § 9.4 ⁂Using the datatool Package for Exams or Assignment
Sheets
Argument Summary:
- ⟨db-name⟩ The database name
- ⟨filename⟩ The name of the .dbtex file.
The pie chart radius § 12.2.1 ⁑The datapie Package
Defines extra mappings for \DTLloadrawdb. § 2.2.1 ⁑Loading Data From a CSV File
Argument Summary:
- ⟨string⟩ The thing that needs replacing (typically just a character).
- ⟨replacement⟩ The replacement text.
Rounds ⟨number⟩ to ⟨num-digits⟩ decimal places and
stores the result in ⟨cs⟩, which must be a control sequence.
The number should be formatted according to the current locale (set
via \DTLsetnumberchars) and may optionally be prefixed with a
known currency identifier. See the datatool documentation for
further details. § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨cs⟩ Control sequence in which to store the result.
- ⟨number⟩ Plain decimal number.
- ⟨num-digits⟩ Number of digits to round to.
Rounds ⟨number⟩ to ⟨num-digits⟩ decimal places and stores the result in ⟨cs⟩, which must be a control sequence. The number must be a plain decimal number (a full stop as a decimal point, no number grouping and no currency prefix). § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨cs⟩ Control sequence in which to store the result.
- ⟨number⟩ Plain decimal number.
- ⟨num-digits⟩ Number of digits to round to.
Saves the database in the format that can be loaded by
\DTLloaddbtex and the datatooltk application.
If the database contains any fragile commands, use
\DTLprotectedsaverawdb instead. § 9.4 ⁂Using the datatool Package for Exams or Assignment
Sheets
Argument Summary:
- ⟨db-name⟩ The database name
- ⟨filename⟩ The name of the .dbtex file.
Sets the ⟨n⟩th bar colour to ⟨colour⟩. § 12.3.2 ⁑The databar Package
Argument Summary:
- ⟨n⟩ The bar index (starting from 1).
- ⟨colour⟩ The required colour.
Specifies the delimiter character for CSV files. § 2.2.1 ⁑Loading Data From a CSV File
Argument Summary:
- ⟨character⟩ The delimiter character.
Assigns a header for the column identified by ⟨col-label⟩ in the database labelled ⟨db-name⟩. § 2.2.2 ⁑Loading Data From a .dbtex File
Argument Summary:
- ⟨db-name⟩ The label identifying the database.
- ⟨col-label⟩ The label identifying the column.
- ⟨header⟩ The new header text.
Sets the number group and decimal character for real numbers. See the datatool package for further details. § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨number group character⟩ The symbol used to separate groups of digits within a real number.
- ⟨decimal character⟩ The symbol used to indicate the decimal character.
Sets the colour for the ⟨n⟩th pie chart segment. § 12.2.1 ⁑The datapie Package
Argument Summary:
- ⟨n⟩ The segment index (starting from 1).
- ⟨colour⟩ The required colour.
Specifies the separator character for CSV files. § 2.2.1 ⁑Loading Data From a CSV File
Argument Summary:
- ⟨character⟩ The separator character.
Sets the separator character for CSV files to the tab character. § 2.2.1 ⁑Loading Data From a CSV File
A shortcut for \dtlsort where the comparison handler is
\dtlcompare (case-sensitive). § 2.4 ⁑Sorting Data
Argument Summary:
- ⟨replacement⟩ List of replacement columns to use when a null value is encountered.
- ⟨criteria⟩ A comma-separated list of column labels indicating the sort criteria.
- ⟨db-name⟩ The label identifying the data to be sorted.
Sorts the data identified by ⟨db-name⟩ according to the columns listed in the ⟨criteria⟩ using the given comparison handler control sequence. § 2.4 ⁑Sorting Data
Argument Summary:
- ⟨replacement⟩ List of replacement columns to use when a null value is encountered.
- ⟨criteria⟩ A comma-separated list of column labels indicating the sort criteria.
- ⟨db-name⟩ The label identifying the data to be sorted.
- ⟨handler⟩ The comparison handler control sequence.
A shortcut for \dtlsort where the comparison handler is
\dtlicompare (case-insensitive). § 2.4 ⁑Sorting Data
Argument Summary:
- ⟨replacement⟩ List of replacement columns to use when a null value is encountered.
- ⟨criteria⟩ A comma-separated list of column labels indicating the sort criteria.
- ⟨db-name⟩ The label identifying the data to be sorted.
For use within the definition of \DTLeverybarhook, this
can be used to reference the start of the bar. § 12.3.2 ⁑The databar Package
Computes ⟨number1⟩ minus ⟨number2⟩ and
stores the result in ⟨cs⟩, which must be a control sequence.
The number should be formatted according to the current locale (set
via \DTLsetnumberchars) and may optionally be prefixed with a
known currency identifier. See the datatool documentation for
further details. § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨cs⟩ Control sequence in which to store the result.
- ⟨number1⟩ The first number.
- ⟨number2⟩ The second number.
Computes ⟨number1⟩ minus ⟨number2⟩ and stores the result in ⟨cs⟩, which must be a control sequence. The number must be a plain decimal number (a full stop as a decimal point, no number grouping and no currency prefix). § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨cs⟩ Control sequence in which to store the result.
- ⟨number1⟩ First number.
- ⟨number2⟩ Second number.
A word-ordering comparison handler for use with \dtlsort. § 2.4 ⁑Sorting Data
Argument Summary:
- ⟨register⟩ A count register in which to store the result of the comparison.
- ⟨text1⟩ The first string to be compared.
- ⟨text2⟩ The second string to be compared.
Displays the given date according to the current date format. § 7.1 ⁎The datetime2 Package
Argument Summary:
- ⟨date⟩ The date given in the format ⟨yyyy⟩-⟨mm⟩-⟨dd⟩.
Inserts into the output file the date and time when the LaTeX application created it from the source code. § 7.1 ⁎The datetime2 Package
Stores the given date. § 7.1 ⁎The datetime2 Package
Argument Summary:
- ⟨name⟩ The label identifying this data.
- ⟨data⟩ The date the same format as
\DTMdate.
Stores the given date and time data. § 7.1 ⁎The datetime2 Package
Argument Summary:
- ⟨name⟩ The label identifying this data.
- ⟨data⟩ The date and given in the format ⟨YYYY⟩-⟨MM⟩-⟨DD⟩T⟨hh⟩:⟨mm⟩:⟨ss⟩⟨zone⟩ where ⟨YYYY⟩ is the year, ⟨MM⟩ is the month number, ⟨DD⟩ is the day of the month number, ⟨hh⟩ is the hour (24), ⟨mm⟩ is the minute value, ⟨ss⟩ is the second value and ⟨zone⟩ is the time zone information, which may be just Z or in the form ⟨TZh⟩::⟨TZm⟩.
Displays the previously saved date and time stamp. § 7.1 ⁎The datetime2 Package
Argument Summary:
- ⟨name⟩ The label identifying the data.
Displays the previously saved date. § 7.1 ⁎The datetime2 Package
Argument Summary:
- ⟨name⟩ The label identifying the data.
Displays the previously saved time. § 7.1 ⁎The datetime2 Package
Argument Summary:
- ⟨name⟩ The label identifying the data.
Sets the contents of a dynamic frame. (Verbatim not allowed.) § 10.5 ⁂The flowfram Package and the flowframtk Application
Argument Summary:
- ⟨id⟩ The frame's index for the unstarred version or the label for the starred version.
Similar to \appto but expands ⟨code⟩. Use \xappto for a global assignment. § 2.1.2 ⁂Hook Management
Argument Summary:
- ⟨cs⟩ The control sequence to modify
- ⟨code⟩ The code to append
For use within the invoice environment, this command
is used to specify a local expense. § 4.2 ⁑Writing an Invoice Using the invoice Package
Argument Summary:
- ⟨description⟩ A description of the expense.
- ⟨amount⟩ The expense (in terms of the base currency unit).
For use within the invoice environment, this command
is like \EBC but although the amount is added to the
total expense it's not itemized. § 4.2 ⁑Writing an Invoice Using the invoice Package
Argument Summary:
- ⟨description⟩ A description of the expense.
- ⟨amount⟩ The expense (in terms of the base currency unit).
Specifies your address. § 5.2.1 ⁎Setting Personal Information
Argument Summary:
- ⟨address⟩ Your address.
Specifies text to include after insert your personal image.
You can use \ecvspace within ⟨text⟩. § 5.2.1 ⁎Setting Personal Information
Argument Summary:
- ⟨text⟩ The text to go after your image.
Specifies text to include before insert your personal image.
You can use \ecvspace within ⟨text⟩. § 5.2.1 ⁎Setting Personal Information
Argument Summary:
- ⟨text⟩ The text to go before your image.
For use in the ⟨l1⟩, …, ⟨l5⟩ arguments
of \ecvlanguage or \ecvlastlanguage. § 5.2.3 ⁑Spoken Languages
Argument Summary:
- ⟨level⟩ The self-assessment level code.
- ⟨descr⟩ A short description.
Sets the column separation. § 5.2.3 ⁑Spoken Languages
Argument Summary:
- ⟨width⟩ The required width.
Specifies your date of birth. § 5.2.1 ⁎Setting Personal Information
Argument Summary:
- ⟨date⟩ Your date of birth.
Specifies your email address. § 5.2.1 ⁎Setting Personal Information
Argument Summary:
- ⟨address⟩ Your email address.
Specifies your fax number. § 5.2.1 ⁎Setting Personal Information
Argument Summary:
- ⟨fax number⟩ Your fax number.
Specifies your name as it will appear in the footer. If omitted,
the name will be taken from that specified by \ecvname. § 5.2.1 ⁎Setting Personal Information
Argument Summary:
- ⟨name⟩ Your name.
Specifies your gender. § 5.2.1 ⁎Setting Personal Information
Argument Summary:
- ⟨gender⟩ Your gender.
Adds ⟨left text⟩ to the left of the vertical rule and ⟨right text⟩ to the right of the vertical rule. § 5.2.2 ⁑Sections and Publication Lists
Argument Summary:
- ⟨vspace⟩ The height of the vertical space to insert after the text.
- ⟨left text⟩ The text to go on the left.
- ⟨right text⟩ The text to go on the right.
Typesets a row in the language table. Each of the
⟨l1⟩, …, ⟨l5⟩ arguments should be in the form
\ecvCEF{⟨level⟩}{⟨desc⟩}. Use \ecvlastlanguage
for the last row. § 5.2.3 ⁑Spoken Languages
Argument Summary:
- ⟨vspace⟩ Vertical space to insert after the row.
- ⟨language⟩ The language name.
- ⟨l1⟩ level of understanding (listening).
- ⟨l2⟩ level of understanding (reading).
- ⟨l3⟩ level of speaking (spoken interaction).
- ⟨l4⟩ level of speaking (spoken production).
- ⟨l5⟩ level of writing.
Typesets the footer of the language table and identifies
the symbol to use as a footnote symbol, which should
be the same as that used in \ecvlanguageheader. § 5.2.3 ⁑Spoken Languages
Argument Summary:
- ⟨vspace⟩ Vertical space to insert after the footer.
- ⟨symbol⟩ The symbol to use in the footnote.
Typesets the header of the language table and identifies the symbol to use as a footnote symbol. § 5.2.3 ⁑Spoken Languages
Argument Summary:
- ⟨symbol⟩ The symbol to use in the footnote.
Typesets the last row in the language table. Each of the
⟨l1⟩, …, ⟨l5⟩ arguments should be in the form
\ecvCEF{⟨level⟩}{⟨desc⟩}. § 5.2.3 ⁑Spoken Languages
Argument Summary:
- ⟨vspace⟩ Vertical space to insert after the row.
- ⟨language⟩ The language name.
- ⟨l1⟩ level of understanding (listening).
- ⟨l2⟩ level of understanding (reading).
- ⟨l3⟩ level of speaking (spoken interaction).
- ⟨l4⟩ level of speaking (spoken production).
- ⟨l5⟩ level of writing.
Sets the width of the left column. § 5.2.3 ⁑Spoken Languages
Argument Summary:
- ⟨width⟩ The required width.
Starts the spoken language section and identifies your mother tongue. § 5.2.3 ⁑Spoken Languages
Argument Summary:
- ⟨vspace⟩ Vertical space to insert after the heading.
- ⟨language⟩ The language name.
Specifies your name. § 5.2.1 ⁎Setting Personal Information
Argument Summary:
- ⟨name⟩ Your name.
Specifies your nationality. § 5.2.1 ⁎Setting Personal Information
Argument Summary:
- ⟨nationality⟩ Your nationality.
Typesets your personal details. § 5.2.1 ⁎Setting Personal Information
Argument Summary:
- ⟨vspace⟩ Vertical space to insert after the personal information.
Specifies the name of the file showing an image of yourself. § 5.2.1 ⁎Setting Personal Information
Argument Summary:
- ⟨options⟩ Graphics options, as per the optional
argument of
\includegraphics. - ⟨image filename⟩ The name of the image file (as used by graphicx).
Creates a section heading. § 5.2.2 ⁑Sections and Publication Lists
Argument Summary:
- ⟨vspace⟩ The height of the vertical space to insert after the title.
- ⟨title⟩ The section title.
May only be used within the argument of \ecvbeforepicture or
\ecvafterpicture to insert some vertical space. § 5.2.1 ⁎Setting Personal Information
Argument Summary:
- ⟨height⟩ The amount of space to insert. (May be negative.)
Specifies your telephone number and optionally your mobile phone number. § 5.2.1 ⁎Setting Personal Information
Argument Summary:
- ⟨mobile⟩ Your mobile phone number.
- ⟨telephone⟩ Your telephone number.
This locally defines the command ⟨cs⟩ to the full expansion
of ⟨definition⟩. Use \xdef for global definitions. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cs⟩ The new command being defined.
- ⟨arg-syntax⟩ The command syntax where each parameter is referenced using #⟨n⟩ in order
- ⟨definition⟩ The command definition.
For use within the invoice environment, this command
is used to specify a foreign expense. § 4.2 ⁑Writing an Invoice Using the invoice Package
Argument Summary:
- ⟨description⟩ A description of the expense.
- ⟨foreign currency⟩ The name of the foreign currency.
- ⟨amount⟩ The expense (in terms of the foreign currency unit).
- ⟨conversion rate⟩ The currency conversion rate (may be blank).
- ⟨base currency result⟩ The expense in terms of the base currency (may be blank).
For use within the invoice environment, this command
is like \EFC but although the amount is added to the
total expense it's not itemized. § 4.2 ⁑Writing an Invoice Using the invoice Package
Argument Summary:
- ⟨description⟩ A description of the expense.
- ⟨foreign currency⟩ The name of the foreign currency.
- ⟨amount⟩ The expense (in terms of the foreign currency unit).
- ⟨conversion rate⟩ The currency conversion rate (may be blank).
- ⟨base currency result⟩ The expense in terms of the base currency (may be blank).
Specifies the sender's email address. § 3.3 ⁑Writing a Letter Using the newlfm Class
Argument Summary:
- ⟨text⟩ The sender's email.
Toggles the upright and italic/slanted rendering of ⟨text⟩. (See Volume 1.) § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨text⟩ The text on which to apply the font change.
Does nothing. § 12.5 ⁑Plots
letter environment.Used to indicate any enclosures accompanying the letter. § 3.1 ⁎Writing a Letter Using the letter Class
Argument Summary:
- ⟨enclosures info⟩ The list of enclosures.
Specifies the list of enclosures. § 3.5 ⁑Mail Merging
Argument Summary:
- ⟨text⟩ The list of enclosures
Ends an environment. (Must have a matching \begin.
See Volume 1.) § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨env-name⟩ The name of the environment.
Marks the end of the header code for the first page of the
longtable environment. § 4.3 ⁂Building Your Own Invoice using longtable and
datatool
Marks the end of the footer code for the
longtable environment. § 4.3 ⁂Building Your Own Invoice using longtable and
datatool
Marks the end of the header code for the
longtable environment. § 4.3 ⁂Building Your Own Invoice using longtable and
datatool
Stops reading the current file. Anything in the current file occurring after this command is skipped. § 7.3 ⁂Displaying a Date
Marks the end of the footer code for the last page of the
longtable environment. § 4.3 ⁂Building Your Own Invoice using longtable and
datatool
Specifies the end time of the meeting. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨time⟩ The end time.
Horizontal spacing command (half as wide as \quad). § 9.1 ⁑The exam Class
Ordered list. Some packages, such as paralist, modify this environment to provide an optional argument that allows you to adjust the counter format. § 6.5.1 ⁑Hierarchical Paragraph Numbering
Similar to \preto but expands ⟨code⟩. Use \xpreto for a global assignment. § 2.1.2 ⁂Hook Management
Argument Summary:
- ⟨cs⟩ The control sequence to modify
- ⟨code⟩ The code to prepend
A test that can be used within the condition of \ifthenelse
to determine if ⟨text1⟩ is the same as ⟨text2⟩. (Both
arguments are expanded.) § 2.7.1 ⁑Iterating Through a Database
Argument Summary:
- ⟨text1⟩ The first text under comparison.
- ⟨text2⟩ The second text under comparison.
The body of the CV. § 5.2 ⁎The europecv Class
A length containing the horizontal offset for even pages. See
\hoffset. § 11. ⁑Forms
Indicates code to be performed at the start of every paragraph. § 6.5.2 ⁂Non-Hierarchical Paragraph Numbering
Argument Summary:
- ⟨code⟩ The code to insert at the start of each paragraph.
Evaluates to true if the given file doesn't exist. The argument ⟨ref⟩ may either be
a string "⟨extension⟩" which indicates the file extension
or a file reference toFile("⟨filename⟩"). § 1.2 ⁑Arara
Argument Summary:
- ⟨ref⟩ The file extension or a file reference.
\expandafter⟨token 1⟩⟨token 2⟩
Equivalent to ⟨token 1⟩ expansion of ⟨token 2⟩. § 2.7.2 ⁂Iterating Over a Comma-Separated List
Argument Summary:
- ⟨token 1⟩ The token about to be processed
- ⟨token 2⟩ The token that needs to be expanded before ⟨token 1⟩ is processed.
\expandonce⟨cs⟩
Only permits one level of expansion of the command ⟨cs⟩. § 2.1.2 ⁂Hook Management
Argument Summary:
- ⟨cs⟩ The command to be expanded
Puts a frame around its contents, prohibiting a line break in the contents. § 7.5 ⁂Displaying a Calendar
Argument Summary:
- ⟨text⟩ The contents of the box.
For use within the invoice environment, this command
is used to specify a fee. § 4.2 ⁑Writing an Invoice Using the invoice Package
Argument Summary:
- ⟨description⟩ A description of the fee.
- ⟨rate/unit⟩ The rate per unit of work (such as the charge per day)
- ⟨count⟩ The number of units (such as the number of working days)
Floats the contents to the nearest location according to the
preferred placement options, if possible. Within the environment,
\caption may be used one or more times, as required.
(See Volume 1.)
§ 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨placement⟩ The preferred placement.
geometry option.Produces a small filled circle. § 11.1 ⁂Writing a Class File for a Form
Sets the starting label on a partially used sheet. § 3.6 ⁑Envelopes
Argument Summary:
- ⟨row⟩ The row index
- ⟨column⟩ The column index
Aligns its contents flush-right and places a small vertical gap above and below the environment. § 10.3 ⁑The leaflet Class
Sets the name of the current font family. (The change won't take
effect until the next \selectfont.) For example, in text
mode, \rmfamily is equivalent to
\fontfamily{cmr}\selectfont (unless it's been
modified by a font package.) § 6.4.2.2 ⁑The xwatermark Package
Argument Summary:
- ⟨name⟩ The name of the font family (for example cmr for Computer Modern Roman).
Sets the name of the current font series. (The change won't take
effect until the next \selectfont.) For example, in text
mode, \bfseries is equivalent to
\fontseries{b}\selectfont (unless it's been
modified by a font package.) § 6.4.2.2 ⁑The xwatermark Package
Argument Summary:
- ⟨weight⟩ The weight identifier (for example b for bold).
Inserts a footnote. § 2.1.2 ⁂Hook Management
Argument Summary:
- ⟨number⟩ Overrides the default footnote number with the specified ⟨number⟩.
- ⟨text⟩ The footnote text.
This is like \docsvlist except that instead
of using \do it uses ⟨handler-cs⟩. § 2.7.2 ⁂Iterating Over a Comma-Separated List
Argument Summary:
- ⟨handler-cs⟩ The control sequence (which takes one argument) to execute on each iteration.
- ⟨item1,item2,…⟩ Comma-separated list of items to iterate over.
Iterates through the ⟨list⟩ and assigns ⟨variables⟩
which can be used in ⟨body⟩. The full syntax is quite
complicated, so read the pgf manual for further details.
The \breakforeach command can be used to prematurely
terminate the loop after the current iteration. § 2.7.2 ⁂Iterating Over a Comma-Separated List
Argument Summary:
- ⟨variables⟩ In the simplest case, this is just a control sequence used to store the current item in the list. For more complicated cases, see the pgf manual.
- ⟨options⟩ Options to customize the foreach-statement. See the pgf manual for details.
- ⟨list⟩ The list to be iterated over. This can be a comma-separated list or a control sequence that expands to a comma-separated list. You can also use ... within the list if the full contents can be inferred from the start and end items. For example 1,...,6 indicates the list 1,2,3,4,5,6 whereas 2,4,...,10 indicates the list 2,4,6,8,10.
- ⟨body⟩ The code to be performed on each iteration.
Iterates over all defined datasets and performs ⟨body⟩ at each iteration. § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨cs⟩ A control sequence that's set to the name of the current dataset.
- ⟨body⟩ The code to perform on each iteration.
Iterates through the given dataset and does ⟨body⟩ at each
iteration. Within ⟨body⟩, \thisproblem may be used to
display the current problem and \thisproblemlabel may be used
to access the current problem label. § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨dataset⟩ The dataset to iterate over. (If omitted the default dataset is used.)
- ⟨body⟩ The code to perform on each iteration.
Similar to \foreachproblem but only iterates through
problems that contain the onlysolution environment. § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨dataset⟩ The dataset to iterate over. (If omitted the default dataset is used.)
- ⟨body⟩ The code to perform on each iteration.
Similar to \forlistloop except the list control sequence
name (without the leading backslash) is used. § 2.7.3 ⁑Iteration With etoolbox's Internal Lists
Argument Summary:
- ⟨handler-cs⟩ The control sequence to use on each iteration.
- ⟨list-csname⟩ The name of the control sequence used to store the list.
Similar to \dolistloop except it uses ⟨handler-cs⟩
instead of \do at each iteration. § 2.7.3 ⁑Iteration With etoolbox's Internal Lists
Argument Summary:
- ⟨handler-cs⟩ The control sequence to use on each iteration.
- ⟨list-cs⟩ The control sequence used to store the list.
Environment containing interactive form elements. § 11.2 ⁑Electronic PDF Forms
Argument Summary:
- ⟨parameters⟩ A key=value list to specify the action, method and encoding for the form submission.
Evaluates to true if the given regular expression is found in the
given file. The argument ⟨ref⟩ may either be
a string "⟨extension⟩" which indicates the file extension
or a file reference toFile("⟨filename⟩"). § 1.2 ⁑Arara
Argument Summary:
- ⟨ref⟩ The file extension or a file reference.
- ⟨expression⟩ A regular expression.
Generates a random number between 0 and 1 and assigns the result to the given control sequence ⟨cs⟩. § 9.5 ⁂Random Numbers
Argument Summary:
- ⟨cs⟩ A control sequence in which to store the result.
A count register that stores the random generator seed. § 9.5 ⁂Random Numbers
Displays a fraction. § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨numerator⟩ The numerator (above the line).
- ⟨denominator⟩ The denominator (below the line).
Creates a slide (or possibly multiple slides if the frame contains overlays) § 8. ⁎Presentations (The beamer Class)
Puts a rectangular frame around ⟨text⟩. Similar to
\fbox but doesn't insert a gap between ⟨text⟩ and the
frame. The beamer class redefines this command for its
frame environment. § 10.4 ⁑The pst-barcode Package
Argument Summary:
- ⟨text⟩ The text to put the frame around.
picture environment.
Unlike the ordinary \framebox command, this version
doesn't add any space between the frame and the text. § 10.1 ⁑The picture Environment
Argument Summary:
- ⟨w⟩ The width of the box.
- ⟨h⟩ The height of the box.
- ⟨align⟩ The alignment of the text. This may be one or two letters that specify the alignment. The letters may be one of: l (left), r (right), t (top) or b (bottom). If omitted, the default centres the text horizontally and vertically.
Puts a frame around its contents, prohibiting a line break in the
contents. § 10.1 ⁑The picture Environment
Argument Summary:
- ⟨width⟩ The width of the box. (If omitted, this value is the natural width of the box contents.)
- ⟨align⟩ Horizontal alignment of box contents (c if omitted).
- ⟨text⟩ The contents of the box.
Inserted at the point of the frame break when a paragraph spans two flow frames of unequal widths. § 10.5 ⁂The flowfram Package and the flowframtk Application
Subtitle for a frame. (For use within the frame
environment.) § 8. ⁎Presentations (The beamer Class)
Argument Summary:
- ⟨subtitle⟩ The frame subtitle.
Title for a frame. (For use within the frame
environment. § 8. ⁎Presentations (The beamer Class)
Argument Summary:
- ⟨title⟩ The frame title.
For use within the ganttchart environment, this
draws a bar representing a task or subtask. § 12.4 ⁑Gantt Charts
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨text⟩ The task's label text.
- ⟨start-tss⟩ The starting time slot.
- ⟨end-tss⟩ The end time slot.
Creates a Gantt chart. § 12.4 ⁑Gantt Charts
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨start⟩ The starting time slot.
- ⟨end⟩ The end time slot.
For use within the ganttchart environment, this
draws a group bar. § 12.4 ⁑Gantt Charts
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨text⟩ The group's label text.
- ⟨start-tss⟩ The starting time slot.
- ⟨end-tss⟩ The end time slot.
For use within the ganttchart environment, this
draws a linked bar representing a task or subtask. § 12.4 ⁑Gantt Charts
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨text⟩ The task's label text.
- ⟨start-tss⟩ The starting time slot.
- ⟨end-tss⟩ The end time slot.
For use within the ganttchart environment, this
draws a linked group bar. § 12.4 ⁑Gantt Charts
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨text⟩ The group's label text.
- ⟨start-tss⟩ The starting time slot.
- ⟨end-tss⟩ The end time slot.
For use within the ganttchart environment, this
draws a linked milestone marker. § 12.4 ⁑Gantt Charts
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨text⟩ The milestone's label text.
- ⟨tss⟩ The time slot when the milestone was achieved.
For use within the ganttchart environment, this
draws a milestone marker. § 12.4 ⁑Gantt Charts
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨text⟩ The milestone's label text.
- ⟨tss⟩ The time slot when the milestone was achieved.
For use within the ganttchart environment, this
starts a new row. § 12.4 ⁑Gantt Charts
Argument Summary:
- ⟨options⟩ A key=value list of options.
Sets the options governing the Gantt chart style. § 12.4 ⁑Gantt Charts
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨start⟩ The starting time slot.
- ⟨end⟩ The end time slot.
For use within the ganttchart environment, this
draws a single title element. § 12.4 ⁑Gantt Charts
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨text⟩ The title text.
- ⟨n⟩ The number of time slots that the title covers.
For use within the ganttchart environment, this
draws a title calendar that spans the whole chart. § 12.4 ⁑Gantt Charts
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨calendar-lines⟩ A comma-separated list of calendar line elements
For use within the ganttchart environment, this
draws a title calendar that spans the chart from ⟨start-tss⟩
to ⟨end-tss⟩. § 12.4 ⁑Gantt Charts
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨start-tss⟩ The starting time slot.
- ⟨end-tss⟩ The end time slot.
- ⟨calendar lines⟩ A comma-separated list of calendar line elements
For use within the ganttchart environment, this
iterates over ⟨list⟩ and draws a title element spanning
⟨n⟩ time slots. § 12.4 ⁑Gantt Charts
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨list⟩ A comma-separated list of titles.
- ⟨n⟩ The number of time slots that each title covers.
Global version of \appto. § 2.1.2 ⁂Hook Management
Argument Summary:
- ⟨cs⟩ The control sequence to modify
- ⟨code⟩ The code to append
As \def but the definition is global. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cs⟩ The new command being defined.
- ⟨arg-syntax⟩ The command syntax where each parameter is referenced using #⟨n⟩ in order
- ⟨definition⟩ The command definition.
Global version of \DTLforeachbibentry. The starred version is read-only. § 5.2.2 ⁑Sections and Publication Lists
Argument Summary:
- ⟨condition⟩ The condition to apply on each iteration.
- ⟨db-name⟩ The database name.
- ⟨body⟩ The code to perform on each iteration where the condition is met.
Gets the location and size of the given flow frame.
The results are stored in the lengths \ffareax, \ffareay,
\ffareawidth and \ffareaheight. § 11. ⁑Forms
Argument Summary:
- ⟨id⟩ The frame's index for the unstarred version or the label for the starred version.
Gets the location and size of the given flow frame for even pages.
The results are stored in the lengths \ffareax, \ffareay,
\ffareawidth and \ffareaheight. § 11. ⁑Forms
Argument Summary:
- ⟨id⟩ The frame's index for the unstarred version or the label for the starred version.
\global⟨assignment⟩
An assignment prefix that indicates the following assignment shouldn't be confined to the current scope. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨assignment⟩ The assignment being prefixed.
Global version of \preto. § 2.1.2 ⁂Hook Management
Argument Summary:
- ⟨cs⟩ The control sequence to modify
- ⟨code⟩ The code to prepend
Displays the grading table. § 9.1 ⁑The exam Class
Argument Summary:
- ⟨orientation⟩ May be either h (horizontal) or v (vertical).
- ⟨index-type⟩ May be either questions or pages.
The salutation text. § 3.3 ⁑Writing a Letter Using the newlfm Class
Argument Summary:
- ⟨text⟩ The salutation text, such as “Dear Sir” or “Dear Madam”
Specifies the names of any guests present. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨names⟩ The list of names.
Indicates a half point § 9.1 ⁑The exam Class
Specifies the subject of a press release. § 6.2 ⁎Press Releases
Argument Summary:
- ⟨text⟩ The information text.
Inserts a horizontal space that will expand to fit the available width. § 3.6 ⁑Envelopes
Similar to the
items environment but is only displayed if the
agenda class option is used. § 6.3.1 ⁑The meetingmins Class
Similar to the
subitems environment but is only displayed if the
agenda class option is used. § 6.3.1 ⁑The meetingmins Class
This environment only displays its contents if the agenda
class option is used. § 6.3.1 ⁑The meetingmins Class
Hides the solutions (from that point onwards). § 9.3 ⁑The probsoln Package
A length containing the horizontal offset. The left margin of a
page is computed from \hoffset plus 1 in
plus \oddsidemargin/\evensidemargin. § 11. ⁑Forms
Fills the remaining space with a line. § 9.1 ⁑The exam Class
Inserts a horizontal gap of the given width. The unstarred version doesn't create a space if it occurs at the beginning or end of a paragraph. The starred version always creates a space. § 3.6 ⁑Envelopes
Argument Summary:
- ⟨length⟩ The width of the horizontal gap.
Switches to extra-huge sized text. § 10.3 ⁑The leaflet Class
Set up options. § 2.3 ⁑Security
Argument Summary:
- ⟨key-val list⟩ A key=value list of options.
Only run the application if ⟨condition⟩ is true. § 1.2 ⁑Arara
Argument Summary:
- ⟨condition⟩ The condition to evaluate.
Expands to ⟨true⟩ if the boolean flag ⟨name⟩ is true, and to ⟨false⟩ otherwise. § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨name⟩ The name of the boolean flag.
- ⟨true⟩ The code to perform if true.
- ⟨false⟩ The code to perform if false.
Evaluates the ⟨expression⟩ and executes ⟨true⟩ if true, and ⟨false⟩ otherwise. The syntax for the expression is described in the etoolbox manual. § 2.9 ⁑Null and Boolean Values
Argument Summary:
- ⟨expression⟩ The expression to test.
- ⟨true⟩ Code to execute if the expression is true.
- ⟨false⟩ Code to execute if the expression is false.
If ⟨number⟩ equals 0, performs ⟨case0 code⟩,
if ⟨number⟩ equals 1, performs ⟨case1 code⟩,
if ⟨number⟩ equals 2, performs ⟨case2 code⟩, etc.
If none of the cases match, ⟨default code⟩ is performed.
The \else ⟨default code⟩ part may be omitted.
If ⟨case 0 code⟩ starts with a number, insert \relax
before it to prevent TeX from scanning it as part of
⟨number⟩. § 7.3 ⁂Displaying a Date
Argument Summary:
- ⟨number⟩ The number being tested.
- ⟨case0 code⟩ The code to perform if ⟨number⟩ equals 0.
- ⟨case1 code⟩ The code to perform if ⟨number⟩ equals 1.
- ⟨case2 code⟩ The code to perform if ⟨number⟩ equals 2.
- ⟨default code⟩ The code to perform if none of the cases match.
Checks if the control sequence with the name ⟨cs-name⟩ exists. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cs-name⟩ The name of the control sequence whose existence is being tested.
- ⟨true-part⟩ Code that's performed if the control sequence exists.
- ⟨false-part⟩ Code that's performed if the control sequence doesn't exist.
Checks if the control sequence whose name is given by ⟨cs
name⟩ doesn't exist or is
defined as \relax. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cs-name⟩ The name of the control sequence whose non-existence is being tested.
- ⟨true-part⟩ Code that's performed if the control
sequence doesn't exist or is defined to
\relax. - ⟨false-part⟩ Code that's performed if the control sequence exists.
For use within the ⟨code⟩ part of \pgfcalendar.
The same as \pgfcalendarifdate for the current date. § 7.5 ⁂Displaying a Calendar
Argument Summary:
- ⟨test⟩ The test (same as
\pgfcalendarifdate). - ⟨true-part⟩ The code to perform if the test is true.
- ⟨false-part⟩ The code to perform if the test is false.
Checks if the control sequence ⟨cs⟩ exists. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cs⟩ The control sequence whose existence is being tested.
- ⟨true-part⟩ Code that's performed if the control sequence exists.
- ⟨false-part⟩ Code that's performed if the control sequence doesn't exist.
If the control sequence ⟨cs⟩ is empty this does ⟨true⟩ otherwise it does ⟨false⟩. § 2.9 ⁑Null and Boolean Values
Argument Summary:
- ⟨cs⟩ Control sequence being tested.
- ⟨true⟩ Stuff to do if ⟨cs⟩ is empty.
- ⟨false⟩ Stuff to do if ⟨cs⟩ isn't empty.
If the control sequence ⟨cs⟩ was defined to be ⟨string⟩ this does ⟨true⟩ otherwise it does ⟨false⟩. (No expansion is performed.) § 2.9 ⁑Null and Boolean Values
Argument Summary:
- ⟨cs⟩ Control sequence being tested.
- ⟨string⟩ String being tested.
- ⟨true⟩ Stuff to do if ⟨cs⟩ is empty.
- ⟨false⟩ Stuff to do if ⟨cs⟩ isn't empty.
Checks if ⟨item⟩ is included in one of etoolbox's
internal list macros ⟨list-cs⟩ and does ⟨true⟩ if true,
otherwise it does ⟨false⟩. No expansion is performed on
⟨item⟩. See also \xifinlist § 2.7.3 ⁑Iteration With etoolbox's Internal Lists
Argument Summary:
- ⟨item⟩ The item to be tested.
- ⟨list-cs⟩ The control sequence used to store the list.
- ⟨true⟩ The code to process if the item is in the list.
- ⟨false⟩ The code to process if the item isn't in the list.
As \ifinlist but the control sequence name is supplied
(without the backslash). § 2.7.3 ⁑Iteration With etoolbox's Internal Lists
Argument Summary:
- ⟨item⟩ The item to be tested.
- ⟨list-csname⟩ The name of control sequence used to store the list.
- ⟨true⟩ The code to process if the item is in the list.
- ⟨false⟩ The code to process if the item isn't in the list.
Compares ⟨num1⟩ to ⟨num2⟩. The comparison ⟨comp⟩
may be one of: = (equality), < (less than)
or > (greater than). The \else
⟨false-part⟩ may be omitted. If ⟨true-part⟩ starts with
a number, insert \relax before it to prevent TeX from
scanning it as part of ⟨num2⟩. § 2.7.4 ⁂General Iteration with TeX's \loop
Argument Summary:
- ⟨num1⟩ First number.
- ⟨comp⟩ Comparison symbol (= or < or >).
- ⟨num2⟩ Second number.
- ⟨true-part⟩ Code to perform if the comparison is true.
- ⟨false-part⟩ Code to perform if the comparison is false.
Checks if ⟨number1⟩ is less than ⟨number2⟩. Both values should be integers. § 5.2.2 ⁑Sections and Publication Lists
Argument Summary:
- ⟨number1⟩ The first number.
- ⟨number2⟩ The second number.
- ⟨true-part⟩ The code to perform if ⟨number1⟩ is less than ⟨number2⟩.
- ⟨false-part⟩ The code to perform if ⟨number1⟩ isn't less than ⟨number2⟩.
Tests if ⟨number⟩ is odd. If true this does ⟨odd code⟩
otherwise it does ⟨even code⟩. The \else ⟨even
code⟩ may be omitted. § 11. ⁑Forms
Argument Summary:
- ⟨number⟩ The integer number to be tested.
- ⟨odd code⟩ The code to perform if ⟨number⟩ is odd.
- ⟨even code⟩ The code to perform if ⟨number⟩ is even.
Tests if the solutions are displayed. § 9.3 ⁑The probsoln Package
Tests if ⟨string⟩ is empty. (No expansion is performed on ⟨string⟩.) § 7.3 ⁂Displaying a Date
Argument Summary:
- ⟨string⟩ The string being tested.
- ⟨true-part⟩ Code that's performed if ⟨string⟩ is empty.
- ⟨false-part⟩ Code that's performed if ⟨string⟩ isn't empty.
Tests if ⟨string1⟩ is the same as ⟨string2⟩. (No expansion is performed on ⟨string1⟩ or ⟨string2⟩.) § 7.4 ⁂Parsing and Displaying Times
Argument Summary:
- ⟨string1⟩ The first string being tested.
- ⟨string2⟩ The second string being tested.
- ⟨true-part⟩ Code that's performed if the strings are equal.
- ⟨false-part⟩ Code that's performed if the strings aren't equal.
If the condition is met, does ⟨true⟩ otherwise does
⟨false⟩. The ⟨condition⟩ must follow the syntax
defined by the ifthen package. The datatool package
provides additional commands that may be used in ⟨condition⟩.
Note that in general, it's better to use the conditionals provided
by the etoolbox package, but the optional argument of
\DTLforeach (and the starred version) requires the same
format as the first argument of \ifthenelse. § 2.7.1 ⁑Iterating Through a Database
Argument Summary:
- ⟨condition⟩ A condition using the ifthen package syntax. (See the ifthen documentation for further details.)
- ⟨true⟩ The stuff to do if the condition is true.
- ⟨false⟩ The stuff to do if the condition is false.
Determines if the current page is odd or even. § 11. ⁑Forms
Argument Summary:
- ⟨odd code⟩ Code to do if the current page is odd.
- ⟨even code⟩ Code to do if the current page is even.
Checks if the control sequence ⟨cs⟩ doesn't exist or is
defined as \relax. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cs⟩ The control sequence whose non-existence is being tested.
- ⟨true-part⟩ Code that's performed if the control
sequence doesn't exist or is defined to
\relax. - ⟨false-part⟩ Code that's performed if the control sequence exists.
Used in begin environment code to suppress any spaces occurring
at the start of the environment (see also \ignorespacesafterend). § 9.3 ⁑The probsoln Package
Used in end environment code to suppress any spaces following the end of the environment. § 9.3 ⁑The probsoln Package
Generates a row of data for use within \itable. § 4.1 ⁑Writing an Invoice Using the isodoc Class
Argument Summary:
- ⟨description⟩ The item description.
- ⟨amount⟩ The item amount.
Issues a \clearpage, creates an associated auxiliary file,
inputs ⟨filename⟩ and issues another \clearpage.
(See also \input.) § 13. ⁎Collaborating on Documents
Argument Summary:
- ⟨filename⟩ The name of the file to be included. (The .tex extension may be omitted.)
\includegraphics[⟨option-list⟩]{⟨filename⟩}
Inserts a graphics file into the document. Permitted file types depend on the output format. (PostScript (PS) and Encapsulated PostScript (EPS) for the DVI format. PDF, JPG and PNG for the PDF format (also EPS if the TeX distribution permits on-the-fly epstopdf conversion). § 3.2 ⁑Writing a Letter Using the scrlttr2 Class
Argument Summary:
- ⟨option list⟩ Comma-separated list of options that can be used to change the way the image is displayed.
- ⟨filename⟩ The name of the image file. The extension may be omitted.
Includes questions defined in the named files. § 9.2 ⁑The exsheets Package
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨filenames⟩ Comma-separated list of filenames.
For use within the textenum, this command may be used
in place of \item to indicate an incorrect choice. If the
solutions aren't displayed this command behaves the same as
\item. § 9.3 ⁑The probsoln Package
The format used by \incorrectitem. § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨marker⟩ The item marker.
An inline numbered list. (Similar to the enumerate
environment, but the items don't start a new paragraph, unless you
explicitly insert a paragraph break.) § 9.2 ⁑The exsheets Package
Argument Summary:
Reads in the contents of ⟨filename⟩. § 2.2.2 ⁑Loading Data From a .dbtex File
Argument Summary:
- ⟨filename⟩ The name of the file to be read in. (The .tex extension may be omitted. Any other extension must be included.)
If the given file exists, this does ⟨true-part⟩ and then loads the file. Otherwise it does ⟨false-part⟩. § 6.4.1 ⁎Redaction: The censor Package
Argument Summary:
- ⟨file⟩ The file name (the .tex extension may be omitted).
- ⟨true-part⟩ Code to perform before loading the file if it exists.
- ⟨false-part⟩ Code to perform if the file doesn't exist.
Used to prefix each institute listed in \institute
when there are multiple institutes. A corresponding
\inst{⟨number⟩} should be placed after the relevant
author name within \author. § 8. ⁎Presentations (The beamer Class)
Argument Summary:
- ⟨text⟩ Text (such as a number) identifying the institute.
Specifies the author's institution for use with \maketitle
in a similar manner to \title. Some classes, such as
beamer, also provide an optional argument for this command. § 8. ⁎Presentations (The beamer Class)
Argument Summary:
- ⟨text⟩ The name of the institute.
Creates an invoice. § 4.1 ⁑Writing an Invoice Using the isodoc Class
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨contents⟩ The invoice contents.
The body of the invoice. § 4.2 ⁑Writing an Invoice Using the invoice Package
Argument Summary:
- ⟨base-currency⟩ The base currency name.
- ⟨VAT⟩ The percentage VAT (without the percent sign).
Generates the table used within \invoice. § 4.1 ⁑Writing an Invoice Using the isodoc Class
Argument Summary:
- ⟨contents⟩ The table contents
Specifies the start of an item in a list. (Only allowed inside one of
the list making environments, such as enumerate.) § 5.1 ⁎The currvita Package
Argument Summary:
- ⟨marker⟩ If specified, the default item marker is replaced with ⟨marker⟩.
Unordered list. § 8.1 ⁑Overlays
A numbered list for use within a section. Use the
subitems environment for lists within subsections and
sub-subsections. § 6.3.1 ⁑The meetingmins Class
Generates a row of for the total amount for use within \itable. § 4.1 ⁑Writing an Invoice Using the isodoc Class
Argument Summary:
- ⟨tag⟩ A tag such as “Subtotal”.
- ⟨amount⟩ The total amount.
Switches to the italic form of the current font family, if it exists. See Volume 1. § 10.2 ⁑The ticket Package
The current job name. This is usually the base name (without the .tex extension) of the main .tex file, but can be changed using TeX's -jobname switch. § 5.2.2 ⁑Sections and Publication Lists
Allows you to specify a list of values to the given multi-valued KOMA-Script option. § 3.2 ⁑Writing a Letter Using the scrlttr2 Class
Argument Summary:
- ⟨option⟩ The name of the multivalued KOMA-Script option.
- ⟨value list⟩ A comma-separated list of individual values to apply to the given option.
Allows you to set one or more of the KOMA-Script options. § 3.2 ⁑Writing a Letter Using the scrlttr2 Class
Argument Summary:
- ⟨option list⟩ A key=value list of options.
Assigns a unique textual label linked to the most recently incremented cross-referencing counter in the current scope. (See Volume 1.) § 1.2 ⁑Arara
Argument Summary:
- ⟨string⟩ A unique label that can be referenced
elsewhere in the document with
\ref. (It's best to just use alphanumerics and non-active punctuation characters in the label.)
Used by \item in the first level enumerate
environment to display the label. § 6.5.1 ⁑Hierarchical Paragraph Numbering
Used by \item in the second level enumerate
environment to display the label. § 6.5.1 ⁑Hierarchical Paragraph Numbering
Used by \item in the third level enumerate
environment to display the label. § 6.5.1 ⁑Hierarchical Paragraph Numbering
Used by \item in the fourth level enumerate
environment to display the label. § 6.5.1 ⁑Hierarchical Paragraph Numbering
A length register used to store the label height. § 3.6 ⁑Envelopes
Length register used by list environments to store the size of the horizontal gap between the item marker and the following text. § 6.5.1.1 ⁂Delving Deeper
A length register used to store the label width. § 3.6 ⁑Envelopes
Length register used by list environments to store the label width. The value is typically
set in the ⟨list declarations⟩ argument of the list
environment. § 6.5.1.1 ⁂Delving Deeper
Sets its body in an extra-large sized font. § 2.1.1 ⁂Macro Definitions
Switches to extra-large sized text. § 2.1.1 ⁂Macro Definitions
Switches to large sized text. § 10.1 ⁑The picture Environment
Lays out the label and associated check box. This just defaults to ⟨label⟩ ⟨field⟩. § 11.2 ⁑Electronic PDF Forms
Argument Summary:
- ⟨label⟩ The text to appear next to the interactive element.
- ⟨field⟩ The interactive element.
Lays out the label and associated choice field. This just defaults to ⟨label⟩ ⟨field⟩. § 11.2 ⁑Electronic PDF Forms
Argument Summary:
- ⟨label⟩ The text to appear next to the interactive element.
- ⟨field⟩ The interactive element.
Lays out the label and associated text field. This just defaults to ⟨label⟩ ⟨field⟩. § 11.2 ⁑Electronic PDF Forms
Argument Summary:
- ⟨label⟩ The text to appear next to the interactive element.
- ⟨field⟩ The interactive element.
Length register used by list environments to store the left margin
width. The value is typically
set in the ⟨list declarations⟩ argument of the list
environment. § 6.5.1.1 ⁂Delving Deeper
May be used to specify a length instead of a value that's in terms
of \unitlength for use within the picture
environment. § 10.3 ⁑The leaflet Class
Argument Summary:
- ⟨length⟩ The required length.
\let⟨new cs⟩⟨org cs⟩
Gives ⟨new cs⟩ the same meaning as ⟨org cs⟩. For example
if I define:
\newcommand{ and then
\mycmd}{stuff}\let\mynewcmd\mycmd is like doing
\newcommand{, but no
existence check is performed. If I then
redefine \mynewcmd}{stuff}\mycmd, \mynewcmd still retains the old
definition of \mycmd. Since there's no check to see if the
new command is already defined, care is required to prevent
accidentally overwriting a preexisting command. (The arguments
⟨new cs⟩ and ⟨org cs⟩ don't actually have to be control
sequences. They can be any tokens, but that's beyond the scope of
this book.)
§ 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨new cs⟩ The new control sequence
- ⟨org cs⟩ The original control sequence
Analogous to \let except that the name of the
control sequence (without the initial backslash) is supplied
for the second argument. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cs-name⟩ The name of the new control sequence.
- ⟨cs⟩ The original control sequence.
Typesets its contents as correspondence. The KOMA-Script scrlttr2 class also allows an optional argument before the mandatory argument. § 3.1 ⁎Writing a Letter Using the letter Class
Argument Summary:
- ⟨addressee⟩ The recipient's name and address.
Creates a letter. § 3.4 ⁑Writing a Letter Using the isodoc Class
Argument Summary:
- ⟨recipient-options⟩ A key=value list of options.
- ⟨contents⟩ The letter contents.
Typesets lim function name (may have limits via _ or ^). § 9.3 ⁑The probsoln Package
For use within the argument of \put, this draws a straight line of
the given length whose horizontal and vertical extent (gradient
vector) is given by
(⟨h⟩,⟨v⟩). § 10.1 ⁑The picture Environment
Argument Summary:
- ⟨h⟩ The horizontal extent.
- ⟨v⟩ The vertical extent.
- ⟨length⟩ The length of the line (non-negative).
A TeX primitive that stores the interline glue. § 3.6 ⁑Envelopes
A length containing the desired current line width. This is
usually the width of the typeblock, but inside a minipage
or \parbox it will be the width the box. Note that
the actual contents of the line may fall short of the line width
(underfull hbox) or extend beyond it (overfull hbox). § 4.3 ⁂Building Your Own Invoice using longtable and
datatool
Produces dummy text for testing purposes. The optional argument specifies which paragraphs to display. (There are 250 predefined paragraphs). By default this command displays the first seven paragraphs, but this may be changed via the optional argument, which may be either a single number or a range. The starred version suppresses the paragraph breaks. § 6.4.2.1 ⁎The background Package
Argument Summary:
- ⟨selection⟩ Either a number, indicating a single paragraph, or a number range ⟨n⟩-⟨m⟩ indicating paragraphs ⟨n⟩ to ⟨m⟩, inclusive.
A generic list environment § 6.5.1.1 ⁂Delving Deeper
Argument Summary:
Appends the given ⟨item⟩ to the list control sequence ⟨list-cs⟩. A blank item is not added. No expansion is performed on the item. § 2.7.3 ⁑Iteration With etoolbox's Internal Lists
Argument Summary:
- ⟨list-cs⟩ The control sequence used to store the list.
- ⟨item⟩ The item to be added.
Similar to \listadd except the name (without the preceding
backslash) of the list control sequence is used. § 2.7.3 ⁑Iteration With etoolbox's Internal Lists
Argument Summary:
- ⟨list-csname⟩ The name of the control sequence used to store the list.
- ⟨item⟩ The item to be added.
Similar to \listeadd except the name (without the preceding
backslash) of the list control sequence is used. § 2.7.3 ⁑Iteration With etoolbox's Internal Lists
Argument Summary:
- ⟨list-csname⟩ The name of the control sequence used to store the list.
- ⟨item⟩ The item to be added.
As \listcsadd but the assignment is global. § 2.7.3 ⁑Iteration With etoolbox's Internal Lists
Argument Summary:
- ⟨list-csname⟩ The name of control sequence (without the leading backslash) used to store the list.
- ⟨item⟩ The item to be added.
As \listcseadd but the assignment is global. § 2.7.3 ⁑Iteration With etoolbox's Internal Lists
Argument Summary:
- ⟨list-csname⟩ The name of control sequence (without the leading backslash) used to store the list.
- ⟨item⟩ The item to be added.
Appends the expansion of ⟨item⟩ to the list control sequence ⟨list-cs⟩. A blank item is not added. § 2.7.3 ⁑Iteration With etoolbox's Internal Lists
Argument Summary:
- ⟨list-cs⟩ The control sequence used to store the list.
- ⟨item⟩ The item to be added.
As \listadd but the assignment is global. § 2.7.3 ⁑Iteration With etoolbox's Internal Lists
Argument Summary:
- ⟨list-cs⟩ The control sequence used to store the list.
- ⟨item⟩ The item to be added.
Print a list or summary of the changes. At least two LaTeX runs are required to make the list appear. § 13.1 ⁑Change Markup
Argument Summary:
- ⟨options⟩ A key=value list of options.
Displays a list of decisions. § 6.3.2 ⁑The minutes Package
Inserts the list of figures. A second (possibly third) run is required to ensure the page numbering is correct. § 13.1 ⁑Change Markup
Inserts the list of tables. A second (possibly third) run is required to ensure the page numbering is correct. § 6.3.2 ⁑The minutes Package
As \listeadd but the assignment is global. § 2.7.3 ⁑Iteration With etoolbox's Internal Lists
Argument Summary:
- ⟨list-cs⟩ The control sequence used to store the list.
- ⟨item⟩ The item to be added.
Places ⟨text⟩ to the left of the reference point without taking up any space. § 11.1 ⁂Writing a Class File for a Form
Argument Summary:
- ⟨text⟩ The text to be placed by the reference point.
Loads all problems defined in ⟨filename⟩ and appends them to the specified data set in the order in which they are defined in the file. § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨dataset⟩ The label identifying the required probsoln data set.
- ⟨filename⟩ The name of the .tex file where the problems are defined.
Used in class files to load another class. § 11.1 ⁂Writing a Class File for a Form
Argument Summary:
- ⟨options⟩ Options to pass to the required class.
- ⟨name⟩ The class name.
- ⟨version⟩ If this argument is present, the required class must be at least this version. The version date must be in the numeric format ⟨yyyy⟩/⟨mm⟩/⟨dd⟩
Loads the problems defined in the given filename except those listed in ⟨exception list⟩ and adds them to the given dataset. § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨dataset⟩ The name of the dataset. If omitted, the default dataset is used.
- ⟨exception-list⟩ The comma-separated list of labels identifying the problems to be excluded.
- ⟨filename⟩ The name of the file.
Loads ⟨n⟩ randomly selected problems defined in the given filename excluding those listed in ⟨exception list⟩ and adds them to the given dataset. § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨dataset⟩ The name of the dataset. If omitted, the default dataset is used.
- ⟨n⟩ The number of problems to select.
- ⟨filename⟩ The name of the file.
- ⟨exception-list⟩ The comma-separated list of labels identifying the problems to be excluded from the selection.
Loads ⟨n⟩ randomly selected problems defined in the given filename and adds them to the given dataset. § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨dataset⟩ The name of the dataset. If omitted, the default dataset is used.
- ⟨n⟩ The number of problems to select.
- ⟨filename⟩ The name of the file.
Loads the listed problems defined in the given filename and adds them to the given dataset. § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨dataset⟩ The name of the dataset. If omitted, the default dataset is used.
- ⟨labels⟩ The comma-separated list of labels identifying the required problems.
- ⟨filename⟩ The name of the file.
Specifies the sender's additional location information. § 3.1 ⁎Writing a Letter Using the letter Class
Argument Summary:
- ⟨text⟩ The additional information.
Specifies the location of the meeting. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨place⟩ The meeting location.
\long⟨assignment⟩
An assignment prefix that indicates the following assignment
(such as \def) should define a long command. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨assignment⟩ The assignment being prefixed.
Like a combination of the table and tabular environments, except it can span multiple pages. § 2.6 ⁑Displaying Tabulated Data
Argument Summary:
- ⟨horizontal alignment⟩ A single letter (l, c or r) indicating the horizontal alignment of the table. (The default is c.)
- ⟨column specifiers⟩ Indicates how to align the columns.
Repeats code while the given condition is true. § 2.7.4 ⁂General Iteration with TeX's \loop
Argument Summary:
- ⟨code⟩ The code to repeat while
\if…is true.
Reads in ⟨filename⟩ and typesets the contents as displayed code. § 9.4 ⁂Using the datatool Package for Exams or Assignment Sheets
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨filename⟩ The name of the file to input.
Typesets the contents of the environment as displayed code. § 8. ⁎Presentations (The beamer Class)
Argument Summary:
- ⟨options⟩ A key=value list of ⟨key⟩=⟨value⟩ options.
Changes the category code of the at character (@) to
“letter” so that it can be used in control sequence names.
See also \makeatother. § 2.1.1 ⁂Macro Definitions
Changes the category code of the at character (@) to
“other”. This means that it can no longer be used in control
sequence names. See also \makeatletter. § 2.1.1 ⁂Macro Definitions
Puts ⟨text⟩ in a box, prohibiting a line break in the contents. § 9.1 ⁑The exam Class
Argument Summary:
- ⟨width⟩ The width of the box. (If omitted, this value is the natural width of the box contents.)
- ⟨align⟩ Horizontal alignment of box contents (c if omitted).
- ⟨text⟩ The contents of the box.
picture environment.
Creates a box picture object without a frame. § 10.1 ⁑The picture Environment
Argument Summary:
- ⟨w⟩ The width of the box.
- ⟨h⟩ The height of the box.
- ⟨align⟩ The alignment of the text. This may be one or two letters that specify the alignment. The letters may be one of: l (left), r (right), t (top) or b (bottom). If omitted, the default centres the text horizontally and vertically.
The format for push button labels. § 11.2 ⁑Electronic PDF Forms
Argument Summary:
- ⟨text⟩ The push button text.
The display for check fields. § 11.2 ⁑Electronic PDF Forms
Argument Summary:
- ⟨width⟩ The width of the field.
- ⟨height⟩ The height of the field.
The display for choice fields. § 11.2 ⁑Electronic PDF Forms
Argument Summary:
- ⟨width⟩ The width of the field.
- ⟨height⟩ The height of the field.
Switches on the label-generating function. § 3.6 ⁑Envelopes
The display for radio fields. § 11.2 ⁑Electronic PDF Forms
Argument Summary:
- ⟨width⟩ The width of the field.
- ⟨height⟩ The height of the field.
The display for text fields. § 11.2 ⁑Electronic PDF Forms
Argument Summary:
- ⟨width⟩ The width of the field.
- ⟨height⟩ The height of the field.
Generates the title page (or title block). This command is usually placed at the beginning of the document environment. § 5.1 ⁎The currvita Package
\MakeUppercase{⟨text⟩}
Converts its argument to upper case. § 3.6 ⁑Envelopes
Argument Summary:
- ⟨text⟩ The text to be converted.
Puts ⟨text⟩ in the margin. If the document provides left and right margins (for example, a two-sided document) ⟨left⟩ indicates the text to use if the margin is on the left and ⟨text⟩ indicates the text to use if the margin is on the right. § 6.5.2 ⁂Non-Hierarchical Paragraph Numbering
Argument Summary:
- ⟨left⟩ The text to use if the margin is on the left.
- ⟨text⟩ The text to use if the margin is on the right.
Ensures that the given text doesn't contain a line break. § 7.5 ⁂Displaying a Calendar
Inserts a medium-sized vertical space. The size is given by
the length \medskipamount. § 12.3.1 ⁑The bchart Package
Horizontal rule to go below headings row of a tabular environment. § 2.6 ⁑Displaying Tabulated Data
Argument Summary:
- ⟨wd⟩ Thickness of the rule (dimension).
Makes a box with line-wrapped contents. (See also \parbox.) § 3.6 ⁑Envelopes
Argument Summary:
- ⟨pos⟩ The vertical alignment of the box relative to the surrounding text. (Centred if omitted.)
- ⟨height⟩ The height of the box. (If omitted the height is the natural height of the contents of the box.)
- ⟨width⟩ The width of the box.
Contains the minutes from a meeting. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨title⟩ The title of the minutes.
Specifies the date of the meeting. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨date⟩ The date of the meeting.
Specifies the name of the minute taker. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨name⟩ The minute taker's name.
Evaluates to true if the given file doesn't exist. The argument ⟨ref⟩ may either be
a string "⟨extension⟩" which indicates the file extension
or a file reference toFile("⟨filename⟩"). § 1.2 ⁑Arara
Argument Summary:
- ⟨ref⟩ The file extension or a file reference.
List of absentees. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨excused-names⟩ The names of absentees who excused themselves.
- ⟨no-excuse names⟩ The names of absentees who didn't excuse themselves.
List of absentees who gave an excuse. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨names⟩ The list of absentee names.
List of absentees who didn't give an excuse. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨names⟩ The list of absentee names.
Manually creates an address label. § 3.6 ⁑Envelopes
Argument Summary:
- ⟨from-address⟩ Sender's address
- ⟨to-address⟩ Recipient's address
Specifies the name of the meeting moderator. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨name⟩ The moderator's name.
The current month number. § 7.2 ⁂The pgfcalendar Package Utility Commands
Spans multiple columns in a tabular-style environment. See Volume 1. § 2.7.1 ⁑Iterating Through a Database
Argument Summary:
- ⟨cols-spanned⟩ The number of columns to span.
- ⟨col-specifier⟩ The alignment of this column-spanning entry.
- ⟨text⟩ The contents of this column-spanning entry.
\multiply⟨register⟩ by ⟨value⟩
Multiplies the value stored in ⟨register⟩ by ⟨value⟩. The by keyword may be omitted. § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨register⟩ The TeX register whose value needs incrementing.
- ⟨value⟩ The factor.
For use in the picture environment, this puts
⟨n⟩ copies of ⟨object⟩, starting at position
(⟨x⟩,⟨y⟩) and advancing the position by
(⟨inc-x⟩,⟨inc-y⟩) each time. § 10.1 ⁑The picture Environment
Argument Summary:
- ⟨x⟩ The x-coordinate of the initial position.
- ⟨y⟩ The y-coordinate of the initial position.
- ⟨inc-x⟩ The x-increment.
- ⟨inc-y⟩ The y-increment.
- ⟨n⟩ The number of copies.
- ⟨object⟩ The object to put at each location.
Specifies the sender's name. § 3.1 ⁎Writing a Letter Using the letter Class
Argument Summary:
- ⟨text⟩ The sender's name.
Specifies the sender's name. § 3.3 ⁑Writing a Letter Using the newlfm Class
Argument Summary:
- ⟨name⟩ The sender's name.
Specifies the recipient's name. § 3.3 ⁑Writing a Letter Using the newlfm Class
Argument Summary:
- ⟨name⟩ The recipient's name.
This should be the first statement of any class or package identifying the required TeX format. For a LaTeX2e class or package this should be LaTeX2e. (Other formats may not define this command.) § 7.3 ⁂Displaying a Date
Argument Summary:
- ⟨format⟩ The required format.
- ⟨version⟩ If this argument is present, the format must be at least this version. The version date must be in the numeric format ⟨yyyy⟩/⟨mm⟩/⟨dd⟩
Defines a new boolean flag called ⟨name⟩. § 9.4 ⁂Using the datatool Package for Exams or Assignment Sheets
Argument Summary:
- ⟨name⟩ The name of the new boolean variable.
Defines a new boolean variable. § 9.4 ⁂Using the datatool Package for Exams or Assignment Sheets
Argument Summary:
- ⟨name⟩ The name of the new boolean variable.
Defines a new command. (See Volume 1.) § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cmd⟩ The new command name (including initial backslash).
- ⟨n-args⟩ The number of arguments this new command should have.
- ⟨default⟩ If the first argument should be optional, the default value if omitted.
- ⟨text⟩ What actions the command should perform.
\newcount⟨cs⟩
Defines a new count register. (Note to be confused with the
LaTeX \newcounter command.) § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨cs⟩ The control sequence that can be used to identify the new count register.
\newcounter{⟨counter⟩}[⟨outer-counter⟩]
Defines a new counter (see Volume 1). § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨counter⟩ The name of the new counter.
- ⟨outer-counter⟩ The name of the parent counter.
Defines a new dynamic frame. The starred version adds a rectangular border to the frame. § 10.5 ⁂The flowfram Package and the flowframtk Application
Argument Summary:
- ⟨page-list⟩ The list of pages for which this frame is defined.
- ⟨width⟩ The width of the frame.
- ⟨height⟩ The height of the frame.
- ⟨x⟩ The x-coordinate of the bottom left-hand corner of the frame relative to the typeblock.
- ⟨y⟩ The y-coordinate of the bottom left-hand corner of the frame relative to the typeblock.
- ⟨label⟩ A label uniquely identifying this frame.
Defines a new environment. § 11.1 ⁂Writing a Class File for a Form
Argument Summary:
- ⟨env-name⟩ The new environment name (no backslash).
- ⟨n-args⟩ The number of arguments this new environment should have.
- ⟨default⟩ If the first argument should be optional, the default value if omitted.
- ⟨begin-code⟩ Actions to perform at the start of the environment.
- ⟨end-code⟩ Actions to perform at the end of the environment.
Defines a new flow frame. The starred version adds a rectangular border to the frame. § 10.5 ⁂The flowfram Package and the flowframtk Application
Argument Summary:
- ⟨page-list⟩ The list of pages for which this frame is defined.
- ⟨width⟩ The width of the frame.
- ⟨height⟩ The height of the frame.
- ⟨x⟩ The x-coordinate of the bottom left-hand corner of the frame relative to the typeblock.
- ⟨y⟩ The y-coordinate of the bottom left-hand corner of the frame relative to the typeblock.
- ⟨label⟩ A label uniquely identifying this frame.
\newglossaryentry{⟨label⟩}{⟨key-val list⟩}
Defines a new glossary entry or term. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨label⟩ A unique label identifying this entry.
- ⟨key-val list⟩ A key=value list that define this entry.
\newlength⟨length cs⟩
Defines a new length register called ⟨length cs⟩. § 6.5.1.1 ⁂Delving Deeper
Argument Summary:
- ⟨length cs⟩ The name (including initial backslash) of the new register.
The body of the letter, fax or memo. § 3.3 ⁑Writing a Letter Using the newlfm Class
Sets the given options. § 3.3 ⁑Writing a Letter Using the newlfm Class
Argument Summary:
- ⟨option list⟩ A comma-separated list of options
Forces a line break. § 5.2.1 ⁎Setting Personal Information
Forces a page break leaving a ragged bottom. § 10.3 ⁑The leaflet Class
A shortcut that defines a problem with an associated solution
using the defproblem, onlysolution
and solution environments. § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨n⟩ The number of arguments (default: 0).
- ⟨default-args⟩ The default arguments.
- ⟨label⟩ The label uniquely identifying this problem.
- ⟨problem⟩ The problem or question.
- ⟨solution⟩ The solution.
A shortcut that defines a problem
using the defproblem environment. § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨n⟩ The number of arguments (default: 0).
- ⟨default-args⟩ The default arguments.
- ⟨label⟩ The label uniquely identifying this problem.
- ⟨problem⟩ The problem or question.
Defines a new static frame. The starred version adds a rectangular border to the frame. § 10.5 ⁂The flowfram Package and the flowframtk Application
Argument Summary:
- ⟨page-list⟩ The list of pages for which this frame is defined.
- ⟨width⟩ The width of the frame.
- ⟨height⟩ The height of the frame.
- ⟨x⟩ The x-coordinate of the bottom left-hand corner of the frame relative to the typeblock.
- ⟨y⟩ The y-coordinate of the bottom left-hand corner of the frame relative to the typeblock.
- ⟨label⟩ A label uniquely identifying this frame.
Specifies a watermark. § 6.4.2.2 ⁑The xwatermark Package
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨mark⟩ The text of the watermark.
Displays the next meeting date and time. § 6.3.1 ⁑The meetingmins Class
Argument Summary:
- ⟨date and time⟩ The date and time of the next meeting.
Disable the point-totalling commands. § 9.1 ⁑The exam Class
Indicates the background shouldn't be displayed on the current page. (For use with the all pages option.) § 6.4.2.1 ⁎The background Package
Analogous to \bibliography, this command writes the
information to the .aux file that's required by BibTeX but
doesn't display anything in the document. Individual bibliography entries can
then be displayed using \bibentry. § 5.2.2 ⁑Sections and Publication Lists
Argument Summary:
- ⟨bib-list⟩ A comma-separated list of database names (without the .bib extension).
Like \cite except that it doesn't produce any text.
The ⟨key list⟩ may be just an asterisk * to indicated
that all citations in the .bib file (or files) should be
included in the bibliography. § 5.1 ⁎The currvita Package
Argument Summary:
- ⟨key list⟩ A comma-separated list of keys identifying the citations or just an asterisk to indicate all citations.
Node specification, for use within the tikzpicture environment. § 7.5 ⁂Displaying a Calendar
Argument Summary:
- ⟨options⟩ Node options.
- ⟨label⟩ Node label.
- ⟨text⟩ Node text.
For use within the contents of a split node, this moves from the current split to the split identified by ⟨part⟩. § 7.5 ⁂Displaying a Calendar
Argument Summary:
- ⟨part⟩ The split part.
\noexpand⟨token⟩
Prevents ⟨token⟩ from being expanded in an expandable context. § 2.1.2 ⁂Hook Management
Argument Summary:
- ⟨token⟩ The token that shouldn't be expanded
Suppress the indentation that would usually occur at the start of the next paragraph. § 9.3 ⁑The probsoln Package
Disable (don't show) the solutions. § 9.1 ⁑The exam Class
Switches to normal sized text. § 10.3 ⁑The leaflet Class
\number⟨num⟩
Displays the decimal value of ⟨num⟩. (Any redundant leading zeros are stripped.) § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨num⟩ The number to display.
\numexpr⟨integer expression⟩
Expands to the value given by the integer expression. § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨integer expression⟩ An integer expression involving + (addition) - (subtraction) * (multiplication) and / (division). Parentheses may also be used.
The number of parts. § 9.1 ⁑The exam Class
The total number of points. § 9.1 ⁑The exam Class
The number of questions. § 9.1 ⁑The exam Class
The number of sub-parts. § 9.1 ⁑The exam Class
The number of sub-sub-parts. § 9.1 ⁑The exam Class
A length containing the horizontal offset for odd pages. See
\hoffset. § 11. ⁑Forms
Issues a page break and switches to one column mode. § 10.5 ⁂The flowfram Package and the flowframtk Application
Checkbox choices are listed inline. Items are specified via
\choice. § 9.1 ⁑The exam Class
Labelled choices are listed inline. Items are specified via
\choice. § 9.1 ⁑The exam Class
Only displays its contents if the showanswers boolean flag is off. § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨option⟩ The option may be the
fragileboolean key
Only displays its contents if the showanswers boolean flag is on. § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨option⟩ The option may be the
fragileboolean key
letter environment.Typesets the salutation at the start of the letter. § 3.1 ⁎Writing a Letter Using the letter Class
Argument Summary:
- ⟨salutation⟩ The greeting at the start of the letter, such as “Dear Dr Smith”.
Indicates a discussion on an opinion. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨main⟩ The main opinion held.
- ⟨differing⟩ The differing opinion.
A list like environment to format opinions. § 6.3.2 ⁑The minutes Package
For use in the argument of \put, this command
draws an oval of the given width and height. The optional
argument indicates to only draw a quarter or half oval. § 10.1 ⁑The picture Environment
Argument Summary:
- ⟨w⟩ The width of the oval.
- ⟨h⟩ The height of the oval.
- ⟨segment⟩ One or two letters from: l (left), r (right), t (top) or b (bottom), indicating the half or quarter. If omitted, the whole oval is drawn.
Prefixed used when cross-referencing the enumi counter. § 6.5.1 ⁑Hierarchical Paragraph Numbering
Prefixed used when cross-referencing the enumii counter. § 6.5.1 ⁑Hierarchical Paragraph Numbering
Prefixed used when cross-referencing the enumiii counter. § 6.5.1 ⁑Hierarchical Paragraph Numbering
Prefixed used when cross-referencing the enumiv counter. § 6.5.1 ⁑Hierarchical Paragraph Numbering
\pagestyle{⟨style⟩}
Sets the style of the headers and footers. § 10.1 ⁑The picture Environment
Argument Summary:
A length containing the total height of the page. See also
\textheight. § 10.3 ⁑The leaflet Class
A length containing the total width of the page. See also
\textwidth. § 10.3 ⁑The leaflet Class
Insert a paragraph break. Usually just a blank line in the source
code is used instead of \par. This command is
typically only used within command or environment definitions or
when it's important to remind authors that a paragraph break is
required at a certain point where a blank line may appear
accidental or may be overlooked. (For example, in
{ it's a reminder that there must be
a paragraph break before the closing } to ensure
the \centering Some
centred text.\par}\centering declaration has an effect.) § 1. ⁎Introduction
\paragraph[⟨short-title⟩]{⟨title⟩}
Inserts a subsubsubsection header. Most classes default to an unnumbered running header for this sectional unit. § 6.5.2 ⁂Non-Hierarchical Paragraph Numbering
Argument Summary:
- ⟨short-title⟩ An abbreviated form of the title to go in the table of contents or the page header.
- ⟨title⟩ The title.
Makes a box with line-wrapped contents. (More restrictive than
minipage.) § 7.5 ⁂Displaying a Calendar
Argument Summary:
- ⟨pos⟩ The vertical alignment of the box relative to the surrounding text. (Centred if omitted.)
- ⟨height⟩ The height of the box. (If omitted the height is the natural height of the contents of the box.)
- ⟨width⟩ The width of the box.
- ⟨text⟩ The contents of the box.
A length register that stores the indentation at the start of paragraphs. § 2.1.3 ⁂Arithmetic
Creates a shaped paragraph. § 10.5 ⁂The flowfram Package and the flowframtk Application
Argument Summary:
- ⟨n⟩ Number of lines
- ⟨i1⟩ Left indent of the first line.
- ⟨l1⟩ Width of the first line.
- ⟨in⟩ Left indent of the nth line.
- ⟨ln⟩ Width of the nth line.
Inside the parts environment, this command starts a new numbered question part, with optionally the number of
points the part is worth. Outside the parts
environment this command works as a standard sectioning command. § 9.1 ⁑The exam Class
Argument Summary:
- ⟨points⟩ The number of points.
Inserts a part sectional unit. § 9.1 ⁑The exam Class
Argument Summary:
- ⟨short-title⟩ An abbreviated form of the title to go in the table of contents or the page header.
- ⟨title⟩ The title.
Specifies the names of the people present. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨names⟩ The list of names.
Contains all the question parts. § 9.1 ⁑The exam Class
Passes the given options to the given class. (Must be used before the class is loaded.) § 11.1 ⁂Writing a Class File for a Form
Argument Summary:
- ⟨option-list⟩ A comma-separated list of options to pass to the class.
- ⟨class⟩ The class name.
\path ⟨specification⟩;
For use within the tikzpicture environment. § 7.5 ⁂Displaying a Calendar
Argument Summary:
- ⟨specification⟩ A stream of path operations indicating how the path should be built.
The date and time at the start of the current TeX run. This expands to D:⟨YYYY⟩⟨MM⟩⟨DD⟩⟨hh⟩⟨mm⟩⟨ss⟩⟨time zone⟩. This primitive is also available with LuaTeX but not XeTeX. § 7.4 ⁂Parsing and Displaying Times
The modification date and time of the file ⟨filename⟩.
This expands to
D:⟨YYYY⟩⟨MM⟩⟨DD⟩⟨hh⟩⟨mm⟩⟨ss⟩⟨time
zone⟩. Unlike \pdfcreationdate, this primitive isn't
provided by LuaTeX. § 7.4 ⁂Parsing and Displaying Times
Argument Summary:
- ⟨filename⟩ The name of the file whose modification date and time is required.
A for loop that iterates from ⟨start-date⟩ to ⟨end-date⟩ and performs ⟨code⟩ at each iteration. § 7.5 ⁂Displaying a Calendar
Argument Summary:
- ⟨prefix⟩ A prefix that can be used when
constructing names for nodes within the calendar, if this
command is used within a
tikzpictureenvironment. - ⟨start-date⟩ The starting date.
- ⟨end-date⟩ The end date;
- ⟨code⟩ The code to perform at each iteration.
For use within the ⟨code⟩ part of \pgfcalendar.
The ⟨start-date⟩ parameter in ISO format. § 7.5 ⁂Displaying a Calendar
For use within the ⟨code⟩ part of \pgfcalendar.
The ⟨start-date⟩ parameter converted to a Julian day number. § 7.5 ⁂Displaying a Calendar
For use within the ⟨code⟩ part of \pgfcalendar.
This expands to the day of the month for the current iteration. § 7.5 ⁂Displaying a Calendar
For use within the ⟨code⟩ part of \pgfcalendar.
This is a TeX count register that holds the Julian day number
for the current iteration. § 7.5 ⁂Displaying a Calendar
For use within the ⟨code⟩ part of \pgfcalendar.
This expands to the month for the current iteration. § 7.5 ⁂Displaying a Calendar
For use within the ⟨code⟩ part of \pgfcalendar.
This expands to the week day number for
the current iteration (0 for Monday, 1 for Tuesday, etc). § 7.5 ⁂Displaying a Calendar
For use within the ⟨code⟩ part of \pgfcalendar.
This expands to the year for the current iteration. § 7.5 ⁂Displaying a Calendar
Converts the specified date into a Julian day number and stores the result in the given register. § 7.2 ⁂The pgfcalendar Package Utility Commands
Argument Summary:
- ⟨date⟩ The date specified in the form ⟨year⟩-⟨month-number⟩-⟨day⟩+⟨increment⟩ where +⟨increment⟩ may be omitted and ⟨day⟩ may be the keyword last.
- ⟨register⟩ The register in which to store the result.
For use within the ⟨code⟩ part of \pgfcalendar.
The ⟨end-date⟩ parameter in ISO format. § 7.5 ⁂Displaying a Calendar
For use within the ⟨code⟩ part of \pgfcalendar.
The ⟨end-date⟩ parameter converted to a Julian day number. § 7.5 ⁂Displaying a Calendar
Tests the specified date and does ⟨true-part⟩ if the test succeeds otherwise it does ⟨false-part⟩. § 7.2 ⁂The pgfcalendar Package Utility Commands
Argument Summary:
- ⟨date⟩ The date being tested.
- ⟨test⟩ The test (either just a keyword or in the form ⟨keyword⟩=⟨value⟩).
- ⟨true-part⟩ The code to perform if the test is true.
- ⟨false-part⟩ The code to perform if the test is false.
Converts a Julian day number into an ISO-date. The resulting numbers are stored in the ⟨year-cs⟩, ⟨month-cs⟩ and ⟨day-cs⟩ control sequences. § 7.2 ⁂The pgfcalendar Package Utility Commands
Argument Summary:
- ⟨Julian-day⟩ The Julian day number.
- ⟨year-cs⟩ A control sequence in which to store the year.
- ⟨month-cs⟩ A control sequence in which to store the month number.
- ⟨day-cs⟩ A control sequence in which to store the day of the month.
Converts a Julian day number into a week day number (0 for Monday, 1 for Tuesday, etc). The resulting number is stored in the given register. § 7.2 ⁂The pgfcalendar Package Utility Commands
Argument Summary:
- ⟨Julian-day⟩ The Julian day number.
- ⟨register⟩ A TeX count register in which to store the result.
Expands to a textual representation of the month. § 7.3 ⁂Displaying a Date
Argument Summary:
- ⟨month-number⟩ The number representing the month.
Expands to an abbreviated textual representation of the month. § 7.3 ⁂Displaying a Date
Argument Summary:
- ⟨month-number⟩ The number representing the month.
For use within the ⟨code⟩ part of \pgfcalendar.
The ⟨prefix⟩ parameter. § 7.5 ⁂Displaying a Calendar
For use within the ⟨code⟩ part of \pgfcalendar.
Expands to a representation of the current day, month, year or day
of week. § 7.5 ⁂Displaying a Calendar
Argument Summary:
- ⟨kind⟩ May be one of: d (day of month), m (month), y (year) or w (day of the week).
- ⟨representation⟩ May be one of: - (numerical with no leading zeros), = (numerical with a leading space for single digits, 0 (numerical with a leading zero for single digits), t (textual representation) or . (abbreviated textual representation).
For use within the ⟨code⟩ part of \pgfcalendar.
If the ⟨prefix⟩ parameter is empty, this command expands
to empty otherwise it expands to
⟨prefix⟩-⟨YYYY⟩-⟨MM⟩-⟨DD⟩,
where ⟨YYYY⟩ is the current year, ⟨MM⟩ is the current
month and ⟨DD⟩ is the current day of the month. § 7.5 ⁂Displaying a Calendar
Expands to a textual representation of the day of week. § 7.3 ⁂Displaying a Date
Argument Summary:
- ⟨week day number⟩ The number representing the day of the week (0 is Monday, 1 is Tuesday, etc).
Expands to an abbreviated textual representation of the day of week. § 7.3 ⁂Displaying a Date
Argument Summary:
- ⟨week day number⟩ The number representing the day of the week (0 is Monday, 1 is Tuesday, etc).
Sets the options related to the pgf package and any related packages that use pgf's option interface. § 12.5 ⁑Plots
Argument Summary:
- ⟨options⟩ A key=value list of options.
Defines a list that can have items randomly selected from it
(using \pgfmathrandomitem). § 9.5 ⁂Random Numbers
Argument Summary:
- ⟨list-name⟩ The name of the list.
- ⟨item1⟩ The first item in the list.
- ⟨item2⟩ The second item in the list etc.
Parses the given mathematical expression and stores the result in
\pgfmathresult. § 9.5 ⁂Random Numbers
Argument Summary:
- ⟨expression⟩ The expression to parse.
Pretty-prints the given number. § 12.5 ⁑Plots
Argument Summary:
- ⟨number⟩ The number to display.
Defines the control sequence ⟨cs⟩ to be a pseudo-randomly generated number between ⟨minimum⟩ and ⟨maximum⟩ (inclusive). § 9.5 ⁂Random Numbers
Argument Summary:
- ⟨cs⟩ The control sequence in which to store the result.
- ⟨minimum⟩ The minimum value.
- ⟨maximum⟩ The maximum value.
Randomly select an item from the given list, which should have
previously been declared using \pgfmathdeclarerandomlist. § 9.5 ⁂Random Numbers
Argument Summary:
- ⟨cs⟩ A control sequence which can be used to access the randomly selected item.
- ⟨list-name⟩ The name of the list.
Sets the seed for the random number generator. § 9.5 ⁂Random Numbers
Argument Summary:
- ⟨n⟩ The seed.
Sets the options governing plot styles. § 12.5 ⁑Plots
Argument Summary:
- ⟨options⟩ A key=value list of options.
Specifies the sender's phone number. § 3.3 ⁑Writing a Letter Using the newlfm Class
Argument Summary:
- ⟨text⟩ The sender's phone number.
An environment that produces a box with the given dimensions
(specified in terms of \unitlength). The second argument
⟨llx,lly⟩ is optional and specifies the co-ordinates of
the lower left corner, (0,0) if omitted. The contents of
the environment should consist of commands such as \put
that puts text or lines in the box. § 10. ⁑Business Cards, Flyers and Leaflets
Argument Summary:
- ⟨width⟩ The width of the box.
- ⟨height⟩ The height of the box.
- ⟨llx⟩ The x-coordinate of the lower left corner of the box.
- ⟨lly⟩ The y-coordinate of the lower left corner of the box.
For use within the tikzpicture environment.
Draws a pie chart. § 12.2.2 ⁑The pgf-pie Package
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨list⟩ A comma-separated list of values in the form ⟨number⟩/⟨text⟩
Displays the number of points. The starred version omits the unit. § 9.2 ⁑The exsheets Package
Argument Summary:
- ⟨n⟩ The number of points to display.
Switches off the automatic point placement. (Used with
\droppoints.) § 9.1 ⁑The exam Class
Puts the points in the left margin. § 9.1 ⁑The exam Class
Puts the points in the left margin. § 9.1 ⁑The exam Class
Displays the total number of points, excluding bonus points. (Requires two LaTeX runs to ensure it's up to date.) The starred version omits the unit. § 9.2 ⁑The exsheets Package
Displays additional information that doesn't form part of the minutes. § 6.3.2 ⁑The minutes Package
Displays additional information that doesn't form part of the minutes. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨text⟩ The additional information.
Pound £ symbol. This robust command may be used in math or text mode. § 2.2.1 ⁑Loading Data From a CSV File
Specifies the PPS line. § 3.3 ⁑Writing a Letter Using the newlfm Class
Argument Summary:
- ⟨text⟩ The PPS text
Specifies the company's address. § 6.2 ⁎Press Releases
Argument Summary:
- ⟨address⟩ The company's address.
Specifies the company's name. § 6.2 ⁎Press Releases
Argument Summary:
- ⟨name⟩ The company's name.
Specifies the department's name. § 6.2 ⁎Press Releases
Argument Summary:
- ⟨name⟩ The company's name.
Specifies the company's email address. § 6.2 ⁎Press Releases
Argument Summary:
- ⟨address⟩ The company's email address.
Creates a press release. § 6.2 ⁎Press Releases
Prepends ⟨code⟩ to the definition of the control sequence
⟨cs⟩. Use \gpreto for a global assignment. § 2.1.2 ⁂Hook Management
Argument Summary:
- ⟨cs⟩ The control sequence to modify
- ⟨code⟩ The code to prepend
Specifies the company's fax number. § 6.2 ⁎Press Releases
Argument Summary:
- ⟨number⟩ The company's fax number.
Specifies the headline. § 6.2 ⁎Press Releases
Argument Summary:
- ⟨text⟩ The headline text.
Specifies the company's opening hours. § 6.2 ⁎Press Releases
Argument Summary:
- ⟨times⟩ The company's opening hours.
Used internally to typeset the recipient's address. § 3.6 ⁑Envelopes
Argument Summary:
- ⟨address⟩ The recipient's address
Enable (show) the solutions. § 9.1 ⁑The exam Class
Used internally to typeset the big labels. § 3.6 ⁑Envelopes
Argument Summary:
- ⟨from-address⟩ the sender's address
- ⟨to-address⟩ the recipient's address
Used internally to typeset the sender's address. § 3.6 ⁑Envelopes
Argument Summary:
- ⟨address⟩ The sender's address
Prints all the solutions. § 9.2 ⁑The exsheets Package
Argument Summary:
- ⟨settings⟩ A key=value list of options.
Displays the text “The minutes of the previous meeting were approved”. § 6.3.1 ⁑The meetingmins Class
Specifies the company's location. § 6.2 ⁎Press Releases
Argument Summary:
- ⟨location⟩ The company's location.
Specifies the code to use to produce the logo. Typically, this
will usually just involve the \includegraphics command. § 6.2 ⁎Press Releases
Argument Summary:
- ⟨code⟩ The logo code.
Specifies the company's mobile phone number. § 6.2 ⁎Press Releases
Argument Summary:
- ⟨number⟩ The company's mobile phone number.
For use within the Argumentation environment,
this indicates the start of an important item in favour of the argument. § 6.3.2 ⁑The minutes Package
For use within the Argumentation environment,
this indicates the start of an item in favour of the argument. § 6.3.2 ⁑The minutes Package
Stores the extension of the temporary file used by probsoln to work with verbatim code. (Defaults to vrb.) § 9.3 ⁑The probsoln Package
Stores the basename of the temporary file used by probsoln
to work with verbatim code. (Defaults to \jobname.) § 9.3 ⁑The probsoln Package
Process all the declare options. § 11.1 ⁂Writing a Class File for a Form
For use within the invoice environment, this command
is used to specify the project title. § 4.2 ⁑Writing an Invoice Using the invoice Package
Argument Summary:
- ⟨title⟩ The project title.
An environment for typesetting proofs. § 8. ⁎Presentations (The beamer Class)
Argument Summary:
- ⟨proof name⟩ The block title.
\protect⟨command⟩
Used in a moving argument to prevent a fragile command from expanding. § 9.4 ⁂Using the datatool Package for Exams or Assignment Sheets
Argument Summary:
- ⟨command⟩ The fragile command that needs protecting.
Similar to \protected@edef but the name of the control
sequence (without the leading backslash) is used. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cs-name⟩ The name of the new command being defined.
- ⟨arg-syntax⟩ The command syntax where each parameter is referenced using #⟨n⟩ in order
- ⟨definition⟩ The command definition.
Similar to \protected@xdef but the name of the control
sequence (without the leading backslash) is used. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cs-name⟩ The name of the new command being defined.
- ⟨arg-syntax⟩ The command syntax where each parameter is referenced using #⟨n⟩ in order
- ⟨definition⟩ The command definition.
Similar to \edef but a protected expansion is performed on
⟨definition⟩. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cs⟩ The new command being defined.
- ⟨arg-syntax⟩ The command syntax where each parameter is referenced using #⟨n⟩ in order
- ⟨definition⟩ The command definition.
Writes ⟨text⟩ to the file identified by ⟨output stream⟩. § 9.4 ⁂Using the datatool Package for Exams or Assignment Sheets
Argument Summary:
- ⟨output-stream⟩ The output stream to write to.
- ⟨init-code⟩ Initialisation code.
- ⟨text⟩ The text to write to the file.
Similar to \xdef but a protected expansion is performed on
⟨definition⟩. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cs⟩ The new command being defined.
- ⟨arg-syntax⟩ The command syntax where each parameter is referenced using #⟨n⟩ in order
- ⟨definition⟩ The command definition.
Defines the command only if it doesn't already exist. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cmd⟩ The new command name (including initial backslash).
- ⟨n-args⟩ The number of arguments this new command should have.
- ⟨default⟩ If the first argument should be optional, the default value if omitted.
- ⟨text⟩ What actions the command should perform.
Identifies the class name and optionally the version date. § 11.1 ⁂Writing a Class File for a Form
Argument Summary:
- ⟨name⟩ The class name.
- ⟨version⟩ If this argument is present, it identifies the class version information. The version date must be in the numeric format ⟨yyyy⟩/⟨mm⟩/⟨dd⟩ optionally followed by a version number and brief description.
Identifies the package name and optionally the version date. § 4.2 ⁑Writing an Invoice Using the invoice Package
Argument Summary:
- ⟨name⟩ The package name.
- ⟨version⟩ If this argument is present, it identifies the package version information. The version date must be in the numeric format ⟨yyyy⟩/⟨mm⟩/⟨dd⟩ optionally followed by a version number and brief description.
Specifies the company's phone number. § 6.2 ⁎Press Releases
Argument Summary:
- ⟨number⟩ The company's phone number.
Specifies the sub-headline. § 6.2 ⁎Press Releases
Argument Summary:
- ⟨text⟩ The sub-headline text.
Specifies the company's website. § 6.2 ⁎Press Releases
Argument Summary:
- ⟨website⟩ The company's website address.
letter environment.Indicates the start of the postscript. § 3.1 ⁎Writing a Letter Using the letter Class
Generates a bar code. § 10.4 ⁑The pst-barcode Package
Argument Summary:
- ⟨options⟩ A comma-separated list of options.
- ⟨text or filename⟩
- ⟨PS options⟩
- ⟨type⟩
Specifies the PS line. § 3.3 ⁑Writing a Letter Using the newlfm Class
Argument Summary:
- ⟨text⟩ The PS text
Randomly generates an integer between 1 and ⟨n⟩ (inclusive) and stores the result in the given register. § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨register⟩ The count register.
- ⟨n⟩ The upper bound.
Sets the random number generator seed. § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨n⟩ The seed.
Environment for drawing vector graphics. § 10.4 ⁑The pst-barcode Package
Argument Summary:
- ⟨baseline⟩ Sets the baseline fraction from the bottom.
- ⟨llx⟩ Lower left x-coordinate.
- ⟨lly⟩ Lower left y-coordinate.
- ⟨urx⟩ Upper right x-coordinate.
- ⟨ury⟩ Upper right y-coordinate.
A push button that performs some action (for use within the Form environment.) § 11.2 ⁑Electronic PDF Forms
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨label⟩ A textual label.
For use inside the picture environment, this
puts ⟨object⟩ at the given co-ordinates (which are
in terms of \unitlength). § 10.1 ⁑The picture Environment
Argument Summary:
- ⟨x⟩ The x-coordinate.
- ⟨y⟩ The y-coordinate.
- ⟨object⟩ The object (such as text or a line) to place at the given co-ordinate.
For use in the picture, this draws a quadratic
Bézier curve with the given start, end and
curvature control points. § 10.1 ⁑The picture Environment
Argument Summary:
- ⟨start-x⟩ The x-coordinate of the start control.
- ⟨start-y⟩ The y-coordinate of the start control.
- ⟨control-x⟩ The x-coordinate of the curvature control.
- ⟨control-y⟩ The y-coordinate of the curvature control.
- ⟨end-x⟩ The x-coordinate of the end control.
- ⟨end-y⟩ The y-coordinate of the end control.
Horizontal spacing command (twice as wide as \quad). § 11.1 ⁂Writing a Class File for a Form
Starts a new numbered question, with optionally the number of points the question is worth. § 9.1 ⁑The exam Class
Argument Summary:
- ⟨points⟩ The number of points.
Creates a new question. Both arguments are optional! § 9.2 ⁑The exsheets Package
Argument Summary:
- ⟨options⟩ Option list.
- ⟨points⟩ The points the question is worth.
Contains all the question in the exam. § 9.1 ⁑The exam Class
Ragged-right paragraph justification. § 4.3 ⁂Building Your Own Invoice using longtable and datatool
Randomly generates an integer between ⟨min⟩ and ⟨max⟩ (inclusive) and stores the result in the given counter. § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨counter⟩ The counter name.
- ⟨min⟩ The lower bound.
- ⟨max⟩ The upper bound.
Specifies the “re” part of a memo. § 6.1 ⁑Memos
Argument Summary:
- ⟨text⟩ The information text
References the value of the counter linked to the given label. A second (possibly third) run of LaTeX is required to ensure the cross-references are up-to-date. (See Volume 1.) § 1.2 ⁑Arara
Argument Summary:
- ⟨string⟩ The required label that was used in the
corresponding
\label.
\refstepcounter{⟨counter⟩}
Increments the value of the given counter by one and allows the
counter to be cross-referenced using \ref and \label. § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨counter⟩ The name of the counter that needs incrementing.
Specifies subject of letter. § 3.3 ⁑Writing a Letter Using the newlfm Class
Argument Summary:
- ⟨text⟩ The information text
Unexpandable nothing. § 2.1.1 ⁂Macro Definitions
Specifies the release information. § 6.2 ⁎Press Releases
Argument Summary:
- ⟨text⟩ The release information.
Redefines an existing command. (See Volume 1.) § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cmd⟩ The command name (including initial backslash).
- ⟨n-args⟩ The number of arguments this command should have.
- ⟨default⟩ If the first argument should be optional, the default value if omitted.
- ⟨text⟩ What actions the command should perform.
Redefines an existing environment. § 6.5.1.1 ⁂Delving Deeper
Argument Summary:
- ⟨env-name⟩ The environment name (no backslash).
- ⟨n-args⟩ The number of arguments this new environment should have.
- ⟨default⟩ If the first argument should be optional, the default value if omitted.
- ⟨begin-code⟩ Actions to perform at the start of the environment.
- ⟨end-code⟩ Actions to perform at the end of the environment.
Indicates that ⟨old-text⟩ has been replaced with ⟨new text⟩. § 13.1 ⁑Change Markup
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨new-text⟩ The new text.
- ⟨old-text⟩ The old text.
Analogous to \usepackage but for use in class or
package files. § 4.2 ⁑Writing an Invoice Using the invoice Package
Argument Summary:
- ⟨options⟩ Options to pass to the required package(s).
- ⟨name⟩ The package name (or several package names separated by commas).
- ⟨version⟩ If this argument is present, the required package must be at least this version. The version date must be in the numeric format ⟨yyyy⟩/⟨mm⟩/⟨dd⟩
A reset button that resets the form (for use within the Form environment.) § 11.2 ⁑Electronic PDF Forms
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨label⟩ A textual label.
Scales the specified contents to the given dimensions. § 10.3 ⁑The leaflet Class
Argument Summary:
- ⟨h-length⟩ The required width or ! to keep the aspect ratio.
- ⟨v-length⟩ The required height or ! to keep the aspect ratio.
- ⟨text⟩ The text to be scaled.
Switches on the censoring. § 6.4.1 ⁎Redaction: The censor Package
For use within the Argumentation environment,
this indicates the start of an item indicating the result of the
argument. § 6.3.2 ⁑The minutes Package
The return address. Defaults to the address given by
\address § 3.6 ⁑Envelopes
Right arrow →. § 9.3 ⁑The probsoln Package
Places ⟨text⟩ to the right of the reference point without taking up any space. § 11. ⁑Forms
Argument Summary:
- ⟨text⟩ The text to be placed by the reference point.
Displays counter value as an upper case Roman number. (I, II, III, …) § 9.2 ⁑The exsheets Package
Argument Summary:
- ⟨counter⟩ The name of the counter.
Displays counter value as a lower case Roman number. (i, ii, iii, …) § 6.5.1 ⁑Hierarchical Paragraph Numbering
Argument Summary:
- ⟨counter⟩ The name of the counter.
\romannumeral⟨number⟩
Expands ⟨number⟩ to a lower case Roman numeral. § 6.5.1.1 ⁂Delving Deeper
Argument Summary:
- ⟨number⟩ The number (may be a register) to convert.
Rotates the given contents by the given angle. § 3.6 ⁑Envelopes
Argument Summary:
- ⟨option-list⟩ A comma-separated list of options:
- ⟨angle⟩ The angle of rotation.
- ⟨text⟩ The text to be rotated.
Draws a rule (filled rectangle) with the given width and height. If the optional argument is present, the rule is raised by that amount. § 3.6 ⁑Envelopes
Argument Summary:
- ⟨raise⟩ Height to raise the rule (may be negative to lower it)
- ⟨width⟩ The width of the rule (may be zero to make an invisible rule with a height but no width)
- ⟨height⟩ The height of the rule (may be zero to make an invisible rule with a width but no height)
For use within the tikzpicture environment, this
provides a way of scoping options. § 7.5 ⁂Displaying a Calendar
Argument Summary:
- ⟨options⟩ A list of options to apply to the scope.
Switches to the small-caps form of the current font family, if it exists. See Volume 1. § 10.2 ⁑The ticket Package
The environment contents will only be displayed if
the package option Secret is used. § 6.3.2 ⁑The minutes Package
The ⟨secret text⟩ will only be displayed if the
package option Secret is used. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨secret text⟩ The secret text.
The font declaration used by the sectioning commands. § 10.3 ⁑The leaflet Class
Inserts a section header. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨short-title⟩ An abbreviated form of the title to go in the table of contents or the page header.
- ⟨title⟩ The title.
Sets how covered material should appear. § 8.1 ⁑Overlays
Argument Summary:
- ⟨options⟩ Specifies the effect. Options include: invisible (completely disappear); transparent=⟨opaqueness⟩ (specifies the opaqueness as a percentage, default is 85% if ⟨opaqueness⟩ is missing); dynamic (transparent in a dynamic way); highly dynamic (as dynamic but stronger). See the beamer manual for other options.
Sets the custom dimensions for the big labels. § 3.6 ⁑Envelopes
Argument Summary:
- ⟨width⟩ Total label width
- ⟨height⟩ Total label height
- ⟨top⟩ Distance between the top edge of paper and the label
- ⟨left⟩ Distance between the left edge of paper and the label
- ⟨sep⟩ Horizontal distance between labels
- ⟨columns⟩ Number of columns of labels per page
- ⟨rows⟩ Number of rows of labels per page
Sets the state (true or false) of a boolean
variable. (Local effect only.) A new boolean variable can be defined using
\newbool and can be tested in the first argument
of \ifbool. § 9.4 ⁂Using the datatool Package for Exams or Assignment
Sheets
Argument Summary:
- ⟨name⟩ The name of the boolean variable.
- ⟨state⟩ The new state. This may be either true or false.
Sets the state (true or false) of a boolean
variable. (Local effect only.) A new boolean variable can be defined using
\newboolean and can be tested in the first argument
of \ifthenelse with \boolean. § 6.1 ⁑Memos
Argument Summary:
- ⟨name⟩ The name of the boolean variable.
- ⟨state⟩ The new state. This may be either true or false.
Sets the committee name. § 6.3.1 ⁑The meetingmins Class
Argument Summary:
- ⟨name⟩ The name of the committee.
\setcounter{⟨counter⟩}{⟨number⟩}
Sets the value of a counter. § 10.5 ⁂The flowfram Package and the flowframtk Application
Argument Summary:
- ⟨counter⟩ The name of the counter that needs changing.
- ⟨number⟩ The new value. (Must be an integer.)
Sets the date of the meeting. § 6.3.1 ⁑The meetingmins Class
Argument Summary:
- ⟨date⟩ The date of the meeting.
Sets the contents of a dynamic frame. § 10.5 ⁂The flowfram Package and the flowframtk Application
Argument Summary:
- ⟨id⟩ The frame's index for the unstarred version or the label for the starred version.
- ⟨contents⟩ The frame's contents.
Sets the custom envelope dimensions. § 3.6 ⁑Envelopes
Argument Summary:
- ⟨top-margin⟩ Height of the top margin
- ⟨width⟩ Envelope width
- ⟨height⟩ Envelope height
Sets the options provided by the given option family § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨family⟩ The option family.
- ⟨options⟩ A key=value list of options.
Sets the content and optionally the description of a KOMA-Script variable. § 3.2 ⁑Writing a Letter Using the scrlttr2 Class
Argument Summary:
- ⟨name⟩ The name of the variable.
- ⟨description⟩ The description of the variable.
- ⟨content⟩ The content of the variable.
Sets the description of a KOMA-Script variable. § 3.2 ⁑Writing a Letter Using the scrlttr2 Class
Argument Summary:
- ⟨name⟩ The name of the variable.
- ⟨description⟩ The description of the variable.
Sets the custom label dimensions. § 3.6 ⁑Envelopes
Argument Summary:
- ⟨width⟩ Total label width
- ⟨height⟩ Total label height
- ⟨top⟩ Distance between the top edge of paper and the label
- ⟨left⟩ Distance between the left edge of paper and the label
- ⟨sep⟩ Horizontal distance between labels
- ⟨columns⟩ Number of columns of labels per page
- ⟨rows⟩ Number of rows of labels per page
\setlength{⟨register⟩}{⟨dimension⟩}
Sets the value of a length register. § 6.5.1.1 ⁂Delving Deeper
Argument Summary:
- ⟨register⟩ The name of the length register (for
example
\parindent). - ⟨dimension⟩ The new dimension.
Used to specify the page margins. § 10.3 ⁑The leaflet Class
Argument Summary:
- ⟨top⟩ The top margin.
- ⟨bottom⟩ The bottom margin.
- ⟨left⟩ The left margin.
- ⟨right⟩ The right margin.
Sets the list of members. The chair should be indicated
within the list with the \chair command. § 6.3.1 ⁑The meetingmins Class
Argument Summary:
- ⟨list⟩ A comma-separated list of members.
Sets the list of people present. The chair should be indicated
within the list with the \chair command. § 6.3.1 ⁑The meetingmins Class
Argument Summary:
- ⟨list⟩ A comma-separated list of names.
Sets the extension of the list or summary of changes file. § 13.1 ⁑Change Markup
Argument Summary:
- ⟨extension⟩ The file extension.
Sets the contents of a static frame. § 10.5 ⁂The flowfram Package and the flowframtk Application
Argument Summary:
- ⟨id⟩ The frame's index for the unstarred version or the label for the starred version.
- ⟨contents⟩ The frame's contents.
Sets up the general document options § 3.4 ⁑Writing a Letter Using the isodoc Class
Argument Summary:
- ⟨options⟩ A key=value list of options.
Sets options for the exsheet package. § 9.2 ⁑The exsheets Package
Argument Summary:
- ⟨module⟩ The module to which the options belong.
- ⟨options⟩ The options to set.
Switches to the predefined sans-serif font. (Defaults to Computer Modern Sans.) § 12.3.1 ⁑The bchart Package
Produces a box with a single column of text with the reference
point at the lower-left corner. Similar to using a single
column tabular environment. § 10.1 ⁑The picture Environment
Argument Summary:
- ⟨align⟩ The horizontal alignment of the column. May be one of: c (centred), l (left) or r (right).
- ⟨text⟩ The column text.
\show⟨token⟩
Interrupts the document compilation and writes the definition of ⟨token⟩ to the transcript. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨token⟩ The token under inspection.
Shows the solutions (from that point onwards). § 9.3 ⁑The probsoln Package
Specifies the sender's (or author's) name to go after the closing text. § 3.1 ⁎Writing a Letter Using the letter Class
Argument Summary:
- ⟨text⟩ The sender's name.
Typesets sin function name. § 9.1 ⁑The exam Class
Switches to small sized text. § 6.4.1 ⁎Redaction: The censor Package
Inserts a small vertical space. The size is given by
the length \smallskipamount. § 12.3.1 ⁑The bchart Package
Typesets its contents if the answers option is set
otherwise it hides its contents, optionally replacing the contents
with space for the student to fill in their answer. § 9.1 ⁑The exam Class
Argument Summary:
- ⟨length⟩ If supplied, this amount of vertical space will be inserted when the solution is hidden.
Contains the solution to the preceding question. § 9.2 ⁑The exsheets Package
Starts a new paragraph (without indentation), typesets
\solutionname in bold followed by a colon space
and then the environment contents. § 9.3 ⁑The probsoln Package
The solution title text used by the
solution environment. § 9.3 ⁑The probsoln Package
Typesets its contents if the answers option is set
otherwise it hides its contents, optionally replacing the contents
with an empty box for the student to fill in their answer. § 9.1 ⁑The exam Class
Argument Summary:
- ⟨length⟩ If supplied, this height of the box to be inserted when the solution is hidden.
Typesets its contents if the answers option is set
otherwise it hides its contents, optionally replacing the contents
with an area containing dotted lines for the student to fill in their answer. § 9.1 ⁑The exam Class
Argument Summary:
- ⟨length⟩ If supplied, this height of the dotted lined area to be inserted when the solution is hidden.
Typesets its contents if the answers option is set
otherwise it hides its contents, optionally replacing the contents
with a lined area for the student to fill in their answer. § 9.1 ⁑The exam Class
Argument Summary:
- ⟨length⟩ If supplied, this height of the ruled area to be inserted when the solution is hidden.
A space character. Sometimes used instead of typing a space
character when the author wants to emphasize that there's supposed
to be a space there. For example, if the space occurs at the end of
a line of code, using \space is a visual indication that
the author hasn't simply forgotten to discard an unwanted EOL character. § 3.6 ⁑Envelopes
geometry option.Produces a square symbol ☐. § 10.3 ⁑The leaflet Class
Starts the manual generation of labels (which should be made using
\mlabel). § 3.6 ⁑Envelopes
Specifies the start time of the meeting. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨time⟩ The starting time.
Sets the contents of a static frame. § 10.5 ⁂The flowfram Package and the flowframtk Application
Argument Summary:
- ⟨id⟩ The frame's index for the unstarred version or the label for the starred version.
For use within the invoice environment, this command
is used to make a subtotal appear for all the expenses hidden via
\EBCi or \EFCi. § 4.2 ⁑Writing an Invoice Using the invoice Package
Switches off the redaction to produce an uncensored version of the document. § 6.4.1 ⁎Redaction: The censor Package
\string⟨cs⟩
Converts the given control sequence into the list of characters that makes up that control sequence name (including the initial backslash) where each character in the list has category code 12 (“other”) § 11.1 ⁂Writing a Class File for a Form
Argument Summary:
- ⟨cs⟩ The control sequence to convert into characters.
A numbered list for use within subsections and sub-subsections. Use the
items environment for lists within sections. § 6.3.1 ⁑The meetingmins Class
A submit button that sends the data to the URL provided by the
form's action (for use within the Form environment.) § 11.2 ⁑Electronic PDF Forms
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨label⟩ A textual label.
\subparagraph[⟨short-title⟩]{⟨title⟩}
Inserts a subsubsubsubsection header. Most classes default to an unnumbered running header for this sectional unit. § 6.5.2 ⁂Non-Hierarchical Paragraph Numbering
Argument Summary:
- ⟨short-title⟩ An abbreviated form of the title to go in the table of contents or the page header.
- ⟨title⟩ The title.
Starts a new numbered question sub-part, with optionally the number of points the sub-part is worth. § 9.1 ⁑The exam Class
Argument Summary:
- ⟨points⟩ The number of points.
Contains all the question sub-parts. § 9.1 ⁑The exam Class
\subsection[⟨short-title⟩]{⟨title⟩}
Inserts a subsection header. § 6.3.1 ⁑The meetingmins Class
Argument Summary:
- ⟨short-title⟩ An abbreviated form of the title to go in the table of contents or the page header.
- ⟨title⟩ The title.
Starts a new numbered question sub-sub-part, with optionally the number of points the sub-sub-part is worth. § 9.1 ⁑The exam Class
Argument Summary:
- ⟨points⟩ The number of points.
Contains all the question sub-sub-parts. § 9.1 ⁑The exam Class
\subsubsection[⟨short-title⟩]{⟨title⟩}
Inserts a subsubsection header. § 6.5.2 ⁂Non-Hierarchical Paragraph Numbering
Argument Summary:
- ⟨short-title⟩ An abbreviated form of the title to go in the table of contents or the page header.
- ⟨title⟩ The title.
Specifies the subtitle. Usually for use with \maketitle
in a similar manner to \title. Some classes, such as
beamer, also provide an optional argument for this command. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨title⟩ The subtitle text.
Starts a new subtopic. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨toc title⟩ The title to use in the overview and table of contents.
- ⟨title⟩ The subtopic title.
Prints a summary of the Subversion information in the same form as
the Id keyword anchor. § 13.2 ⁑Version Control
Parses the Subversion Id keyword anchor. § 13.2 ⁑Version Control
Argument Summary:
- ⟨Id⟩ The Id keyword anchor.
Prints the date in the form ⟨YYYY⟩-⟨MM⟩-⟨DD⟩ when the file was checked out or the current date if unknown. § 13.2 ⁑Version Control
Prints the day (in ⟨DD⟩ form) when the file was checked out or the current day if unknown. § 13.2 ⁑Version Control
Prints the name of the source file or --sourcefile-- if unknown. § 13.2 ⁑Version Control
Prints the information obtained from the HeadURL
keyword. § 13.2 ⁑Version Control
Prints date in the form of \today when the file was
checked out or the current date if unknown. § 13.2 ⁑Version Control
Prints the maximum revision number for all the files in the document or --maxrevision-- if unknown. § 13.2 ⁑Version Control
Prints date in the form of \today from the latest
Subversion revision. § 13.2 ⁑Version Control
Prints the minimum revision number for all the files in the document or --minrevision-- if unknown. § 13.2 ⁑Version Control
Prints the month (in ⟨MM⟩ form) when the file was checked out or the current month if unknown. § 13.2 ⁑Version Control
Prints the user name of the file owner or --owner-- if unknown. § 13.2 ⁑Version Control
Prints the revision number of the checked out file or --revision-- if unknown. § 13.2 ⁑Version Control
Prints the time when the file was checked out or --time-- if unknown. § 13.2 ⁑Version Control
Prints the year when the file was checked out or the current year if unknown. § 13.2 ⁑Version Control
Parses the Subversion keyword anchor. § 13.2 ⁑Version Control
Argument Summary:
- ⟨keyword⟩ The keyword anchor.
Floats the contents to the nearest location according to the
preferred placement options, if possible. Within the environment,
\caption may be used one or more times, as required.
(See Volume 1.) § 2.6 ⁑Displaying Tabulated Data
Argument Summary:
- ⟨placement⟩ The preferred placement.
Inserts the table of contents. A second (possibly third) run is required to ensure the page numbering is correct. § 6.3.2 ⁑The minutes Package
Environment for lining things up in rows and columns. § 2.6 ⁑Displaying Tabulated Data
Argument Summary:
- ⟨v-pos⟩ Vertical alignment of the entire environment with respect to the surrounding baseline. May be one of t (top), b (bottom) or c (centered).
- ⟨col-specs⟩ Indicates how to align the columns.
Specifies a task. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨footnote-text⟩ Text to go in a footnote.
- ⟨name⟩ Person responsible for the task.
- ⟨when⟩ Date of task completion.
- ⟨text⟩ A description of the task.
Specifies a task. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨when⟩ Date of task completion.
- ⟨text⟩ A description of the task.
Specifies the sender's telephone number. § 3.1 ⁎Writing a Letter Using the letter Class
Argument Summary:
- ⟨text⟩ The telephone number.
Typesets the TeX logo. § 7.4 ⁂Parsing and Displaying Times
Displays its argument in the normal text font (as opposed to the current maths font). § 7.4 ⁂Parsing and Displaying Times
Argument Summary:
- ⟨text⟩ The text to be displayed in the normal text font.
Circumflex ^ symbol. § 2.2.1 ⁑Loading Data From a CSV File
Tilde ~ symbol. (If you are typing an
URL, use the url package, which provides
\url{⟨address⟩}
that allows you to directly type ~ in the
address.) § 2.2.1 ⁑Loading Data From a CSV File
Renders ⟨text⟩ with a bold weight in the current font family, if it exists. (See Volume 1.) § 1. ⁎Introduction
Argument Summary:
- ⟨text⟩ The text on which to apply the font change.
Sets ⟨text⟩ with the foreground colour according to the given ⟨specs⟩. § 2.3 ⁑Security
Argument Summary:
- ⟨⟨model⟩⟩ The colour model, for example rgb or named.
- ⟨⟨specs⟩⟩ The colour specification for the given model. For example, if the rgb model is chosen, ⟨specs⟩ must be a comma-separated list of three numbers each between 0 and 1.
- ⟨⟨text⟩⟩ The text to be displayed in the given colour.
Displays the dollar symbol $. § 4.2 ⁑Writing an Invoice Using the invoice Package
An inline numbered list environment. Each item may be started with
the standard \item command, but may also be started with
\correctitem or \incorrectitem. § 9.3 ⁑The probsoln Package
Displays the Euro symbol €. § 4.2 ⁑Writing an Invoice Using the invoice Package
A text field (for use within the Form environment.) § 11.2 ⁑Electronic PDF Forms
Argument Summary:
- ⟨options⟩ A key=value list of options.
- ⟨label⟩ A textual label.
A length containing the height of the typeblock. Note that the actual contents of the page may fall short of the text height (underfull vbox) or extend beyond it (overfull vbox). This measurement does not include the header and footer areas. § 10.5 ⁂The flowfram Package and the flowframtk Application
Selects the symbol identified by ⟨number⟩ from the given font family. § 11.1 ⁂Writing a Class File for a Form
Argument Summary:
- ⟨font-family⟩ The symbol font family. Defaults to ifsym.
- ⟨number⟩ The symbol index.
Makes ⟨text⟩ a subscript. Unlike \sb, this command
is for use in text mode. § 13.1 ⁑Change Markup
Argument Summary:
- ⟨text⟩ The text to convert to a subscript.
Makes ⟨text⟩ a superscript. Unlike \sp, this command
is for use in text mode. § 13.1 ⁑Change Markup
Argument Summary:
- ⟨text⟩ The text to convert to a superscript.
Renders ⟨text⟩ in the predefined monospaced font. See Volume 1. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨text⟩ The text on which to apply the font change.
A length containing the width of the typeblock. Note that the actual contents of the line may fall short of the line width (underfull hbox) or extend beyond it (overfull hbox). This width does not include the area for marginal notes. § 2.1.3 ⁂Arithmetic
\the⟨register⟩
Expands ⟨register⟩ to the current value of the register. § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨register⟩ The register containing the required value.
Displays the current value of the enumi (first level enumerate) counter. § 6.5.1 ⁑Hierarchical Paragraph Numbering
Displays the current value of the enumii (second level enumerate) counter. § 6.5.1 ⁑Hierarchical Paragraph Numbering
Displays the current value of the enumiii (third level enumerate) counter. § 6.5.1 ⁑Hierarchical Paragraph Numbering
Displays the current value of the enumiv (fourth level enumerate) counter. § 6.5.1 ⁑Hierarchical Paragraph Numbering
An environment for typesetting theorems. § 8. ⁎Presentations (The beamer Class)
Argument Summary:
- ⟨title⟩ The theorem title.
Displays the current question number. § 9.1 ⁑The exam Class
Displays the current value of the section counter § 6.5.1 ⁑Hierarchical Paragraph Numbering
This declaration switches to a thick line width for lines drawn
within the picture environment. § 10.1 ⁑The picture Environment
\thispagestyle{⟨style⟩}
Like \pagestyle but only affects the current page. § 3.1 ⁎Writing a Letter Using the letter Class
Argument Summary:
- ⟨style⟩ The name of the page style.
May be used within the ⟨body⟩ argument of
\foreachproblem to display the current problem. § 9.3 ⁑The probsoln Package
May be used within the ⟨body⟩ argument of
\foreachproblem to access the current problem label. § 9.3 ⁑The probsoln Package
For use within one of the tick label options, this expands to the current tick element. § 12.5 ⁑Plots
Specifies the variable ticket content. § 10.2 ⁑The ticket Package
Argument Summary:
- ⟨content⟩ The ticket content.
The default ticket content. § 10.2 ⁑The ticket Package
The horizontal and vertical distances between tickets in terms of
\unitlength. § 10.2 ⁑The ticket Package
Argument Summary:
- ⟨x-dist⟩ The horizontal distance.
- ⟨y-dist⟩ The vertical distance.
Specifies the number of tickets per sheet and their arrangement. § 10.2 ⁑The ticket Package
Argument Summary:
- ⟨num-cols⟩ The number of tickets on the sheet in the horizontal direction.
- ⟨num-rows⟩ The number of tickets on the sheet in the vertical direction.
The width and height of the tickets in terms of
\unitlength. § 10.2 ⁑The ticket Package
Argument Summary:
- ⟨width⟩ The ticket width.
- ⟨height⟩ The ticket height.
For use within one of the tick label options, this expands to the current tick number (starting from 0). § 12.5 ⁑Plots
Environment for drawing vector graphics. § 7.5 ⁂Displaying a Calendar
Argument Summary:
- ⟨options⟩ Comma-separated list of options.
The current time expressed as the number of minutes since midnight. § 7.4 ⁂Parsing and Displaying Times
Specifies the document title. This command doesn't
display any text so may be used in the preamble, but if it's not
in the preamble it must be placed before \maketitle. Some
classes, such as beamer, provide an optional argument for
this command. § 8. ⁎Presentations (The beamer Class)
Argument Summary:
- ⟨text⟩ The title of the document.
Like \question but assigns a title to the question. § 9.1 ⁑The exam Class
Argument Summary:
- ⟨title⟩ The question title.
- ⟨points⟩ The number of points.
Code to produce a title graphic used by \maketitle. § 8. ⁎Presentations (The beamer Class)
Argument Summary:
- ⟨graphic⟩ The code to produce the image.
A length register used to store the width of the recipient's address. § 3.6 ⁑Envelopes
Inserts into the output file the date when the LaTeX application created it from the source code. § 3.3 ⁑Writing a Letter Using the newlfm Class
Create a file reference. § 1.2 ⁑Arara
Starts a new topic. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨toc title⟩ The title to use in the overview and table of contents.
- ⟨title⟩ The topic title.
Horizontal rule for the top of a tabular environment. § 2.6 ⁑Displaying Tabulated Data
Argument Summary:
- ⟨wd⟩ Thickness of the rule (dimension).
Displays the total number of points, including bonus points. (Requires two LaTeX runs to ensure it's up to date.) The starred version omits the unit. § 9.2 ⁑The exsheets Package
Displays ⟨number⟩, ensuring that it has at least two digits. (If ⟨number⟩ is less than 10 a leading 0 is inserted.) § 7.4 ⁂Parsing and Displaying Times
Argument Summary:
- ⟨number⟩ The number to be displayed.
Issues a page break and switches to two column mode. § 10.5 ⁂The flowfram Package and the flowframtk Application
Evaluates to true if the given file hasn't changed. The argument ⟨ref⟩ may either be
a string "⟨extension⟩" which indicates the file extension
or a file reference toFile("⟨filename⟩"). § 1.2 ⁑Arara
Argument Summary:
- ⟨ref⟩ The file extension or a file reference.
Switches off the default frame around the solutions. § 9.1 ⁑The exam Class
A length used as the unit of measurement in the
picture environment. § 10.1 ⁑The picture Environment
Only run the application if ⟨condition⟩ is false. § 1.2 ⁑Arara
Argument Summary:
- ⟨condition⟩ The condition to evaluate.
Repeatedly run the application until ⟨condition⟩ is true. § 1.2 ⁑Arara
Argument Summary:
- ⟨condition⟩ The condition to evaluate.
Typesets an URL in a typewriter font and allows you to use characters such as ~. § 6.2 ⁎Press Releases
Argument Summary:
- ⟨address⟩ The web address.
Loads a beamer color theme. § 8.2 ⁑Themes
Argument Summary:
- ⟨options⟩ A comma-separated list of options.
- ⟨name⟩ The theme name.
Loads a beamer font theme. § 8.2 ⁑Themes
Argument Summary:
- ⟨options⟩ A comma-separated list of options.
- ⟨name⟩ The theme name.
Loads a beamer inner theme. § 8.2 ⁑Themes
Argument Summary:
- ⟨options⟩ A comma-separated list of options.
- ⟨name⟩ The theme name.
Loads a beamer outer theme. § 8.2 ⁑Themes
Argument Summary:
- ⟨options⟩ A comma-separated list of options.
- ⟨name⟩ The theme name.
Loads the listed package(s). (See Volume 1.) § 1.1 ⁎Packages and Document Classes
Argument Summary:
- ⟨option-list⟩ A comma-separated list of options to pass to the package.
- ⟨package-list⟩ A comma-separated list of package names (without the .sty extension).
Uses a previously defined problem. § 9.3 ⁑The probsoln Package
Argument Summary:
- ⟨dataset⟩ The dataset in which the problem has been stored.
- ⟨label⟩ The label uniquely identifying the problem.
- ⟨ arg1⟩…⟨argN⟩ The arguments given the problem was defined to have N arguments.
Loads a beamer presentation theme. § 8.2 ⁑Themes
Argument Summary:
- ⟨options⟩ A comma-separated list of options.
- ⟨name⟩ The theme name.
Load the tikz library called ⟨name⟩. (Preamble only.) § 7.5 ⁂Displaying a Calendar
Argument Summary:
- ⟨name⟩ The name of the library.
References the value of the given counter where a number rather than a counter name is required. § 2.1.3 ⁂Arithmetic
Argument Summary:
- ⟨counter⟩ The name of the counter.
For use within the argument of \put, this draws a straight
line with an arrowhead of
the given length whose horizontal and vertical extent (gradient
vector) is given by
(⟨h⟩,⟨v⟩). § 10.1 ⁑The picture Environment
Argument Summary:
- ⟨h⟩ The horizontal extent.
- ⟨v⟩ The vertical extent.
- ⟨length⟩ The length of the line (non-negative).
\verb⟨char⟩⟨text⟩⟨char⟩
Typesets ⟨text⟩ verbatim. The starred version replaces spaces with the visible space symbol. § 8. ⁎Presentations (The beamer Class)
Argument Summary:
- ⟨char⟩ A character the delimits the text. (Should not appear in ⟨text⟩.)
- ⟨text⟩ The text.
Typesets the contents of the environment as is. (Can't be used in the argument of a command.) § 8. ⁎Presentations (The beamer Class)
Inputs the given file verbatim. § 9.4 ⁂Using the datatool Package for Exams or Assignment Sheets
Argument Summary:
- ⟨filename⟩ The name of the file to input.
Inserts a vertical space that will expand to fit the available height. § 3.6 ⁑Envelopes
If multiple votes were made, the \vote commands are
listed in this environment. § 6.3.2 ⁑The minutes Package
Indicates a vote took place. § 6.3.2 ⁑The minutes Package
Argument Summary:
- ⟨description⟩ Brief description of the vote.
- ⟨yes⟩ Number in favour.
- ⟨no⟩ Number against.
- ⟨abstain⟩ Number of abstainers.
- ⟨decision⟩ A decision.
Inserts a vertical gap of the given height. The unstarred version doesn't create a space if it occurs at the beginning or end of a page. The starred version always creates a space. § 9.1 ⁑The exam Class
Argument Summary:
- ⟨length⟩ The height of the vertical gap.
Repeatedly run the application while ⟨condition⟩ is true. § 1.2 ⁑Arara
Argument Summary:
- ⟨condition⟩ The condition to evaluate.
Global version of \eappto. § 2.1.2 ⁂Hook Management
Argument Summary:
- ⟨cs⟩ The control sequence to modify
- ⟨code⟩ The code to append
Like \blackout, but also blacks out the interword spaces. § 6.4.1 ⁎Redaction: The censor Package
Argument Summary:
- ⟨text⟩ The text to be censored.
Produces a square with a cross in it ☒. § 11.1 ⁂Writing a Class File for a Form
As \edef but the definition is global. § 2.1.1 ⁂Macro Definitions
Argument Summary:
- ⟨cs⟩ The new command being defined.
- ⟨arg-syntax⟩ The command syntax where each parameter is referenced using #⟨n⟩ in order
- ⟨definition⟩ The command definition.
Finds the first row in the database ⟨db-name⟩ where entry in the column
identified by the label ⟨col-label⟩ matches a one level
expansion of ⟨value⟩
and applies the assignment list, which has the same format as for
\DTLforeach and \DTLforeach*. See also \DTLassignfirstmatch. § 2.8 ⁑Fetching Data From a Given Row
Argument Summary:
- ⟨db-name⟩ The label identifying the data.
- ⟨col-label⟩ The label identifying the column.
- ⟨value⟩ The value to be matched.
- ⟨assign-list⟩ The assignment list in the form ⟨cs⟩=⟨another column label⟩.
As \ifinlist but the test is performed on the expansion of
⟨item⟩. § 2.7.3 ⁑Iteration With etoolbox's Internal Lists
Argument Summary:
- ⟨item⟩ The item to be tested.
- ⟨list-cs⟩ The control sequence used to store the list.
- ⟨true⟩ The code to process if the item is in the list.
- ⟨false⟩ The code to process if the item isn't in the list.
As \xifinlist but the control sequence name is supplied
(without the backslash). § 2.7.3 ⁑Iteration With etoolbox's Internal Lists
Argument Summary:
- ⟨item⟩ The item to be tested.
- ⟨list-csname⟩ The name of control sequence used to store the list.
- ⟨true⟩ The code to process if the item is in the list.
- ⟨false⟩ The code to process if the item isn't in the list.
Global version of \epreto. § 2.1.2 ⁂Hook Management
Argument Summary:
- ⟨cs⟩ The control sequence to modify
- ⟨code⟩ The code to prepend
The current year. § 7.2 ⁂The pgfcalendar Package Utility Commands
This book is also available as A4 PDF or 12.8cm x 9.6cm PDF or paperback (ISBN 978-1-909440-07-4).