Bug Tracker

ID 174🔗 Fiore Finto 2021-06-19 07:51:20 Closed (Not a Bug) glossaries-extra 1.45 Default to \setabbreviationstyle[acronym]{long-short}

Description

From a user perspective adding glossaries-extra package "breaks" existing acronym first use expansion from the main glossaries package. Reading the fine manual reveals that one needs to add \setabbreviationstyle[acronym]{long-short} to migrate properly, so this should be the default.

Background:
I only needed \printunsrtglossary and I was surprised to see the acronyms' behavior change (I did not know about the redefinition of \newacronym yet). I wrongly assumed that I do not use any of the new acronym code. RTFM helped, I guess, since I did not think about styles at all (I also skipped the parts about style several times, since I thought style is a question of small caps/slanted font and not about expansion on first use or not).
It is something to stumble over and had me invest quite some time in finding a bug in the first use logic that was not there.

MWE

\documentclass{article}
\usepackage[acronyms,nomain]{glossaries}
%\usepackage{glossaries-extra} % Add this line and \gls does not expand anymore
%\RestoreAcronyms % one-size-fits-all solution, not recommended
%\setabbreviationstyle[acronym]{long-short} % recommended
\newacronym{bug}{BUG}{back up generator}
\begin{document}
\gls{bug}?
\end{document}

Evaluation

This isn’t a bug as it works as documented. Changing the default behaviour will break existing documents that rely on the documented default.

The main reason for having a different default style for the acronym category was intended to draw the users attention to the fact that abbreviations behave differently from the base package (for example, \glsxtrshort etc must be used instead of \acrshort).

I will add a note to the start of the glossaries-extra user manual (in the next update) to emphasize that there are different defaults.

Name (optional):

Are you human? Please confirm the bug report ID (which can be found at the top of this page) or login if you have an account.

Comment:

You can use the following markup:

Block:

[pre]Displayed verbatim[/pre]
[quote]block quote[/quote]

In line:

[tt]code[/tt]
[file]file/package/class name[/file]
[em]emphasized text[/em]
[b]bold text[/b]
[url]web address[/url] [sup]superscript[/sup]
[sub]subscript[/sub]

Ordered list:
[ol]
[li]first item[/li]
[li]second item[/li]
[/ol]

Unordered list:
[ul]
[li]first item[/li]
[li]second item[/li]
[/ul]

You can use the Preview button to review your message formatting before submitting.