snm-0.0.4: The Simple Nice-Looking Manual Generator.

Manual.Structure

Description

The structure of a manual

Synopsis

Documentation

data Manual Source

A manual

Constructors

Manual 

Fields

header :: Header

The manual's header file.

style :: CSS

The style used in the manual.

mcontents :: Contents

The manual's contents.

sections :: ![Section]

The sections of a manual.

data Header Source

A manual's header file

Constructors

Header 

Fields

mtitle :: !Banner

The name of the manual

banners :: ![Banner]

Banners

preamble :: ![Paragraph]

Preamble, not linked in the manual's contents.

data Contents Source

Contents listing

Constructors

Contents [Contents] 
Entry [Int] String String 

data Section Source

Sections, subsections

Constructors

Section 

Fields

number :: [Int]

The section's number.

title :: Banner

The title of the section

unique :: String

Unique name for this section

stext :: ![Paragraph]

The section text

subsections :: ![Section]

Subsections

data Banner Source

A banner for the top of the document

Constructors

Banner 

Fields

btext :: ![Inline]
 
bclass :: !String
 

data Paragraph Source

A text paragraph

Constructors

Paragraph 

Fields

ptext :: ![Inline]

The paragraph text

pclass :: String

The paragraph's class

wrap :: Bool

Wrap the text

data Inline Source

Inline document elements may be...

Constructors

IText String

A text string

ISectionLink

A link to another section

Fields

ltext :: String

The link text.

ldest :: String

The section number

IExternLink

An external link.

Fields

ltext :: String

The link text.

ldest :: String

The section number

ILiteral String

Literal text

Instances

contents :: [Section] -> ContentsSource

Create the manual's contents