-
Notifications
You must be signed in to change notification settings - Fork 28
Description
Context: #4207 (comment)
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:
Drasil/code/drasil-example/ssp/lib/Drasil/SSP/Body.hs
Lines 160 to 167 in fb8a7fb
| abbreviationsList :: [IdeaDict] | |
| abbreviationsList = | |
| -- CIs | |
| map nw acronyms ++ | |
| -- ConceptChunks | |
| nw progName : | |
| -- DefinedQuantityDicts | |
| map nw symbols |
| [TUnits, tsymb'' tableOfSymbIntro TAD, TAandA abbreviationsList], |
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:
- (Simpler, less work) Traversing over generated SRS documents and scanning for acronyms placed. -- Replace
usedinfodbhack with a simpler hack #4207 (comment) - (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. -- Replace
usedinfodbhack with a simpler hack #4207 (comment)
(1) is best for now -- #4207 (comment) . However, if #3864 is completed before anyone attempts this ticket, (2) might not be too difficult either.