Text.PDF.Slave

Reexports

Template definition

type TemplateName = Text

Template unique name

type TemplateInput = Value

A template takes simple YAML document as input

type TemplateBody = Text

Template body is text with .htex content

type TemplateBibtex = Text

Template can define additional bibtex database

type DependencyBody = ByteString

Dependency can be a binary file

type BibTexBody = Text

Content of bibtex file

data TemplateDependency

Template has different types of dependencies, each type of the dependecy has own affect on rendering pipe.

Constructors

BibtexDep BibTexBody

Bibtex file for references to other documents. Need call to bibtex

TemplateDep Template

HTex file that need to be compiled to .tex file

TemplatePdfDep Template

HTex file that need to be compiled to .pdf file

OtherDep DependencyBody

Any other file that doesn't need a compilation (listings, images, etc)

Instances

Show TemplateDependency

Methods

showsPrec :: Int -> TemplateDependency -> ShowS

show :: TemplateDependency -> String

showList :: [TemplateDependency] -> ShowS

Generic TemplateDependency

Associated Types

type Rep TemplateDependency :: * -> *

Methods

from :: TemplateDependency -> Rep TemplateDependency x

to :: Rep TemplateDependency x -> TemplateDependency

ToJSON TemplateDependency

Methods

toJSON :: TemplateDependency -> Value

toEncoding :: TemplateDependency -> Encoding

FromJSON TemplateDependency

Methods

parseJSON :: Value -> Parser TemplateDependency

type Rep TemplateDependency

type Rep TemplateDependency = D1 (MetaData "TemplateDependency" "Text.PDF.Slave.Template" "pdf-slave-1.0.1.0-7bYo1EAU9SXLRzs5p4cl60" False) ((:+:) ((:+:) (C1 (MetaCons "BibtexDep" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BibTexBody))) (C1 (MetaCons "TemplateDep" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Template)))) ((:+:) (C1 (MetaCons "TemplatePdfDep" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Template))) (C1 (MetaCons "OtherDep" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 DependencyBody)))))

data Template

Description of document template

Constructors

Template

Fields

• templateName :: TemplateName

  Template has human readable name

• templateInput :: Maybe TemplateInput

  Template expects input in YAML format

• templateBody :: TemplateBody

  Template contents

• templateDeps :: Map TemplateName TemplateDependency

  Template dependencies (bibtex, listings, other htex files)

• templateHaskintexOpts :: [Text]

  Additional flags for haskintex

Instances

Show Template

Methods

showsPrec :: Int -> Template -> ShowS

show :: Template -> String

showList :: [Template] -> ShowS

Generic Template

Associated Types

type Rep Template :: * -> *

Methods

from :: Template -> Rep Template x

to :: Rep Template x -> Template

ToJSON Template

Methods

toJSON :: Template -> Value

toEncoding :: Template -> Encoding

FromJSON Template

Methods

parseJSON :: Value -> Parser Template

type Rep Template

type Rep Template = D1 (MetaData "Template" "Text.PDF.Slave.Template" "pdf-slave-1.0.1.0-7bYo1EAU9SXLRzs5p4cl60" False) (C1 (MetaCons "Template" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "templateName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TemplateName)) (S1 (MetaSel (Just Symbol "templateInput") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe TemplateInput)))) ((:*:) (S1 (MetaSel (Just Symbol "templateBody") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TemplateBody)) ((:*:) (S1 (MetaSel (Just Symbol "templateDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map TemplateName TemplateDependency))) (S1 (MetaSel (Just Symbol "templateHaskintexOpts") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text]))))))

data TemplateDependencyFile

Same as TemplateDependency but keeps contents in separate files

Constructors

BibtexDepFile

Bibtex file for references to other documents. Need call to bibtex. Name of dependency is a filename with contents.

TemplateDepFile TemplateFile

HTex file that need to be compiled to .tex file Name of dependency defines a subfolder for the template.

TemplatePdfDepFile TemplateFile

HTex file that need to be compiled to .pdf file Name of dependency deinfes a subfolder for the template.

OtherDepFile

Any other file that doesn't need a compilation (listings, images, etc) Name of dependency is a filename with contents.

Instances

Show TemplateDependencyFile

Methods

showsPrec :: Int -> TemplateDependencyFile -> ShowS

show :: TemplateDependencyFile -> String

showList :: [TemplateDependencyFile] -> ShowS

Generic TemplateDependencyFile

Associated Types

type Rep TemplateDependencyFile :: * -> *

Methods

from :: TemplateDependencyFile -> Rep TemplateDependencyFile x

to :: Rep TemplateDependencyFile x -> TemplateDependencyFile

ToJSON TemplateDependencyFile

Methods

toJSON :: TemplateDependencyFile -> Value

toEncoding :: TemplateDependencyFile -> Encoding

FromJSON TemplateDependencyFile

Methods

parseJSON :: Value -> Parser TemplateDependencyFile

type Rep TemplateDependencyFile

type Rep TemplateDependencyFile = D1 (MetaData "TemplateDependencyFile" "Text.PDF.Slave.Template" "pdf-slave-1.0.1.0-7bYo1EAU9SXLRzs5p4cl60" False) ((:+:) ((:+:) (C1 (MetaCons "BibtexDepFile" PrefixI False) U1) (C1 (MetaCons "TemplateDepFile" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TemplateFile)))) ((:+:) (C1 (MetaCons "TemplatePdfDepFile" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TemplateFile))) (C1 (MetaCons "OtherDepFile" PrefixI False) U1)))

data TemplateFile

Same as Template, but holds info about template content and dependencies in other files.

Constructors

TemplateFile

Fields

• templateFileName :: TemplateName

  Template has human readable name

• templateFileInput :: Maybe FilePath

  Template expects input in JSON format. The field contains filename of the YAML file.

• templateFileBody :: FilePath

  Template contents filename.

• templateFileDeps :: Map TemplateName TemplateDependencyFile

  Template dependencies (bibtex, listings, other htex files)

• templateFileHaskintexOpts :: [Text]

  Additional flags for haskintex

Instances

Show TemplateFile

Methods

showsPrec :: Int -> TemplateFile -> ShowS

show :: TemplateFile -> String

showList :: [TemplateFile] -> ShowS

Generic TemplateFile

Associated Types

type Rep TemplateFile :: * -> *

Methods

from :: TemplateFile -> Rep TemplateFile x

to :: Rep TemplateFile x -> TemplateFile

ToJSON TemplateFile

Methods

toJSON :: TemplateFile -> Value

toEncoding :: TemplateFile -> Encoding

FromJSON TemplateFile

Methods

parseJSON :: Value -> Parser TemplateFile

type Rep TemplateFile

type Rep TemplateFile = D1 (MetaData "TemplateFile" "Text.PDF.Slave.Template" "pdf-slave-1.0.1.0-7bYo1EAU9SXLRzs5p4cl60" False) (C1 (MetaCons "TemplateFile" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "templateFileName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TemplateName)) (S1 (MetaSel (Just Symbol "templateFileInput") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath)))) ((:*:) (S1 (MetaSel (Just Symbol "templateFileBody") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) ((:*:) (S1 (MetaSel (Just Symbol "templateFileDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map TemplateName TemplateDependencyFile))) (S1 (MetaSel (Just Symbol "templateFileHaskintexOpts") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text]))))))

Bundle helpers

loadTemplateInMemory :: TemplateFile -> Sh (Either String Template)

Load all external references of template into memory

storeTemplateInFiles :: Template -> FilePath -> Sh TemplateFile

Extract all external references of template into file system

Template rendering to PDF

type PDFContent = ByteString

Contents of PDF file

data PDFRenderException

Errors that are thrown by rendering functions

Constructors

TemplateFormatError FilePath ParseException

Failed to parse template YAML

BundleFormatError FilePath ParseException

Failed to parse template bundle YAML | Failed to parse file in both formats: bundle and template file.

BundleOrTemplateFormatError FilePath ParseException ParseException

InputFileFormatError FilePath String

Failed to parse JSON input

Instances

Show PDFRenderException

Methods

showsPrec :: Int -> PDFRenderException -> ShowS

show :: PDFRenderException -> String

showList :: [PDFRenderException] -> ShowS

Generic PDFRenderException

Associated Types

type Rep PDFRenderException :: * -> *

Methods

from :: PDFRenderException -> Rep PDFRenderException x

to :: Rep PDFRenderException x -> PDFRenderException

Exception PDFRenderException

Methods

toException :: PDFRenderException -> SomeException

fromException :: SomeException -> Maybe PDFRenderException

displayException :: PDFRenderException -> String

type Rep PDFRenderException

type Rep PDFRenderException = D1 (MetaData "PDFRenderException" "Text.PDF.Slave.Render" "pdf-slave-1.0.1.0-7bYo1EAU9SXLRzs5p4cl60" False) ((:+:) ((:+:) (C1 (MetaCons "TemplateFormatError" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ParseException)))) (C1 (MetaCons "BundleFormatError" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ParseException))))) ((:+:) (C1 (MetaCons "BundleOrTemplateFormatError" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ParseException)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ParseException))))) (C1 (MetaCons "InputFileFormatError" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))))

displayPDFRenderException :: PDFRenderException -> String

Convert PDF rendering exception to user readable format

renderBundleOrTemplateFromFile

Arguments

:: FilePath

Path to either bundle Template or template TemplateFile

-> Maybe Value

Overwrite of input JSON for bundle

-> Sh PDFContent

Helper to render either a bundle or distributed template from file to PDF.

renderFromFileBundleToPDF

Arguments

:: FilePath

Path to Template all-in bundle

-> Maybe Value

Overwrite of input JSON for bundle

-> Sh PDFContent

Helper to render from all-in bundle template

renderFromFileToPDF

Arguments

:: FilePath

Path to TemplateFile

-> Sh PDFContent

Helper to render from template file

renderBundleToPDF

Arguments

:: Template

Input all-in template

-> FilePath

Base directory

-> Sh PDFContent

Unpack bundle, render the template, cleanup and return PDF

renderTemplateToPDF

Arguments

:: TemplateFile

Input template

-> FilePath

Base directory

-> Sh PDFContent

Output PDF file

Render template and return content of resulted PDF file