fix missing chunk refs by using cdbWithRefs

Xinlu-Y · Xinlu-Y · commit 9d3a701a5b34 · 2026-02-16T14:52:14.000-05:00
diff --git a/code/drasil-example/dblpend/lib/Drasil/DblPend/Body.hs b/code/drasil-example/dblpend/lib/Drasil/DblPend/Body.hs
@@ -5,7 +5,7 @@ import Language.Drasil hiding (organization, section)
 import qualified Language.Drasil.Development as D
 import Theory.Drasil (TheoryModel)
 import Drasil.SRSDocument
-import Drasil.Generator (cdb)
+import Drasil.Generator (cdbWithRefs)
 import qualified Drasil.DocLang.SRS as SRS
 import Drasil.System (SystemKind(Specification), mkSystem)
 
@@ -134,9 +134,12 @@ conceptChunks =
   [cw len]
 
 symbMap :: ChunkDB
-symbMap = cdb symbols ideaDicts conceptChunks []
+symbMap = cdbWithRefs cdbRefs symbols ideaDicts conceptChunks []
   dataDefs iMods genDefns tMods concIns citations (labelledContent ++ funcReqsTables)
 
+cdbRefs :: [Reference]
+cdbRefs = SRS.sectionReferences
+
 -- | Holds all references and links used in the document.
 allRefs :: [Reference]
 allRefs = [externalLinkRef]
diff --git a/code/drasil-example/gamephysics/lib/Drasil/GamePhysics/Body.hs b/code/drasil-example/gamephysics/lib/Drasil/GamePhysics/Body.hs
@@ -2,7 +2,7 @@ module Drasil.GamePhysics.Body where
 
 import Language.Drasil hiding (organization, section)
 import Drasil.SRSDocument
-import Drasil.Generator (cdb)
+import Drasil.Generator (cdbWithRefs)
 import qualified Drasil.DocLang.SRS as SRS
 import Language.Drasil.Chunk.Concept.NamedCombinators
 import qualified Language.Drasil.Development as D
@@ -125,9 +125,13 @@ conceptChunks =
   [cw surface]
 
 symbMap :: ChunkDB
-symbMap = cdb symbols ideaDicts conceptChunks [] dataDefs iMods generalDefns
+symbMap = cdbWithRefs cdbRefs
+  symbols ideaDicts conceptChunks [] dataDefs iMods generalDefns
   tMods concIns citations labelledContent
 
+cdbRefs :: [Reference]
+cdbRefs = SRS.sectionReferences ++ [pymunk]
+
 abbreviationsList :: [IdeaDict]
 abbreviationsList =
   -- QuantityDicts
diff --git a/code/drasil-example/glassbr/lib/Drasil/GlassBR/Body.hs b/code/drasil-example/glassbr/lib/Drasil/GlassBR/Body.hs
@@ -9,8 +9,8 @@ import qualified Language.Drasil.Development as D
 import Drasil.Metadata as M (dataDefn, inModel, thModel, software)
 import Drasil.SRSDocument
 import Drasil.DocLang (auxSpecSent, termDefnF')
-import Drasil.Generator (cdb)
-import qualified Drasil.DocLang.SRS as SRS (reference, assumpt, inModel)
+import Drasil.Generator (cdbWithRefs)
+import qualified Drasil.DocLang.SRS as SRS (reference, assumpt, inModel, sectionReferences)
 import Language.Drasil.Chunk.Concept.NamedCombinators
 import Language.Drasil.Code (Mod(..), asVC)
 import qualified Language.Drasil.Sentence.Combinators as S
@@ -136,9 +136,13 @@ abbreviationsList =
   map nw acronyms
 
 symbMap :: ChunkDB
-symbMap = cdb symbolsWCodeSymbols ideaDicts conceptChunks ([] :: [UnitDefn])
+symbMap = cdbWithRefs cdbRefs
+  symbolsWCodeSymbols ideaDicts conceptChunks ([] :: [UnitDefn])
   GB.dataDefs iMods [] tMods concIns citations labCon
 
+cdbRefs :: [Reference]
+cdbRefs = SRS.sectionReferences
+
 symbolsWCodeSymbols :: [DefinedQuantityDict]
 symbolsWCodeSymbols = map asVC (concatMap (\(Mod _ _ _ _ l) -> l) allMods)
   ++ implVars ++ symbols
diff --git a/code/drasil-example/pdcontroller/lib/Drasil/PDController/Body.hs b/code/drasil-example/pdcontroller/lib/Drasil/PDController/Body.hs
@@ -3,8 +3,8 @@ module Drasil.PDController.Body (si, mkSRS, pidODEInfo) where
 import Language.Drasil
 import Drasil.Metadata (dataDefn)
 import Drasil.SRSDocument
-import Drasil.Generator (cdb)
-import qualified Drasil.DocLang.SRS as SRS (inModel)
+import Drasil.Generator (cdbWithRefs)
+import qualified Drasil.DocLang.SRS as SRS (inModel, sectionReferences)
 import qualified Language.Drasil.Sentence.Combinators as S
 import Drasil.System (SystemKind(Specification), mkSystem)
 
@@ -114,7 +114,7 @@ conceptChunks =
   physicalcon ++ [linear, angular]
 
 symbMap :: ChunkDB
-symbMap = cdb
+symbMap = cdbWithRefs cdbRefs
   (map dqdWr physicscon ++ symbols ++
     [dqdWr mass, dqdWr posInf, dqdWr negInf] ++
     map dqdWr pidConstants)
@@ -129,6 +129,9 @@ symbMap = cdb
   citations
   (labelledContent ++ funcReqsTables)
 
+cdbRefs :: [Reference]
+cdbRefs = SRS.sectionReferences
+
 -- | Holds all references and links used in the document.
 allRefs :: [Reference]
 allRefs = [externalLinkRef]
diff --git a/code/drasil-example/projectile/lib/Drasil/Projectile/Body.hs b/code/drasil-example/projectile/lib/Drasil/Projectile/Body.hs
@@ -3,7 +3,7 @@ module Drasil.Projectile.Body (si, mkSRS) where
 import Language.Drasil
 import qualified Language.Drasil.Development as D
 import Drasil.SRSDocument
-import Drasil.Generator (cdb)
+import Drasil.Generator (cdbWithRefs)
 import Language.Drasil.Chunk.Concept.NamedCombinators
 import qualified Language.Drasil.NounPhrase.Combinators as NP
 import qualified Language.Drasil.Sentence.Combinators as S
@@ -161,10 +161,14 @@ conceptChunks =
   positionVec, cartesian]
 
 symbMap :: ChunkDB
-symbMap = cdb (pi_ : symbols) ideaDicts conceptChunks ([] :: [UnitDefn])
+symbMap = cdbWithRefs cdbRefs
+  (pi_ : symbols) ideaDicts conceptChunks ([] :: [UnitDefn])
   dataDefs iMods genDefns tMods concIns citations
   (labelledContent ++ funcReqsTables)
 
+cdbRefs :: [Reference]
+cdbRefs = SRS.sectionReferences
+
 abbreviationsList  :: [IdeaDict]
 abbreviationsList  =
   -- CIs
diff --git a/code/drasil-example/sglpend/lib/Drasil/SglPend/Body.hs b/code/drasil-example/sglpend/lib/Drasil/SglPend/Body.hs
@@ -8,7 +8,7 @@ import Language.Drasil hiding (organization, section)
 import qualified Language.Drasil.Development as D
 import Theory.Drasil (TheoryModel, output)
 import Drasil.SRSDocument
-import Drasil.Generator (cdb)
+import Drasil.Generator (cdbWithRefs)
 import qualified Drasil.DocLang.SRS as SRS
 import Language.Drasil.Chunk.Concept.NamedCombinators (the)
 import qualified Language.Drasil.Sentence.Combinators as S
@@ -120,10 +120,14 @@ abbreviationsList =
   map nw symbols
 
 symbMap :: ChunkDB
-symbMap = cdb (map (^. output) iMods ++ symbols) ideaDicts conceptChunks []
+symbMap = cdbWithRefs cdbRefs
+  (map (^. output) iMods ++ symbols) ideaDicts conceptChunks []
   dataDefs iMods genDefns tMods concIns citations
   (labelledContent ++ funcReqsTables)
 
+cdbRefs :: [Reference]
+cdbRefs = SRS.sectionReferences
+
 -- | Holds all references and links used in the document.
 allRefs :: [Reference]
 allRefs = [externalLinkRef]
diff --git a/code/drasil-example/ssp/lib/Drasil/SSP/Body.hs b/code/drasil-example/ssp/lib/Drasil/SSP/Body.hs
@@ -6,9 +6,9 @@ import Prelude hiding (sin, cos, tan)
 import Language.Drasil hiding (Verb, number, organization, section, variable)
 import qualified Language.Drasil.Development as D
 import Drasil.SRSDocument
-import Drasil.Generator (cdb)
+import Drasil.Generator (cdbWithRefs)
 import qualified Drasil.DocLang.SRS as SRS (inModel, assumpt,
-  genDefn, dataDefn, datCon)
+  genDefn, dataDefn, datCon, sectionReferences)
 import Drasil.Document.Contents (foldlSP, foldlSPCol)
 import Drasil.Sentence.Combinators (bulletNested, bulletFlat)
 import Drasil.System (SystemKind(Specification), mkSystem)
@@ -142,9 +142,13 @@ conceptChunks =
   map cw [time, surface]
 
 symbMap :: ChunkDB
-symbMap = cdb symbols ideaDicts conceptChunks
+symbMap = cdbWithRefs cdbRefs
+  symbols ideaDicts conceptChunks
   [degree] dataDefs iMods generalDefinitions tMods concIns citations labCon
 
+cdbRefs :: [Reference]
+cdbRefs = SRS.sectionReferences
+
 abbreviationsList :: [IdeaDict]
 abbreviationsList =
   -- CIs
diff --git a/code/drasil-example/swhs/lib/Drasil/SWHS/Body.hs b/code/drasil-example/swhs/lib/Drasil/SWHS/Body.hs
@@ -5,8 +5,8 @@ import Control.Lens ((^.))
 
 import Language.Drasil hiding (organization, section, variable)
 import Drasil.SRSDocument
-import Drasil.Generator (cdb)
-import qualified Drasil.DocLang.SRS as SRS (inModel)
+import Drasil.Generator (cdbWithRefs)
+import qualified Drasil.DocLang.SRS as SRS (inModel, sectionReferences)
 import Theory.Drasil (GenDefn, InstanceModel)
 import Language.Drasil.Chunk.Concept.NamedCombinators
 import qualified Language.Drasil.Development as D
@@ -89,9 +89,13 @@ conceptChunks =
   map cw [surArea, area]
 
 symbMap :: ChunkDB
-symbMap = cdb symbols ideaDicts conceptChunks [] SWHS.dataDefs insModel
+symbMap = cdbWithRefs cdbRefs
+  symbols ideaDicts conceptChunks [] SWHS.dataDefs insModel
   genDefs tMods concIns citations (labelledContent ++ funcReqsTables)
 
+cdbRefs :: [Reference]
+cdbRefs = SRS.sectionReferences
+
 abbreviationsList :: [IdeaDict]
 abbreviationsList =
   -- CIs
diff --git a/code/drasil-example/swhsnopcm/lib/Drasil/SWHSNoPCM/Body.hs b/code/drasil-example/swhsnopcm/lib/Drasil/SWHSNoPCM/Body.hs
@@ -8,8 +8,8 @@ import Drasil.System (SystemKind(Specification), mkSystem)
 
 import Drasil.Metadata (inModel)
 import Drasil.SRSDocument
-import qualified Drasil.DocLang.SRS as SRS (inModel)
-import Drasil.Generator (cdb)
+import qualified Drasil.DocLang.SRS as SRS (inModel, sectionReferences)
+import Drasil.Generator (cdbWithRefs)
 import Data.Drasil.People (thulasi)
 
 import Data.Drasil.Concepts.Documentation as Doc (material_)
@@ -163,10 +163,14 @@ conceptChunks =
   map cw [surArea, area]
 
 symbMap :: ChunkDB
-symbMap = cdb symbols ideaDicts conceptChunks ([] :: [UnitDefn]) NoPCM.dataDefs
+symbMap = cdbWithRefs cdbRefs
+  symbols ideaDicts conceptChunks ([] :: [UnitDefn]) NoPCM.dataDefs
   NoPCM.iMods genDefs tMods concIns citations
   (labelledContent ++ funcReqsTables)
 
+cdbRefs :: [Reference]
+cdbRefs = SRS.sectionReferences
+
 abbreviationsList :: [IdeaDict]
 abbreviationsList =
   -- CIs
diff --git a/code/drasil-example/template/lib/Drasil/Template/Body.hs b/code/drasil-example/template/lib/Drasil/Template/Body.hs
@@ -10,7 +10,7 @@ import Drasil.Metadata
 import Language.Drasil
 import Drasil.SRSDocument
 import Drasil.DocLang (tunitNone)
-import Drasil.Generator (cdb)
+import Drasil.Generator (cdbWithRefs)
 import Theory.Drasil (DataDefinition, GenDefn, InstanceModel, TheoryModel)
 
 import qualified Drasil.DocLang.SRS as SRS
@@ -87,11 +87,15 @@ conceptChunks :: [ConceptChunk]
 conceptChunks = [] :: [ConceptChunk]
 
 symbMap :: ChunkDB
-symbMap = cdb ([] :: [DefinedQuantityDict]) ideaDicts conceptChunks
+symbMap = cdbWithRefs cdbRefs
+  ([] :: [DefinedQuantityDict]) ideaDicts conceptChunks
   ([] :: [UnitDefn]) ([] :: [DataDefinition]) ([] :: [InstanceModel])
   ([] :: [GenDefn]) ([] :: [TheoryModel]) ([] :: [ConceptInstance])
   citations ([] :: [LabelledContent])
 
+cdbRefs :: [Reference]
+cdbRefs = SRS.sectionReferences
+
 citations :: BibRef
 citations = [parnasClements1986, koothoor2013, smithEtAl2007, smithLai2005,
              smithKoothoor2016]
diff --git a/code/drasil-gen/lib/Drasil/Generator/BaseChunkDB.hs b/code/drasil-gen/lib/Drasil/Generator/BaseChunkDB.hs
@@ -1,11 +1,12 @@
 module Drasil.Generator.BaseChunkDB (
   -- * Base ChunkDB for all case studies
-  cdb
+  cdb,
+  cdbWithRefs
 ) where
 
 import Drasil.Database (empty, insertAll, ChunkDB, insertAllOutOfOrder11)
 import Language.Drasil (IdeaDict, nw, Citation, ConceptChunk, ConceptInstance,
-  DefinedQuantityDict, UnitDefn, LabelledContent)
+  DefinedQuantityDict, UnitDefn, LabelledContent, Reference)
 import Data.Drasil.Concepts.Documentation (doccon, doccon', srsDomains)
 import Data.Drasil.Software.Products (prodtcon)
 import Data.Drasil.Concepts.Education (educon)
@@ -91,3 +92,10 @@ cdb :: [DefinedQuantityDict] -> [IdeaDict] -> [ConceptChunk] -> [UnitDefn] ->
     [DataDefinition] -> [InstanceModel] -> [GenDefn] -> [TheoryModel] ->
     [ConceptInstance] -> [Citation] -> [LabelledContent] -> ChunkDB
 cdb = insertAllOutOfOrder11 basisCDB
+
+-- | Variant of 'cdb' that pre-registers reference chunks before mass insertion.
+cdbWithRefs :: [Reference] -> [DefinedQuantityDict] -> [IdeaDict] ->
+    [ConceptChunk] -> [UnitDefn] -> [DataDefinition] -> [InstanceModel] ->
+    [GenDefn] -> [TheoryModel] -> [ConceptInstance] -> [Citation] ->
+    [LabelledContent] -> ChunkDB
+cdbWithRefs refs = insertAllOutOfOrder11 (insertAll refs basisCDB)
