Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions code/drasil-docLang/lib/Drasil/DocumentLanguage.hs
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ import Drasil.Sections.ReferenceMaterial (emptySectSentPlu)
-- * Main Function
-- | Creates a document from a document description, a title combinator function, and system information.
mkDoc :: SRSDecl -> (IdeaDict -> IdeaDict -> Sentence) -> System -> Document
mkDoc dd comb si@SI {_sys = sys, _kind = kind, _authors = docauthors} =
Document (nw kind `comb` nw sys) (foldlList Comma List $ map (S . name) docauthors) (findToC l) $
mkDoc dd comb si@SI {_sys = sys, _authors = docauthors} =
Document (whatsTheBigIdea si `comb` nw sys) (foldlList Comma List $ map (S . name) docauthors) (findToC l) $
mkSections fullSI l where
fullSI = fillcdbSRS dd si
l = mkDocDesc fullSI dd
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ import Drasil.DocumentLanguage.Notebook.Core (LsnDesc, LsnChapter(..),

import Language.Drasil hiding (kind)

import System.Drasil (System(SI), _authors, _kind, _sys)
import System.Drasil (System(SI), _authors, _sys, whatsTheBigIdea)
import Drasil.GetChunks (citeDB)

import qualified Drasil.DocLang.Notebook as Lsn (intro, learnObj, caseProb, example,
appendix, review, reference, summary)

-- | Creates a notebook from a lesson description and system information.
mkNb :: LsnDecl -> (IdeaDict -> IdeaDict -> Sentence) -> System -> Document
mkNb dd comb si@SI {_sys = sys, _kind = kind, _authors = authors} =
Notebook (nw kind `comb` nw sys) (foldlList Comma List $ map (S . name) authors) $
mkNb dd comb si@SI {_sys = sys, _authors = authors} =
Notebook (whatsTheBigIdea si `comb` nw sys) (foldlList Comma List $ map (S . name) authors) $
mkSections si l where
l = mkLsnDesc si dd

Expand Down
5 changes: 3 additions & 2 deletions code/drasil-example/dblpend/lib/Drasil/DblPend/Body.hs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import qualified Language.Drasil.Sentence.Combinators as S
import Data.Drasil.People (dong)
import Data.Drasil.SI_Units (siUnits)
import Data.Drasil.Concepts.Computation (inDatum, compcon, algorithm)
import qualified Data.Drasil.Concepts.Documentation as Doc (srs, physics, variable)
import qualified Data.Drasil.Concepts.Documentation as Doc (physics, variable)
import Data.Drasil.Concepts.Documentation (assumption, condition, endUser,
environment, datum, input_, interface, output_, problem, product_,
physical, sysCont, software, softwareConstraint, softwareSys, srsDomains,
Expand Down Expand Up @@ -46,6 +46,7 @@ import Data.Drasil.ExternalLibraries.ODELibraries (scipyODESymbols,
import Language.Drasil.Code (quantvar)
import Drasil.DblPend.ODEs (dblPenODEInfo)

import System.Drasil (SystemKind(Specification))

srs :: Document
srs = mkDoc mkSRS (S.forGen titleize phrase) si
Expand Down Expand Up @@ -106,7 +107,7 @@ mkSRS = [TableOfContents, -- This creates the Table of Contents
si :: System
si = SI {
_sys = progName,
_kind = Doc.srs,
_kind = Specification,
_authors = [dong],
_purpose = [purp],
_background = [background],
Expand Down
1 change: 1 addition & 0 deletions code/drasil-example/dblpend/package.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ dependencies:
- drasil-lang
- drasil-metadata
- drasil-printers
- drasil-system
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm somewhat surprised that I need to add this to the other case studies. Things from drasil-system are being re-exported somewhere they shouldn't be.

- drasil-theory
- drasil-utils

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ import Data.Drasil.Concepts.Documentation as Doc (assumption, concept,
quantity, realtime, section_, simulation, software, softwareSys,
srsDomains, system, systemConstraint, sysCont, task, user, doccon, doccon',
property, problemDescription)
import qualified Data.Drasil.Concepts.Documentation as Doc (srs)
import Data.Drasil.TheoryConcepts as Doc (dataDefn, inModel)
import Data.Drasil.Concepts.Education (frstYr, highSchoolCalculus,
highSchoolPhysics, educon)
Expand Down Expand Up @@ -43,6 +42,8 @@ import Drasil.GamePhysics.Unitals (symbolsAll, outputConstraints,
inputSymbols, outputSymbols, inputConstraints, defSymbols)
import Drasil.GamePhysics.GenDefs (generalDefns)

import System.Drasil (SystemKind(Specification))

srs :: Document
srs = mkDoc mkSRS (S.forGen titleize short) si

Expand Down Expand Up @@ -97,7 +98,7 @@ mkSRS = [TableOfContents,
si :: System
si = SI {
_sys = progName,
_kind = Doc.srs,
_kind = Specification,
_authors = [alex, luthfi, olu],
_purpose = [purp],
_background = [],
Expand Down
1 change: 1 addition & 0 deletions code/drasil-example/gamephysics/package.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ dependencies:
- drasil-lang
- drasil-metadata
- drasil-printers
- drasil-system
- drasil-theory
- drasil-utils

Expand Down
5 changes: 3 additions & 2 deletions code/drasil-example/glassbr/lib/Drasil/GlassBR/Body.hs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ import Data.Drasil.Concepts.Documentation as Doc (appendix, assumption,
environment, input_, interface, model, physical, problem, product_,
software, softwareConstraint, softwareSys, srsDomains, standard, sysCont,
system, term_, user, value, variable, reference, definition)
import qualified Data.Drasil.Concepts.Documentation as Doc (srs)
import Data.Drasil.TheoryConcepts as Doc (dataDefn, inModel, thModel)
import Data.Drasil.Concepts.Education as Edu (civilEng, scndYrCalculus, structuralMechanics,
educon)
Expand Down Expand Up @@ -48,6 +47,8 @@ import Drasil.GlassBR.Unitals (blast, blastTy, bomb, explosion, constants,
glassTypes, glBreakage, lateralLoad, load, loadTypes, pbTol, probBr, stressDistFac, probBreak,
sD, termsWithAccDefn, termsWithDefsOnly, concepts, dataConstraints)

import System.Drasil (SystemKind(Specification))

srs :: Document
srs = mkDoc mkSRS (S.forGen titleize phrase) si

Expand All @@ -60,7 +61,7 @@ printSetting = piSys fullSI Equational defaultConfiguration
si :: System
si = SI {
_sys = progName,
_kind = Doc.srs,
_kind = Specification,
_authors = [nikitha, spencerSmith],
_purpose = [purp],
_background = [background],
Expand Down
7 changes: 4 additions & 3 deletions code/drasil-example/hghc/lib/Drasil/HGHC/Body.hs
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@ import Data.Drasil.People (spencerSmith)
import Data.Drasil.Concepts.Documentation (doccon, doccon')
import Data.Drasil.Concepts.Math (mathcon)
import Data.Drasil.Concepts.Thermodynamics as CT (heatTrans)
import qualified Data.Drasil.Concepts.Documentation as Doc (srs)


import System.Drasil (SystemKind(Specification))

srs :: Document
srs = mkDoc mkSRS S.forT si

Expand All @@ -27,7 +28,7 @@ printSetting = piSys fullSI Equational defaultConfiguration
si :: System
si = SI {
_sys = progName,
_kind = Doc.srs,
_kind = Specification,
_authors = [spencerSmith],
_quants = symbols,
_purpose = [purp],
Expand Down
1 change: 1 addition & 0 deletions code/drasil-example/hghc/package.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ dependencies:
- drasil-lang
- drasil-metadata
- drasil-printers
- drasil-system
- drasil-theory
- drasil-utils

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import qualified Drasil.DocLang.SRS as SRS (inModel)
import qualified Language.Drasil.Sentence.Combinators as S

import Data.Drasil.Concepts.Documentation (doccon, doccon', srsDomains)
import qualified Data.Drasil.Concepts.Documentation as Doc (srs)
import Data.Drasil.Concepts.Math (mathcon, mathcon', ode)
import Data.Drasil.Concepts.Software (program)
import Data.Drasil.Software.Products (sciCompS)
Expand Down Expand Up @@ -42,6 +41,8 @@ import Drasil.PDController.Unitals (symbols, inputs, outputs, inputsUC,
import Drasil.PDController.ODEs (pidODEInfo)
import Language.Drasil.Code (quantvar)

import System.Drasil (SystemKind(Specification))

naveen :: Person
naveen = person "Naveen Ganesh" "Muralidharan"

Expand Down Expand Up @@ -98,7 +99,7 @@ mkSRS
si :: System
si = SI {
_sys = progName,
_kind = Doc.srs,
_kind = Specification,
_authors = [naveen],
_purpose = [purp],
_background = [background],
Expand Down
1 change: 1 addition & 0 deletions code/drasil-example/pdcontroller/package.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ dependencies:
- drasil-lang
- drasil-metadata
- drasil-printers
- drasil-system
- drasil-theory
- drasil-utils

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ import Drasil.Projectile.Unitals

import Theory.Drasil (TheoryModel)

import System.Drasil (SystemKind(Specification))

srs :: Document
srs = mkDoc mkSRS (S.forGen titleize phrase) si

Expand Down Expand Up @@ -131,7 +133,7 @@ projectileExamples = [S "ballistics" +:+ plural problem +:+ sParen (S "missiles"
si :: System
si = SI {
_sys = progName,
_kind = Doc.srs,
_kind = Specification,
_authors = [samCrawford, brooks, spencerSmith],
_purpose = [purp],
_background = [background],
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
module Drasil.Projectile.Lesson.Body where

import Data.List (nub)
import Language.Drasil
import Language.Drasil hiding (Notebook)
import Language.Drasil.Printers (PrintingInformation(..), defaultConfiguration)
import Database.Drasil
import System.Drasil
Expand All @@ -13,7 +13,6 @@ import Drasil.DocLang (mkNb, LsnDecl, LsnChapter(BibSec, LearnObj, Review, CaseP

import Data.Drasil.Concepts.Documentation (doccon, doccon')
import Data.Drasil.Concepts.Math (mathcon)
import qualified Data.Drasil.Concepts.Documentation as Doc (notebook)
import Data.Drasil.Quantities.Physics (physicscon)
import Data.Drasil.Concepts.Physics (physicCon)

Expand Down Expand Up @@ -45,7 +44,7 @@ mkNB = [
si :: System
si = SI {
_sys = projectileMotion,
_kind = Doc.notebook,
_kind = Notebook,
_authors = [spencerSmith],
_purpose = [],
_background = [],
Expand Down
1 change: 1 addition & 0 deletions code/drasil-example/projectile/package.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ dependencies:
- drasil-metadata
- drasil-printers
- drasil-system
- drasil-system
- drasil-theory
- drasil-utils

Expand Down
5 changes: 3 additions & 2 deletions code/drasil-example/sglpend/lib/Drasil/SglPend/Body.hs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ import Data.Drasil.People (olu)
import Data.Drasil.SI_Units (siUnits)
import Data.Drasil.Concepts.Computation (compcon, algorithm)
import Data.Drasil.Concepts.Documentation (srsDomains, doccon, doccon')
import qualified Data.Drasil.Concepts.Documentation as Doc (srs)
import Data.Drasil.Concepts.Education (educon)
import Data.Drasil.Concepts.Math (mathcon, mathcon')
import Data.Drasil.Concepts.Physics (physicCon, physicCon', motion, pendulum)
Expand Down Expand Up @@ -43,6 +42,8 @@ import Drasil.SglPend.GenDefs (genDefns)
import Drasil.SglPend.Unitals (inputs, outputs, inConstraints, outConstraints, symbols)
import Drasil.SglPend.Requirements (funcReqs)

import System.Drasil (SystemKind(Specification))

srs :: Document
srs = mkDoc mkSRS (S.forGen titleize phrase) si

Expand Down Expand Up @@ -102,7 +103,7 @@ mkSRS = [TableOfContents, -- This creates the Table of Contents
si :: System
si = SI {
_sys = progName,
_kind = Doc.srs,
_kind = Specification,
_authors = [olu],
_purpose = [purp],
_background = [],
Expand Down
1 change: 1 addition & 0 deletions code/drasil-example/sglpend/package.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ dependencies:
- drasil-lang
- drasil-metadata
- drasil-printers
- drasil-system
- drasil-theory
- drasil-utils
- dblpend
Expand Down
5 changes: 3 additions & 2 deletions code/drasil-example/ssp/lib/Drasil/SSP/Body.hs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ import Data.Drasil.Concepts.Documentation as Doc (analysis, assumption,
physical, physics, problem, software, softwareSys, srsDomains, symbol_,
sysCont, system, type_, user, value, variable, doccon, doccon',
datumConstraint)
import qualified Data.Drasil.Concepts.Documentation as Doc (srs)
import Data.Drasil.TheoryConcepts as Doc (inModel)
import Data.Drasil.Concepts.Education (solidMechanics, undergraduate, educon)
import Data.Drasil.Concepts.Math (equation, shape, surface, mathcon, mathcon',
Expand Down Expand Up @@ -53,6 +52,8 @@ import Drasil.SSP.TMods (tMods)
import Drasil.SSP.Unitals (constrained, effCohesion, fricAngle, fs, index,
inputs, inputsWUncrtn, outputs, symbols)

import System.Drasil (SystemKind(Specification))

--Document Setup--

srs :: Document
Expand All @@ -70,7 +71,7 @@ resourcePath = "../../../../datafiles/ssp/"
si :: System
si = SI {
_sys = progName,
_kind = Doc.srs,
_kind = Specification,
_authors = [henryFrankis, brooks],
_purpose = [purp],
_background = [],
Expand Down
1 change: 1 addition & 0 deletions code/drasil-example/ssp/package.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ dependencies:
- drasil-lang
- drasil-metadata
- drasil-printers
- drasil-system
- drasil-theory
- drasil-utils

Expand Down
5 changes: 3 additions & 2 deletions code/drasil-example/swhs/lib/Drasil/SWHS/Body.hs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import Language.Drasil.Chunk.Concept.NamedCombinators
import qualified Language.Drasil.NounPhrase.Combinators as NP
import qualified Language.Drasil.Sentence.Combinators as S

import qualified Data.Drasil.Concepts.Documentation as Doc (srs)
import Data.Drasil.TheoryConcepts as Doc (inModel)
import Data.Drasil.Concepts.Computation (algorithm, compcon)
import Data.Drasil.Concepts.Documentation as Doc (assumption, column,
Expand Down Expand Up @@ -56,6 +55,8 @@ import Drasil.SWHS.Unitals (coilHTC, coilSA, consTol, constrained,
simTime, specParamValList, symbols, symbolsAll, tempC, tempPCM,
tempW, thickness, watE)

import System.Drasil (SystemKind(Specification))

-------------------------------------------------------------------------------

srs :: Document
Expand All @@ -73,7 +74,7 @@ resourcePath = "../../../../datafiles/swhs/"
si :: System
si = SI {
_sys = progName',
_kind = Doc.srs,
_kind = Specification,
_authors = [thulasi, brooks, spencerSmith],
_purpose = [purp],
_background = [],
Expand Down
1 change: 1 addition & 0 deletions code/drasil-example/swhs/package.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ dependencies:
- drasil-lang
- drasil-metadata
- drasil-printers
- drasil-system
- drasil-theory
- drasil-utils

Expand Down
5 changes: 3 additions & 2 deletions code/drasil-example/swhsnopcm/lib/Drasil/SWHSNoPCM/Body.hs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ import Data.Drasil.People (thulasi)

import Data.Drasil.Concepts.Computation (algorithm, inValue)
import Data.Drasil.Concepts.Documentation as Doc (doccon, doccon', material_, srsDomains, sysCont)
import qualified Data.Drasil.Concepts.Documentation as Doc (srs)
import Data.Drasil.TheoryConcepts as Doc (inModel)
import Data.Drasil.Concepts.Education (educon)
import Data.Drasil.Concepts.Math (mathcon, mathcon', ode)
Expand Down Expand Up @@ -67,6 +66,8 @@ import Drasil.SWHSNoPCM.References (citations)
import Drasil.SWHSNoPCM.Unitals (inputs, constrained, unconstrained,
specParamValList)

import System.Drasil (SystemKind(Specification))

srs :: Document
srs = mkDoc mkSRS S.forT si

Expand Down Expand Up @@ -163,7 +164,7 @@ stdFields = [DefiningEquation, Description Verbose IncludeUnits, Notes, Source,
si :: System
si = SI {
_sys = srsSWHS,
_kind = Doc.srs,
_kind = Specification,
_authors = [thulasi],
_purpose = [purp],
_background = [introStartNoPCM],
Expand Down
1 change: 1 addition & 0 deletions code/drasil-example/swhsnopcm/package.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ dependencies:
- drasil-lang
- drasil-metadata
- drasil-printers
- drasil-system
- drasil-theory
- drasil-utils
- swhs
Expand Down
4 changes: 2 additions & 2 deletions code/drasil-example/template/lib/Drasil/Template/Body.hs
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ import Data.Drasil.Concepts.Computation (inValue, algorithm)
import Data.Drasil.Concepts.Software (errMsg, program)
import Data.Drasil.Concepts.Math (mathcon)

import qualified Data.Drasil.Concepts.Documentation as Doc (srs)
import qualified Drasil.DocLang.SRS as SRS
import Data.Drasil.Software.Products
import Data.Drasil.TheoryConcepts
import Data.Drasil.Citations
import Drasil.DocumentLanguage.TraceabilityGraph
import Drasil.DocLang (tunitNone)
import System.Drasil (SystemKind(Specification))

srs :: Document
srs = mkDoc mkSRS (S.forGen titleize phrase) si
Expand Down Expand Up @@ -86,7 +86,7 @@ mkSRS = [TableOfContents,
si :: System
si = SI {
_sys = progName,
_kind = Doc.srs,
_kind = Specification,
_authors = [authorName],
_background = [],
_purpose = [],
Expand Down
Loading