Ronn.AST

Documentation

data Ronn

Constructors

Ronn

Fields

• name :: ManRef
• description :: [Part]
• sections :: [Section]

data Section

Constructors

Section

Fields

• name :: Text
• content :: [Content]

data Content

Constructors

Definitions [Definition]

Groups [Group]

Instances

IsString Content

Defined in Ronn.AST

Methods

fromString :: String -> Content

data Definition

Constructors

Definition

Fields

• name :: Part
• description :: Line

  A line of nested description is required

• content :: Maybe [Content]

  More content can be optionally nested

data Group

Constructors

Title ManRef [Part]

Header Text

Lines [Line]

Instances

IsString Group

Defined in Ronn.AST

Methods

fromString :: String -> Group

newtype Line

Constructors

Line

Fields

• unwrap :: [Part]

Instances

IsString Line

Defined in Ronn.AST

Methods

fromString :: String -> Line

data Part

Constructors

Concat [Part]

Concat joins Parts without automaticaly inserting a space

The following expressions are equivalent:

• ronnLineToText $ Line [p1, p2]

• ronnLineToText $ Line [Concat [p1, " ", p2]]

• ronnLineToText $ Line [p1 <> " " <> p2]

Using the Semigroup instance should be preferred, in case the AST changes in the future.

Code Part

UserInput Part

Strong Part

Variable Part

Ephasis Part

Brackets Part

Parens Part

Ref ManRef

Raw Text

Instances

IsString Part

Defined in Ronn.AST

Methods

fromString :: String -> Part

Monoid Part

Defined in Ronn.AST

Methods

mempty :: Part

mappend :: Part -> Part -> Part

mconcat :: [Part] -> Part

Semigroup Part

Defined in Ronn.AST

Methods

(<>) :: Part -> Part -> Part

sconcat :: NonEmpty Part -> Part

stimes :: Integral b => b -> Part -> Part

References

data ManRef

Constructors

ManRef

Fields

• name :: Text
• section :: ManSection

Instances

Show ManRef

Defined in Ronn.ManRef

Methods

showsPrec :: Int -> ManRef -> ShowS

show :: ManRef -> String

showList :: [ManRef] -> ShowS

Eq ManRef

Defined in Ronn.ManRef

Methods

(==) :: ManRef -> ManRef -> Bool

(/=) :: ManRef -> ManRef -> Bool

Ord ManRef

Defined in Ronn.ManRef

Methods

compare :: ManRef -> ManRef -> Ordering

(<) :: ManRef -> ManRef -> Bool

(<=) :: ManRef -> ManRef -> Bool

(>) :: ManRef -> ManRef -> Bool

(>=) :: ManRef -> ManRef -> Bool

max :: ManRef -> ManRef -> ManRef

min :: ManRef -> ManRef -> ManRef

data ManSection

Constructors

ManSection1

ManSection2

ManSection3

ManSection4

ManSection5

ManSection6

ManSection7

ManSection8

Instances

Bounded ManSection

Defined in Ronn.ManRef

Methods

minBound :: ManSection

maxBound :: ManSection

Enum ManSection

Defined in Ronn.ManRef

Methods

succ :: ManSection -> ManSection

pred :: ManSection -> ManSection

toEnum :: Int -> ManSection

fromEnum :: ManSection -> Int

enumFrom :: ManSection -> [ManSection]

enumFromThen :: ManSection -> ManSection -> [ManSection]

enumFromTo :: ManSection -> ManSection -> [ManSection]

enumFromThenTo :: ManSection -> ManSection -> ManSection -> [ManSection]

Show ManSection

Defined in Ronn.ManRef

Methods

showsPrec :: Int -> ManSection -> ShowS

show :: ManSection -> String

showList :: [ManSection] -> ShowS

Eq ManSection

Defined in Ronn.ManRef

Methods

(==) :: ManSection -> ManSection -> Bool

(/=) :: ManSection -> ManSection -> Bool

Ord ManSection

Defined in Ronn.ManRef

Methods

compare :: ManSection -> ManSection -> Ordering

(<) :: ManSection -> ManSection -> Bool

(<=) :: ManSection -> ManSection -> Bool

(>) :: ManSection -> ManSection -> Bool

(>=) :: ManSection -> ManSection -> Bool

max :: ManSection -> ManSection -> ManSection

min :: ManSection -> ManSection -> ManSection

manSectionNumber :: ManSection -> Int