Skip to content

Commit ab3e162

Browse files
committed
Added explicit inclusion of the refBy UID in getAllChunksFromDoc
1 parent d022a3c commit ab3e162

File tree

9 files changed

+25
-1
lines changed

9 files changed

+25
-1
lines changed

code/drasil-docLang/lib/Drasil/DocumentLanguage.hs

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ import Drasil.Sections.ReferenceMaterial (emptySectSentPlu)
6969

7070
import qualified Data.Drasil.Concepts.Documentation as Doc (likelyChg, section_,
7171
software, unlikelyChg)
72+
import Data.Drasil.Concepts.Documentation (refBy)
7273

7374
import Language.Drasil.Development (shortdep)
7475

@@ -280,7 +281,14 @@ mkRefSec si dd (RefProg c l) renderedSecs = SRS.refMat [c] (map (mkSubRef si) l)
280281
-- | Extracts abbreviations/acronyms found in the document
281282
getAllChunksFromDoc :: [Section] -> ChunkDB -> [TermAbbr]
282283
getAllChunksFromDoc renderedSecs cdb =
283-
map (termResolve' cdb) $ nub $ concatMap shortdep $ concatMap getSec renderedSecs
284+
let
285+
-- UIDs extracted from short-style positions in the rendered sections
286+
uids = nub $ concatMap shortdep $ concatMap getSec renderedSecs
287+
-- Ensure the common "RefBy" short-form chunk is included since it is
288+
-- referenced in generated tables and definition fields (helperCI), but may
289+
-- not always appear directly as a ShortStyle occurrence in some inputs.
290+
uids' = if (refBy ^. uid) `elem` uids then uids else (refBy ^. uid) : uids
291+
in map (termResolve' cdb) uids'
284292

285293
collectDocumentAbbreviations :: [Section] -> ChunkDB -> [TermAbbr]
286294
collectDocumentAbbreviations renderedSecs cdb =

code/stable/dblpend/SRS/HTML/DblPend_SRS.html

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

code/stable/dblpend/SRS/Jupyter/DblPend_SRS.ipynb

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

code/stable/dblpend/SRS/PDF/DblPend_SRS.tex

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

code/stable/dblpend/SRS/mdBook/src/SecTAbbAcc.md

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

code/stable/sglpend/SRS/HTML/SglPend_SRS.html

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

code/stable/sglpend/SRS/Jupyter/SglPend_SRS.ipynb

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

code/stable/sglpend/SRS/PDF/SglPend_SRS.tex

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

code/stable/sglpend/SRS/mdBook/src/SecTAbbAcc.md

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)