Generic functions for references support

This file contains functions for references support, independent of actual implementation.

The main function is DocGen4.preprocessBibFile which preprocess the contents of bib file using user provided process function, and save the bib file and processed json file to output directory, as "references.bib" and "references.json", respectively.

Note that "references.bib" is only for user to download it, the actual file used later is "references.json". It contains an array of objects with 4 fields: 'citekey', 'tag', 'html' and 'plaintext'. For the meaning of these fields, see DocGen4.Output.BibItem.

def DocGen4.preprocessBibFile (buildDir : System.FilePath) (contents : String) (process : String → IO (Array Output.BibItem)) : IO Unit

Preprocess (using the user provided process function) and save the bib file to the output path.

Equations

• One or more equations did not get rendered due to their size.

def DocGen4.preprocessBibJson (buildDir : System.FilePath) (contents : String) : IO Unit

Save the bib json to the output path.

Equations

• One or more equations did not get rendered due to their size.

def DocGen4.disableBibFile (buildDir : System.FilePath) : IO Unit

Erase the contents of bib file in the output path.

Equations

• One or more equations did not get rendered due to their size.

def DocGen4.Output.refItem (ref : BibItem) (backrefs : Array BackrefItem) : BaseHtmlM Html

Equations

• One or more equations did not get rendered due to their size.

def DocGen4.Output.references (backrefs : Array BackrefItem) : BaseHtmlM Html

Equations

• One or more equations did not get rendered due to their size.