https://github.com/yuki-koyama/latexie

Utilities for writing papers with LaTeX
https://github.com/yuki-koyama/latexie

commands latex package

Last synced: 3 months ago
JSON representation

Utilities for writing papers with LaTeX

• Host: GitHub
• URL: https://github.com/yuki-koyama/latexie
• Owner: yuki-koyama
• License: mit
• Created: 2019-07-22T11:11:11.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-11-09T09:32:53.000Z (about 1 year ago)
• Last Synced: 2023-11-09T11:15:26.504Z (about 1 year ago)
• Topics: commands, latex, package
• Language: TeX
• Size: 22.5 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# latexie

Utilities for writing papers with LaTeX

- `latexie.sty`: The main style file with many custom commands

- `latexie-article.cls`: A plain article class with nice format settings

## Goals

- Faster paper writing (especially in the computer science domain)

- Shorter commands while preserving readability (e.g., `\bfx` rather than `\mathbf{x}`)

- Better maintainability by providing semantic commands (e.g., `\T` rather than `\top` for the matrix transposition)

## Usage

```latex

\usepackage{/path/to/this/repository/latexie}

```

## Policies

### Overall

- Prefer `\newcommand` and `\renewcommand` (LaTeX) to `\def` (TeX)

  - [macros - What is the difference between \def and \newcommand? - TeX - LaTeX Stack Exchange](https://tex.stackexchange.com/questions/655/what-is-the-difference-between-def-and-newcommand)

- Prefer `\newcommand*` to `\newcommand` if it is the intention

  - [macros - What's the difference between \newcommand and \newcommand*? - TeX - LaTeX Stack Exchange](https://tex.stackexchange.com/questions/1050/whats-the-difference-between-newcommand-and-newcommand)

### Math

- Prefer `\DeclareMathOperator` (from `amsmath` package) to `\newcommand`

  - [best practices - What is the difference of \mathop, \operatorname and \DeclareMathOperator? - TeX - LaTeX Stack Exchange](https://tex.stackexchange.com/questions/84302/what-is-the-difference-of-mathop-operatorname-and-declaremathoperator)

- Use `\top` for the matrix and vector transpose operator

  - [List of mathematical symbols - Wikipedia](https://en.wikipedia.org/wiki/List_of_mathematical_symbols) (Retrieved: 2022/04/03)

## Documentation

### Options

- `noannotation`: If this option is passed, the annotation commands do not display annotaions. More specifically, `\note` and `\todo` do not rendered, and `\spot` displays its content without colored.

## Dependencies

- amsmath

- amsfonts

- ifthen

- xcolor

## Math Examples

Before:

```latex

p(\mathcal{D} \:\vert\: \boldsymbol{\theta})

```

After:

```latex

\cprob{ \calD }{ \bftheta }

```

Result:



----

Before:

```latex

\mathcal{N}(\mathbf{x}; \boldsymbol{\mu}, \boldsymbol{\Sigma})

=

\frac{1}{(2 \pi)^{\frac{n}{2}} \det(\boldsymbol{\Sigma})^{\frac{1}{2}}}

\exp \left\{

  - \frac{1}{2} (\mathbf{x} - \boldsymbol{\mu})^{\top} \boldsymbol{\Sigma}^{-1} (\mathbf{x} - \boldsymbol{\mu})

\right\}

```

After:

```latex

\calN(\bfx; \bfmu, \bfSigma)

=

\frac{1}{(2 \pi)^{\frac{n}{2}} \det(\bfSigma)^{\frac{1}{2}}}

\exp \left\{

  - \frac{1}{2} (\bfx - \bfmu)^\T \bfSigma^\inv (\bfx - \bfmu)

\right\}

```

Result:



----

Before:

```latex

\begin{bmatrix}

  \mathbf{A} & \mathbf{B} \\

  \mathbf{C} & \mathbf{D}

\end{bmatrix}^{-1}

=

\begin{bmatrix}

  \mathbf{A}^{-1} ( \mathbf{I} + \mathbf{B} ( \mathbf{D} - \mathbf{C} \mathbf{A}^{-1} \mathbf{B} )^{-1} \mathbf{C} \mathbf{A}^{-1} ) &

  - \mathbf{A}^{-1} \mathbf{B} ( \mathbf{D} - \mathbf{C} \mathbf{A}^{-1} \mathbf{B} )^{-1} \\

  - ( \mathbf{D} - \mathbf{C} \mathbf{A}^{-1} \mathbf{B} )^{-1} \mathbf{C} \mathbf{A}^{-1} &

  ( \mathbf{D} - \mathbf{C} \mathbf{A}^{-1} \mathbf{B} )^{-1}

\end{bmatrix}

```

After:

```latex

\bmat{

  \bfA & \bfB \\

  \bfC & \bfD

}^\inv

=

\bmat{

  \bfA^\inv ( \bfI + \bfB ( \bfD - \bfC \bfA^\inv \bfB )^\inv \bfC \bfA^\inv ) &

  - \bfA^\inv \bfB ( \bfD - \bfC \bfA^\inv \bfB )^\inv \\

  - ( \bfD - \bfC \bfA^\inv \bfB )^\inv \bfC \bfA^\inv &

  ( \bfD - \bfC \bfA^\inv \bfB )^\inv

}

```

Result:



## Limitations

Some commands are probably not very effective with

- code highlighting

- code completion

- code snippets

## Example

See `example.tex` for a working example. It can be compiled by using `pdflatex`. If you use `latexmk`, then run this command:

```sh

latexmk -pdf example

```