changelog.md 10.9 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](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

Ekkart Kleinod's avatar
Ekkart Kleinod committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

## Unreleased

### Added

- neues Skript `pyMergeChanges.py` für die Entfernung von Markierungen

- new script `pyMergeChanges.py` for removing markup

### Removed

- altes Skript `delcmdchanges.bash`, das nicht mehr funktionierte

- old script `delcmdchanges.bash` which does not work anymore


24
## [3.0.0] - 2018-11-04
Ekkart Kleinod's avatar
Ekkart Kleinod committed
25 26 27

### Added

Ekkart Kleinod's avatar
Ekkart Kleinod committed
28 29
- Befehl `comment` und zugehörige Hilfsbefehle/-zähler
- Befehl `highlight` und zugehörige Hilfsbefehle/-zähler
30
- Änderungslistenstil `compactsummary`
31
- Titel-Option für Änderungslisten `title`
32
- `show`-Option für Änderungslisten (Einschränkung der Anzeige auf bestimmte Typen von Änderungen)
33
- Befehle `setsummarywidth` und `setsummarytowidthof` zum Setzen der Breite der Änderungszusammenfassung
34
- Befehl `settruncatewidth` zum Setzen der Breite der Textkürzung in der Änderungsliste
35

Ekkart Kleinod's avatar
Ekkart Kleinod committed
36 37
- command `comment` and the belonging helper commands resp. counters
- command `highlight` and the belonging helper commands resp. counters
38
- style for list of changes `compactsummary`
39 40
- `title` option for list of changes
- `show` option for list of changes, specify types of changes to show
41 42
- commands `setsummarywidth` and `setsummarytowidth` for setting the width of the summary
- command `settruncatewidth` for setting width of truncation in list of changes
43

Ekkart Kleinod's avatar
Ekkart Kleinod committed
44 45
### Changed

46
- default Markup für zugefügten und gelöschten Text umbenannt von `none` zu `colored`
47
- Anmerkungen werden als Kommentare formatiert
48
- Änderungsliste: etwas breitere Kürzung des Textes und deutlichere Kürzungsmarkierung
49
- Standardfarbe für Autoren ist blau (vorher schwarz)
50

51
- default markup for added and deleted text renamed from `none` to `colored`
52
- remarks are formatted as comments
53
- list of changes: slightly wider truncation of text, clearer truncation marker
54
- default color for authors is blue (from black)
55

Ekkart Kleinod's avatar
Ekkart Kleinod committed
56 57
### Deprecated

58 59 60
- optionaler Parameter `remark`, ersetzt durch `comment` in 3.0.0, wird in Version 4 entfernt werden; Befehl `\setremarkmarkup` ist bereits entfernt

- optional parameter `remark`, replaced by `comment` in 3.0.0, will be removed in Version 4; command `\setremarkmarkup` is removed yet
61

Ekkart Kleinod's avatar
Ekkart Kleinod committed
62 63
### Removed

64
- `decision` Keys für Änderungskommandos (waren nie voll implementiert und sind zu kompliziert für den Zweck des Pakets)
65
- Anmerkungs-Markup-Befehl `\setremarkmarkup`
66
- Markup `none`, `sout` und `xout` für zugefügten Text
67
- `textsubscript`-Befehl, der mittlerweile Standard-LaTeX ist
68 69

- `decision` keys for markup commands (they were not fully implemented yet and are much to complicated for the purpose of the package)
70
- remark markup command `\setremarkmarkup`
71
- markup `none`, `sout`, and `xout` for added text
72
- command `textsubscript`, which is standard LaTeX now
73

Ekkart Kleinod's avatar
Ekkart Kleinod committed
74 75 76
### Fixed

- Rechtschreibfehler in readme und Release Notes
77 78
- Leerzeichenprobleme im Code
- Zeilenumbruch zwischen alten und neuen Text bei `replaced` jetzt erlaubt
79
- zu viele Klammern bei `authormarkup=brackets` (galt für alle Autormarkierungen)
Ekkart Kleinod's avatar
Ekkart Kleinod committed
80 81
- Fehler bei der Ausgabe des Autorennamens bei Autoren ohne Name
- Option `nocolor` erzeugt Fehler beim nächsten LaTeX-Lauf mit Farben
Ekkart Kleinod's avatar
Ekkart Kleinod committed
82 83

- typo in description of readme and release notes
84 85
- space issues in the code
- linebreak between old and new text allowed for `replaced`
86
- too much brackets with `authormarkup=brackets` (was wrong for all author markups)
Ekkart Kleinod's avatar
Ekkart Kleinod committed
87 88
- error with author name output for authors without name
- option `nocolor` broke next LaTeX run with colors
Ekkart Kleinod's avatar
Ekkart Kleinod committed
89 90


91
## [2.1.0] - 2018-10-10
92 93 94 95 96 97 98

### Added

- readme
- Lizenzdatei
- Seitenumbrüche für Kapitel in Nutzerhandbuch
- changelog, dafür Versionsinfo im Handbuch entfernt
99
- Warnung bei Angabe eines falschen Stils für die Änderungsliste (Issue #5 bei gitlab)
100 101 102 103

- readme
- license file
- page breaks for chapters in user manual
104
- changelog, removed version information in user manual
105
- warning when using a wrong style for list of changes (issue #5 at gitlab)
106 107 108 109 110 111 112 113 114 115

### Removed

- Versionsinfo im Handbuch entfernt, ersetzt durch changelog

- removed version information in user manual, replaced by changelog

### Fixed

- Dokumentationsfehler für geänderten Text (Issue #19 bei sourceforge)
116
- mehrfache Leerzeichen bei allen Auszeichnungen mit `final`-Option (Issue #2 bei gitlab)
117 118
- mehrfache blanks vor Änderungsliste (Issue #3 bei gitlab)
- Überschrift der Änderungsliste bei `final`-Option (Issue #4 bei gitlab)
119 120

- documentation bug for replaced text (issue #19 at sourceforge)
121
- additional spaces with all change commands and option `final` (issue #2 at gitlab)
122 123
- additional blanks before list of changes (issue #3 at gitlab)
- heading of list of changes with option `final` (issue #4 at gitlab)
124 125 126 127 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 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395


## [2.0.4] - 2015-04-27

### Fixed

- Fehler bei Benutzung einer unbekannten Sprache

- error when using an unknown language


## [2.0.3] - 2014-10-15

### Fixed

- Crash bei Einsatz der `amsart`-Klasse

- crash when used with the `amsart` class


## [2.0.2] - 2013-08-13

### Changed

- kleine Erweiterungen der Doku

- improved documentation

### Fixed

- Probleme mit korrupten Dokumentations-PDFs bei CTAN gefixt
- Doku

- fixed problem of corrupt documentation PDFs in CTAN
- documentation


## [2.0.1] - 2013-08-10

### Changed

- alle nötigen Dateien in CTAN-Archiv gepackt

- put all needed files in CTAN archive

### Fixed

- Upload-Probleme bei CTAN gefixt (falsche Zeilenenden)

- fixed upload problems with CTAN (wrong line endings)


## [2.0.0] - 2013-06-30

### Added

- "richtige" Liste der Änderungen, alte Zusammenfassung jetzt über den optionalen Parameter `style=summary`
- neues Autormarkup `none`
- Scriptbeschreibung um Parameter `-i` ergänzt

- "real" list of changes, old summary now with optional parameter `style=summary`
- new author markup `none`
- completed script description with `-i` parameter

### Changed

- `setlocextension` umbenannt in `setsocextension`

- renamed `setlocextension` to `setsocextension`

### Fixed

- Problem mit einigen Sonderzeichen in der Änderungszusammenfassung gelöst

- fixed problem with special characters in summary of changes


## [1.0.0] - 2012-04-25

### Added

- Key-Value-Interface für Änderungsmanagement-Kommandos
- Fehlermeldung bei Verwendung einer ungültigen Autor\_innen-ID
- Leerzeichen vor Autor\_innenname in Änderungsliste

- key-value-interface for change commands
- error message if an unknown author id is used
- added space before author name in list of changes

### Fixed

- Fehler (Crash) in Änderungsliste gefixt, der bei Sonderzeichen auftrat

- fixed bug (crash) with special characters in list of changes


## [0.6.0] - 2012-01-11

### Added

- Italienische Übersetzungen der captions von Daniele Giovannini
- neues Nutzerinterface für das Setzen von Optionen sowie die Definition von Markup und Autoren
- Beispieldateien für alle Optionen und Befehle

- Italian translations of captions by Daniele Giovannini
- redefined user interface for setting options and definitions of markup and authors
- example files for all options and commands

### Changed

- Restrukturierung und Codeverbesserung
- verbesserte Dokumentation mit typischem Anwendungsfall
- Anmerkungen sind per Default nicht mehr farbig

- restructuring and code improvement
- improved documentation including typical use case
- by default remarks are not colored anymore


## [0.5.4] - 2011-04-25

### Added

- neues Script, um die `changes`-Befehle zu löschen von Silvano Chiaradonna

- new script for removal of `changes` commands by Silvano Chiaradonna

### Changed

- Auslagerung der Nutzerdokumentation in eigene Datei
- Änderung der default-Sprache zu Englisch

- extraction of user documentation in separate file
- default language changed to English


## [0.5.3] - 2010-11-22

### Added

- Dokumentoptionen von `documentclass` werden ebenfalls genutzt (Vorschlag und Code von Steve Wolter)

- document options of `documentclass` are used too (suggestion and code by Steve Wolter)


## [0.5.2] - 2007-10-10

### Added

- Paketoptionen der Pakete `ulem` und `xcolor` werden an diese weitergeleitet

- package options for `ulem` and `xcolor` are passed to the packages


## [0.5.1] - 2007-08-27

### Fixed

- gelöschter Text wieder durchgestrichen, Paket `ulem` funktioniert; ausgrauen hat nicht funktioniert

- deleted text is striked out again using package `ulem`, greying didn't work


## [0.5] - 2007-08-26

### Added

- neues optionales Argument für Autorenname
- farbige Liste der Änderungen

- new optional argument for author's name
- colored list of changes

### Changed

- auf UTF-8-encoding umgestellt
- gelöschter Text durch grauen Hintergrund visualisiert (es gibt bisher kein ordentliches Durchstreichen bei UTF-8-Nutzung)
- loc-Format geändert
- englische Doku verbessert

- switch to UTF-8-encoding
- markup for deleted text changed to gray background, because there's no possibility to conveniently strike out UTF-8-text
- changed loc file format
- improved English documentation

### Fixed

- keine Nutzung des `arrayjob`-Pakets mehr, dadurch Fehler im Zusammenspiel mit `array` behoben
- keine Nutzung des `soul`-Pakets mehr, dadurch Fehler im Zusammenspiel UTF-8-encoding behoben

- no usage of package `arrayjob` anymore, thus no errors using package `array`
- no usage of package `soul` anymore, thus no errors using UTF-8-encoding


## [0.4] - 2007-01-24

- erste Version für das CTAN

- first version uploaded to CTAN

### Changed

- `setremarkmarkup` um Autor-ID erweitert, um Anmerkung farbig setzen zu können
- Anmerkungen werden in der Fußnote farbig gesetzt

- extended `setremarkmarkup` with author's id for using color in remarks
- by default remarks are colored now

### Fixed

- `pdfcolmk` eingebunden, um Problem mit farbigem Text bei Seitenumbrüchen zu lösen

- included `pdfcolmk` to solve problem with colored text and page breaks


## [0.3] - 2007-01-22

### Added

- englische Nutzerdokumentation

- English user-documentation

### Changed

- Befehl `changed` ersetzt durch `replaced`

- replaced command `changed` with `replaced`

### Fixed

- verbesserte `final`-Option: kein zusätzlicher Leerraum

- improved `final`-option: no additional space


## [0.2] - 2007-01-17

### Added

- `setauthormarkup`, `setlocextension`, `setremarkmarkup` für Einstellungen
- Beispieldateien generiert
- LPPL eingefügt

- new commands `setauthormarkup`, `setlocextension`, `setremarkmarkup`
- generated examples
- inserted LPPL

### Fixed

- Bezeichnungen auch bei fehlendem `babel`-Paket eingeführt
- Fehler mit `ifthen`-Paketplazierung behoben
- bei Liste war immer "Eingefügt" eingestellt, behoben
- Autorausgabe war buggy (`if`-Abfrage nicht einwandfrei)

- defined loc-names when missing `babel`-package
- fixed wrong `ifthen` package placement
- fixed error in loc, always showing "added"
- fixed authormarkup (`if`-condition not bugfree)


## [0.1] - 2007-01-16

- initiale Version

- initial version

### Added

- Befehle `added`, `deleted` und `changed`

- commands `added`, `deleted`, and `changed`