drasil-docLang-0.1.26.0: A framework for code and document generation for scientific software - Document Language SubPackage
Safe HaskellSafe-Inferred
LanguageHaskell2010

Drasil.Sections.TableOfSymbols

Description

Standard code to make a table of symbols.

Synopsis

Documentation

table :: (Quantity s, MayHaveUnit s) => Stage -> [s] -> (s -> Sentence) -> LabelledContent Source #

Table of Symbols creation function. Takes in a Stage, Symbols, and something that turns the symbols into a Sentence. Filters non-symbol chunks and checks for duplicate symbol error.

symbTableRef :: Reference Source #

Makes a reference to the Table of Symbols.

tsymb :: [TSIntro] -> RefTab Source #

Default is term and given introduction.

Table of symbols constructor.

tsymb' :: [TSIntro] -> RefTab Source #

Similar to tsymb, but has a default Defn for the LFunc type. Still has a given introduction.

Table of symbols constructor.

tsymb'' :: [TSIntro] -> LFunc -> RefTab Source #

Table of symbols constructor. Takes a custom function and introduction.

tsIntro :: [TSIntro] -> Contents Source #

Table of symbols introduction builder. Used by mkRefSec.