Safe Haskell	None
Language	GHC2024

Drasil.Data.Formats.HTML

Synopsis

data HTMLBody
- = Div [Attr] [HTMLBody]
- | Paragraph [Attr] [HTMLBody]
- | TextFormat Format [Attr] [HTMLBody]
- | Heading HLevel [Attr] [HTMLBody]
- | List ListType [Attr] [LItem]
- | Section [Attr] [HTMLBody]
- | Table [Attr] [Row]
- | DescriptionList [Attr] [DItem]
- | Anchor URL [Attr] [HTMLBody]
- | Figure [Attr] [HTMLBody]
- | FigCaption [Attr] [HTMLBody]
- | Img File Text [Attr]
- | RawText Text
- | Custom CustomTag [Attr] [HTMLBody]
- | Comment Text
data TagType
- = Standard
- | Void
span :: [Attr] -> Text -> HTMLBody
data Format
- = Bold
- | Emphasis
- | Subscript
- | Superscript
- | Span
data HTMLHead
- = Script [Attr] Text
- | Title Text
- | Meta [Attr]
- | Link Relation File [Attr]
span_ :: [Attr] -> [HTMLBody] -> HTMLBody
data HTML = HTML [HTMLHead] [HTMLBody]
newtype CustomTag = CT Text
data Attr = Attr Text Text
data HLevel
- = H1
- | H2
- | H3
- | H4
- | H5
- | H6
data Row = Row [Attr] [Cell]
data Cell
- = THeader [Attr] [HTMLBody]
- | TData [Attr] [HTMLBody]
data LItem = LItem [Attr] [HTMLBody]
data DItem
- = DTerm [Attr] [HTMLBody]
- | DDetails [Attr] [HTMLBody]
data ListType
- = Ordered
- | Unordered
attr :: Text -> Text -> Attr
id_ :: Text -> Attr
class_ :: [Text] -> Attr
rawText :: Text -> HTMLBody
rawText' :: String -> HTMLBody
customTag :: Text -> CustomTag
bold :: [Attr] -> Text -> HTMLBody
bold_ :: [HTMLBody] -> HTMLBody
emphasis :: [Attr] -> Text -> HTMLBody
emphasis_ :: [HTMLBody] -> HTMLBody
subscript :: [Attr] -> Text -> HTMLBody
subscript_ :: [HTMLBody] -> HTMLBody
superscript :: [Attr] -> Text -> HTMLBody
superscript_ :: [HTMLBody] -> HTMLBody
toHLevel :: Int -> HLevel
figureImage :: [Attr] -> [Attr] -> File -> Text -> Text -> HTMLBody
inlineScript :: Text -> HTMLHead
externalScript :: File -> [Attr] -> HTMLHead
stylesheet :: Text -> HTMLHead
renderHTML :: HTMLRenderOptions -> HTML -> Doc ann
data HTMLRenderOptions = HTMLRO {
- customElementTagTypes :: Map CustomTag TagType
- indentationSize :: Int
}
defaultHTMLRO :: HTMLRenderOptions

Documentation

data HTMLBody Source #

Body elements

Constructors

Div [Attr] [HTMLBody]
Paragraph [Attr] [HTMLBody]
TextFormat Format [Attr] [HTMLBody]
Heading HLevel [Attr] [HTMLBody]
List ListType [Attr] [LItem]
Section [Attr] [HTMLBody]
Table [Attr] [Row]
DescriptionList [Attr] [DItem]
Anchor URL [Attr] [HTMLBody]
Figure [Attr] [HTMLBody]
FigCaption [Attr] [HTMLBody]
Img File Text [Attr]
RawText Text
Custom CustomTag [Attr] [HTMLBody]
Comment Text

Instances

Instances details

IsString HTMLBody Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods fromString :: String -> HTMLBody #
Show HTMLBody Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods showsPrec :: Int -> HTMLBody -> ShowS # show :: HTMLBody -> String # showList :: [HTMLBody] -> ShowS #
Eq HTMLBody Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods (==) :: HTMLBody -> HTMLBody -> Bool # (/=) :: HTMLBody -> HTMLBody -> Bool #

data TagType Source #

Constructors

Standard
Void

Instances

Instances details

Show TagType Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods showsPrec :: Int -> TagType -> ShowS # show :: TagType -> String # showList :: [TagType] -> ShowS #
Eq TagType Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods (==) :: TagType -> TagType -> Bool # (/=) :: TagType -> TagType -> Bool #

span :: [Attr] -> Text -> HTMLBody Source #

Smart constructors for formatting text.

data Format Source #

Text format

Constructors

Bold
Emphasis
Subscript
Superscript
Span

Instances

Instances details

Show Format Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods showsPrec :: Int -> Format -> ShowS # show :: Format -> String # showList :: [Format] -> ShowS #
Eq Format Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods (==) :: Format -> Format -> Bool # (/=) :: Format -> Format -> Bool #

data HTMLHead Source #

Head elements

Constructors

Script [Attr] Text
Title Text
Meta [Attr]
Link Relation File [Attr]

Instances

Instances details

Show HTMLHead Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods showsPrec :: Int -> HTMLHead -> ShowS # show :: HTMLHead -> String # showList :: [HTMLHead] -> ShowS #
Eq HTMLHead Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods (==) :: HTMLHead -> HTMLHead -> Bool # (/=) :: HTMLHead -> HTMLHead -> Bool #

span_ :: [Attr] -> [HTMLBody] -> HTMLBody Source #

Smart constructors for span elements.

data HTML Source #

Constructors

HTML [HTMLHead] [HTMLBody]

Instances

Instances details

Show HTML Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods showsPrec :: Int -> HTML -> ShowS # show :: HTML -> String # showList :: [HTML] -> ShowS #
Eq HTML Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods (==) :: HTML -> HTML -> Bool # (/=) :: HTML -> HTML -> Bool #

newtype CustomTag Source #

A CustomTag is either (a) an ill-supported HTML-spec. node (ill-supported by HTMLBody, that is) or (b) a purely custom one.

Constructors

CT Text

Instances

Instances details

Show CustomTag Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods showsPrec :: Int -> CustomTag -> ShowS # show :: CustomTag -> String # showList :: [CustomTag] -> ShowS #
Eq CustomTag Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods (==) :: CustomTag -> CustomTag -> Bool # (/=) :: CustomTag -> CustomTag -> Bool #
Ord CustomTag Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods compare :: CustomTag -> CustomTag -> Ordering # (<) :: CustomTag -> CustomTag -> Bool # (<=) :: CustomTag -> CustomTag -> Bool # (>) :: CustomTag -> CustomTag -> Bool # (>=) :: CustomTag -> CustomTag -> Bool # max :: CustomTag -> CustomTag -> CustomTag # min :: CustomTag -> CustomTag -> CustomTag #

data Attr Source #

HTML Attrs for tags in the format key="value"

Constructors

Attr
Fields Text Key Text Value

Instances

Instances details

Show Attr Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods showsPrec :: Int -> Attr -> ShowS # show :: Attr -> String # showList :: [Attr] -> ShowS #
Eq Attr Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods (==) :: Attr -> Attr -> Bool # (/=) :: Attr -> Attr -> Bool #

data HLevel Source #

Heading level

Constructors

H1
H2
H3
H4
H5
H6

Instances

Instances details

Bounded HLevel Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods minBound :: HLevel # maxBound :: HLevel #
Enum HLevel Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods succ :: HLevel -> HLevel # pred :: HLevel -> HLevel # toEnum :: Int -> HLevel # fromEnum :: HLevel -> Int # enumFrom :: HLevel -> [HLevel] # enumFromThen :: HLevel -> HLevel -> [HLevel] # enumFromTo :: HLevel -> HLevel -> [HLevel] # enumFromThenTo :: HLevel -> HLevel -> HLevel -> [HLevel] #
Show HLevel Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods showsPrec :: Int -> HLevel -> ShowS # show :: HLevel -> String # showList :: [HLevel] -> ShowS #
Eq HLevel Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods (==) :: HLevel -> HLevel -> Bool # (/=) :: HLevel -> HLevel -> Bool #

data Row Source #

Table structure

Constructors

Row [Attr] [Cell]

Instances

Instances details

Show Row Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods showsPrec :: Int -> Row -> ShowS # show :: Row -> String # showList :: [Row] -> ShowS #
Eq Row Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods (==) :: Row -> Row -> Bool # (/=) :: Row -> Row -> Bool #

data Cell Source #

Constructors

THeader [Attr] [HTMLBody]
TData [Attr] [HTMLBody]

Instances

Instances details

Show Cell Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods showsPrec :: Int -> Cell -> ShowS # show :: Cell -> String # showList :: [Cell] -> ShowS #
Eq Cell Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods (==) :: Cell -> Cell -> Bool # (/=) :: Cell -> Cell -> Bool #

data LItem Source #

Ordered/unordered list structure

Constructors

LItem [Attr] [HTMLBody]

Instances

Instances details

Show LItem Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods showsPrec :: Int -> LItem -> ShowS # show :: LItem -> String # showList :: [LItem] -> ShowS #
Eq LItem Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods (==) :: LItem -> LItem -> Bool # (/=) :: LItem -> LItem -> Bool #

data DItem Source #

Description list elements

Constructors

DTerm [Attr] [HTMLBody]
DDetails [Attr] [HTMLBody]

Instances

Instances details

Show DItem Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods showsPrec :: Int -> DItem -> ShowS # show :: DItem -> String # showList :: [DItem] -> ShowS #
Eq DItem Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods (==) :: DItem -> DItem -> Bool # (/=) :: DItem -> DItem -> Bool #

data ListType Source #

List type

Constructors

Ordered
Unordered

Instances

Instances details

Show ListType Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods showsPrec :: Int -> ListType -> ShowS # show :: ListType -> String # showList :: [ListType] -> ShowS #
Eq ListType Source #
Instance details Defined in Drasil.Data.Formats.HTML.Core Methods (==) :: ListType -> ListType -> Bool # (/=) :: ListType -> ListType -> Bool #

attr :: Text -> Text -> Attr Source #

Creates a generic HTML attribute from a key and value.

id_ :: Text -> Attr Source #

Creates an id attribute.

class_ :: [Text] -> Attr Source #

Creates a class attribute from a list of class names.

rawText :: Text -> HTMLBody Source #

Wraps Text into a RawText HTMLBody.

rawText' :: String -> HTMLBody Source #

Wraps a String into a RawText HTMLBody.

customTag :: Text -> CustomTag Source #

Tag names are used within element start tags and end tags to give the element’s name. HTML elements all have names that only use characters in the range 0–9, a–z, and A–Z.

bold :: [Attr] -> Text -> HTMLBody Source #

Smart constructors for formatting text.

bold_ :: [HTMLBody] -> HTMLBody Source #

Smart constructors for formatting HTML elements.

emphasis :: [Attr] -> Text -> HTMLBody Source #

Smart constructors for formatting text.

emphasis_ :: [HTMLBody] -> HTMLBody Source #

Smart constructors for formatting HTML elements.

subscript :: [Attr] -> Text -> HTMLBody Source #

Smart constructors for formatting text.

subscript_ :: [HTMLBody] -> HTMLBody Source #

Smart constructors for formatting HTML elements.

superscript :: [Attr] -> Text -> HTMLBody Source #

Smart constructors for formatting text.

superscript_ :: [HTMLBody] -> HTMLBody Source #

Smart constructors for formatting HTML elements.

toHLevel :: Int -> HLevel Source #

Converts a 0-indexed integer to a heading level (capped at H6).

figureImage :: [Attr] -> [Attr] -> File -> Text -> Text -> HTMLBody Source #

Creates a figure containing an image and a caption. The first list of attributes is applied to the figure; the second is applied to the image.

inlineScript :: Text -> HTMLHead Source #

Creates an inline script. Does not allow any attributes.

externalScript :: File -> [Attr] -> HTMLHead Source #

Creates an external script. Requires a source file/URL and allows optional attributes.

stylesheet :: Text -> HTMLHead Source #

Create the link to the CSS file.

renderHTML :: HTMLRenderOptions -> HTML -> Doc ann Source #

Render HTML to a Doc

data HTMLRenderOptions Source #

Constructors

HTMLRO
Fields customElementTagTypes :: Map CustomTag TagType What `TagType` is each `CustomTag`? indentationSize :: Int The number of spaces to use for each level of indentation.

defaultHTMLRO :: HTMLRenderOptions Source #

Default HTMLRenderOptions with standard indentation and no custom tags.