Skip to content

Commit

Permalink
New file CHANGELOG.md
Browse files Browse the repository at this point in the history
  • Loading branch information
quachpas committed Oct 6, 2024
1 parent a4aa757 commit 26975db
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 67 deletions.
65 changes: 0 additions & 65 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,68 +181,3 @@ I recommend setting a show rule for the links to that your readers understand th
#show link: set text(fill: blue.darken(60%))
// links are now blue !
```

## Changelog

### Unreleased

### 0.4.2

> [!TIP] For Typst v0.12.0 and later
> A new function is introduced `register-glossary`.
> Recommended usage is the following:
> ```diff
> #import "@preview/glossarium:0.4.0": make-glossary, register-glossary, print-glossary, gls, glspl
> #show: make-glossary
> + #let entry-list = (...)
> + #register-glossary(entry-list)
> ... // Your document body
> #print-glossary(
> - (
> - ...
> - )
> + entry-list
> )
> ```
> [!NOTE] Deprecate `location` argument in queries
> [!TIP] `short` is no longer **required**, but **semi-optional**.
> Accept `short` or `long` for an entry, but not neither.
### 0.4.1
- Resolved an issue causing Glossarium to crash when all entries had a defined, non-empty group.
### 0.4.0
- Support for plurals has been implemented, showcased in [examples/plural-example/main.typ](examples/plural-example). Contributed by [@St0wy](https://github.com/St0wy).
- The behavior of the gls and glspl functions has been altered regarding calls on undefined glossary keys. They now cause panics. Contributed by [@St0wy](https://github.com/St0wy).
### 0.3.0
- Introducing support for grouping terms in the glossary. Use the optional and case-sensitive key `group` to assign terms to specific groups. The appearanceof the glossary can be customized with the new parameter `enable-group-pagebreak`, allowing users to insert page breaks between groups for better organization. Contributed by [indicatelovelace](https://github.com/indicatelovelace).
### 0.2.6
#### Added
- A new boolean parameter `disable-back-references` has been introduced. If set to true, it disable the back-references (the page number at the end of the description of each term). Please note that disabling back-references only disables the display of the page number, if you don't have any references to your glossary terms, they won't show up unless the parameter `show-all` has been set to true.
### 0.2.5
#### Fixed
- Fixed a bug where there was 2 space after a reference. Contributed by [@drupol](https://github.com/drupol)
### 0.2.4
#### Fixed
- Fixed a bug where the reference would a long ref even when "long" was set to false. Contributed by [@dscso](https://github.com/dscso)
#### Changed
- The glossary appearance have been improved slightlyby. Contributed by [@JuliDi](https://github.com/JuliDi)
### Previous versions did not have a changelog entry
3 changes: 1 addition & 2 deletions tbump.toml
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,9 @@ src = "justfile"

[[file]]
src = "README.md"
search = '#import "@preview/glossarium:{current_version}": make-glossary, print-glossary, gls, glspl'

[[file]]
src = "glossarium.typ"
src = "themes/**/*.typ"
search = '#let glossarium_version = "{current_version}"'

[[before_commit]]
Expand Down

0 comments on commit 26975db

Please sign in to comment.