Diagrams.Backend.PGF.Surface

A Surface defines how a pgfpicture should be placed and compiled. Surfaces are used for rendering a .tex or .pdf using functions from PGF.

Surfaces are also used in Hbox for querying envelopes of text.

Surfaces for Latex, Context and plain Tex are provided and reexported by Diagrams.Backend.PGF. Lenses here allow these to be adjusted as required.

Surface definition

data Surface

Constructors

Surface

Fields

_texFormat :: TexFormat

Format for the PGF commands

_command :: String

System command to be called.

_arguments :: [String]

Auguments for command.

_pageSize :: Maybe (V2 Int -> String)

Command to change page size from dimensions of image. (in bp)

_preamble :: String

Preamble for document, should import pgfcore.

_beginDoc :: String

Begin document.

_endDoc :: String

End document.

Instances

Default Surface

Latex is the default surface.

Hashable Surface

type MainOpts (Surface, QDiagram PGF V2 n Any)

type MainOpts (Surface, OnlineTex (QDiagram PGF V2 n Any))

data TexFormat

The TexFormat is used to choose the different PGF commands nessesary for that format.

Constructors

LaTeX

ConTeXt

PlainTeX

Instances

Eq TexFormat

Read TexFormat

Show TexFormat

Hashable TexFormat

Online rendering with surfaces

surfOnlineTex :: Surface -> OnlineTex a -> a

Get the result of an OnlineTex using the given surface.

surfOnlineTexIO :: Surface -> OnlineTex a -> IO a

Get the result of an OnlineTex using the given surface.

Predefined surfaces

latexSurface :: Surface

Default surface for latex files by calling pdflatex.

Sample output

command: pdflatex

% preamble
documentclass{article}
usepackage{pgfcore}
pagenumbering{gobble}

% pageSize
pdfpagewidth=100bp
pdfpageheight=80bp
textheight=80bp
pdfhorigin=-76.6bp
pdfvorigin=-52.8bp

% beginDoc
begin{document}

<Latex pgf code>

% endDoc
end{document}

contextSurface :: Surface

Default surface for latex files by calling pdflatex.

Sample output

command: context --pipe --once

% preamble
usemodule[pgf]
setuppagenumbering[location=]

% pageSize
definepapersize[diagram][width=100bp,height=80bp]
setuppapersize[diagram][diagram]
setuplayout
  [ topspace=0bp
  , backspace=0bp
  , header=0bp
  , footer=0bp
  , width=100bp
  , height=80bp
  ]

% beginDoc
starttext

<Context pgf code>

% endDoc
stoptext

plaintexSurface :: Surface

Default surface for latex files by calling pdflatex.

Sample output

command: pdftex

% preamble
input eplain
beginpackages
usepackage{color}
endpackages
input pgfcore
deffrac2{{begingroup 2}}nopagenumbers

% pageSize
pdfpagewidth=100bp
pdfpageheight=80bp
pdfhorigin=-20bp
pdfvorigin=0bp

% beginDoc


pgf code

% endDoc
bye

sampleSurfaceOutput :: Surface -> String

Lenses

texFormat :: Lens' Surface TexFormat

Format for the PGF commands.

command :: Lens' Surface String

System command to call for rendering PDFs for OnlineTex.

arguments :: Lens' Surface [String]

List of arguments for the command.

pageSize :: Lens' Surface (Maybe (V2 Int -> String))

Specify the page size for the tex file.

preamble :: Lens' Surface String

Preamble for the tex document. This should at least import pgfcore.

beginDoc :: Lens' Surface String

Command to begin the document. (This normally doesn't need to change)

endDoc :: Lens' Surface String

Command to end the document. (This normally doesn't need to change)