Presentation.Yeamer

Documentation

type Presentation = IPresentation IO ()

Running a presentation

yeamer :: Presentation -> IO ()

Run a Yesod/Warp web server that will allow the presentation to be viewed in a web browser, on port 14910. This is a shorthand for yeamer' def.

Primitives

staticContent :: Monoid r => Html -> IPresentation m r

tweakContent :: Sessionable r => (Html -> Html) -> IPresentation m r -> IPresentation m r

serverSide :: Sessionable a => m a -> IPresentation m a

Run a monadic action and use the result in the presentation. Note that the action may not be re-run even if it depends to other values chosen at another point in the presentation, so use with care.

Maths

($<>) :: (r ~ (), SymbolClass σ, SCConstraint σ LaTeX, Monad m) => CAS (Infix LaTeX) (Encapsulation LaTeX) (SymbolD σ LaTeX) -> IPresentation m r -> IPresentation m r infixr 6

Include a mathematical expression inline in the document.

maths :: (r ~ (), SymbolClass σ, SCConstraint σ LaTeX) => [[CAS (Infix LaTeX) (Encapsulation LaTeX) (SymbolD σ LaTeX)]] -> String -> IPresentation m r

Include a mathematical expression as a “display” in the document, typically used for equations.

Example:

    "The constant "<>π$<>" fulfills "
      <>maths [[ sin π⩵0 ]]"."
  

The maths expressions use TeX-my-maths syntax (Math.LaTeX.Prelude). Note that TeX-my-maths has different syntax flavours (e.g. 𝑎×𝑒◝γ vs. a * exp gamma). Both can be used with $<> and maths, but the downside is type ambiguity in expressions that include no symbols at all (e.g. single numbers), which can lead to Could not deduce ‘SymbolClass σ’ compiler errors. To avoid this problem, you can add local type signatures or use the Presentation.Yeamer.Maths.Unicode.MathLatin_RomanGreek module.

Media content

imageFromFile :: FilePath -> IPresentation IO ()

Display an image that lies on the server as any ordinary static file. This is a special case of useFile, wrapping the file in an img tag.

mediaFromFile :: FilePath -> IPresentation IO ()

More general form of imageFromFile. Takes a guess based on the file extension, as to whether the media is a standing image or a video. In the latter case, simple HTML5 controls are added.

imageFromFileSupplier

Arguments

:: String

File extension

-> (FilePath -> IO ())

File-writer function. This will be called every time a slide with the image is requested.

-> IPresentation IO ()

Display an image generated on-the-fly in the server. The image will be stored temporarily, in a content-indexed fashion.

Arbitrary file serving

useFile

Arguments

:: FilePath

File that should be served to the client

-> (Url -> Html)

How it should be used in the presentation

-> IPresentation IO ()

useFileSupplier

Arguments

:: String

File extension

-> (FilePath -> IO ())

Server-side file-providing action

-> (Url -> Html)

How to use the file client-side

-> IPresentation IO ()

Code / plaintext

verbatim

Arguments

:: QuasiQuoter

≈ Value -> IPresentation m ()

Include a piece of plaintext, preserving all formatting. To be used in an oxford bracket.

In practice, you probably want to use this for monospace plaintext, which should appear in a pre or textarea tag. Use the specialised quoters for that.

plaintext

Arguments

:: QuasiQuoter

≈ Value -> IPresentation m ()

A simple version of verbatim that gives the HTML wrapped in pre tags, so it will (by default) appear in a monospace font.

verbatimWithin

Arguments

:: Name

A function Html -> Html that should be used for presenting the (pre-escaped) plaintext.

-> QuasiQuoter

A specialised version of verbatim that will always use the wrapper.

Convenience wrapper to generate quasi-quoters that will wrap code in any suitable HTML environment.

Haskell values

class InteractiveShow a where

Minimal complete definition

Nothing

Methods

display :: a -> Presentation

displayOriented :: DisplayOrientation -> a -> Presentation

displayOriented :: (Generic a, GInteractiveShow (Rep a)) => DisplayOrientation -> a -> Presentation

displayList :: DisplayOrientation -> [a] -> Presentation

Instances

InteractiveShow Char

Defined in Presentation.Yeamer

Methods

display :: Char -> Presentation

displayOriented :: DisplayOrientation -> Char -> Presentation

displayList :: DisplayOrientation -> [Char] -> Presentation

InteractiveShow Double

Defined in Presentation.Yeamer

Methods

display :: Double -> Presentation

displayOriented :: DisplayOrientation -> Double -> Presentation

displayList :: DisplayOrientation -> [Double] -> Presentation

InteractiveShow Int

Defined in Presentation.Yeamer

Methods

display :: Int -> Presentation

displayOriented :: DisplayOrientation -> Int -> Presentation

displayList :: DisplayOrientation -> [Int] -> Presentation

InteractiveShow Int16

Defined in Presentation.Yeamer

Methods

display :: Int16 -> Presentation

displayOriented :: DisplayOrientation -> Int16 -> Presentation

displayList :: DisplayOrientation -> [Int16] -> Presentation

InteractiveShow Int32

Defined in Presentation.Yeamer

Methods

display :: Int32 -> Presentation

displayOriented :: DisplayOrientation -> Int32 -> Presentation

displayList :: DisplayOrientation -> [Int32] -> Presentation

InteractiveShow Int64

Defined in Presentation.Yeamer

Methods

display :: Int64 -> Presentation

displayOriented :: DisplayOrientation -> Int64 -> Presentation

displayList :: DisplayOrientation -> [Int64] -> Presentation

InteractiveShow a => InteractiveShow [a]

Defined in Presentation.Yeamer

Methods

display :: [a] -> Presentation

displayOriented :: DisplayOrientation -> [a] -> Presentation

displayList :: DisplayOrientation -> [[a]] -> Presentation

Interactive parameters

inputBox :: forall i m. (Inputtable i, FromJSON i) => i -> IPresentation m i

dropdownSelect :: forall a m. (a -> String) -> [a] -> Int -> IPresentation m a

feedback_ :: Sessionable a => (Maybe a -> IPresentation m a) -> IPresentation m ()

Structure / composition

addHeading :: Sessionable r => Html -> IPresentation m r -> IPresentation m r

(======) :: Sessionable r => Html -> IPresentation m r -> IPresentation m r infixr 6

Infix synonym of addHeading. Intended to be used in do blocks, for headings of presentation slides.

discardResult :: IPresentation m r -> IPresentation m ()

module Data.Monoid

(→│) :: Sessionable a => IPresentation m a -> IPresentation m b -> IPresentation m a infix 6

(↘──) :: Sessionable a => IPresentation m a -> IPresentation m b -> IPresentation m a infix 5

(│←) :: Sessionable b => IPresentation m a -> IPresentation m b -> IPresentation m b infix 6

(──↖) :: Sessionable b => IPresentation m a -> IPresentation m b -> IPresentation m b infix 5

(→│←) :: (Sessionable a, Sessionable b) => IPresentation m a -> IPresentation m b -> IPresentation m (a, b) infix 6

(↘──↖) :: (Sessionable a, Sessionable b) => IPresentation m a -> IPresentation m b -> IPresentation m (a, b) infix 5

(→│→) :: (Sessionable a, Monad m) => IPresentation m a -> (a -> IPresentation m ()) -> IPresentation m a infix 6

(↘──↘) :: (Sessionable a, Monad m) => IPresentation m a -> (a -> IPresentation m ()) -> IPresentation m a infix 5

CSS

divClass :: Sessionable r => Text -> IPresentation m r -> IPresentation m r

divClasses :: Sessionable r => [(Text, IPresentation m r)] -> IPresentation m r

spanClass :: Sessionable r => Text -> IPresentation m r -> IPresentation m r

(#%) :: Sessionable r => Text -> IPresentation m r -> IPresentation m r infix 8

Assign this content a CSS class attribute. If the content is inline, this will be a span, else a div.

styling :: Css -> IPresentation m r -> IPresentation m r

data Css

Instances

HasContentType Css

Defined in Yesod.Core.Content

Methods

getContentType :: Monad m => m Css -> ContentType

ToContent Css

Defined in Yesod.Core.Content

Methods

toContent :: Css -> Content

ToTypedContent Css

Defined in Yesod.Core.Content

Methods

toTypedContent :: Css -> TypedContent

ToWidget site Css

Defined in Yesod.Core.Widget

Methods

toWidget :: (MonadWidget m, HandlerSite m ~ site) => Css -> m ()

ToWidgetHead site Css

Defined in Yesod.Core.Widget

Methods

toWidgetHead :: (MonadWidget m, HandlerSite m ~ site) => Css -> m ()

ToWidgetMedia site Css

Defined in Yesod.Core.Widget

Methods

toWidgetMedia :: (MonadWidget m, HandlerSite m ~ site) => Text -> Css -> m ()

render ~ RY site => ToWidget site (render -> Css)

Defined in Yesod.Core.Widget

Methods

toWidget :: (MonadWidget m, HandlerSite m ~ site) => (render -> Css) -> m ()

render ~ RY site => ToWidgetHead site (render -> Css)

Defined in Yesod.Core.Widget

Methods

toWidgetHead :: (MonadWidget m, HandlerSite m ~ site) => (render -> Css) -> m ()

render ~ RY site => ToWidgetMedia site (render -> Css)

Defined in Yesod.Core.Widget

Methods

toWidgetMedia :: (MonadWidget m, HandlerSite m ~ site) => Text -> (render -> Css) -> m ()

Server configuration

yeamer' :: YeamerServerConfig -> Presentation -> IO ()

data YeamerServerConfig

Instances

Default YeamerServerConfig

Defined in Presentation.Yeamer

Methods

def :: YeamerServerConfig

Default port is 14910

yeamerTcpPort :: Lens' YeamerServerConfig Int

Internals

data IPresentation m r

Instances

SemigroupNo 0 (IPresentation m ())

Defined in Presentation.Yeamer

Methods

sappendN :: proxy 0 -> IPresentation m () -> IPresentation m () -> IPresentation m ()

sconcatN :: proxy 0 -> NonEmpty (IPresentation m ()) -> IPresentation m ()

stimesN :: (Integral b, HasCallStack) => proxy 0 -> b -> IPresentation m () -> IPresentation m ()

SemigroupNo 1 (IPresentation m ())

Defined in Presentation.Yeamer

Methods

sappendN :: proxy 1 -> IPresentation m () -> IPresentation m () -> IPresentation m ()

sconcatN :: proxy 1 -> NonEmpty (IPresentation m ()) -> IPresentation m ()

stimesN :: (Integral b, HasCallStack) => proxy 1 -> b -> IPresentation m () -> IPresentation m ()

Monad (IPresentation m)

Defined in Presentation.Yeamer

Methods

(>>=) :: IPresentation m a -> (a -> IPresentation m b) -> IPresentation m b

(>>) :: IPresentation m a -> IPresentation m b -> IPresentation m b

return :: a -> IPresentation m a

fail :: String -> IPresentation m a

Functor (IPresentation m)

Defined in Presentation.Yeamer

Methods

fmap :: (a -> b) -> IPresentation m a -> IPresentation m b

(<$) :: a -> IPresentation m b -> IPresentation m a

Applicative (IPresentation m)

Defined in Presentation.Yeamer

Methods

pure :: a -> IPresentation m a

(<*>) :: IPresentation m (a -> b) -> IPresentation m a -> IPresentation m b

liftA2 :: (a -> b -> c) -> IPresentation m a -> IPresentation m b -> IPresentation m c

(*>) :: IPresentation m a -> IPresentation m b -> IPresentation m b

(<*) :: IPresentation m a -> IPresentation m b -> IPresentation m a

r ~ () => IsString (IPresentation m r)

Defined in Presentation.Yeamer

Methods

fromString :: String -> IPresentation m r

(Monad m, Monoid r, Sessionable r) => Semigroup (IPresentation m r)

Defined in Presentation.Yeamer

Methods

(<>) :: IPresentation m r -> IPresentation m r -> IPresentation m r

sconcat :: NonEmpty (IPresentation m r) -> IPresentation m r

stimes :: Integral b => b -> IPresentation m r -> IPresentation m r

Monad m => Monoid (IPresentation m ())

Defined in Presentation.Yeamer

Methods

mempty :: IPresentation m ()

mappend :: IPresentation m () -> IPresentation m () -> IPresentation m ()

mconcat :: [IPresentation m ()] -> IPresentation m ()