Text.LaTeX.Base.Commands

LaTeX standard commands and environments.

Basic functions

raw :: Text -> LaTeX

Insert a raw piece of Text. This functions doesn't care about LaTeX reserved characters, it insert the text just as it is received.

between :: LaTeX -> LaTeX -> LaTeX -> LaTeX

Calling between c l1 l2 puts c between l1 and l2 and appends them.

Preamble commands

title :: LaTeX -> LaTeX

Set the title of your document.

author :: LaTeX -> LaTeX

Set the author(s) of the document.

date :: LaTeX -> LaTeX

Set a date for your document.

institute :: Maybe LaTeX -> LaTeX -> LaTeX

Set either an institute or an organization for the document.

thanks :: LaTeX -> LaTeX

documentclass

Arguments

:: [ClassOption]

Class options

-> ClassName

Class name

-> LaTeX

Set the document class. Needed in all documents.

usepackage :: [LaTeX] -> PackageName -> LaTeX

Import a package. First argument is a list of options for the package named in the second argument.

linespread :: Float -> LaTeX

Classes

Document classes

article :: ClassName

proc :: ClassName

report :: ClassName

minimal :: ClassName

book :: ClassName

slides :: ClassName

Class options

data ClassOption

A class option to be passed to the documentclass function.

Constructors

Draft

TitlePage

NoTitlePage

OneColumn

TwoColumn

OneSide

TwoSide

Landscape

OpenRight

OpenAny

Fleqn

Leqno

FontSize Measure

Paper PaperType

CustomOption String

Instances

Show ClassOption

IsString ClassOption

Render ClassOption

customopt :: String -> ClassOption

draft :: ClassOption

titlepage :: ClassOption

notitlepage :: ClassOption

onecolumn :: ClassOption

twocolumn :: ClassOption

oneside :: ClassOption

twoside :: ClassOption

landscape :: ClassOption

Changes the layout of the document to print in landscape mode

openright :: ClassOption

Makes chapters begin either only on right hand pages

openany :: ClassOption

Makes chapters begin on the next page available.

fleqn :: ClassOption

Typesets displayed formulae left-aligned instead of centred.

leqno :: ClassOption

Places the numbering of formulae on the left hand side instead of the right.

Paper sizes

data PaperType

LaTeX available paper types.

Constructors

A0

A1

A2

A3

A4

A5

A6

B0

B1

B2

B3

B4

B5

B6

Letter

Executive

Legal

Instances

Show PaperType

Render PaperType

a0paper :: ClassOption

a1paper :: ClassOption

a2paper :: ClassOption

a3paper :: ClassOption

a4paper :: ClassOption

a5paper :: ClassOption

a6paper :: ClassOption

b0paper :: ClassOption

b1paper :: ClassOption

b2paper :: ClassOption

b3paper :: ClassOption

b4paper :: ClassOption

b5paper :: ClassOption

b6paper :: ClassOption

letterpaper :: ClassOption

executivepaper :: ClassOption

legalpaper :: ClassOption

Page styles

pagestyle :: LaTeX -> LaTeX

thispagestyle :: LaTeX -> LaTeX

plain :: LaTeX

headings :: LaTeX

empty :: LaTeX

myheadings :: LaTeX

markboth :: LaTeX -> LaTeX -> LaTeX

Used in conjunction with myheadings for setting both the left and the right heading.

markright :: LaTeX -> LaTeX

Used in conjunction with myheadings for setting the right heading.

Body commands

document :: LaTeX -> LaTeX

maketitle :: LaTeX

Generate the title. It normally contains the title name of your document, the author(s) and date.

Document structure

tableofcontents :: LaTeX

Create the table of contents, automatically generated from your sections, subsections, and other related stuff.

abstract :: LaTeX -> LaTeX

appendix :: LaTeX

Sections

part :: LaTeX -> LaTeX

chapter :: LaTeX -> LaTeX

section :: LaTeX -> LaTeX

Start a new section with a given title.

subsection :: LaTeX -> LaTeX

subsubsection :: LaTeX -> LaTeX

paragraph :: LaTeX -> LaTeX

subparagraph :: LaTeX -> LaTeX

Logos & symbols

today :: LaTeX

tex :: LaTeX

latex :: LaTeX

The LaTeX logo.

laTeX2 :: LaTeX

laTeXe :: LaTeX

ldots :: LaTeX

Horizontal dots.

vdots :: LaTeX

Vertical dots.

ddots :: LaTeX

Diagonal dots.

HaTeX specific

hatex :: LaTeX

Print the HaTeX logo.

hatex3 :: LaTeX

Print the HaTeX 3 logo.

hatex_meta :: LaTeX

Print the HaTeX-meta logo.

hatex_version :: LaTeX

Print the HaTeX logo, beside the complete version number.

Document layout

par :: LaTeX

Start a new paragraph

newline :: LaTeX

Start a new line.

lnbk :: LaTeX

Start a new line. In a tabular, it starts a new row, so use newline instead.

lnbk_ :: LaTeX

newpage :: LaTeX

cleardoublepage :: LaTeX

clearpage :: LaTeX

linebreak :: LaTeX -> LaTeX

nolinebreak :: LaTeX -> LaTeX

pagebreak :: LaTeX -> LaTeX

nopagebreak :: LaTeX -> LaTeX

hspace :: Measure -> LaTeX

hspace_ :: Measure -> LaTeX

vspace :: Measure -> LaTeX

stretch :: Int -> LaTeX

smallskip :: LaTeX

bigskip :: LaTeX

indent :: LaTeX

noindent :: LaTeX

Document measures

textwidth :: LaTeX

linewidth :: LaTeX

Formatting text

verbatim :: LaTeX -> LaTeX

Fonts

textbf :: LaTeX -> LaTeX

textit :: LaTeX -> LaTeX

texttt :: LaTeX -> LaTeX

textrm :: LaTeX -> LaTeX

textsf :: LaTeX -> LaTeX

textmd :: LaTeX -> LaTeX

textup :: LaTeX -> LaTeX

textsl :: LaTeX -> LaTeX

textsc :: LaTeX -> LaTeX

textnormal :: LaTeX -> LaTeX

underline :: LaTeX -> LaTeX

emph :: LaTeX -> LaTeX

Sizes

tiny :: LaTeX -> LaTeX

scriptsize :: LaTeX -> LaTeX

footnotesize :: LaTeX -> LaTeX

small :: LaTeX -> LaTeX

normalsize :: LaTeX -> LaTeX

large :: LaTeX -> LaTeX

large2 :: LaTeX -> LaTeX

large3 :: LaTeX -> LaTeX

huge :: LaTeX -> LaTeX

huge2 :: LaTeX -> LaTeX

Environments

equation :: LaTeX -> LaTeX

equation_ :: LaTeX -> LaTeX

enumerate :: LaTeX -> LaTeX

itemize :: LaTeX -> LaTeX

item :: Maybe LaTeX -> LaTeX

flushleft :: LaTeX -> LaTeX

flushright :: LaTeX -> LaTeX

center :: LaTeX -> LaTeX

quote :: LaTeX -> LaTeX

verse :: LaTeX -> LaTeX

cite :: LaTeX -> LaTeX

description :: LaTeX -> LaTeX

minipage

Arguments

:: Maybe Pos

Optional position

-> LaTeX

Width

-> LaTeX

Minipage content

-> LaTeX

Minipage environments.

Page numbering

pagenumbering :: LaTeX -> LaTeX

arabic :: LaTeX

Arabic numerals.

roman :: LaTeX

Lowercase roman numerals.

roman_ :: LaTeX

Uppercase roman numerals.

alph :: LaTeX

Lowercase letters.

alph_ :: LaTeX

Uppercase letters.

Boxes

mbox :: LaTeX -> LaTeX

fbox :: LaTeX -> LaTeX

parbox :: Maybe Pos -> Measure -> LaTeX -> LaTeX

framebox :: Maybe Measure -> Maybe Pos -> LaTeX -> LaTeX

makebox :: Maybe Measure -> Maybe Pos -> LaTeX -> LaTeX

raisebox :: Measure -> Maybe Measure -> Maybe Measure -> LaTeX -> LaTeX

rule

Arguments

:: Maybe Measure

Optional lifting.

-> Measure

Width.

-> Measure

Height.

-> LaTeX

Produce a simple black box.

Cross references

label :: Label -> LaTeX

ref :: Label -> LaTeX

pageref :: Label -> LaTeX

Tables

tabular

Arguments

:: Maybe Pos

This optional parameter can be used to specify the vertical position of the table. Defaulted to Center.

-> [TableSpec]

Table specification of columns and vertical lines.

-> LaTeX

Table content. See &, lnbk, hline and cline.

-> LaTeX

Resulting table syntax.

The tabular environment can be used to typeset tables with optional horizontal and vertical lines.

(&) :: LaTeX -> LaTeX -> LaTeX

Column separator.

hline :: LaTeX

Horizontal line.

cline :: Int -> Int -> LaTeX

cline i j writes a partial horizontal line beginning in column i and ending in column j.

Others

footnote :: LaTeX -> LaTeX

protect :: LaTeX -> LaTeX

hyphenation :: LaTeX -> LaTeX

hyp :: LaTeX

qts :: LaTeX -> LaTeX

Quotation marks.