Ronn.AST

Contents

Description

Synopsis

Documentation

Constructors

Ronn
Fields name :: ManRef description :: [Part] sections :: [Section]

Constructors

Section
Fields name :: Text content :: [Content]

Instances details

Pretty Section Source #
Instance details Defined in Ronn.AST Methods pretty :: Section -> Doc ann # prettyList :: [Section] -> Doc ann #

Constructors

Instances details

IsString Content Source #
Instance details Defined in Ronn.AST Methods fromString :: String -> Content #
Pretty Content Source #
Instance details Defined in Ronn.AST Methods pretty :: Content -> Doc ann # prettyList :: [Content] -> Doc ann #

Constructors

Definition
Fields name :: Part description :: [Part] A line of nested description is required content :: Maybe [Content] More content can be optionally nested

Instances details

Pretty Definition Source #
Instance details Defined in Ronn.AST Methods pretty :: Definition -> Doc ann # prettyList :: [Definition] -> Doc ann #

Constructors

Concat [Part]	`Concat` joins `Part`s without automaticaly inserting a space `pretty [p1, p2]` (may be broken for reflow) `pretty [Concat [p1, " ", p2]]` (never broken) `(<>)` is implemented with `Concat` and should be preferred, to avoid unnecessary nesting.
Code Part
UserInput Part
Strong Part
Variable Part
Ephasis Part
Brackets Part
Parens Part
Ref ManRef
Raw Text

Instances details

IsString Part Source #
Instance details Defined in Ronn.AST Methods fromString :: String -> Part #
Monoid Part Source #
Instance details Defined in Ronn.AST Methods mempty :: Part # mappend :: Part -> Part -> Part # mconcat :: [Part] -> Part #
Semigroup Part Source #
Instance details Defined in Ronn.AST Methods (<>) :: Part -> Part -> Part # sconcat :: NonEmpty Part -> Part # stimes :: Integral b => b -> Part -> Part #
Pretty Part Source #
Instance details Defined in Ronn.AST Methods pretty :: Part -> Doc ann # prettyList :: [Part] -> Doc ann #

References

Constructors

ManRef
Fields name :: Text section :: ManSection

Instances details

Show ManRef Source #
Instance details Defined in Ronn.ManRef Methods showsPrec :: Int -> ManRef -> ShowS # show :: ManRef -> String # showList :: [ManRef] -> ShowS #
Eq ManRef Source #
Instance details Defined in Ronn.ManRef Methods (==) :: ManRef -> ManRef -> Bool # (/=) :: ManRef -> ManRef -> Bool #
Ord ManRef Source #
Instance details 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 #
Pretty ManRef Source #
Instance details Defined in Ronn.ManRef Methods pretty :: ManRef -> Doc ann # prettyList :: [ManRef] -> Doc ann #

Constructors

Instances details

Bounded ManSection Source #
Instance details Defined in Ronn.ManRef Methods minBound :: ManSection # maxBound :: ManSection #
Enum ManSection Source #
Instance details 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 Source #
Instance details Defined in Ronn.ManRef Methods showsPrec :: Int -> ManSection -> ShowS # show :: ManSection -> String # showList :: [ManSection] -> ShowS #
Eq ManSection Source #
Instance details Defined in Ronn.ManRef Methods (==) :: ManSection -> ManSection -> Bool # (/=) :: ManSection -> ManSection -> Bool #
Ord ManSection Source #
Instance details 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 #
Pretty ManSection Source #
Instance details Defined in Ronn.ManRef Methods pretty :: ManSection -> Doc ann # prettyList :: [ManSection] -> Doc ann #