Ronn.AST

Documentation

data Ronn

Constructors

Ronn

Fields

• name :: ManRef
• description :: [RonnPart]
• sections :: [RonnSection]

data RonnSection

Constructors

RonnSection

Fields

• name :: Text
• content :: [RonnContent]

data RonnContent

Constructors

RonnDefinitions [RonnDefinition]

RonnGroups [RonnGroup]

Instances

IsString RonnContent

Defined in Ronn.AST

Methods

fromString :: String -> RonnContent

data RonnDefinition

Constructors

RonnDefinition

Fields

• name :: RonnPart
• description :: RonnLine

  A line of nested description is required

• content :: Maybe [RonnContent]

  More content can be optionally nested

data RonnGroup

Constructors

RonnTitle ManRef [RonnPart]

RonnHeader Text

RonnLines [RonnLine]

Instances

IsString RonnGroup

Defined in Ronn.AST

Methods

fromString :: String -> RonnGroup

newtype RonnLine

Constructors

RonnLine

Fields

• unwrap :: [RonnPart]

Instances

IsString RonnLine

Defined in Ronn.AST

Methods

fromString :: String -> RonnLine

data RonnPart

Constructors

RonnConcat [RonnPart]

RonnConcat joins RonnParts without automaticaly inserting a space

The following expressions are equivalent:

• ronnLineToText $ RonnLine [p1, p2]

• ronnLineToText $ RonnLine [RonnConcat [p1, " ", p2]]

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

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

RonnCode RonnPart

RonnUserInput RonnPart

RonnStrong RonnPart

RonnVariable RonnPart

RonnEphasis RonnPart

RonnBrackets RonnPart

RonnParens RonnPart

RonnRef ManRef

RonnRaw Text

Instances

IsString RonnPart

Defined in Ronn.AST

Methods

fromString :: String -> RonnPart

Monoid RonnPart

Defined in Ronn.AST

Methods

mempty :: RonnPart

mappend :: RonnPart -> RonnPart -> RonnPart

mconcat :: [RonnPart] -> RonnPart

Semigroup RonnPart

Defined in Ronn.AST

Methods

(<>) :: RonnPart -> RonnPart -> RonnPart

sconcat :: NonEmpty RonnPart -> RonnPart

stimes :: Integral b => b -> RonnPart -> RonnPart

References

data ManRef

Constructors

ManRef

Fields

• name :: Text
• section :: ManSection

newtype ManSection

Constructors

ManSection Int

manSectionNumber :: ManSection -> Int