Text.LaTeX.Base.Commands.Monad

LaTeX standard commands and environments.

For contributors: This module was automatically generated by HaTeX-meta. So, please, don't make any change here directly, because this is intended to be generated automatically from Text.LaTeX.Base.Commands module via HaTeX-meta, and therefore, changes must to be done in these places.

Basic functions

raw :: Monad m => Text -> LaTeXT_ m

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 :: Monad m => LaTeXT_ m -> LaTeXT_ m -> LaTeXT_ m -> LaTeXT_ m

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

Preamble commands

title :: Monad m => LaTeXT_ m -> LaTeXT_ m

Set the title of your document.

author :: Monad m => LaTeXT_ m -> LaTeXT_ m

Set the author(s) of the document.

date :: Monad m => LaTeXT_ m -> LaTeXT_ m

Set a date for your document.

institute :: Monad m => Maybe (LaTeXT_ m) -> LaTeXT_ m -> LaTeXT_ m

Set either an institute or an organization for the document.

thanks :: Monad m => LaTeXT_ m -> LaTeXT_ m

documentclass :: Monad m => [ClassOption] -> ClassName -> LaTeXT_ m

Set the document class. Needed in all documents.

usepackage :: Monad m => [LaTeXT_ m] -> PackageName -> LaTeXT_ m

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

linespread :: Monad m => Float -> LaTeXT_ m

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 :: Monad m => LaTeXT_ m -> LaTeXT_ m

thispagestyle :: Monad m => LaTeXT_ m -> LaTeXT_ m

plain :: Monad m => LaTeXT_ m

headings :: Monad m => LaTeXT_ m

empty :: Monad m => LaTeXT_ m

myheadings :: Monad m => LaTeXT_ m

markboth :: Monad m => LaTeXT_ m -> LaTeXT_ m -> LaTeXT_ m

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

markright :: Monad m => LaTeXT_ m -> LaTeXT_ m

Used in conjunction with myheadings for setting the right heading.

Body commands

document :: Monad m => LaTeXT_ m -> LaTeXT_ m

maketitle :: Monad m => LaTeXT_ m

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

Document structure

tableofcontents :: Monad m => LaTeXT_ m

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

abstract :: Monad m => LaTeXT_ m -> LaTeXT_ m

appendix :: Monad m => LaTeXT_ m

Sections

part :: Monad m => LaTeXT_ m -> LaTeXT_ m

chapter :: Monad m => LaTeXT_ m -> LaTeXT_ m

section :: Monad m => LaTeXT_ m -> LaTeXT_ m

Start a new section with a given title.

subsection :: Monad m => LaTeXT_ m -> LaTeXT_ m

subsubsection :: Monad m => LaTeXT_ m -> LaTeXT_ m

paragraph :: Monad m => LaTeXT_ m -> LaTeXT_ m

subparagraph :: Monad m => LaTeXT_ m -> LaTeXT_ m

Logos & symbols

today :: Monad m => LaTeXT_ m

tex :: Monad m => LaTeXT_ m

latex :: Monad m => LaTeXT_ m

The LaTeX logo.

laTeX2 :: Monad m => LaTeXT_ m

laTeXe :: Monad m => LaTeXT_ m

ldots :: Monad m => LaTeXT_ m

Horizontal dots.

vdots :: Monad m => LaTeXT_ m

Vertical dots.

ddots :: Monad m => LaTeXT_ m

Diagonal dots.

HaTeX specific

hatex :: Monad m => LaTeXT_ m

Print the HaTeX logo.

hatex3 :: Monad m => LaTeXT_ m

Print the HaTeX 3 logo.

hatex_meta :: Monad m => LaTeXT_ m

Print the HaTeX-meta logo.

hatex_version :: Monad m => LaTeXT_ m

Print the HaTeX logo, beside the complete version number.

Document layout

par :: Monad m => LaTeXT_ m

Start a new paragraph

newline :: Monad m => LaTeXT_ m

Start a new line.

lnbk :: Monad m => LaTeXT_ m

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

lnbk_ :: Monad m => LaTeXT_ m

newpage :: Monad m => LaTeXT_ m

cleardoublepage :: Monad m => LaTeXT_ m

clearpage :: Monad m => LaTeXT_ m

linebreak :: Monad m => LaTeXT_ m -> LaTeXT_ m

nolinebreak :: Monad m => LaTeXT_ m -> LaTeXT_ m

pagebreak :: Monad m => LaTeXT_ m -> LaTeXT_ m

nopagebreak :: Monad m => LaTeXT_ m -> LaTeXT_ m

hspace :: Monad m => Measure -> LaTeXT_ m

hspace_ :: Monad m => Measure -> LaTeXT_ m

vspace :: Monad m => Measure -> LaTeXT_ m

stretch :: Monad m => Int -> LaTeXT_ m

smallskip :: Monad m => LaTeXT_ m

bigskip :: Monad m => LaTeXT_ m

indent :: Monad m => LaTeXT_ m

noindent :: Monad m => LaTeXT_ m

Document measures

textwidth :: Monad m => LaTeXT_ m

linewidth :: Monad m => LaTeXT_ m

Formatting text

verbatim :: Monad m => LaTeXT_ m -> LaTeXT_ m

Fonts

textbf :: Monad m => LaTeXT_ m -> LaTeXT_ m

textit :: Monad m => LaTeXT_ m -> LaTeXT_ m

texttt :: Monad m => LaTeXT_ m -> LaTeXT_ m

textrm :: Monad m => LaTeXT_ m -> LaTeXT_ m

textsf :: Monad m => LaTeXT_ m -> LaTeXT_ m

textmd :: Monad m => LaTeXT_ m -> LaTeXT_ m

textup :: Monad m => LaTeXT_ m -> LaTeXT_ m

textsl :: Monad m => LaTeXT_ m -> LaTeXT_ m

textsc :: Monad m => LaTeXT_ m -> LaTeXT_ m

textnormal :: Monad m => LaTeXT_ m -> LaTeXT_ m

underline :: Monad m => LaTeXT_ m -> LaTeXT_ m

emph :: Monad m => LaTeXT_ m -> LaTeXT_ m

Sizes

tiny :: Monad m => LaTeXT_ m -> LaTeXT_ m

scriptsize :: Monad m => LaTeXT_ m -> LaTeXT_ m

footnotesize :: Monad m => LaTeXT_ m -> LaTeXT_ m

small :: Monad m => LaTeXT_ m -> LaTeXT_ m

normalsize :: Monad m => LaTeXT_ m -> LaTeXT_ m

large :: Monad m => LaTeXT_ m -> LaTeXT_ m

large2 :: Monad m => LaTeXT_ m -> LaTeXT_ m

large3 :: Monad m => LaTeXT_ m -> LaTeXT_ m

huge :: Monad m => LaTeXT_ m -> LaTeXT_ m

huge2 :: Monad m => LaTeXT_ m -> LaTeXT_ m

Environments

equation :: Monad m => LaTeXT_ m -> LaTeXT_ m

equation_ :: Monad m => LaTeXT_ m -> LaTeXT_ m

enumerate :: Monad m => LaTeXT_ m -> LaTeXT_ m

itemize :: Monad m => LaTeXT_ m -> LaTeXT_ m

item :: Monad m => Maybe (LaTeXT_ m) -> LaTeXT_ m

flushleft :: Monad m => LaTeXT_ m -> LaTeXT_ m

flushright :: Monad m => LaTeXT_ m -> LaTeXT_ m

center :: Monad m => LaTeXT_ m -> LaTeXT_ m

quote :: Monad m => LaTeXT_ m -> LaTeXT_ m

verse :: Monad m => LaTeXT_ m -> LaTeXT_ m

cite :: Monad m => LaTeXT_ m -> LaTeXT_ m

description :: Monad m => LaTeXT_ m -> LaTeXT_ m

minipage :: Monad m => Maybe Pos -> LaTeXT_ m -> LaTeXT_ m -> LaTeXT_ m

Minipage environments.

Page numbering

pagenumbering :: Monad m => LaTeXT_ m -> LaTeXT_ m

arabic :: Monad m => LaTeXT_ m

Arabic numerals.

roman :: Monad m => LaTeXT_ m

Lowercase roman numerals.

roman_ :: Monad m => LaTeXT_ m

Uppercase roman numerals.

alph :: Monad m => LaTeXT_ m

Lowercase letters.

alph_ :: Monad m => LaTeXT_ m

Uppercase letters.

Boxes

mbox :: Monad m => LaTeXT_ m -> LaTeXT_ m

fbox :: Monad m => LaTeXT_ m -> LaTeXT_ m

parbox :: Monad m => Maybe Pos -> Measure -> LaTeXT_ m -> LaTeXT_ m

framebox :: Monad m => Maybe Measure -> Maybe Pos -> LaTeXT_ m -> LaTeXT_ m

makebox :: Monad m => Maybe Measure -> Maybe Pos -> LaTeXT_ m -> LaTeXT_ m

raisebox :: Monad m => Measure -> Maybe Measure -> Maybe Measure -> LaTeXT_ m -> LaTeXT_ m

rule :: Monad m => Maybe Measure -> Measure -> Measure -> LaTeXT_ m

Produce a simple black box.

Cross references

label :: Monad m => Label -> LaTeXT_ m

ref :: Monad m => Label -> LaTeXT_ m

pageref :: Monad m => Label -> LaTeXT_ m

Tables

tabular :: Monad m => Maybe Pos -> [TableSpec] -> LaTeXT_ m -> LaTeXT_ m

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

(&) :: Monad m => LaTeXT_ m -> LaTeXT_ m -> LaTeXT_ m

hline :: Monad m => LaTeXT_ m

Horizontal line.

cline :: Monad m => Int -> Int -> LaTeXT_ m

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

Others

footnote :: Monad m => LaTeXT_ m -> LaTeXT_ m

protect :: Monad m => LaTeXT_ m -> LaTeXT_ m

hyphenation :: Monad m => LaTeXT_ m -> LaTeXT_ m

hyp :: Monad m => LaTeXT_ m

qts :: Monad m => LaTeXT_ m -> LaTeXT_ m

Quotation marks.