Safe Haskell	None
Language	Haskell2010

Data.OrgMode.Doc

Synopsis

Documentation

data Node Source

An outline node in org-mode. For a node ** TODO Foo a bar :FOOBAR:

nDepth is 2
nPrefix is Just TODO
nTags is [FOOBAR]
nTopic is "Foo a bar", note the stripped whitespace on the front and back.
nChildren aren't determined by this line, but by the lines after.

Constructors

Node
Fields nDepth :: Int Number of stars on the left. nPrefix :: Maybe Prefix E.g., TODO or DONE. nTags :: [String] :TAGS:AT:END: nChildren :: [NodeChild] Everything hierarchially under the node. nTopic :: String Text of he header line, minus prefix and tags. nLine :: TextLine Literal text of the node header.

Instances

Eq Node
Show Node
TextLineSource Node

data Prefix Source

A keyword at the front of a node heading, like TODO or DONE.

Constructors

Prefix String

Instances

Eq Prefix
Show Prefix

data Drawer Source

Constructors

Drawer
Fields drName :: String :PROPERTIES: or another name. drProperties :: [(String, String)] Key-value pairs. drLines :: [TextLine] Literal text of the entire drawer.

Instances

Eq Drawer
Show Drawer

data OrgFileProperty Source

Properties within the org file. Examples include #+TITLE:

Constructors

OrgFileProperty
Fields fpName :: String fpValue :: String

Instances

Eq OrgFileProperty
Show OrgFileProperty
TextLineSource OrgFileProperty

data Babel Source

Currently underimplemented: stores the lines of the babel environment.

Constructors

Babel [TextLine]

Instances

Eq Babel
Show Babel

data Table Source

Currently underimplemented: stores the lines of the table.

Constructors

Table [TextLine]

Instances

Eq Table
Show Table

data OrgDoc Source

Full contents of an org file.

Constructors

OrgDoc
Fields odNodes :: [Node] odProperties :: [OrgFileProperty] odLines :: [TextLine]

Instances

Eq OrgDoc
Show OrgDoc
TextLineSource OrgDoc

data NodeChild Source

Children of top-level Org Nodes.

Constructors

ChildText TextLine	Regular text.
ChildDrawer Drawer
ChildNode Node	outline nodes of higher depth.
ChildBabel Babel
ChildTable Table

Instances

Eq NodeChild
Show NodeChild
TextLineSource NodeChild

updateNode :: (Node -> Maybe Node) -> Node -> Node Source

trim :: [Char] -> [Char] Source

makeNodeLine :: Node -> String Source