Drasil icon indicating copy to clipboard operation
Drasil copied to clipboard

Automatically collect abbreviations for SRS

Open balacij opened this issue 5 months ago • 1 comments

Context: https://github.com/JacquesCarette/Drasil/issues/4207#issuecomment-2985573121

Have to wonder: what if we scanned the SRS, recursing through its pieces, how close would we get to gathering everything?

Our generated SRSs contain a Table of Abbreviations and Acronyms. Currently, said tables rely on manually collected lists which are passed to the SRS format declaration:

https://github.com/JacquesCarette/Drasil/blob/fb8a7fb07be04af1a49b3f1615b947028a2b787f/code/drasil-example/ssp/lib/Drasil/SSP/Body.hs#L160-L167

https://github.com/JacquesCarette/Drasil/blob/fb8a7fb07be04af1a49b3f1615b947028a2b787f/code/drasil-example/ssp/lib/Drasil/SSP/Body.hs#L84

The goal of this ticket is to remove these manually collected lists in favour of automatically collecting them from the generated SRS documents.

There are two ways we can do this:

  1. (Simpler, less work) Traversing over generated SRS documents and scanning for acronyms placed. -- https://github.com/JacquesCarette/Drasil/issues/4207#issuecomment-2985573121
  2. (Much more work) Switching the renderers to stateful ones that automatically collect a list of abbreviations and acronyms used in the document for later placing in the table of abbreviations and acronyms. -- https://github.com/JacquesCarette/Drasil/issues/4207#issuecomment-2991968653

(1) is best for now -- https://github.com/JacquesCarette/Drasil/issues/4207#issuecomment-2992367161 . However, if #3864 is completed before anyone attempts this ticket, (2) might not be too difficult either.

balacij avatar Jul 24 '25 16:07 balacij

I agree with everything above.

JacquesCarette avatar Jul 24 '25 20:07 JacquesCarette