Drafting and Glossarium cause non-convergence in some case

Questions
, ,
1

I’m posting here, as I don’t know where I would report this bug to (typst, drafting, or glossarium), and I am interested if someone can explain what is going on.

Compiling the following document, gives a warning layout did not converge within 5 attempts
This can be resolved by

  • changing the long form to something shorter
  • adding a #gls("abc") anywhere in the document
  • removing the margin-note
  • removing one @abc

I do not understand why all of these help. Can anyone explain what is going on/point to the issue (i.e., whom to report this to, if this is considered a bug).

#import "@preview/drafting:0.2.2"
#import "@preview/glossarium:0.5.10": make-glossary, print-glossary, register-glossary, gls
#let glossary_entries=(
  (key: "abc", short: "ABC", long: "some multiword term"),
)
#show: make-glossary
#register-glossary(glossary_entries)

// #gls("abc")

@abc
@abc
@abc
@abc

foo #drafting.margin-note[asdf] bar

#print-glossary(glossary_entries)

(Tested on typst 0.14.2 (b33de9de) and Typst)

2

I’m leaning towards that it’s mainly glossarium, since it needs all five iterations to converge by itself (removing drafting), and has some known issues with convergence. (This test was done using the layout-ltd package.)

I would personally be tempted to try to change glossarium to use metadata + query instead of state, but since it has 1800 lines of code I don’t think I can afford to be pulled into it :sweat_smile:.

3

Hi! I’m the maintainer of glossarium. I don’t have a computer at hand atm, but I’d be happy to take a look at your issue since @bluss identified it to be glossarium taking too many iterations to converge.
Can I bother you and ask you to open an issue on the project’s page?
Technically, glossarium uses state to keep track of the glossary, and usage counts. @bluss is right to say that it should be using queries only probably and leaving metadata where it can. To be honest even though it has 1k8 LoC most of it is boiler plate and layout logic. The actual state handling is very small. In any case, convergence has always been an issue but it’s time-consuming to change the internal state to something else and I just haven’t had the time unfortunately.

3 Likes
4

Done, thanks for the reply.