Module

Data.Text.Format.Org.Construct

Package: purescript-org-doc
Repository: shamansir/purescript-org-doc

#emptyDoc Source

emptyDoc :: OrgDoc

#f Source

f :: OrgDoc -> OrgFile

Create OrgFile with empty meta and given OrgDoc as its root

#f_ Source

f_ :: Array (OrgKeyword String) -> Array (OrgProperty String) -> OrgDoc -> OrgFile

Create OrgFile with given meta keywords and properties and given OrgDoc as its root

#ds Source

ds :: Array Section -> OrgDoc

create OrgDoc from given Sections without any preceding blocks

#ds1 Source

ds1 :: Section -> OrgDoc

create OrgDoc from one given Section without any preceding blocks

#db Source

db :: Array Block -> OrgDoc

create OrgDoc from given Blocks without any following sections

#db1 Source

db1 :: Block -> OrgDoc

create OrgDoc from one given Block without any following sections

#dbs Source

dbs :: Array Block -> Array Section -> OrgDoc

create OrgDoc from given Blocks and Sections

#blocks Source

blocks :: OrgDoc -> Array Block

Get all the zeroth blocks of given document

#sections Source

sections :: OrgDoc -> Array Section

Get all the sections of given document

#sectionsn Source

sectionsn :: OrgDoc -> Int

How many sections does this OrgDoc have

#blocksn Source

blocksn :: OrgDoc -> Int

How many blocks does this OrgDoc have

#meta_kw Source

meta_kw :: OrgKeyword String -> OrgFile -> OrgFile

Add meta keyword to the OrgFile as the last one

#meta_kw_ Source

meta_kw_ :: OrgKeyword String -> OrgFile -> OrgFile

Add meta keyword to the OrgFile as the first one

#meta_prop Source

meta_prop :: OrgProperty String -> OrgFile -> OrgFile

Add property to the OrgFile properties drawer as the last one

#meta_prop_ Source

meta_prop_ :: OrgProperty String -> OrgFile -> OrgFile

Add property to the OrgFile properties drawer as the first one

#ProgressStep Source

data ProgressStep

Constructors

Progress String

#FinishStep Source

data FinishStep

Constructors

Finish String

#todoSequence Source

todoSequence :: Array ProgressStep -> Array FinishStep -> OrgFile -> OrgFile

#quote Source

quote :: Array Words -> Block

#example Source

example :: Array Words -> Block

#code Source

code :: String -> Block

#code' Source

code' :: Array Words -> Block

#codeIn Source

codeIn :: String -> String -> Block

#codeIn' Source

codeIn' :: String -> Array Words -> Block

#bcomment Source

bcomment :: Array String -> Block

#verse Source

verse :: Array Words -> Block

#bcenter Source

bcenter :: Array Words -> Block

#bexport Source

bexport :: Array Words -> Block

#list Source

list :: ListType -> Array Item -> Block

#det_item Source

det_item :: DetachedListItem -> Block

#item Source

item :: Array Words -> Item

#item1 Source

item1 :: Words -> Item

#table Source

table :: Array TableRow -> Block

#tablef Source

tablef :: TableFormat -> Array TableRow -> Block

#tbreak Source

tbreak :: TableRow

#tbreak_c Source

tbreak_c :: TableCustomBreak -> TableRow

#tcol Source

tcol :: Array Words -> TableColumn

#tcol1 Source

tcol1 :: Words -> TableColumn

#tskip Source

tskip :: TableColumn

#trow Source

trow :: Array TableColumn -> TableRow

#qrow Source

qrow :: Array Words -> TableRow

#qrow' Source

qrow' :: Array String -> TableRow

#check Source

check :: Check -> Item -> Item

#count Source

count :: Int -> Item -> Item

#sub Source

sub :: ListType -> Array Item -> Item -> Item

#tagi Source

tagi :: String -> Item -> Item

#idrawer Source

idrawer :: String -> Array Words -> Item -> Item

#idrawer1 Source

idrawer1 :: String -> Words -> Item -> Item

#bdrawer Source

bdrawer :: String -> Array Words -> Block

#bdrawer1 Source

bdrawer1 :: String -> Words -> Block

#bdrawer' Source

bdrawer' :: Drawer -> Block

#para1 Source

para1 :: Words -> Block

Block of a paragraph with a single instance of Words

#br_blank Source

br_blank :: Block

Block only with a line break

#bold Source

bold :: MarkupKey

#italic Source

italic :: MarkupKey

#hilite Source

hilite :: MarkupKey

#under Source

under :: MarkupKey

#verbatim Source

verbatim :: MarkupKey

#icode Source

icode :: MarkupKey

#strike Source

strike :: MarkupKey

#both Source

both :: MarkupKey -> MarkupKey -> MarkupKey

#b Source

b :: String -> Words

#i Source

i :: String -> Words

#hl Source

hl :: String -> Words

#u Source

u :: String -> Words

#v Source

v :: String -> Words

#ic Source

ic :: String -> Words

#s Source

s :: String -> Words

#subs Source

subs :: String -> Words

#sups Source

sups :: String -> Words

#a Source

a :: String -> String -> Words

#a' Source

a' :: String -> Words

#to Source

to :: LinkTarget -> String -> Words

#ref Source

ref :: LinkTarget -> Words

#raw Source

raw :: LinkTarget -> Words

#rem Source

rem :: String -> LinkTarget

#loc Source

loc :: String -> LinkTarget

#head Source

head :: String -> LinkTarget

#irem Source

irem :: String -> ImageSource

#iloc Source

iloc :: String -> ImageSource

#img Source

img :: String -> Words

#img_ Source

img_ :: ImageSource -> Words

#imgRaw_ Source

imgRaw_ :: ImageSource -> Words

#text Source

text :: String -> Words

#br Source

br :: Words

#marked Source

marked :: MarkupKey -> String -> Words

#icomment Source

icomment :: String -> Words

#entity Source

entity :: String -> Words

#logbook_cont Source

logbook_cont :: Array Words -> LogBook -> LogBook

#logbook_item_cont Source

logbook_item_cont :: Array Words -> LogBookEntry -> LogBookEntry

#t Source

t :: Int -> Int -> Time

Create time from hours and minutes (exactly in this order) numbers with fallback to bottom of Enum for every invalid integer not in range

#t' Source

t' :: Int -> Int -> Int -> Time

Create time from hours and minutes and seconds (exactly in this order) numbers with fallback to bottom of Enum for every invalid integer not in range

#d Source

d :: Int -> Int -> Int -> Date

Create a canonical date from year, month and day (exactly in this order) numbers with fallback to bottom of Enum for every invalid integer not in range

#clock Source

clock :: Time -> Words

#clockB Source

clockB :: OrgDateTime -> OrgDateTime -> Int -> Int -> Block

#adate Source

adate :: Date -> OrgDateTime

active timestamp with given Date and no specific Time or repeat / delays

#idate Source

idate :: Date -> OrgDateTime

inactive timestamp with given Date and no specific Time or repeat / delays

#adatetime Source

adatetime :: Date -> Time -> OrgDateTime

active timestamp with given Date and given Time and no repeat / delays

#idatetime Source

idatetime :: Date -> Time -> OrgDateTime

inactive timestamp with given Date and given Time and no repeat / delays

#fromto Source

fromto :: Time -> Time -> OrgDateTime -> OrgDateTime

change Time of the timestamp to given range

#afromto Source

afromto :: Date -> Time -> Time -> OrgDateTime

active timestamp with given Date and given Time range and no repeat / delays

#ifromto Source

ifromto :: Date -> Time -> Time -> OrgDateTime

inactive timestamp with given Date and given Time range and no repeat / delays

#ch_rng Source

ch_rng :: (Maybe OrgTimeRange -> OrgTimeRange) -> OrgDateTime -> OrgDateTime

#sec Source

sec :: Int -> Array Words -> OrgDoc -> Section

Create Section of the level l with given array of Words as its heading and attach given OrgDoc to it

#sec1 Source

sec1 :: Int -> Words -> OrgDoc -> Section

Create Section of the level l with given Words as its heading and attach given OrgDoc to it

#sece Source

sece :: Int -> Array Words -> Section

Create empty Section (with empty OrgDoc in it) of the level l with given array of Words as its heading

#sece1 Source

sece1 :: Int -> Words -> Section

Create empty Section (with empty OrgDoc in it) of the level l with given Words as its heading

#ssec Source

ssec :: Int -> Array Words -> OrgDoc -> OrgDoc

Create OrgDoc with single Section only, of the level l with given array of Words as its heading

#ssec1 Source

ssec1 :: Int -> Words -> OrgDoc -> OrgDoc

Create OrgDoc with single Section only, of the level l with given Words as its heading

#sec_head Source

sec_head :: Array Words -> Section -> Section

Set heading of the Section

#sec_head' Source

sec_head' :: (NonEmptyArray Words -> NonEmptyArray Words) -> Section -> Section

Update heading of the Section

#sec_head1 Source

sec_head1 :: Words -> Section -> Section

Change heading of the Section

#sec_wdoc Source

sec_wdoc :: (OrgDoc -> OrgDoc) -> Section -> Section

Perform function over the OrgDoc inside the section

#set Source

set :: Todo -> Section -> Section

#priority Source

priority :: Priority -> Section -> Section

#low Source

low :: Section -> Section

#hi Source

hi :: Section -> Section

#tag Source

tag :: String -> Section -> Section

#untag Source

untag :: String -> Section -> Section

#level Source

level :: Int -> Section -> Section

#inc Source

inc :: Section -> Section

#dec Source

dec :: Section -> Section

#close Source

close :: OrgDateTime -> Section -> Section

#deadline Source

deadline :: OrgDateTime -> Section -> Section

#schedule Source

schedule :: OrgDateTime -> Section -> Section

#timestamp Source

timestamp :: OrgDateTime -> Section -> Section

#wprop Source

wprop :: OrgProperty String -> Section -> Section

#wprops Source

wprops :: Array (OrgProperty String) -> Section -> Section

#drawer Source

drawer :: String -> Array Words -> Section -> Section

#drawer1 Source

drawer1 :: String -> Words -> Section -> Section

#mk_drawer Source

mk_drawer :: String -> Array Words -> Drawer

#mk_drawer' Source

mk_drawer' :: String -> NonEmptyArray Words -> Drawer

#set_logbook Source

set_logbook :: LogBook -> Section -> Section

#drawer_add Source

drawer_add :: Array Words -> Drawer -> Drawer

Add words to the drawer

#logbook_add Source

logbook_add :: LogBookEntry -> LogBook -> LogBook

#sec_append_drawer Source

sec_append_drawer :: Drawer -> Section -> Section

Append drawer as the last one into the section

#note Source

note :: Array Words -> OrgDateTime -> LogBookEntry

#comment Source

comment :: Section -> Section

#diary Source

diary :: String -> Words

#diary_r Source

diary_r :: String -> OrgTimeRange -> Words

#at_r Source

at_r :: Time -> OrgTimeRange

create `Time`` range that starts at given time and never ends (it is the same as just stating a time)

#fromto_r Source

fromto_r :: Time -> Time -> OrgTimeRange

create `Time`` range that starts at given time and ends and given time

#repeat Source

repeat :: RepeaterMode -> Int -> Interval -> OrgDateTime -> OrgDateTime

#rwith Source

rwith :: Int -> Interval -> OrgDateTime -> OrgDateTime

#delay Source

delay :: DelayMode -> Int -> Interval -> OrgDateTime -> OrgDateTime

#fn Source

fn :: String -> Words

#fndef Source

fndef :: String -> String -> Words

#fndef' Source

fndef' :: String -> Words

#fn_ Source

fn_ :: String -> Array Words -> Block

#hr Source

hr :: Block

#fw Source

fw :: Array Words -> Block

#kw Source

kw :: String -> String -> OrgKeyword String

#kwopt Source

kwopt :: String -> String -> String -> OrgKeyword String

#with_kw Source

with_kw :: String -> String -> Block -> Block

#with_kws Source

with_kws :: Array (OrgKeyword String) -> Block -> Block

#lcomment Source

lcomment :: Array String -> Block

#At Source

data At :: (Type -> Type) -> Type -> Typedata At f a

AtBlock Block AtWords Words AtSection Section AtHeading Words AtProperty String String AtTag String String AtDrawer Drawer AtPriority Priority AtPlanning -- TODO

Constructors

AtBlock Block
AtSection Section (f a)

#traverse Source

traverse :: forall b a (f :: Type -> Type). Unfoldable f => (f b -> f b -> f a) -> (At f a -> b) -> OrgDoc -> f a

#wdoc Source

wdoc :: (OrgDoc -> OrgDoc) -> OrgFile -> OrgFile

update OrgDoc inside the OrgFile with given function (there's only one root OrgDoc inside the file)

#cons_sec Source

cons_sec :: Section -> OrgDoc -> OrgDoc

add Section in front of other child sections in this OrgDoc

#snoc_sec Source

snoc_sec :: Section -> OrgDoc -> OrgDoc

add Section as the last of other child sections in this OrgDoc

#cons_bl Source

cons_bl :: Block -> OrgDoc -> OrgDoc

add Block in front of other child blocks in this OrgDoc in its zeroth section

#snoc_bl Source

snoc_bl :: Block -> OrgDoc -> OrgDoc

add Block as the last of other child blocks in this OrgDoc in its zeroth section

#last_bl_of Source

last_bl_of :: OrgDoc -> Maybe Block

#wlast_bl Source

wlast_bl :: (Block -> Block) -> OrgDoc -> OrgDoc

Perform function over the last Block of OrgDoc when it exists, or leave the document as it is

#wlast_bl' Source

wlast_bl' :: (Block -> Block) -> Block -> OrgDoc -> OrgDoc

Perform function over the last Block of OrgDoc when it exists, or else put given block as the first one

#wlast_sec Source

wlast_sec :: (Section -> Section) -> OrgDoc -> OrgDoc

Perform function over the last Section of OrgDoc when it exists, or leave the document as it is

#wlast_sec' Source

wlast_sec' :: (Section -> Section) -> Section -> OrgDoc -> OrgDoc

Perform function over the last Section of OrgDoc when it exists, or else put given section as the first one

#wlast_bl_rec Source

wlast_bl_rec :: (Block -> Block) -> OrgDoc -> OrgDoc

Recursively (going into sections, unlike wlast_bl and wlast_bl') find the last block and call given function with it; if OrgDoc is empty, do nothing

#append_bl Source

append_bl :: Block -> OrgFile -> OrgFile

Ensure to append given block to the current end of the root document of the file

#append_bl' Source

append_bl' :: Block -> OrgDoc -> OrgDoc

Ensure to append given block to the end of the given document

#append_bl_sec Source

append_bl_sec :: Block -> Section -> Section

#inject_words Source

inject_words :: Array Words -> Block -> Block

If Block can directly contain words (Of, Drawer, Footnote, DetachedItem, Paragraph, WithKeyword, FixedWidth, but neither List or LogBook or Table or HR or LComment or ClockB) add given words to the end of the block

#det_indent Source

det_indent :: String -> DetachedListItem -> DetachedListItem

#det_ltype Source

det_ltype :: ListType -> DetachedListItem -> DetachedListItem

#det_ch_ltype Source

det_ch_ltype :: (ListType -> ListType) -> DetachedListItem -> DetachedListItem

#det_check Source

det_check :: Check -> DetachedListItem -> DetachedListItem

#det_counter Source

det_counter :: Counter -> DetachedListItem -> DetachedListItem

#det_tag Source

det_tag :: String -> DetachedListItem -> DetachedListItem

#det_drawers Source

det_drawers :: Array Drawer -> DetachedListItem -> DetachedListItem

#det_add_text Source

det_add_text :: Array Words -> DetachedListItem -> DetachedListItem

#det_add_drawer Source

det_add_drawer :: Drawer -> DetachedListItem -> DetachedListItem

#isDocEmpty Source

isDocEmpty :: OrgDoc -> Boolean

#parseRepeaterMode Source

parseRepeaterMode :: String -> Maybe RepeaterMode

#parseDelayMode Source

parseDelayMode :: String -> Maybe DelayMode

#parseInterval Source

parseInterval :: String -> Maybe Interval

#parseDate Source

parseDate :: String -> Date

Parse date from yyyy-MM-dd string or init or fill it with zeroes on failure

#parseTime Source

parseTime :: String -> Time

Parse time from hh:mm or hh:mm:ss string or fill it with zeroes on failure

#__items Source

__items :: ListType -> Array Item -> ListItems

#__qset Source

__qset :: ({ check :: Maybe Check, comment :: Boolean, cookie :: Maybe Cookie, doc :: OrgDoc, drawers :: Array Drawer, heading :: NonEmptyArray Words, level :: Int, logbook :: Maybe LogBook, planning :: Planning, priority :: Maybe Priority, props :: OrgProperties String, tags :: Array String, todo :: Maybe Todo } -> { check :: Maybe Check, comment :: Boolean, cookie :: Maybe Cookie, doc :: OrgDoc, drawers :: Array Drawer, heading :: NonEmptyArray Words, level :: Int, logbook :: Maybe LogBook, planning :: Planning, priority :: Maybe Priority, props :: OrgProperties String, tags :: Array String, todo :: Maybe Todo }) -> Section -> Section

#__qplan Source

__qplan :: ({ closed :: Maybe OrgDateTime, deadline :: Maybe OrgDateTime, scheduled :: Maybe OrgDateTime, timestamp :: Maybe OrgDateTime } -> { closed :: Maybe OrgDateTime, deadline :: Maybe OrgDateTime, scheduled :: Maybe OrgDateTime, timestamp :: Maybe OrgDateTime }) -> Section -> Section

#__neaf Source

__neaf :: forall (a875 :: Type). a875 -> Array a875 -> NonEmptyArray a875

#__neafws Source

__neafws :: Array Words -> NonEmptyArray Words

Modules: Data.Text.Format.Org; Data.Text.Format.Org.Construct; Data.Text.Format.Org.Keyword; Data.Text.Format.Org.Parse.Ebnf; Data.Text.Format.Org.Path; Data.Text.Format.Org.Property; Data.Text.Format.Org.Render; Data.Text.Format.Org.Types; Yoga.Json.Extra

Data.Text.Format.Org.Construct

#empty Source

#emptyDoc Source

#f Source

#f_ Source

#ds Source

#ds1 Source

#db Source

#db1 Source

#dbs Source

#docf Source

#docs Source

#blocks Source

#sections Source

#sectionsn Source

#blocksn Source

#meta_kw Source

#meta_kw_ Source

#meta_prop Source

#meta_prop_ Source

#ProgressStep Source

Constructors

#FinishStep Source

Constructors

#todoSequence Source

#quote Source

#example Source

#code Source

#code' Source

#codeIn Source

#codeIn' Source

#bcomment Source

#verse Source

#bcenter Source

#bexport Source

#list Source

#det_item Source

#item Source

#item1 Source

#table Source

#tablef Source

#tbreak Source

#tbreak_c Source

#tcol Source

#tcol1 Source

#tskip Source

#trow Source

#qrow Source

#qrow' Source

#check Source

#count Source

#sub Source

#tagi Source

#idrawer Source

#idrawer1 Source

#bdrawer Source

#bdrawer1 Source

#bdrawer' Source

#joinB Source

#para Source

#para1 Source

#blank Source

#br_blank Source

#bold Source

#italic Source

#hilite Source

#under Source

#verbatim Source

#icode Source

#strike Source

#both Source

#b Source

#i Source

#hl Source

#u Source

#v Source

#ic Source

#s Source

#subs Source

#sups Source