CHANGELOG.md 3.06 KB
Newer Older
1 2 3 4 5 6 7 8 9
# 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).

## [Unreleased]

Alexander Povel's avatar
Alexander Povel committed
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
## [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
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
## [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).

44 45
## [1.2.0] - 2020-10-29

Alexander Povel's avatar
Alexander Povel committed
46 47 48
### Added

- Showcase for multiple lines with contours in TikZ overlay (ae4ad39)
Alexander Povel's avatar
Alexander Povel committed
49
- Hint for the `glossaries-extra` *Beginner's Guide* (d8b7fb4)
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
- 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)
66

67 68 69 70 71 72
## [1.1.1] - 2020-06-09

### Added

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

73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
## [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