Safe Haskell	None
Language	Haskell2010

Patat.Presentation.Internal

Synopsis

type Breadcrumbs = [(Int, [Inline])]
data Presentation = Presentation {
- 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
- pEvalBlocks :: !EvalBlocks
- pUniqueGen :: !UniqueGen
- pVars :: !(HashMap Var [Block])
}
data PresentationSettings = PresentationSettings {
- 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)
- psLinks :: !(Maybe LinkSettings)
}
defaultPresentationSettings :: PresentationSettings
data MarginSettings = MarginSettings {
- msTop :: !(Maybe (AutoOr (FlexibleNum Int)))
- msLeft :: !(Maybe (AutoOr (FlexibleNum Int)))
- msRight :: !(Maybe (AutoOr (FlexibleNum Int)))
}
data Margins = Margins {
- mTop :: AutoOr Int
- mLeft :: AutoOr Int
- mRight :: AutoOr Int
}
margins :: PresentationSettings -> Margins
newtype ExtensionList = ExtensionList {
- unExtensionList :: Extensions
}
defaultExtensionList :: ExtensionList
data ImageSettings = ImageSettings {
- isBackend :: !Text
- isParams :: !Object
}
newtype EvalSettingsMap = EvalSettingsMap (HashMap (CI Text) EvalSettings)
data EvalSettings = EvalSettings {
- evalCommand :: !Text
- evalReplace :: !Bool
- evalReveal :: !Bool
- evalContainer :: !EvalSettingsContainer
- evalStderr :: !Bool
- evalSyntax :: !(Maybe (CI Text))
}
data Slide = Slide {
- slideSpeakerNotes :: !SpeakerNotes
- slideSettings :: !(Either String PresentationSettings)
- slideContent :: !SlideContent
}
data SlideContent
- = ContentSlide [Block]
- | TitleSlide Int [Inline]
type Index = (Int, Int)
getSlide :: Int -> Presentation -> Maybe Slide
numFragments :: Slide -> Int
data ActiveFragment
- = ActiveContent [Block] (HashSet Var) RevealState
- | ActiveTitle Block
activeFragment :: Presentation -> Maybe ActiveFragment
activeSpeakerNotes :: Presentation -> SpeakerNotes
activeVars :: Presentation -> HashSet Var
getSettings :: Int -> Presentation -> PresentationSettings
activeSettings :: Presentation -> PresentationSettings
data Size
getPresentationSize :: Presentation -> IO Size
updateVar :: Var -> [Block] -> Presentation -> Presentation

Documentation

type Breadcrumbs = [(Int, [Inline])] Source #

data Presentation Source #

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
pEvalBlocks :: !EvalBlocks
pUniqueGen :: !UniqueGen
pVars :: !(HashMap Var [Block])

data PresentationSettings Source #

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)
psLinks :: !(Maybe LinkSettings)

Instances

Instances details

FromJSON PresentationSettings Source #
Instance details Defined in Patat.Presentation.Settings Methods parseJSON :: Value -> Parser PresentationSettings parseJSONList :: Value -> Parser [PresentationSettings] omittedField :: Maybe PresentationSettings
Monoid PresentationSettings Source #
Instance details Defined in Patat.Presentation.Settings Methods mempty :: PresentationSettings mappend :: PresentationSettings -> PresentationSettings -> PresentationSettings mconcat :: [PresentationSettings] -> PresentationSettings
Semigroup PresentationSettings Source #
Instance details Defined in Patat.Presentation.Settings Methods (<>) :: PresentationSettings -> PresentationSettings -> PresentationSettings sconcat :: NonEmpty PresentationSettings -> PresentationSettings stimes :: Integral b => b -> PresentationSettings -> PresentationSettings
Show PresentationSettings Source #
Instance details Defined in Patat.Presentation.Settings Methods showsPrec :: Int -> PresentationSettings -> ShowS show :: PresentationSettings -> String showList :: [PresentationSettings] -> ShowS
Eq PresentationSettings Source #
Instance details Defined in Patat.Presentation.Settings Methods (==) :: PresentationSettings -> PresentationSettings -> Bool (/=) :: PresentationSettings -> PresentationSettings -> Bool

defaultPresentationSettings :: PresentationSettings Source #

data MarginSettings Source #

Constructors

MarginSettings
Fields msTop :: !(Maybe (AutoOr (FlexibleNum Int))) msLeft :: !(Maybe (AutoOr (FlexibleNum Int))) msRight :: !(Maybe (AutoOr (FlexibleNum Int)))

Instances

Instances details

FromJSON MarginSettings Source #
Instance details Defined in Patat.Presentation.Settings Methods parseJSON :: Value -> Parser MarginSettings parseJSONList :: Value -> Parser [MarginSettings] omittedField :: Maybe MarginSettings
Monoid MarginSettings Source #
Instance details Defined in Patat.Presentation.Settings Methods mempty :: MarginSettings mappend :: MarginSettings -> MarginSettings -> MarginSettings mconcat :: [MarginSettings] -> MarginSettings
Semigroup MarginSettings Source #
Instance details Defined in Patat.Presentation.Settings Methods (<>) :: MarginSettings -> MarginSettings -> MarginSettings sconcat :: NonEmpty MarginSettings -> MarginSettings stimes :: Integral b => b -> MarginSettings -> MarginSettings
Show MarginSettings Source #
Instance details Defined in Patat.Presentation.Settings Methods showsPrec :: Int -> MarginSettings -> ShowS show :: MarginSettings -> String showList :: [MarginSettings] -> ShowS
Eq MarginSettings Source #
Instance details Defined in Patat.Presentation.Settings Methods (==) :: MarginSettings -> MarginSettings -> Bool (/=) :: MarginSettings -> MarginSettings -> Bool

data Margins Source #

Constructors

Margins
Fields mTop :: AutoOr Int mLeft :: AutoOr Int mRight :: AutoOr Int

Instances

Instances details

Show Margins Source #
Instance details Defined in Patat.Presentation.Internal Methods showsPrec :: Int -> Margins -> ShowS show :: Margins -> String showList :: [Margins] -> ShowS

margins :: PresentationSettings -> Margins Source #

newtype ExtensionList Source #

Constructors

ExtensionList
Fields unExtensionList :: Extensions

Instances

Instances details

FromJSON ExtensionList Source #
Instance details Defined in Patat.Presentation.Settings Methods parseJSON :: Value -> Parser ExtensionList parseJSONList :: Value -> Parser [ExtensionList] omittedField :: Maybe ExtensionList
Show ExtensionList Source #
Instance details Defined in Patat.Presentation.Settings Methods showsPrec :: Int -> ExtensionList -> ShowS show :: ExtensionList -> String showList :: [ExtensionList] -> ShowS
Eq ExtensionList Source #
Instance details Defined in Patat.Presentation.Settings Methods (==) :: ExtensionList -> ExtensionList -> Bool (/=) :: ExtensionList -> ExtensionList -> Bool

defaultExtensionList :: ExtensionList Source #

data ImageSettings Source #

Constructors

ImageSettings
Fields isBackend :: !Text isParams :: !Object

Instances

Instances details

FromJSON ImageSettings Source #
Instance details Defined in Patat.Presentation.Settings Methods parseJSON :: Value -> Parser ImageSettings parseJSONList :: Value -> Parser [ImageSettings] omittedField :: Maybe ImageSettings
Show ImageSettings Source #
Instance details Defined in Patat.Presentation.Settings Methods showsPrec :: Int -> ImageSettings -> ShowS show :: ImageSettings -> String showList :: [ImageSettings] -> ShowS
Eq ImageSettings Source #
Instance details Defined in Patat.Presentation.Settings Methods (==) :: ImageSettings -> ImageSettings -> Bool (/=) :: ImageSettings -> ImageSettings -> Bool

newtype EvalSettingsMap Source #

Constructors

EvalSettingsMap (HashMap (CI Text) EvalSettings)

Instances

Instances details

FromJSON EvalSettingsMap Source #
Instance details Defined in Patat.Presentation.Settings Methods parseJSON :: Value -> Parser EvalSettingsMap parseJSONList :: Value -> Parser [EvalSettingsMap] omittedField :: Maybe EvalSettingsMap
Semigroup EvalSettingsMap Source #
Instance details Defined in Patat.Presentation.Settings Methods (<>) :: EvalSettingsMap -> EvalSettingsMap -> EvalSettingsMap sconcat :: NonEmpty EvalSettingsMap -> EvalSettingsMap stimes :: Integral b => b -> EvalSettingsMap -> EvalSettingsMap
Show EvalSettingsMap Source #
Instance details Defined in Patat.Presentation.Settings Methods showsPrec :: Int -> EvalSettingsMap -> ShowS show :: EvalSettingsMap -> String showList :: [EvalSettingsMap] -> ShowS
Eq EvalSettingsMap Source #
Instance details Defined in Patat.Presentation.Settings Methods (==) :: EvalSettingsMap -> EvalSettingsMap -> Bool (/=) :: EvalSettingsMap -> EvalSettingsMap -> Bool

data EvalSettings Source #

Constructors

EvalSettings
Fields evalCommand :: !Text evalReplace :: !Bool evalReveal :: !Bool evalContainer :: !EvalSettingsContainer evalStderr :: !Bool evalSyntax :: !(Maybe (CI Text))

Instances

Instances details

FromJSON EvalSettings Source #
Instance details Defined in Patat.Presentation.Settings Methods parseJSON :: Value -> Parser EvalSettings parseJSONList :: Value -> Parser [EvalSettings] omittedField :: Maybe EvalSettings
Show EvalSettings Source #
Instance details Defined in Patat.Presentation.Settings Methods showsPrec :: Int -> EvalSettings -> ShowS show :: EvalSettings -> String showList :: [EvalSettings] -> ShowS
Eq EvalSettings Source #
Instance details Defined in Patat.Presentation.Settings Methods (==) :: EvalSettings -> EvalSettings -> Bool (/=) :: EvalSettings -> EvalSettings -> Bool

data Slide Source #

Constructors

Slide
Fields slideSpeakerNotes :: !SpeakerNotes slideSettings :: !(Either String PresentationSettings) slideContent :: !SlideContent

Instances

Instances details

Show Slide Source #
Instance details Defined in Patat.Presentation.Internal Methods showsPrec :: Int -> Slide -> ShowS show :: Slide -> String showList :: [Slide] -> ShowS

data SlideContent Source #

Constructors

ContentSlide [Block]
TitleSlide Int [Inline]

Instances

Instances details

Show SlideContent Source #
Instance details Defined in Patat.Presentation.Internal Methods showsPrec :: Int -> SlideContent -> ShowS show :: SlideContent -> String showList :: [SlideContent] -> ShowS

type Index = (Int, Int) Source #

Active slide, active fragment.

getSlide :: Int -> Presentation -> Maybe Slide Source #

numFragments :: Slide -> Int Source #

data ActiveFragment Source #

Constructors

ActiveContent [Block] (HashSet Var) RevealState
ActiveTitle Block

Instances

Instances details

Show ActiveFragment Source #
Instance details Defined in Patat.Presentation.Internal Methods showsPrec :: Int -> ActiveFragment -> ShowS show :: ActiveFragment -> String showList :: [ActiveFragment] -> ShowS

activeFragment :: Presentation -> Maybe ActiveFragment Source #

activeSpeakerNotes :: Presentation -> SpeakerNotes Source #

activeVars :: Presentation -> HashSet Var Source #

getSettings :: Int -> Presentation -> PresentationSettings Source #

activeSettings :: Presentation -> PresentationSettings Source #

data Size Source #

Instances

Instances details

Show Size Source #
Instance details Defined in Patat.Size Methods showsPrec :: Int -> Size -> ShowS show :: Size -> String showList :: [Size] -> ShowS

getPresentationSize :: Presentation -> IO Size Source #

updateVar :: Var -> [Block] -> Presentation -> Presentation Source #