drasil-system-0.1.1.0: A framework for code and document generation for scientific software - System SubPackage
Safe HaskellSafe-Inferred
LanguageHaskell2010

Drasil.System.Core

Synopsis

Documentation

type Purpose = [Sentence] Source #

Project Example purpose.

type Background = [Sentence] Source #

Project Example background information, used in the What section of README.

type Scope = [Sentence] Source #

Project Example scope.

type Motivation = [Sentence] Source #

Project Example motivation.

data SystemMeta Source #

Instances

Instances details
HasSystemMeta SystemMeta Source # 
Instance details

Defined in Drasil.System.Core

Methods

systemMeta :: Lens' SystemMeta SystemMeta Source #

authors :: Lens' SystemMeta People Source #

background :: Lens' SystemMeta Background Source #

motivation :: Lens' SystemMeta Motivation Source #

purpose :: Lens' SystemMeta Purpose Source #

scope :: Lens' SystemMeta Scope Source #

sysName :: Lens' SystemMeta CI Source #

systemdb :: Lens' SystemMeta ChunkDB Source #

class HasSystemMeta c where Source #

Minimal complete definition

systemMeta

Methods

systemMeta :: Lens' c SystemMeta Source #

authors :: Lens' c People Source #

background :: Lens' c Background Source #

motivation :: Lens' c Motivation Source #

purpose :: Lens' c Purpose Source #

scope :: Lens' c Scope Source #

sysName :: Lens' c CI Source #

systemdb :: Lens' c ChunkDB Source #

Instances

Instances details
HasSystemMeta SystemMeta Source # 
Instance details

Defined in Drasil.System.Core

Methods

systemMeta :: Lens' SystemMeta SystemMeta Source #

authors :: Lens' SystemMeta People Source #

background :: Lens' SystemMeta Background Source #

motivation :: Lens' SystemMeta Motivation Source #

purpose :: Lens' SystemMeta Purpose Source #

scope :: Lens' SystemMeta Scope Source #

sysName :: Lens' SystemMeta CI Source #

systemdb :: Lens' SystemMeta ChunkDB Source #

HasSystemMeta DrasilWebsite Source # 
Instance details

Defined in Drasil.System.DrasilWebsite

Methods

systemMeta :: Lens' DrasilWebsite SystemMeta Source #

authors :: Lens' DrasilWebsite People Source #

background :: Lens' DrasilWebsite Background Source #

motivation :: Lens' DrasilWebsite Motivation Source #

purpose :: Lens' DrasilWebsite Purpose Source #

scope :: Lens' DrasilWebsite Scope Source #

sysName :: Lens' DrasilWebsite CI Source #

systemdb :: Lens' DrasilWebsite ChunkDB Source #

HasSystemMeta LessonPlan Source # 
Instance details

Defined in Drasil.System.LessonPlan

Methods

systemMeta :: Lens' LessonPlan SystemMeta Source #

authors :: Lens' LessonPlan People Source #

background :: Lens' LessonPlan Background Source #

motivation :: Lens' LessonPlan Motivation Source #

purpose :: Lens' LessonPlan Purpose Source #

scope :: Lens' LessonPlan Scope Source #

sysName :: Lens' LessonPlan CI Source #

systemdb :: Lens' LessonPlan ChunkDB Source #

HasSystemMeta SmithEtAlSRS Source # 
Instance details

Defined in Drasil.System.SmithEtAlSRS

Methods

systemMeta :: Lens' SmithEtAlSRS SystemMeta Source #

authors :: Lens' SmithEtAlSRS People Source #

background :: Lens' SmithEtAlSRS Background Source #

motivation :: Lens' SmithEtAlSRS Motivation Source #

purpose :: Lens' SmithEtAlSRS Purpose Source #

scope :: Lens' SmithEtAlSRS Scope Source #

sysName :: Lens' SmithEtAlSRS CI Source #

systemdb :: Lens' SmithEtAlSRS ChunkDB Source #

mkSystemMeta :: CI -> People -> Purpose -> Background -> Scope -> Motivation -> ChunkDB -> SystemMeta Source #