Summary
Commands or environments defined in the LaTeX kernel are always available.
Replacement text for argument <digit>. (See Volume 1.) § 4.5 Listings and Other Verbatim Text
Switches in and out of in-line math mode. (See Volume 1.) § 4.5 Listings and Other Verbatim Text
Comment character used to ignore everything up to and including the newline character in the source code. Sometimes comments are used to provide information to applications that build your document, such as arara. § 2. Getting Started
Closing quote or apostrophe symbol in text mode or prime symbol ′ in math mode. (See Volume 1.) § 4.7.1 The amsthm Package
Closing double quote symbol in text mode or double prime ″ in math mode. (See Volume 1.) § 4.7.1 The amsthm Package
En-dash symbol. (Normally used for number ranges. See Volume 1.) § 5.1.2 Writing the .bib File Manually
\index
to separate the sort key
from the term being indexed.
§ 6.1.1.1 Overriding the Default Sort
Open delimiter of an optional argument. (See Volume 1.) § 1. Introduction
Escape character indicating a command. (See Volume 1.) § 6.1.1.1 Overriding the Default Sort
Umlaut over <c>. Example: \"{o} produces ö. (See Volume 1.) § 5.1.1 JabRef
Argument Summary:
- <c> The character that requires an umlaut over it.
Acute accent over <c>. Example:
\'
{o} produces ó. (See
Volume 1.)
§ 6.1.2.2 Displaying Terms in the Document
Argument Summary:
- <c> The character that requires an acute accent over it.
1) Outside tabbing environment inserts a discretionary hyphen § 4.6 Tabbing; 2) Inside tabbing environment shifts the left border by one tab stop § 4.6 Tabbing.
When used in the body of one of the environments defined by algorithm2e, such as algorithm, marks the end of the line. Outside those environments, this is a math spacing command. § 4.8 Algorithms
1) Outside tabbing environment puts a macron accent over the following character § 4.6 Tabbing; 2) Inside tabbing environment sets a tab-stop. § 4.6 Tabbing.
Used when a sentence ends with a capital letter. This command should be placed after the letter and before the punctuation mark. (See Volume 1.) § 6.1.2.2 Displaying Terms in the Document
Starts a new row in tabbing or tabular-style environments. (See Volume 1.) § 2. Getting Started
Closing delimiter of an optional argument. (See Volume 1.) § 1. Introduction
Displays its argument as a subscript. (See Volume 1.) § 4.8 Algorithms
Argument Summary:
- <maths> The subscript.
Open double quote symbol. (See Volume 1.) § 4.7.1 The amsthm Package
Marks the beginning of a group. (See Volume 1.) § 1. Introduction
\index
, this symbol indicates that the rest
of the argument list is to be used as the
encapsulating command for the page number. § 6.1.1.2 Setting the Location Format
Marks the end of a group. (See Volume 1.) § 1. Introduction
Unbreakable space. (See Volume 1.) § 4.7.1 The amsthm Package
Displays its argument as a superscript. (See Volume 1.) § 4.8 Algorithms
Argument Summary:
- <maths> The superscript.
Used in the tabbing environment to create accented characters. § 4.6 Tabbing
Argument Summary:
- <accent symbol> the symbol you would usually use in the normal accent command.
- <character> the character that requires the accent
Displays its contents as an abstract. § 2. Getting Started
A synonym for \gls
. This command is only available if
the package option shortcuts is used. § 6.1.2.2 Displaying Terms in the Document
Argument Summary:
- <options> a <key>=<value> list of options.
- <label> the label uniquely identifying the
acronym (as defined by
\newacronym
). - <insert> text to insert after the term (but inside the hyperlink, if used with the hyperref package).
A synonym for \acrfull
. This command is only available if
the package option shortcuts is used. § 6.1.2.2 Displaying Terms in the Document
Argument Summary:
- <options> a <key>=<value> list of options.
- <label> the label uniquely identifying the
acronym (as defined by
\newacronym
). - <insert> text to insert after the term (but inside the hyperlink, if used with the hyperref package).
A synonym for \acrlong
. This command is only available if
the package option shortcuts is used. § 6.1.2.2 Displaying Terms in the Document
Argument Summary:
- <options> a <key>=<value> list of options.
- <label> the label uniquely identifying the
acronym (as defined by
\newacronym
). - <insert> text to insert after the term (but inside the hyperlink, if used with the hyperref package).
As \acr
but the first letter is converted to
uppercase. § 6.2 Using LaTeX to Sort and Collate Indexes or Glossaries
(datagidx package)
Argument Summary:
- <format> the name of the formatting command without the initial backslash to be used for this location.
- <label> the label uniquely identifying the term.
Displays an acronym. On first use the full form is displayed. On subsequent use only the short form is displayed. § 6.2 Using LaTeX to Sort and Collate Indexes or Glossaries (datagidx package)
Argument Summary:
- <format> the name of the formatting command without the initial backslash to be used for this location.
- <label> the label uniquely identifying the term.
Displays the long and short form of the given acronym, the first letter converted to uppercase. § 6.1.2.2 Displaying Terms in the Document
Argument Summary:
- <options> a <key>=<value> list of options.
- <label> the label uniquely identifying the
acronym (as defined by
\newacronym
). - <insert> text to insert after the term (but inside the hyperlink, if used with the hyperref package).
Displays the long and short form of the given acronym. § 6.1.2.2 Displaying Terms in the Document
Argument Summary:
- <options> a <key>=<value> list of options.
- <label> the label uniquely identifying the
acronym (as defined by
\newacronym
). - <insert> text to insert after the term (but inside the hyperlink, if used with the hyperref package).
Displays the long form of the given acronym, the first letter converted to uppercase. § 6.1.2.2 Displaying Terms in the Document
Argument Summary:
- <options> a <key>=<value> list of options.
- <label> the label uniquely identifying the
acronym (as defined by
\newacronym
). - <insert> text to insert after the term (but inside the hyperlink, if used with the hyperref package).
Displays the long form of the given acronym. § 6.1.2.2 Displaying Terms in the Document
Argument Summary:
- <options> a <key>=<value> list of options.
- <label> the label uniquely identifying the
acronym (as defined by
\newacronym
). - <insert> text to insert after the term (but inside the hyperlink, if used with the hyperref package).
Font used to display acronyms. § 6.2 Using LaTeX to Sort and Collate Indexes or Glossaries (datagidx package)
Argument Summary:
- <text> the acronym.
As \acrpl
but the first letter is converted to
uppercase. § 6.2 Using LaTeX to Sort and Collate Indexes or Glossaries
(datagidx package)
Argument Summary:
- <format> the name of the formatting command without the initial backslash to be used for this location.
- <label> the label uniquely identifying the term.
Displays the plural of an acronym. On first use the full form is displayed. On subsequent use only the short form is displayed. § 6.2 Using LaTeX to Sort and Collate Indexes or Glossaries (datagidx package)
Argument Summary:
- <format> the name of the formatting command without the initial backslash to be used for this location.
- <label> the label uniquely identifying the term.
Displays the short form of the given acronym, the first letter converted to uppercase. § 6.1.2.2 Displaying Terms in the Document
Argument Summary:
- <options> a <key>=<value> list of options.
- <label> the label uniquely identifying the
acronym (as defined by
\newacronym
). - <insert> text to insert after the acronym (but inside the hyperlink, if used with the hyperref package).
Displays the short form of the given acronym. § 6.1.2.2 Displaying Terms in the Document
Argument Summary:
- <options> a <key>=<value> list of options.
- <label> the label uniquely identifying the
acronym (as defined by
\newacronym
). - <insert> text to insert after the acronym (but inside the hyperlink, if used with the hyperref package).
A synonym for \acrshort
. This command is only available if
the package option shortcuts is used. § 6.1.2.2 Displaying Terms in the Document
Argument Summary:
- <options> a <key>=<value> list of options.
- <label> the label uniquely identifying the
acronym (as defined by
\newacronym
). - <insert> text to insert after the term (but inside the hyperlink, if used with the hyperref package).
Adds a resource, such as a .bib file § 5.3 Biblatex
Argument Summary:
- <options> comma-separated list of <key>=<value> options
- <resource> the file name or URL of the resource
Sets the font characteristics for the given KOMA-Script element. (See Volume 1.) § 4.1 Changing the Document Style
Argument Summary:
- <element name> The element's name, for example chapter. See the KOMA-Script manual for a full list of defined elements.
- <commands> The font changing commands to apply to that element.
Æ ligature. § 6.1.1.1 Overriding the Default Sort
Indicates code that should be implemented at the next page break. § A.1 Too Many Unprocessed Floats
Argument Summary:
- <code> the relevant code.
A floating environment for typesetting algorithms. § 4.8 Algorithms
Argument Summary:
- <placement> floating placement specifier
Replacement for algorithm when used with the algo2e package option. § 4.8 Algorithms
Argument Summary:
- <placement> floating placement specifier
Typesets <angle> where <angle> is a single number or three semi-colon separated values. § 4.9 Formatting SI Units
Argument Summary:
- <angle> the angle (degrees) to typeset or <degrees>;<minutes>;<seconds>
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
. § 2. Getting Started
Argument Summary:
- <name> The name (or names) of the document author (or authors).
Suppresses chapter and section numbering, but still adds unstarred
sectional units to the table of contents. (See also \frontmatter
and \mainmatter
.) § 2. Getting Started
Starts an environment. (Must have a matching \end
.
See Volume 1.)
§ 2. Getting Started
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.) § 4.1 Changing the Document Style
Indicates the start of a new reference in the bibliography. May only be used inside the contents of thebibliography environment. (See Volume 1.) § 5.1.1 JabRef
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
.
Inputs the .bbl file (if it exists) and identifies the name(s) of the bibliography database files where the citations are defined. § 5.2 BibTeX
Argument Summary:
- <bib list> a comma-separated list of database names (without the .bib extension).
Specifies the bibliography style to be used by bibtex. § 5.2 BibTeX
Argument Summary:
- <style-name> the name of the bibliography style (corresponds to a file called <style-name>.bst).
Converts the initial letter of each word in <text> to uppercase. § 6.2 Using LaTeX to Sort and Collate Indexes or Glossaries (datagidx package)
Argument Summary:
- <text> the text that needs capitalising.
Inserts the caption for a float such as a figure or table. (See Volume 1.) § 4.8 Algorithms
Argument Summary:
- <short caption> If provided, an abbreviated caption to go in the list of figures/tables etc.
- <caption text> The caption contents.
Switches the paragraph alignment to centred. (See Volume 1.) § 4.1 Changing the Document Style
Indicates what to put in the centre footer area for the scrplain and scrheadings page styles. § 4.2 Changing the Page Style
Argument Summary:
- <scrplain> The text used by scrplain page style.
- <scrheadings> The text used by scrheadings page style.
Inserts a chapter heading. § 2. Getting Started
Argument Summary:
- <short title> An abbreviated form of the title to go in the table of contents or the page header.
- <title> The title.
Indicates what to put in the centre heading area for the scrplain and scrheadings page styles. § 4.2 Changing the Page Style
Argument Summary:
- <scrplain> The text used by scrplain page style.
- <scrheadings> The text used by scrheadings page style.
Like \cite
but for use at the start of a sentence. § 5.3 Biblatex
Argument Summary:
- <prenote> a prenote, such as “see”.
- <postnote> a postnote, such as the chapter or section within the work.
- <key list> A comma-separated list of keys identifying the entries.
Inserts the citation markers of each reference identified in the key list. A second run is required to ensure the reference is correct. When used with biblatex, this command has two optional arguments. § 5.2 BibTeX
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 used in
the corresponding
\bibitem
.
Parenthetical citation. § 5.2.1 Author-Year Citations
Argument Summary:
- <pre> prefix text
- <post> suffix text
- <key> key identifying required citation or comma-separated list of keys.
Textual citation. § 5.2.1 Author-Year Citations
Argument Summary:
- <pre> prefix text
- <post> suffix text
- <key> key identifying required citation or comma-separated list of keys.
Inserts a page break and processes any unprocessed floats § 3. Splitting a Large Document into Several Files
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. § 2. Getting Started
Argument Summary:
- <text> The document date.
Loads the document class file, which sets up the type of document you wish to write. (See Volume 1.) § 2. Getting Started
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.
Switches off the end of line semi-colon. (See also
\PrintSemicolon
.) § 4.8 Algorithms
Switches to double line-spacing. § 4.3 Double-Spacing
Formats the long and short form of an acronym. § 6.2 Using LaTeX to Sort and Collate Indexes or Glossaries (datagidx package)
Argument Summary:
- <long> the long form of the acronym.
- <short> the abbreviation.
Sets the default indexing database. § 6.2 Using LaTeX to Sort and Collate Indexes or Glossaries (datagidx package)
Argument Summary:
- <database label> the label uniquely identifying the required database.
For use in algorithm-like environments to indicate an else-block § 4.8 Algorithms
Argument Summary:
- <block> the else-block.
For use in algorithm-like environments to indicate an elseif-block § 4.8 Algorithms
Argument Summary:
- <block> the elseif-block.
Toggles the upright and italic/slanted rendering of <text>. (See Volume 1.) § 4.7.1 The amsthm Package
Argument Summary:
- <text> The text on which to apply the font change.
Ends an environment. (Must have a matching \begin
.
See Volume 1.) § 2. Getting Started
Argument Summary:
- <env-name> The name of the environment.
Ensures that its argument is displayed in maths mode. (If it's
already in maths mode, it just displays its argument, but if it's
not already in maths mode, it will typeset its argument in in-line
maths mode.) This command is usually only used in definitions, such as in
\newglossaryentry
, where it may be used in either text or
math mode. § 6.1.2.1 Defining Glossary Entries
Argument Summary:
- <maths> The maths to be displayed.
Greek lower case epsilon 𝛜. (See Volume 1.) § 4.8 Algorithms
Relational ≣ symbol. (See Volume 1.) § 4.7.1 The amsthm Package
\excludeonly
<<file list>>
Lists which of the files that are not to be included using \include
.
Only those files not in the list will be included. (The opposite
effect of \includeonly
.) § 3. Splitting a Large Document into Several Files
Argument Summary:
- <file list> Comma-separated list of file names.
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.)
§ 4.8 Algorithms
Argument Summary:
- <placement> The preferred placement.
For use in algorithm-like environments to indicate a for-loop § 4.8 Algorithms
Argument Summary:
- <condition> the for-loop condition.
- <body> the for-loop body.
Displays a fraction. (See Volume 1.) § 4.8 Algorithms
Argument Summary:
- <numerator> The numerator (above the line).
- <denominator> The denominator (below the line).
Switches to lower case Roman numeral page numbering. Also suppresses
chapter and section numbering, but still adds unstarred sectional
units to the table of contents. (See also \mainmatter
and \backmatter
.) § 2. Getting Started
Displays a glossary term according to its first use flag. The first letter of the term is converted to uppercase. § 6.1.2.2 Displaying Terms in the Document
Argument Summary:
- <options> a <key>=<value> list of options.
- <label> the label uniquely identifying the term.
- <insert> text to insert after the term (but inside the hyperlink, if used with the hyperref package).
Displays a glossary or index term with the first letter converted to uppercase. § 6.2 Using LaTeX to Sort and Collate Indexes or Glossaries (datagidx package)
Argument Summary:
- <format> the name of the formatting command without the initial backslash to be used for this location.
- <label> the label uniquely identifying the term.
Displays a glossary term according to its first use flag. § 6.1.2.2 Displaying Terms in the Document
Argument Summary:
- <options> a <key>=<value> list of options.
- <label> the label uniquely identifying the term.
- <insert> text to insert after the term (but inside the hyperlink, if used with the hyperref package).
Displays a glossary or index term. § 6.2 Using LaTeX to Sort and Collate Indexes or Glossaries (datagidx package)
Argument Summary:
- <format> the name of the formatting command without the initial backslash to be used for this location.
- <label> the label uniquely identifying the term.
Adds the given entry to the glossary without displaying any text. § 6.1.2.4 Displaying Glossaries
Argument Summary:
- <options> a comma-separated list of <key>=<value> options.
- <label> the label uniquely identifying the entry.
Adds the given entry to the glossary or index without displaying any text. § 6.2 Using LaTeX to Sort and Collate Indexes or Glossaries (datagidx package)
Argument Summary:
- <label> the label uniquely identifying the entry.
Adds all the defined entries without displaying any text. § 6.1.2.4 Displaying Glossaries
Argument Summary:
- <options> a comma-separated list of <key>=<value> options.
Adds all the defined entries in the named database without displaying any text. § 6.2 Using LaTeX to Sort and Collate Indexes or Glossaries (datagidx package)
Argument Summary:
- <database name> the label uniquely identifying the required database.
Displays the value of the first key for a glossary entry. § 6.1.2.2 Displaying Terms in the Document
Argument Summary:
- <label> the label uniquely identifying the entry.
Displays the value of the text key for a glossary entry. § 6.1.2.2 Displaying Terms in the Document
Argument Summary:
- <label> the label uniquely identifying the entry.
Displays the plural form of a glossary term according to its first use flag. The first letter of the plural text is converted to uppercase. § 6.1.2.2 Displaying Terms in the Document
Argument Summary:
- <options> a <key>=<value> list of options.
- <label> the label uniquely identifying the term.
- <insert> text to insert after the term (but inside the hyperlink, if used with the hyperref package).
Displays the plural form of a glossary or index term with the first letter converted to uppercase. § 6.2 Using LaTeX to Sort and Collate Indexes or Glossaries (datagidx package)
Argument Summary:
- <format> the name of the formatting command without the initial backslash to be used for this location.
- <label> the label uniquely identifying the term.
Displays the plural form of a glossary term according to its first use flag. § 6.1.2.2 Displaying Terms in the Document
Argument Summary:
- <options> a <key>=<value> list of options.
- <label> the label uniquely identifying the term.
- <insert> text to insert after the term (but inside the hyperlink, if used with the hyperref package).
Displays the plural form of a glossary or index term. § 6.2 Using LaTeX to Sort and Collate Indexes or Glossaries (datagidx package)
Argument Summary:
- <format> the name of the formatting command without the initial backslash to be used for this location.
- <label> the label uniquely identifying the term.
Resets a glossary term's first use flag. § 6.1.2.2 Displaying Terms in the Document
Argument Summary:
- <label> the label identifying the term that needs resetting.
Displays the symbol element of a glossary entry. § 6.1.2.2 Displaying Terms in the Document
Argument Summary:
- <options> a <key>=<value> list of options.
- <label> the label uniquely identifying the term.
- <insert> text to insert after the term (but inside the hyperlink, if used with the hyperref package).
Unsets a glossary term's first use flag. § 6.1.2.2 Displaying Terms in the Document
Argument Summary:
- <label> the label identifying the term that needs unsetting.
Indicates a gram in commands like \si
. § 4.9 Formatting SI Units
Determines the font used by the header and footer with the scrplain and scrheadings page styles. § 4.2 Changing the Page Style
Used in commands like \ihead
to insert the current
running header. § 4.2 Changing the Page Style
Inserts a horizontal space that will expand to fit the available width. § 4.4 Changing the Title Page
Inserts a horizontal gap of the given width. § 4.4 Changing the Title Page
Argument Summary:
- <length> The width of the horizontal gap.
For use in algorithm-like environments to indicate an if-statement § 4.8 Algorithms
Argument Summary:
- <condition> the if-statement condition.
- <block> the true-part of the if-statement.
Indicates what to put in the inner footer area for the scrplain and scrheadings page styles. § 4.2 Changing the Page Style
Argument Summary:
- <scrplain> The text used by scrplain page style.
- <scrheadings> The text used by scrheadings page style.
Indicates what to put in the inner heading area for the scrplain and scrheadings page styles. § 4.2 Changing the Page Style
Argument Summary:
- <scrplain> The text used by scrplain page style.
- <scrheadings> The text used by scrheadings page style.
Issues a \clearpage
, creates an associated auxiliary file,
inputs <file name> and issues another \clearpage
.
(See also \input
.) § 3. Splitting a Large Document into Several Files
Argument Summary:
- <file name> The name of the file to be included. (The .tex extension may be omitted.)
\includeonly
<<file list>>
Lists which of the files that are included using \include
should be read in. Any files not in the list won't be included. § 3. Splitting a Large Document into Several Files
Argument Summary:
- <file list> Comma-separated list of file names.
Adds indexing information to an external index file. The command
\makeindex
must be used in the preamble to enable
this command. The external index file must be post-processed with
an indexing application, such as makeindex. § 6.1.1 Creating an Index (makeidx
package)
Argument Summary:
- <text> The text to go in the index.
Reads in the contents of <file name>. (See also
\include
.) § 3. Splitting a Large Document into Several Files
Argument Summary:
- <file name> The name of the file to be read in. (The .tex extension may be omitted.)
Switches to the italic form of the current font family, if it exists. (See Volume 1.) § 4.2 Changing the Page Style
Sets the tab stops defined in the line but won't typeset the actual line. § 4.6 Tabbing
Indicates a kilo multiplier in commands like \si
. § 4.9 Formatting SI Units
For use in algorithm-like environments to indicate the algorithm input data § 4.8 Algorithms
Argument Summary:
- <text> the algorithm input data.
For use in algorithm-like environments to indicate the algorithm input § 4.8 Algorithms
Argument Summary:
- <text> the algorithm input
For use in algorithm-like environments to indicate the algorithm output § 4.8 Algorithms
Argument Summary:
- <text> the algorithm output
For use in algorithm-like environments to indicate the algorithm output § 4.8 Algorithms
Argument Summary:
- <text> the algorithm output.
For use in algorithm-like environments to indicate a value returned § 4.8 Algorithms
Argument Summary:
- <value> the return value.
For use in algorithm-like environments to indicate ``to'' keyword § 4.8 Algorithms
Argument Summary:
Assigns a unique textual label linked to the most recently incremented cross-referencing counter in the current scope. (See Volume 1.) § 2. Getting Started
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.)
Switches to large sized text. (See Volume 1.) § 4.1 Changing the Document Style
Argument Summary:
Left arrow ←. (See Volume 1.) § 4.8 Algorithms
Inserts the list of figures. A second (possibly third) run is required to ensure the page numbering is correct. § 2. Getting Started
Inserts the list of tables. A second (possibly third) run is required to ensure the page numbering is correct. § 2. Getting Started
Typesets <code> as an inline code snippet. § 4.5 Listings and Other Verbatim Text
Argument Summary:
- <opts> comma-separated list of <key>=<value> options.
- <char> single character delimiter that doesn't occur in <code>
- <code> the code snippet
Reads in <filename> and typesets the contents as displayed code. § 4.5 Listings and Other Verbatim Text
Argument Summary:
- <options> comma-separated list of <key>=<value> options.
- <filename> the name of the file to input.
Typesets the contents of the environment as displayed code. § 4.5 Listings and Other Verbatim Text
Argument Summary:
- <options> comma-separated list of <key>=<value> options.
Prints a list of listings for those listings with the caption set. § 4.5 Listings and Other Verbatim Text
Sets options used by the listings package. § 4.5 Listings and Other Verbatim Text
Argument Summary:
- <options> comma-separated list of <key>=<value> options.
Left vertical bar | delimiter. (See Volume 1.) § 4.8 Algorithms
Switches to Arabic page numbering and enables
chapter and section numbering. (See also
\frontmatter
and \backmatter
.) § 2. Getting Started
Activates \printglossaries
(and \printglossary
). § 6.1.2.1 Defining Glossary Entries
Enables \index
. § 6.1.1 Creating an Index (makeidx
package)
Converts <text> to uppercase. § 6.2 Using LaTeX to Sort and Collate Indexes or Glossaries (datagidx package)
Argument Summary:
- <text> the text that needs to be uppercased.
Generates the title page (or title block). This command is usually placed at the beginning of the document environment. § 2. Getting Started
Converts its argument to upper case. § 5.1.1 JabRef
Argument Summary:
- <text> the text to be converted.
Renders <maths> in the predefined maths bold font. (Doesn't work with numbers and nonalphabetical symbols. See Volume 1.) § 4.8 Algorithms
Argument Summary:
- <maths> The text on which to apply the font change.
Typesets its argument in the maths calligraphic font.
Example:
$\mathcal
{S}$
produces
𝓢. (See Volume 1.) § 6.1.2.1 Defining Glossary Entries
Argument Summary:
- <maths> The maths to be displayed in a calligraphic font.
Indicates the metre unit for use in commands like \si
. § 4.9 Formatting SI Units
Defines a new acronym. § 6.2 Using LaTeX to Sort and Collate Indexes or Glossaries (datagidx package)
Argument Summary:
- <options> a comma-separated list of
<key>=<value> options (same as
\newterm
). - <short> the abbreviation.
- <long> the long form.
Shortcut that uses \newglossaryentry
to define an acronym. § 6.1.2.1 Defining Glossary Entries
Argument Summary:
- <key-val list> A comma-separated list (same as
for
\newglossaryentry
) that can be used to override\newacronym
defaults or add additional information. - <abbrv> The acronym.
- <long> The long (expanded) form of the acronym.
Defines a new command. (See Volume 1.) § 4.2 Changing the Page Style
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.
Defines a new index (or glossary) database. § 6.2 Using LaTeX to Sort and Collate Indexes or Glossaries (datagidx package)
Argument Summary:
- <label> a label uniquely identifying this database.
- <title> the title to be used when this index (or glossary) is displayed.
Defines a new glossary. § 6.1.2.3 Defining New Glossaries
Argument Summary:
- <log-ext> the extension of the associated log file.
- <name> a label that uniquely identifies this new glossary
- <in-ext> the associated glossary input file extension.
- <out-ext> the associated glossary output file extension.
- <title> the title used when the glossary is displayed.
- <counter> the default counter to use in this glossary's location lists.
Defines a new glossary entry or term. § 6.1.2.1 Defining Glossary Entries
Argument Summary:
- <label> A unique label identifying this entry.
- <key-val list> A comma-separated list that define this entry.
Forces a line break. § 4.7.1 The amsthm Package
Defines a new index or glossary term. § 6.2 Using LaTeX to Sort and Collate Indexes or Glossaries (datagidx package)
Argument Summary:
- <options> a comma-separated list of <key>=<value> options.
- <name> the term.
Defines a new theorem-like environment. The optional arguments are mutually exclusive. Some packages, such as ntheorem and amsthm, redefine this command to have a starred variant that defines unnumbered theorem-like environments. § 4.7 Theorems
Argument Summary:
- <name> the name of the new environment
- <counter> the counter to be used by the new environment
- <title> the title for the new environment
- <outer counter> the parent counter
\newtheoremstyle
{<name>}{<space
above>}{<space below>}{<body
font>}{<indent>}{<head
font>}{<post head punctuation>}{<post head
space>}{<head spec>}
Defines a new theorem style called <name>. § 4.7.1 The amsthm Package
Argument Summary:
- <name> the name of the new theorem style
- <space above> the amount of space above the theorem-like environment
- <space below> the amount of space below the theorem-like environment
- <body font> the font to use in the main theorem body
- <indent> the amount of indentation (empty means
no indent or use
\parindent
for normal paragraph indentation) - <head font> the font to use in the theorem header
- <post head punctuation> the punctuation to use after the theorem head
- <post head space> the space to put
after the theorem head (use { } for normal interword space or
\newline
for a linebreak) - <head spec> the theorem head spec
Switches to the default font style. (See Volume 1.) § 4.2 Changing the Page Style
Typesets <number> with appropriate spacing. § 4.9 Formatting SI Units
Argument Summary:
- <number> the number to typeset
Indicates what to put in the outer footer area for the scrplain and scrheadings page styles. § 4.2 Changing the Page Style
Argument Summary:
- <scrplain> The text used by scrplain page style.
- <scrheadings> The text used by scrheadings page style.
Indicates what to put in the outer heading area for the scrplain and scrheadings page styles. § 4.2 Changing the Page Style
Argument Summary:
- <scrplain> The text used by scrplain page style.
- <scrheadings> The text used by scrheadings page style.
Switches to one-half line-spacing. § 4.3 Double-Spacing
Used in commands like \ihead
to insert the current page
number. § 4.2 Changing the Page Style
Sets the style of the page numbers. § 2. Getting Started
Argument Summary:
- <style> The page numbering style (e.g. roman for lower case Roman numerals).
Sets the style of the headers and footers. § 4.2 Changing the Page Style
Argument Summary:
Like \parencite
but for use at the start of a sentence. § 5.3 Biblatex
Argument Summary:
- <prenote> a prenote, such as “see”.
- <postnote> a postnote, such as the chapter or section within the work.
- <key list> A comma-separated list of keys identifying the entries.
Like \cite
but the citation is enclosed in parentheses. § 5.3 Biblatex
Argument Summary:
- <prenote> a prenote, such as “see”.
- <postnote> a postnote, such as the chapter or section within the work.
- <key list> A comma-separated list of keys identifying the entries.
Indicates a divider in commands like \si
. § 4.9 Formatting SI Units
Determines the font used by \pagemark
with the
scrplain and scrheadings page styles. § 4.2 Changing the Page Style
Prints the bibliography. § 5.3 Biblatex
Argument Summary:
- <options> comma-separated list of <key>=<value> options
Prints all of the defined glossaries. § 6.1.2.4 Displaying Glossaries
Prints the glossary identified in the optional argument or the default glossary if none identified. § 6.1.2.4 Displaying Glossaries
Argument Summary:
- <key-val option list> A comma-separated list of <key>=<value> options
Prints the index. Must be used with \makeindex
and \index
.
(The external index file must first be processed by an indexing application.) § 6.1.1 Creating an Index (makeidx
package)
Switches on the end of line semi-colon. (See also
\DontPrintSemicolon
.) § 4.8 Algorithms
Displays the index or glossary or list of acronyms. § 6.2 Using LaTeX to Sort and Collate Indexes or Glossaries (datagidx package)
Argument Summary:
- <options> a comma-separated list of options.
Typesets its contents as a proof. § 4.7.1 The amsthm Package
Argument Summary:
- <title> replacement for the default title.
Specifies the publisher (set after all the other titling information). § 2. Getting Started
Argument Summary:
- <text> The publisher text.
Overrides default location of QED marker in proof environment. § 4.7.1 The amsthm Package
QED symbol used at the end of the proof environment. § 4.7.1 The amsthm Package
Ragged-right paragraph justification. (See Volume 1.) § 4.1 Changing the Document Style
Governs the justification of headings. Defaults to
\raggedright
§ 4.1 Changing the Document Style
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.) § 4.5 Listings and Other Verbatim Text
Argument Summary:
- <string> The required label that was used in the
corresponding
\label
.
Redefines an existing command. (See Volume 1.) § 4.1 Changing the Document Style
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.
For use in algorithm-like environments to indicate a value returned § 4.8 Algorithms
Argument Summary:
- <value> the return value.
Switches to the predefined serif font. (See Volume 1.) § 4.1 Changing the Document Style
Right vertical bar | delimiter. (See Volume 1.) § 4.8 Algorithms
Switches to the small-caps form of the current font family, if it exists. (See Volume 1.) § 4.7.1 The amsthm Package
Indicates the second unit for use in commands like \si
. § 4.9 Formatting SI Units
Typesets a number and unit, combining the functionality of
\num
and \si
. § 4.9 Formatting SI Units
Argument Summary:
- <unit> the unit to typeset
Typesets the given unit. § 4.9 Formatting SI Units
Argument Summary:
- <unit> the unit to typeset
Relational ∼ symbol. § 4.7 Theorems
Switches to single line-spacing. § 4.3 Double-Spacing
Displays a root. (See Volume 1.) § 4.5 Listings and Other Verbatim Text
Argument Summary:
- <order> The order of the root. (If omitted, a square root).
- <operand> The operand.
\square
<unit>
Indicates a squared unit in commands like \si
. § 4.9 Formatting SI Units
Indicates a squared term in commands like \si
after a unit command such as \metre
. § 4.9 Formatting SI Units
Summation ∑ symbol. (See Volume 1.) § 4.8 Algorithms
Allows you to define tab stops from the left margin. § 4.6 Tabbing
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.) § 4.8 Algorithms
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. § 2. Getting Started
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.
Like \textcite
but for use at the start of a sentence. § 5.3 Biblatex
Argument Summary:
- <prenote> a prenote, such as “see”.
- <postnote> a postnote, such as the chapter or section within the work.
- <key list> A comma-separated list of keys identifying the entries.
Like \cite
but designed for use in the flow of text. § 5.3 Biblatex
Argument Summary:
- <prenote> a prenote, such as “see”.
- <postnote> a postnote, such as the chapter or section within the work.
- <key list> A comma-separated list of keys identifying the entries.
Renders <text> in the predefined monospaced font. (See Volume 1.) § 6.1.1.1 Overriding the Default Sort
Argument Summary:
- <text> The text on which to apply the font change.
Bibliographic list. (See Volume 1.) § 5. Generating a Bibliography
Argument Summary:
- <widest entry label> The widest label in the bibliography list.
Changes the current theorem body fonts to <declarations>. § 4.7.2 The ntheorem Package
Argument Summary:
- <declarations> font declarations (such as
\normalfont
)
Changes the current theorem header fonts to <declarations>. § 4.7.2 The ntheorem Package
Argument Summary:
- <declarations> font declarations (such as
\normalfont
)
Changes the current theorem numbering style to <style>. § 4.7.2 The ntheorem Package
Argument Summary:
- <style> counter style, such as arabic or roman.
Changes the current theorem style to <style name>. § 4.7.1 The amsthm Package
Argument Summary:
- <style name> the name of the theorem style
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
. § 2. Getting Started
Argument Summary:
- <text> The title of the document.
Specifies the title header (typeset at the top of the title page). § 2. Getting Started
Argument Summary:
- <text> The title header text.
The contents of this environment are displayed on a single-column page with no header or footer and the page counter is set to 1. § 4.4 Changing the Title Page
Switches to the predefined monospaced font. (See Volume 1.) § 4.5 Listings and Other Verbatim Text
Like \ElseIf
but doesn't put “end” after <block> § 4.8 Algorithms
Argument Summary:
- <block> the elseif-block.
Like \If
but doesn't put “end” after <block> § 4.8 Algorithms
Argument Summary:
- <condition> the if-statement condition.
- <block> the true-part of the if-statement.
Loads the listed package(s). (See Volume 1.) § 2. Getting Started
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).
Typesets its argument as a vector. (See Volume 1.) § 4.8 Algorithms
Argument Summary:
- <c> The character or symbol that represents a vector.
Operator ∨ symbol. (See Volume 1.) § 4.7.1 The amsthm Package
Typesets the contents of the environment as is. (Can't be used in the argument of a command.) § 4.5 Listings and Other Verbatim Text
Inserts a vertical space that will expand to fit the available height. § 4.4 Changing the Title Page
Inserts a vertical gap of the given height. § 4.4 Changing the Title Page
Argument Summary:
- <length> The height of the vertical gap.
Operator ∧ symbol. (See Volume 1.) § 4.7.1 The amsthm Package
For use in algorithm-like environments to indicate a while-loop § 4.8 Algorithms
Argument Summary:
- <condition> the while-loop condition.
- <body> the while-loop body.
This book is also available as A4 PDF or 12.8cm x 9.6cm PDF or paperback (ISBN 978-1-909440-02-9).