brumaltex3

A \LaTeX package used by abstrnoah.

This package has had three iterations. Each iteration, I have essentially started over, so no cross-compatibility is guaranteed. Maybe they shouldn't be considered versions of the same package. Each iteration aims to be increasingly stable and useful to people who aren't me. That said, it's a personal package, so quite unstable and insufficiently documented. If you find its contents useful and that it contains a bug, please do let me know!

For broad documentation, see below; for per-macro documentation, see docstrings in the source.

To avoid conflicts, command names are prefixed like \brtCommand and environment names like brtenvironment. Exceptions are noted below.

dependencies

The package tries to limit dependencies to mainstream packages. I use the tectonic \LaTeX engine and occasionally Overleaf. Both platforms are able to provide brumaltex3's dependencies as of January 2024.

Core dependencies:

• expl3
• xparse
• amsmath
• amssymb
• amsthm
• mathtools
• physics
  • Single most useful \LaTeX package I have ever found.
• csquotes
  • For quotes, use \enquote{Quoted text} instead of ``Quoted text''.
• mathrsfs
• stmaryrd
• dsfont
• bm

A few modules require additional packages (only if loaded); see below.

For more information on any of these packages, head over to ctan.

modules

The package is modular. Modules are loaded like

\usepackage[comma,
            separated,
            module,
            names,
            in-any-order,
            duplicates-are-okay]
           {brumaltex3}

Modules are declared in the source code as

\brt_declare_module:nnn {module-name} ...

Modules that are loaded by default (and there is no way to prevent them from loading):

• module
  • This isn't actually a module. But the package provides some machinery beyond the builtin \DeclareOption for bootstrapping the module system. The two main features I wanted that I wasn't sure I could easily guarantee with builtins: (1) Transitive dependencies between modules. (2) Never ever load a module more than once no matter what even if you do something like \ExecuteOptions.
• core-external-dependencies
  • See above.

Modules that are optional:

• expl3-library
  • Some utilities built on top of expl3.
  • To use, you'll need \ExplSyntaxOn...\ExplSyntaxOff.
• breaklessmaths
  • Never ever break in maths mode.
• latex3-issue1090-workaround
  • See latex3/latex3#1090.
  • This issue has been fixed in the current version of expl3, but tectonic doesn't ship that version, so I ship this workaround for maximum compatibility.
• ref
  • Include packages 'hyperref' and 'cleverref' with some custom options set.
  • Reformats \thefootnote.
  • Provides \brtRef[text]{label} wrapper around \hyperref.
• biblatex
  • Include package 'biblatex' with some custom options set.
  • Use \addbibresource after loading brumaltex3 to load your .bib file.
  • Use biblatex-draft module instead for faster compilation (does not load biblatex; provides dummy commands instead).
• environments
  • Provide some common environments via \newtheorem.
  • Provide some wrappers around proof.
  • Provide an environment scope which does nothing except create a new environment scope.
  • Warning: Environments are not brt-prefixed.
• sections
  • Redefine \paragraph{#1} -> \paragraph{#1.}.
  • Provides brtpart environment wrapper around \part.
    • Experimental: Auto \label{part:#1}.
  • Provides brtsection environment which automatically "subs" upon nesting.
    • Experimental: Auto \label{section:#1}.
• nestedproofs
  • Change the proof environment QED symbol depending on how deeply it is nested.
  • This is done automatically; the user the does not have to do anything beyond loading this module and using proof as usual.
  • See \brtDefaultQeds for the default list of qed symbols, which provides six levels of nesting.
  • Use \brtQedSet {\topLevelQed, \secondQed, \thirdQed, ...} to set a custom list of QED symbols.
  • An error will occur if you nest deeper than the number of QED symbols passed to \brtQedSet (but you really shouldn't be nesting that deeply, should you?).
• fullpage
  • Load the geometry package and set all margins to 1in.
• composition
  • Provide a way of declaring "composition rules" for pairs of macros.
  • \brt_comp_new_nn_nn:NNN defines a composition rule for a pair of functions each taking two arguments. See how \brtLHForall and \brtLHExists compose for an example.
  • Currently this is the only kind of composition implemented, since it's the only one I've needed. Generalising composition signature is highly nontrivial in LaTeX (believe me, I've tried).
• composition-unwrap-ii
  • Like composition, but "unwrap" the second argument.
  • E.g. with this module, the expression \Forall x {\Exists y {A(x,y)}} behaves the same as \Forall x \Exists y {A(x,y)}. Without this module and only composition loaded, the two are not equivalent.
• longhand
  • Useful macros for document authors (mostly mathematical).
  • All macros have long, self-descriptive names prefixed by \brtLH...; the user could bind their own shorthand commands to these.
• shorthand
  • My own shorthand bindings to longhand macros.
  • Warning: Names are not brt-prefixed, so beware conflicts. I probably redefine your favourite command.
• friends-*
  • TODO
• experiments
  • Scary.
• font
  • Load my custom font setup at your own risk (I don't actually know how LaTeX fonts work).
• datetime
  • Custom 'datetime' configuration, namely day-month-year.
• tikzcd
  • Custom 'tikz-cd' configuration, namely ampersand replacement=\&.
• parskip
  • Load 'parskip' package and (partially) fix spacing around proof environment.
• abstrnoah-*
  • Several collections of modules for the author's common use-cases.
  • Unstable, so check the source for an up-to-date list.

overriding

Because I don't expect name conflicts, many commands are defined in a way that overrides existing definitions or errors out if there is a conflict.

The "officially supported" approach to overriding this package's definitions is to override them after the package is loaded.

The shorthand package clobbers previous definitions and makes inconsistent efforts to save the macros it overrides. If you don't like shorthand's definitions, then you should probably avoid loading it altogether and create your own shorthand on top of longhand.

Most longhand/shorthand macros are declared without definition-time expansion meaning, e.g., that if you override a longhand command then the shorthand command pointing to it will also be changed.

---