Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.Drasil.Document

Contents

Section Types
Content Constructors
Section Constructors
Reference Constructors

Description

Document Description Language.

Synopsis

data SecCons
- = Sub Section
- | Con Contents
data Partition
- = Sections
- | Part
- | Chapter
data Section = Section {
- tle :: Title
- cons :: [SecCons]
- _lab :: Reference
}
lab :: Lens' Section Reference
data Document
- = Document Title Author ShowTableOfContents [Section]
- | Notebook Title Author [Section]
data ShowTableOfContents
- = ToC
- | NoToC
checkToC :: Document -> Document
llcc :: Reference -> RawContent -> LabelledContent
ulcc :: RawContent -> UnlabelledContent
mkParagraph :: Sentence -> Contents
mkFig :: Reference -> RawContent -> Contents
mkRawLC :: RawContent -> Reference -> LabelledContent
section :: Sentence -> [Contents] -> [Section] -> Reference -> Section
extractSection :: Document -> [Section]
getSec :: Section -> [Section]
getSecCons :: SecCons -> [Section]
fig :: Lbl -> Filepath -> RawContent
figNoCap :: Lbl -> Filepath -> RawContent
figWithWidth :: Lbl -> Filepath -> MaxWidthPercent -> RawContent
figNoCapWithWidth :: Lbl -> Filepath -> MaxWidthPercent -> RawContent
docNs :: UID -> UID
docUid :: String -> UID
makeTabRef :: String -> Reference
makeFigRef :: String -> Reference
makeSecRef :: String -> Sentence -> Reference
makeEqnRef :: String -> Reference
makeURI :: String -> String -> ShortName -> Reference
makeTabRef' :: UID -> Reference
makeFigRef' :: UID -> Reference
makeSecRef' :: UID -> Sentence -> Reference
makeEqnRef' :: UID -> Reference
makeURI' :: UID -> String -> ShortName -> Reference

Section Types

data SecCons Source #

Section Contents are split into subsections or contents, where contents are standard layout objects (see Contents).

Constructors

Sub Section
Con Contents

data Partition Source #

Constructors

Sections
Part
Chapter

data Section Source #

Sections have a title (Sentence), a list of contents (SecCons) and a shortname (Reference).

Constructors

Section
Fields tle :: Title cons :: [SecCons] _lab :: Reference

Instances

Instances details

HasRefAddress Section Source #	Finds the reference address of a `Section`.
Instance details Defined in Language.Drasil.Document Methods getRefAdd :: Section -> LblType Source #
Referable Section Source #	Finds the reference information of a `Section`.
Instance details Defined in Language.Drasil.Document Methods refAdd :: Section -> String Source # renderRef :: Section -> LblType Source #
HasShortName Section Source #	Finds the short name of a `Section`.
Instance details Defined in Language.Drasil.Document Methods shortname :: Section -> ShortName Source #
HasUID Section Source #	Finds the `UID` of a `Section`.
Instance details Defined in Language.Drasil.Document Methods uid :: Getter Section UID Source #
Eq Section Source #	`Section`s are equal if `UID`s are equal.
Instance details Defined in Language.Drasil.Document Methods (==) :: Section -> Section -> Bool # (/=) :: Section -> Section -> Bool #

lab :: Lens' Section Reference Source #

data Document Source #

A Document has a Title (Sentence), Author(s) (Sentence), and Sections which hold the contents of the document.

Constructors

Document Title Author ShowTableOfContents [Section]
Notebook Title Author [Section]

data ShowTableOfContents Source #

Determines whether or not the table of contents appears on the generated artifacts.

Constructors

ToC
NoToC

checkToC :: Document -> Document Source #

Manually removes the first section of a document (table of contents section). temp fix for Notebook (see if we need this in notebook later)

Content Constructors

llcc :: Reference -> RawContent -> LabelledContent Source #

Smart constructor for labelled content chunks.

ulcc :: RawContent -> UnlabelledContent Source #

Smart constructor for unlabelled content chunks (no Reference).

mkParagraph :: Sentence -> Contents Source #

Smart constructor that wraps UnlabelledContent into Contents.

mkFig :: Reference -> RawContent -> Contents Source #

Smart constructor that wraps LabelledContent into Contents.

mkRawLC :: RawContent -> Reference -> LabelledContent Source #

Smart constructor similar to llcc, but takes in RawContent first.

Section Constructors

section :: Sentence -> [Contents] -> [Section] -> Reference -> Section Source #

Smart constructor for creating Sections with a title (Sentence), introductory contents (ie. paragraphs, tables, etc.), a list of subsections, and a shortname (Reference).

extractSection :: Document -> [Section] Source #

Smart constructor for retrieving the contents (Sections) from a Document.

getSec :: Section -> [Section] Source #

Smart constructor for retrieving the subsections (Sections) within a Section.

getSecCons :: SecCons -> [Section] Source #

Helper to retrieve subsections (Sections) from section contents (SecCons).

fig :: Lbl -> Filepath -> RawContent Source #

Figure smart constructor with a Lbl and a Filepath. Assumes 100% of page width as max width. Defaults to WithCaption.

figNoCap :: Lbl -> Filepath -> RawContent Source #

Figure smart constructor without a caption.

figWithWidth :: Lbl -> Filepath -> MaxWidthPercent -> RawContent Source #

Figure smart constructor that allows for customized max widths. Defaults to WithCaption.

figNoCapWithWidth :: Lbl -> Filepath -> MaxWidthPercent -> RawContent Source #

Figure smart constructor with customized max widths and no caption.

Reference Constructors

docNs :: UID -> UID Source #

docUid :: String -> UID Source #

makeTabRef :: String -> Reference Source #

Create a reference for a table. Takes in the name of a table (which will also be used for its shortname).

makeFigRef :: String -> Reference Source #

Create a reference for a figure. Takes in the name of a figure (which will also be used for its shortname).

makeSecRef :: String -> Sentence -> Reference Source #

Create a reference for a section. Takes in the name of a section and a shortname for the section.

makeEqnRef :: String -> Reference Source #

Create a reference for a equation. Takes in the name of the equation (which will also be used for its shortname).

makeURI :: String -> String -> ShortName -> Reference Source #

Create a reference for a URI. Takes in a UID (as a String), a reference address, and a shortname.

makeTabRef' :: UID -> Reference Source #

Variants of makeTabRef that takes a UID instead of a String.

makeFigRef' :: UID -> Reference Source #

Variants of makeFigRef that takes a UID instead of a String.

makeSecRef' :: UID -> Sentence -> Reference Source #

Variants of makeSecRef that takes a UID instead of a String.

makeEqnRef' :: UID -> Reference Source #

Variants of makeEqnRef that takes a UID instead of a String.

makeURI' :: UID -> String -> ShortName -> Reference Source #

Variants of makeURI that takes a UID instead of a String.