Creates a bulleted list.

Same as enumBullet but unlabelled.

Currently Unused. Creates a simple bulleted list that labels things with a title and number:

• lb - Reference,
• s - start index for the enumeration,
• t - title of the list,
• l - list to be enumerated.

For example, if we want to create a list of data definitions, we could call the function as follows:

enumSimple _ 2 (S "DD") [def1, def2, ...]

And the resulting LabelledContent would be rendered as:

• DD2: def1
• DD3: def2
• DD4: def3 ...

Same as enumSimple but unlabelled.

Convenience function for transforming referable concepts into a bulleted list. Used in drasil-docLang in making the assumptions, goals, and requirements sections. Output is of the kind Concept Name: definition of concept.

Displays a given expression and attaches a Reference to it.

Same as eqUnR except content is unlabelled (does not attach a Reference).

Unlabelled code expression

Fold sentences then turns into content using foldlSent.

Same as foldlSP but uses foldlSent_.

Same as foldlSP but uses foldlSentCol.

Contents may be labelled or unlabelled.

Denotes the different possible types that can be used as a list.

Denotes how something should behave in a list (ListType).

Types of layout objects we deal with explicitly.

MaxWidthPercent should be kept in the range 1-100. Values outside this range may have unexpected results. Used for specifying max figure width as pagewidth*MaxWidthPercent/100.

Members of this class must have RawContent.

Contains a Reference and RawContent.

Only contains RawContent.

Indicates whether a figure has a caption or not.

For holding a Reference that is decorated with extra information (ex. page numbers, equation sources, etc.).

A class that contains a list of decorated references (DecRefs).

Same as ref, but for DecRef instead of Reference.

For creating a decorated reference (DecRef) with extra reference information (RefInfo).

Extracts all ModelExprs mentioned in a Sentence.

Extracts ModelExprs from something that HasContents.

Extracts Sentences from something that HasContents.

Extracts Sentences from a list of Contents.

Extracts all referenced UIDs from things that have RawContents.

Extracts Sentences from a Section.

Extract bibliography entries from generated sections. This version extracts from fully expanded Sections, capturing citations that are only created during document generation (like those in orgOfDocIntro).

Given a ChunkDB and a set of UIDs, looks up the corresponding Citations and returns them sorted by author, year, and title.

FIXME: This function assumes that all UIDs in the set correspond to Citations in the database. If a UID does not correspond to a Citation, it is simply ignored. This should rather rely on a set of 'UIDRef Citation's.

A Reference contains the identifier (UID), a reference address (LblType), a human-readable shortname (ShortName), and any extra information about the reference (RefInfo).

A class that contains a list of References.

Projector function that creates a Reference from something Referable.

Takes the reference UID and wraps it into a Sentence.

Takes a Reference with a name to be displayed and wraps it into a Sentence. Does not overwrite the shortname contained in the reference, but will only display as the given Sentence.

Takes a Reference with additional display info. Uses the internal shortname for its display name.

Takes a Reference with a name to be displayed and any additional information and wraps it into a Sentence. Does not overwrite the shortname contained in the reference, but will only display as the given Sentence along with the given RefInfo.

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

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

Figure smart constructor without a caption.

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

Figure smart constructor with customized max widths and no caption.

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

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

Smart constructor for labelled content chunks. Now builds a Reference using the provided UID instead of extracting it from the Reference.

Helper for creating labelled content with a figure reference.

Helper for creating labelled content with a table reference.

Helper for creating labelled content with an equation reference.

Helper for creating labelled content with a UID-based figure reference.

Helper for creating labelled content with a UID-based table reference.

Helper for creating labelled content with a UID-based equation reference.

Smart constructor for unlabelled content chunks (no Reference).

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

Smart constructor that wraps UnlabelledContent into Contents.

Smart constructor that wraps LabelledContent into Contents. Takes a Reference to extract UID, LblType, and ShortName for the labelled content.

Smart constructor similar to llcc, but takes in RawContent first. Takes a Reference to extract UID, LblType, and ShortName for the labelled content.

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

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

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

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

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

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

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

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

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

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

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

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

Output is of the form "reference - sentence".

Takes a HasSymbol that is also Referable and outputs as a Sentence: "symbol is defined in reference."

Same as definedIn, but allows for additional information to be appended to the Sentence.

Takes a Referable and outputs as a Sentence "defined in reference" (no HasSymbol).

Takes a Symbol and its Reference (does not append a period at the end!). Outputs as "symbol is defined in source".

Takes a Referable source and a UnitalChunk and outputs as a Sentence: "From source we can replace symbol:".

Wraps "from reference" in parentheses.

Similar to fromSource but takes a list of references instead of one.

Takes an amount as a Sentence and appends a unit to it.

Appends "following reference" to the end of a Sentence.

Takes a list and a Section, then generates a list of that section's reference to match the length of the list.

Converts input to a Sentence and appends %.

Helper functions for making likely change statements. Uses form likelyFrame parameter1 _ parameter2.

Helper functions for making likely change statements. Uses form likelyFrame parameter1 _ parameter2.

Helper functions for making likely change statements. Uses form likelyFrame parameter1 _ parameter2.

Returns the Sentence "(titleize aNamedIdea) Showing the Connections Between contents".

Takes a list of Referables and Symbols and outputs as a Sentence "By substituting symbols, this can be written as:".

Formats typical uncertainty data to be displayed.

Returns the Sentence "The chunk under consideration is chunkDefinition".

Get a unit symbol if there is one.

Apply a binary function to the terms of two named ideas, instead of to the named ideas themselves. Ex. fterms compoundPhrase t1 t2 instead of compoundPhrase (t1 ^. term) (t2 ^. term).

Prepends the word Equation to an Int.

Takes an expression and a Referable and outputs as a Sentence "expression (source)".

Applies Bullet and Flat to a list.

Applies Bullets and headers to a Nested ListType. The first argument is the headers of the Nested lists.

Makes Sentences from an item and its reference. Takes the title of reference as a String and a Sentence containing the full reference. Wraps the full reference in parenthesis.

Makes a traceability matrix from a list of row titles, a list of rows of "checked" columns, and a list of columns.

Zip helper function enumerates abbreviations and zips it with list of ItemType:

• s - the number from which the enumeration should start from (Integer),
• t - the title of the list (Sentence),
• l - the list to be enumerated ([Sentence]).

Helper for making a table from a columns.

Converts lists of simple ItemTypes into a list which may be used in Contents but is not directly referable.

Create a list in the pattern of "The __ are refined to the __". Note: Order matters!

Helpful combinators for making Sentences into Terminologies with Definitions. Returns of the form: "term - termDefinition".

Helpful combinators for making Sentences into Terminologies with Definitions. Returns of the form: "term (abbreviation) - termDefinition".

Helpful combinators for making Sentences into Terminologies with Definitions. Returns of the form: "term (symbol) - termDefinition".

Distributes a list of Sentences by prepending individual Sentences once to an existing list of Sentences.

For example:

>>> zipSentList [S "Hi", S "Hey", S "Hi"] [[S "Hello"], [S "World"], [S "Hello", S "World"]]
[[S "Hi", S "Hello"], [S "Hey", S "World"], [S "Hi", S "Hello", S "World"]]