Patat.Presentation

Documentation

data PresentationSettings

These are patat-specific settings. That is where they differ from more general metadata (author, title...)

Constructors

PresentationSettings

Fields

• psRows :: !(Maybe (FlexibleNum Int))
• psColumns :: !(Maybe (FlexibleNum Int))
• psMargins :: !(Maybe MarginSettings)
• psWrap :: !(Maybe Wrap)
• psTabStop :: !(Maybe (FlexibleNum Int))
• psTheme :: !(Maybe Theme)
• psIncrementalLists :: !(Maybe Bool)
• psAutoAdvanceDelay :: !(Maybe (FlexibleNum Int))
• psSlideLevel :: !(Maybe Int)
• psPandocExtensions :: !(Maybe ExtensionList)
• psImages :: !(Maybe ImageSettings)
• psBreadcrumbs :: !(Maybe Bool)
• psEval :: !(Maybe EvalSettingsMap)
• psSlideNumber :: !(Maybe Bool)
• psSyntaxDefinitions :: !(Maybe [FilePath])
• psSpeakerNotes :: !(Maybe SpeakerNotesSettings)
• psTransition :: !(Maybe TransitionSettings)

Instances

FromJSON PresentationSettings

Defined in Patat.Presentation.Settings

Methods

parseJSON :: Value -> Parser PresentationSettings

parseJSONList :: Value -> Parser [PresentationSettings]

omittedField :: Maybe PresentationSettings

Monoid PresentationSettings

Defined in Patat.Presentation.Settings

Methods

mempty :: PresentationSettings

mappend :: PresentationSettings -> PresentationSettings -> PresentationSettings

mconcat :: [PresentationSettings] -> PresentationSettings

Semigroup PresentationSettings

Defined in Patat.Presentation.Settings

Methods

(<>) :: PresentationSettings -> PresentationSettings -> PresentationSettings

sconcat :: NonEmpty PresentationSettings -> PresentationSettings

stimes :: Integral b => b -> PresentationSettings -> PresentationSettings

Show PresentationSettings

Defined in Patat.Presentation.Settings

Methods

showsPrec :: Int -> PresentationSettings -> ShowS

show :: PresentationSettings -> String

showList :: [PresentationSettings] -> ShowS

defaultPresentationSettings :: PresentationSettings

data Presentation

Constructors

Presentation

Fields

• pFilePath :: !FilePath
• pEncodingFallback :: !EncodingFallback
• pTitle :: ![Inline]
• pAuthor :: ![Inline]
• pSettings :: !PresentationSettings
• pSlides :: !(Seq Slide)
• pBreadcrumbs :: !(Seq Breadcrumbs)
• pSlideSettings :: !(Seq PresentationSettings)
• pTransitionGens :: !(Seq (Maybe TransitionGen))
• pActiveFragment :: !Index
• pSyntaxMap :: !SyntaxMap

readPresentation :: FilePath -> IO (Either String Presentation)

activeSpeakerNotes :: Presentation -> SpeakerNotes

data Size

Instances

Show Size

Defined in Patat.Size

Methods

showsPrec :: Int -> Size -> ShowS

show :: Size -> String

showList :: [Size] -> ShowS

getPresentationSize :: Presentation -> IO Size

data Display

Constructors

DisplayDoc Doc

DisplayImage FilePath

Instances

Show Display

Defined in Patat.Presentation.Display

Methods

showsPrec :: Int -> Display -> ShowS

show :: Display -> String

showList :: [Display] -> ShowS

displayPresentation :: Size -> Presentation -> Display

displayPresentationError :: Size -> Presentation -> String -> Doc

Displays an error in the place of the presentation. This is useful if we want to display an error but keep the presentation running.

dumpPresentation :: Presentation -> IO ()

data PresentationCommand

Constructors

Exit

Forward

Backward

SkipForward

SkipBackward

First

Last

Reload

Seek Int

UnknownCommand String

Instances

Show PresentationCommand

Defined in Patat.Presentation.Interactive

Methods

showsPrec :: Int -> PresentationCommand -> ShowS

show :: PresentationCommand -> String

showList :: [PresentationCommand] -> ShowS

Eq PresentationCommand

Defined in Patat.Presentation.Interactive

Methods

(==) :: PresentationCommand -> PresentationCommand -> Bool

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

readPresentationCommand :: Handle -> IO PresentationCommand

data UpdatedPresentation

Constructors

UpdatedPresentation !Presentation

ExitedPresentation

ErroredPresentation String

updatePresentation :: PresentationCommand -> Presentation -> IO UpdatedPresentation