Emanote.Model.Note

Documentation

data Note

Constructors

Note

Fields

• _noteRoute :: LMLRoute
• _noteDoc :: Pandoc
• _noteMeta :: Value
• _noteTitle :: Title
• _noteErrors :: [Text]

Instances

ToJSON Note

Defined in Emanote.Model.Note

Methods

toJSON :: Note -> Value

toEncoding :: Note -> Encoding

toJSONList :: [Note] -> Value

toEncodingList :: [Note] -> Encoding

Generic Note

Defined in Emanote.Model.Note

Associated Types

type Rep Note :: Type -> Type

Methods

from :: Note -> Rep Note x

to :: Rep Note x -> Note

Show Note

Defined in Emanote.Model.Note

Methods

showsPrec :: Int -> Note -> ShowS

show :: Note -> String

showList :: [Note] -> ShowS

Eq Note

Defined in Emanote.Model.Note

Methods

(==) :: Note -> Note -> Bool

(/=) :: Note -> Note -> Bool

Ord Note

Defined in Emanote.Model.Note

Methods

compare :: Note -> Note -> Ordering

(<) :: Note -> Note -> Bool

(<=) :: Note -> Note -> Bool

(>) :: Note -> Note -> Bool

(>=) :: Note -> Note -> Bool

max :: Note -> Note -> Note

min :: Note -> Note -> Note

Indexable NoteIxs Note

Defined in Emanote.Model.Note

Methods

indices :: IxList NoteIxs Note

type Rep Note

Defined in Emanote.Model.Note

type Rep Note = D1 ('MetaData "Note" "Emanote.Model.Note" "emanote-1.0.0.0-inplace" 'False) (C1 ('MetaCons "Note" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_noteRoute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LMLRoute) :*: S1 ('MetaSel ('Just "_noteDoc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Pandoc)) :*: (S1 ('MetaSel ('Just "_noteMeta") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value) :*: (S1 ('MetaSel ('Just "_noteTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Title) :*: S1 ('MetaSel ('Just "_noteErrors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])))))

newtype RAncestor

Constructors

RAncestor

Fields

• unRAncestor :: R 'Folder

Instances

ToJSON RAncestor

Defined in Emanote.Model.Note

Methods

toJSON :: RAncestor -> Value

toEncoding :: RAncestor -> Encoding

toJSONList :: [RAncestor] -> Value

toEncodingList :: [RAncestor] -> Encoding

Generic RAncestor

Defined in Emanote.Model.Note

Associated Types

type Rep RAncestor :: Type -> Type

Methods

from :: RAncestor -> Rep RAncestor x

to :: Rep RAncestor x -> RAncestor

Show RAncestor

Defined in Emanote.Model.Note

Methods

showsPrec :: Int -> RAncestor -> ShowS

show :: RAncestor -> String

showList :: [RAncestor] -> ShowS

Eq RAncestor

Defined in Emanote.Model.Note

Methods

(==) :: RAncestor -> RAncestor -> Bool

(/=) :: RAncestor -> RAncestor -> Bool

Ord RAncestor

Defined in Emanote.Model.Note

Methods

compare :: RAncestor -> RAncestor -> Ordering

(<) :: RAncestor -> RAncestor -> Bool

(<=) :: RAncestor -> RAncestor -> Bool

(>) :: RAncestor -> RAncestor -> Bool

(>=) :: RAncestor -> RAncestor -> Bool

max :: RAncestor -> RAncestor -> RAncestor

min :: RAncestor -> RAncestor -> RAncestor

Indexable NoteIxs Note

Defined in Emanote.Model.Note

Methods

indices :: IxList NoteIxs Note

type Rep RAncestor

Defined in Emanote.Model.Note

type Rep RAncestor = D1 ('MetaData "RAncestor" "Emanote.Model.Note" "emanote-1.0.0.0-inplace" 'True) (C1 ('MetaCons "RAncestor" 'PrefixI 'True) (S1 ('MetaSel ('Just "unRAncestor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (R 'Folder))))

type NoteIxs = '[LMLRoute, WikiLink, R 'Html, RAncestor, R 'Folder, Tag, NonEmpty Slug]

type IxNote = IxSet NoteIxs Note

noteSelfRefs :: Note -> NonEmpty WikiLink

All possible wiki-links that refer to this note.

noteAncestors :: Note -> [RAncestor]

noteParent :: Note -> Maybe (R 'Folder)

hasChildNotes :: R 'Folder -> IxNote -> Bool

noteTags :: Note -> [Tag]

noteSlug :: Note -> Maybe (NonEmpty Slug)

lookupMeta :: FromJSON a => NonEmpty Text -> Note -> Maybe a

queryNoteTitle :: LMLRoute -> Pandoc -> Value -> (Pandoc, Title)

noteHtmlRoute :: Note -> R 'Html

The HTML route intended by user for this note.

lookupNotesByHtmlRoute :: R 'Html -> IxNote -> [Note]

lookupNotesByRoute :: HasCallStack => LMLRoute -> IxNote -> Maybe Note

ancestorPlaceholderNote :: R 'Folder -> Note

cls :: Text -> Attr

missingNote :: R ext -> Text -> Note

oneOfLmlFilenames :: R ext -> Text

ambiguousNoteURL :: FilePath -> NonEmpty LMLRoute -> Note

mkEmptyNoteWith :: LMLRoute -> [Block] -> Note

mkNoteWith :: LMLRoute -> Pandoc -> Value -> [Text] -> Note

parseNote :: forall m. (MonadIO m, MonadLogger m) => FilePath -> LMLRoute -> FilePath -> Text -> m Note

parseNoteOrg :: MonadWriter [Text] m => Text -> m (Pandoc, Value)

parseNoteMarkdown :: (MonadIO m, MonadLogger m) => FilePath -> FilePath -> Text -> WriterT [Text] m (Pandoc, Value)

defaultFrontMatter :: Value

applyNoteMetaFilters :: Pandoc -> Value -> Value

noteTitle :: Lens' Note Title

noteRoute :: Lens' Note LMLRoute

noteMeta :: Lens' Note Value

noteErrors :: Lens' Note [Text]

noteDoc :: Lens' Note Pandoc