Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Gathers and organizes all the information for the Drasil website.
Synopsis
- printSetting :: FolderLocation -> PrintingInformation
- mkWebsite :: FolderLocation -> Document
- data FolderLocation = Folder {}
- si :: FolderLocation -> SystemInformation
- sections :: FolderLocation -> [Section]
- symbMap :: FolderLocation -> ChunkDB
- getSysName :: SystemInformation -> IdeaDict
- usedDB :: ChunkDB
- allRefs :: FolderLocation -> [Reference]
- webName :: CI
- web :: CI
- headerSec :: Section
- imageContent :: LabelledContent
- gitHubRef :: Reference
- wikiRef :: Reference
- infoEncodingWiki :: Reference
- chunksWiki :: Reference
- recipesWiki :: Reference
- paperGOOL :: Reference
- papersWiki :: Reference
- icsePositionPaper :: Reference
- danPoster :: Reference
- wellUnderstoodPaper :: Reference
- quickStartWiki :: Reference
- newWorkspaceSetupWiki :: Reference
- contribGuideWiki :: Reference
- workflowWiki :: Reference
- createProjWiki :: Reference
- debuggingWiki :: Reference
- websiteTitle :: String
- gitHubInfoURL :: FilePath
- imagePath :: FilePath
- danContributionPath :: FilePath
- footer :: FolderLocation -> Section
- copyrightInfo :: Sentence
Functions to Generate the Website Through Drasil
printSetting :: FolderLocation -> PrintingInformation Source #
Printing info to get document to generate. Takes in the FolderLocation
.
mkWebsite :: FolderLocation -> Document Source #
Instead of being an SRSDecl
, this takes the folder locations and generates the document from there.
data FolderLocation Source #
Folder locations based on environment variables (using getEnv
in Drasil.Website.Main).
Folder | |
|
si :: FolderLocation -> SystemInformation Source #
System information.
sections :: FolderLocation -> [Section] Source #
Puts all the sections in order. Basically the website version of the SRS declaration.
symbMap :: FolderLocation -> ChunkDB Source #
Needed for references and terms to work.
getSysName :: SystemInformation -> IdeaDict Source #
Helper to get the system name as an IdeaDict
from SystemInformation
.
allRefs :: FolderLocation -> [Reference] Source #
Holds all references and links used in the website.
Header Section
imageContent :: LabelledContent Source #
For the drasil tree image on the website.
websiteTitle :: String Source #
Hardcoded info for the title, URL, and image path.
Footer Section
footer :: FolderLocation -> Section Source #
Create the footer section.
copyrightInfo :: Sentence Source #
footer
contents.