CHANGELOG.md 5.3 KB
Newer Older
1 2 3 4 5 6 7
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

8 9
[[_TOC_]]

10 11
## [Unreleased]

Alexander Povel's avatar
Alexander Povel committed
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
## [4.0.0] - 2021-10-18

### Added

- `matlab2tikz` improved alternative showcase using `pgfplots` (0910bca)
- Important badges of high importance for important information (d19b8d9)
- Hint on `parskip` usage to remove paragraph indentation in favor of vertical space (a292f6b)
- Support for *Acronyms* glossary title localization (86c0be1)
- New package for tables, `tabularray` (6825ff9, 480b400)
- Docker image source (merged in c584129)
- Additional math/unit font examples (2e3a582)

### Fixed

- Display of dimensionless quantities (5f8dc71)
- Tabular vertical excess white space (e5f983e)

### Changed

- usage of `chemmacros` over `chemformula` (e379fa9, c26d613)
- `siunitx` settings and usage to support [major version 3](https://github.com/josephwright/siunitx/blob/v3.0.0/CHANGELOG.md#v300) (bb931a9, 4fc2caf, 6747a36, 190bc89, e83902a, 82977ce)
- Docker image source (b50eb6f, f10005e, 548dca9, a8fff45, afa8407, 3a0b4f0, a57a4ec)
- massive simplification/moving of README content (f8f4d3f, 2925463, 2840312, a99df09, bcb4d69)

### Removed

- LaTeX Workshop automatic compilation on save (6b0d313)
- Old files (6fbdc2e, 04eb8fe, 096331c, b37316d, cdc285d)

Alexander Povel's avatar
Alexander Povel committed
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
## [3.1.0] - 2021-03-12

### Added

- Toggle for inclusion of glossaries in the Table of Contents (ToC) (5c23bd0)
- Example for an appendix (d4a42ce)
- Translations for code listings in references, lists, captions (6148d55)
- ARCHITECTURE document (840eff8)
- Example for a `longtabu` (multi-page table) displaying random data generated by custom Lua script (9e89214)
- Section on alternative ways to compile (f2d550d)
- Configuration and ideal setup for working with this template inside Visual Studio Code, using its native container development environment (38a0bb2)
- Example for a new unit specification using `siunitx` (7a2d0d0)

### Changed

- Switched bibliography generation from vanilla Zotero to Zotero with its excellent **Better Bibtex** addon (a05f5f4)
- Fixed biblatex fields according to `biber --validate-datamodel` validation (eb068bd)
- Fixed using a system directory for `pandoc`, which required `sudo` privileges (no just user privileges) (d8f4c1c)

### Removed

- TeXGyrePagella font files: use those included in the TeX distribution itself (d74c2d9)
- Trailing whitespaces (WOW!) (d766fb6)

Alexander Povel's avatar
Alexander Povel committed
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
## [3.0.0] - 2021-02-03

### Added

- Option to suppress printing of pages list in the glossaries (b75d3d1)
- GitLab description templates (7038798)

### Changed

- Syntax highlighting now uses `minted` instead of `listings`, a backwards-incompatible change (19fbd87)
- Documentation now stresses Docker usage over manual "labour" (6843a2b)

### Removed

- Previous, custom-made `listings` language definitions; these are covered much better by `pygments`, aka `minted` (19fbd87)

Alexander Povel's avatar
Alexander Povel committed
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
## [2.0.0] - 2020-11-11

### Added

- Python-based tests for the produced PDFs (1746e4e).
  This allows the user to automatically run a test suite against the produced PDFs,
  for example checking for page count, metadata and much more.
- Makefiles for the [root](Makefile) and [tests](tests/Makefile) directories, while
  also swapping all CI routines over to use `make` (b4a9881).
  This allows for local as well as CI use using the same commands, and reduces coupling
  with the CI engine.
- Caching of files in CI, for much faster pipelines (while introducing some issues) (28aea76).
- Showcase and fixing of `\abs` macro for absolute values (4d0c6ff, bb11b72).

### Changed

- Git metadata display in the colophon (7c59cbe).

99 100
## [1.2.0] - 2020-10-29

Alexander Povel's avatar
Alexander Povel committed
101 102 103
### Added

- Showcase for multiple lines with contours in TikZ overlay (ae4ad39)
Alexander Povel's avatar
Alexander Povel committed
104
- Hint for the `glossaries-extra` *Beginner's Guide* (d8b7fb4)
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
- Written permission (license) to use and distribute the [Fontin Sans](https://www.fontsquirrel.com/fonts/fontin-sans)
  font (cf79ee4)
- Summary for font licenses (0372475)
- Contributing guideline (56c4eac)
- README info on git and Docker (fa228b7)
- A `matlab2tikz` exported plot example (86dac19, c3e9b09)
- `YAML`-based configs for pandoc (cb39706)
- Proper check for the used TeX engine (de2a293)

### Changed

- Fontawesome implementation, away from the `fontawesome` package to the more
  modern `fontawesome5` (8df784e)
- Insertion of git metadata into the document (PDF metadata or into the printed text
  directly): now based on Lua (6d0cd7e)
- Also adjusted the README according to the new Lua implementation (ed946b8)
121

122 123 124 125 126 127
## [1.1.1] - 2020-06-09

### Added

- Entry `Mach` in `names.bib` (d0d5683). Was previously removed, but is required.

128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
## [1.1.0] - 2020-06-09

### Added

- Added `bib` file entries for the built-in math macros (f1803d3b):
  - `\mean`
  - `\logmean`
  - `\flow`
  - `\difference`
  - `\nablaoperator`
  - `\vect`
  - `\deriv`
  - `\fracderiv`
  - `\timederiv`
  - `\posderiv`
- New tabular showcasing those built-in math macros (119fce11)
- New tabular showcasing the built-in glossary commands (0e7ed5a9):
  - `\idx`
  - `\name`
  - `\sym`
  - `\sub`
  - `\abb`
  - `\cons`
- Added sample entries for the *Terms* index (6ca2670b)

### Removed

- Unused entry `Mach` in `names.bib` (c000d4ec)

## [1.0.0] - 2020-04-22

### Added

- Initial release