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

Safe Haskell	None
Language	GHC2024

Drasil.System.Core

Synopsis

type Purpose = [Sentence]
type Background = [Sentence]
type Scope = [Sentence]
type Motivation = [Sentence]
data SystemMeta
class HasSystemMeta c where
- systemMeta :: Lens' c SystemMeta
- authors :: Lens' c People
- background :: Lens' c Background
- motivation :: Lens' c Motivation
- projName :: Lens' c ProjectName
- purpose :: Lens' c Purpose
- scope :: Lens' c Scope
- systemdb :: Lens' c ChunkDB
mkSystemMeta :: ProjectName -> People -> Purpose -> Background -> Scope -> Motivation -> ChunkDB -> SystemMeta

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

HasChunkRefs SystemMeta Source #
Instance details Defined in Drasil.System.Core Methods chunkRefs :: SystemMeta -> Set UID #
HasUID SystemMeta Source #
Instance details Defined in Drasil.System.Core Methods uid :: Getter SystemMeta UID #
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 # projName :: Lens' SystemMeta ProjectName Source # purpose :: Lens' SystemMeta Purpose Source # scope :: Lens' SystemMeta Scope Source # systemdb :: Lens' SystemMeta ChunkDB Source #
HasProjectName SystemMeta Source #
Instance details Defined in Drasil.System.Core Methods projectName :: Lens' SystemMeta ProjectName Source # projAbrv :: Lens' SystemMeta String Source # projRepoName :: Lens' SystemMeta String Source # projTitle :: Lens' SystemMeta NP Source #

class HasSystemMeta c where Source #

Minimal complete definition

Methods

systemMeta :: Lens' c SystemMeta Source #

authors :: Lens' c People Source #

background :: Lens' c Background Source #

motivation :: Lens' c Motivation Source #

projName :: Lens' c ProjectName Source #

purpose :: Lens' c Purpose Source #

scope :: Lens' c Scope 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 #

projName :: Lens' SystemMeta ProjectName Source #

purpose :: Lens' SystemMeta Purpose Source #

scope :: Lens' SystemMeta Scope Source #

systemdb :: Lens' SystemMeta ChunkDB Source #

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