drasil-file-handling-0.1.1.0: A framework for code and document generation for scientific software - file-handling SubPackage
Safe HaskellSafe-Inferred
LanguageHaskell2010

Drasil.FileHandling.Legacy

Synopsis

Documentation

blank :: Doc Source #

Creates a blank document with no text.

indent :: Doc -> Doc Source #

Indents a document (by 4 spaces).

indentList :: [Doc] -> Doc Source #

Indents a list of Docs and combines into one Doc.

listToDoc :: [String] -> Doc Source #

Merge a list of Strings into a Doc format:

e.g., `listToDoc [a,b,c,...] ~= a, b, c, ...`

type Separator = Doc Source #

Separates document sections.

data RelativeFile Source #

A valid, relative file path with an extension in canonical form.

Instances

Instances details
Eq RelativeFile Source # 
Instance details

Defined in Drasil.FileHandling.Legacy.FilePath

relativeFile :: String -> RelativeFile Source #

Create a RelativeFile given a String that must be in canonical form, be a valid file path, contain a file extension, and be relative (not absolute); otherwise, an error is raised.