Safe Haskell	Safe-Inferred
Language	Haskell2010

Drasil.Website.Example

Contents

Gather Example Information
Functions to create the list of examples
Examples Section Functions
Helper functions in getting References for SRS, code folders, and Doxygen

Description

Create the list of Generated Examples for the Drasil website.

Synopsis

data Example = E {
- sysInfoE :: SystemInformation
- choicesE :: [Choices]
- codePath :: FilePath
- srsDoxPath :: FilePath
}
allExampleSI :: [SystemInformation]
allExampleChoices :: [[Choices]]
allExamples :: [SystemInformation] -> [[Choices]] -> FilePath -> FilePath -> [Example]
examples :: FilePath -> FilePath -> [Example]
fullExList :: FilePath -> FilePath -> RawContent
allExampleList :: [Example] -> [ItemType]
individualExList :: Example -> [ItemType]
versionList :: (Example -> Lang -> String -> Reference) -> Example -> [ItemType]
showLang :: Lang -> String
exampleSec :: FilePath -> FilePath -> Section
exampleTitle :: Sentence
exampleIntro :: Sentence
generatedCodeTitle :: String
generatedCodeDocsTitle :: String
convertLang :: Lang -> String
getCodeRef :: Example -> Lang -> String -> Reference
buildDrasilExSrcRef :: Example -> Reference
getDoxRef :: Example -> Lang -> String -> Reference
getSRSRef :: FilePath -> Format -> String -> Reference
getSRSPath :: FilePath -> Format -> String -> FilePath
getCodePath :: FilePath -> String -> String -> FilePath
getDoxPath :: FilePath -> String -> String -> FilePath
exampleRefs :: FilePath -> FilePath -> [Reference]
getCodeRefDB :: Example -> [Reference]
getDoxRefDB :: Example -> [Reference]
getAbrv :: Example -> String

Gather Example Information

First gather all information needed to create an example. This includes system information, descriptions, and choices. These will also be exported for use in CaseStudy.hs.

data Example Source #

Each Example gets placed in here.

Constructors

E
Fields sysInfoE :: SystemInformation Example system information. Used to get the system name and abbreviation. choicesE :: [Choices] Some examples have generated code with specific choices. They may also have more than one set of choices, so we need a list. codePath :: FilePath Generated code path. srsDoxPath :: FilePath Generated documents & doxygen path

allExampleSI :: [SystemInformation] Source #

Records example system information.

allExampleChoices :: [[Choices]] Source #

Records example choices. The order of the list must match up with that in allExampleSI, or the Case Studies Table will be incorrect.

allExamples :: [SystemInformation] -> [[Choices]] -> FilePath -> FilePath -> [Example] Source #

Combine system info, description, choices, and file paths into one nice package.

examples :: FilePath -> FilePath -> [Example] Source #

Calls allExamples on allExampleSI, allExampleDesc, and allExampleChoices. Can be considered a "default" version of allExamples.

Functions to create the list of examples

fullExList :: FilePath -> FilePath -> RawContent Source #

Create the full list of examples.

allExampleList :: [Example] -> [ItemType] Source #

Create each example point and call individualExList to do the rest.

individualExList :: Example -> [ItemType] Source #

Display the points for generated documents and call versionList to display the code.

versionList :: (Example -> Lang -> String -> Reference) -> Example -> [ItemType] Source #

Takes a function that gets the needed references (either references for the code or doxygen references) and the example to create the list out of. For examples that have more than one version of generated code (more than one set of choices) like Projectile, we generate the code and doxygen references for each.

showLang :: Lang -> String Source #

Show function to display program languages to user.