FPO.Dto.DocumentDto.TreeDto

data Edge a

Constructors

• Edge (Tree a)

Instances

• Functor Edge
• (DecodeJson a) => DecodeJson (Edge a)
• (EncodeJson a) => EncodeJson (Edge a)
• (Show a) => Show (Edge a)

newtype Meta

Metadata for a tree node. title is a html-escaped string that represents the title of the node. label is an optional html-escaped string that represents the label of the node (e.g. "§x", etc.). It can be Nothing if the node has no label.

Note: Altough the label and title are html-escaped strings, they should not contain any html tags except for <span> and </span>. Because there is no convenient way to insert raw html into Halogen rendering, we can drop these tags before rendering (using, e.g., getFullTitle). This isn't a perfect solution, but easier than other approaches. We could use FPO.UI.HTML.rawHtml, but this would not work for tooltips... TODO: This workaround causes a bug where some special characters are not rendered correctly, see issue #656.

Constructors

• Meta { label :: Maybe String, title :: Result (Maybe String) }

Instances

• DecodeJson Meta
• Show Meta

data Result a

Signals if a generated TOC title was parsed successfully or not.

Constructors

• Success a
• Error a

Instances

• (DecodeJson a) => DecodeJson (Result a)
• (Show a) => Show (Result a)

data RootTree a

Constructors

• Empty
• RootTree { children :: Array (Edge a), header :: TreeHeader }

Instances

• Functor RootTree
• (DecodeJson a) => DecodeJson (RootTree a)
• (EncodeJson a) => EncodeJson (RootTree a)
• (Show a) => Show (RootTree a)

data Tree a

Constructors

• Node { children :: Array (Edge a), header :: TreeHeader, meta :: Meta }
• Leaf { meta :: Meta, node :: a }

Instances

• Functor Tree
• (DecodeJson a) => DecodeJson (Tree a)
• (EncodeJson a) => EncodeJson (Tree a)
• (Show a) => Show (Tree a)

newtype TreeHeader

Constructors

• TreeHeader { headerKind :: String, headerType :: String, heading :: String }

Instances

• DecodeJson TreeHeader
• EncodeJson TreeHeader
• Show TreeHeader

errorMeta :: Meta

findRootTree :: forall a. (a -> Boolean) -> RootTree a -> Maybe a

findTitleRootTree :: forall a. (a -> Boolean) -> RootTree a -> Maybe String

firstLeafRootTree :: forall a. RootTree a -> Maybe a

getContent :: forall a. Result a -> a

getContentOr :: forall a. a -> Result (Maybe a) -> a

getEdgeTree :: forall a. Edge a -> Tree a

getFullTitle :: Meta -> String

Returns the full title of the node, including the label if it exists. Removes HTML tags.

getHeading :: TreeHeader -> String

modifyNodeRootTree :: forall a. (a -> Boolean) -> (a -> a) -> RootTree a -> RootTree a

replaceNodeRootTree :: forall a. (a -> Boolean) -> a -> RootTree a -> RootTree a

unspecifiedMeta :: Meta

updateHeading :: String -> TreeHeader -> TreeHeader

Updates the heading of a TreeHeader.