Copyright	© 2019 Albert Krewinkel
License	MIT
Maintainer	Albert Krewinkel <tarleb@zeitkraut.de>
Stability	alpha
Portability	portable
Safe Haskell	Safe
Language	Haskell2010

Text.Jira.Markup

Description

Jira markup types.

Synopsis

data Block
- = Code Language [Parameter] Text
- | BlockQuote [Block]
- | Header Int [Inline]
- | List ListStyle [[Block]]
- | NoFormat [Parameter] Text
- | Panel [Parameter] [Block]
- | Para [Inline]
- | Table [Row]
data Inline
- = Anchor Text
- | Deleted [Inline]
- | Emph [Inline]
- | Entity Text
- | Image URL
- | Inserted [Inline]
- | Linebreak
- | Link [Inline] URL
- | Monospaced [Inline]
- | Str Text
- | Space
- | Strong [Inline]
- | Subscript [Inline]
- | Superscript [Inline]
data ListStyle
- = CircleBullets
- | SquareBullets
- | Enumeration
newtype URL = URL {
- fromURL :: Text
}
newtype Row = Row {
- fromRow :: [Cell]
}
data Cell
- = BodyCell [Block]
- | HeaderCell [Block]
newtype Language = Language Text
data Parameter = Parameter {
- parameterKey :: Text
- parameterValue :: Text
}
normalizeInlines :: [Inline] -> [Inline]

Documentation

data Block Source #

Blocks of text.

Constructors

Code Language [Parameter] Text	Code block with panel parameters
BlockQuote [Block]	Block of quoted content
Header Int [Inline]	Header with level and text
List ListStyle [[Block]]	List
NoFormat [Parameter] Text	Unformatted text
Panel [Parameter] [Block]	Formatted panel
Para [Inline]	Paragraph of text
Table [Row]	Table

Instances

Eq Block Source #
Instance details Defined in Text.Jira.Markup Methods (==) :: Block -> Block -> Bool # (/=) :: Block -> Block -> Bool #
Ord Block Source #
Instance details Defined in Text.Jira.Markup Methods compare :: Block -> Block -> Ordering # (<) :: Block -> Block -> Bool # (<=) :: Block -> Block -> Bool # (>) :: Block -> Block -> Bool # (>=) :: Block -> Block -> Bool # max :: Block -> Block -> Block # min :: Block -> Block -> Block #
Show Block Source #
Instance details Defined in Text.Jira.Markup Methods showsPrec :: Int -> Block -> ShowS # show :: Block -> String # showList :: [Block] -> ShowS #

data Inline Source #

Inline Jira markup elements.

Constructors

Anchor Text	anchor for internal links
Deleted [Inline]	deleted (struk-out) text
Emph [Inline]	emphasized text
Entity Text	named or numeric HTML entity
Image URL	an image
Inserted [Inline]	text marked as having been inserted
Linebreak	hard linebreak
Link [Inline] URL	hyperlink with alias
Monospaced [Inline]	text rendered with monospaced font
Str Text	simple, markup-less string
Space	space between words
Strong [Inline]	strongly emphasized text
Subscript [Inline]	subscript text
Superscript [Inline]	superscript text

Instances

Eq Inline Source #
Instance details Defined in Text.Jira.Markup Methods (==) :: Inline -> Inline -> Bool # (/=) :: Inline -> Inline -> Bool #
Ord Inline Source #
Instance details Defined in Text.Jira.Markup Methods compare :: Inline -> Inline -> Ordering # (<) :: Inline -> Inline -> Bool # (<=) :: Inline -> Inline -> Bool # (>) :: Inline -> Inline -> Bool # (>=) :: Inline -> Inline -> Bool # max :: Inline -> Inline -> Inline # min :: Inline -> Inline -> Inline #
Show Inline Source #
Instance details Defined in Text.Jira.Markup Methods showsPrec :: Int -> Inline -> ShowS # show :: Inline -> String # showList :: [Inline] -> ShowS #

data ListStyle Source #

Style used for list items.

Constructors

CircleBullets	List with round bullets
SquareBullets	List with square bullets
Enumeration	Enumeration, i.e., numbered items

Instances

Eq ListStyle Source #
Instance details Defined in Text.Jira.Markup Methods (==) :: ListStyle -> ListStyle -> Bool # (/=) :: ListStyle -> ListStyle -> Bool #
Ord ListStyle Source #
Instance details Defined in Text.Jira.Markup Methods compare :: ListStyle -> ListStyle -> Ordering # (<) :: ListStyle -> ListStyle -> Bool # (<=) :: ListStyle -> ListStyle -> Bool # (>) :: ListStyle -> ListStyle -> Bool # (>=) :: ListStyle -> ListStyle -> Bool # max :: ListStyle -> ListStyle -> ListStyle # min :: ListStyle -> ListStyle -> ListStyle #
Show ListStyle Source #
Instance details Defined in Text.Jira.Markup Methods showsPrec :: Int -> ListStyle -> ShowS # show :: ListStyle -> String # showList :: [ListStyle] -> ShowS #

newtype URL Source #

Unified resource location

Constructors

URL
Fields fromURL :: Text

Instances

Eq URL Source #
Instance details Defined in Text.Jira.Markup Methods (==) :: URL -> URL -> Bool # (/=) :: URL -> URL -> Bool #
Ord URL Source #
Instance details Defined in Text.Jira.Markup Methods compare :: URL -> URL -> Ordering # (<) :: URL -> URL -> Bool # (<=) :: URL -> URL -> Bool # (>) :: URL -> URL -> Bool # (>=) :: URL -> URL -> Bool # max :: URL -> URL -> URL # min :: URL -> URL -> URL #
Show URL Source #
Instance details Defined in Text.Jira.Markup Methods showsPrec :: Int -> URL -> ShowS # show :: URL -> String # showList :: [URL] -> ShowS #

newtype Row Source #

Table row, containing an arbitrary number of cells.

Constructors

Row
Fields fromRow :: [Cell]

Instances

Eq Row Source #
Instance details Defined in Text.Jira.Markup Methods (==) :: Row -> Row -> Bool # (/=) :: Row -> Row -> Bool #
Ord Row Source #
Instance details Defined in Text.Jira.Markup Methods compare :: Row -> Row -> Ordering # (<) :: Row -> Row -> Bool # (<=) :: Row -> Row -> Bool # (>) :: Row -> Row -> Bool # (>=) :: Row -> Row -> Bool # max :: Row -> Row -> Row # min :: Row -> Row -> Row #
Show Row Source #
Instance details Defined in Text.Jira.Markup Methods showsPrec :: Int -> Row -> ShowS # show :: Row -> String # showList :: [Row] -> ShowS #

data Cell Source #

Table cell with block content

Constructors

BodyCell [Block]
HeaderCell [Block]

Instances

Eq Cell Source #
Instance details Defined in Text.Jira.Markup Methods (==) :: Cell -> Cell -> Bool # (/=) :: Cell -> Cell -> Bool #
Ord Cell Source #
Instance details Defined in Text.Jira.Markup Methods compare :: Cell -> Cell -> Ordering # (<) :: Cell -> Cell -> Bool # (<=) :: Cell -> Cell -> Bool # (>) :: Cell -> Cell -> Bool # (>=) :: Cell -> Cell -> Bool # max :: Cell -> Cell -> Cell # min :: Cell -> Cell -> Cell #
Show Cell Source #
Instance details Defined in Text.Jira.Markup Methods showsPrec :: Int -> Cell -> ShowS # show :: Cell -> String # showList :: [Cell] -> ShowS #

newtype Language Source #

Programming language used for syntax highlighting.

Constructors

Language Text

Instances

Eq Language Source #
Instance details Defined in Text.Jira.Markup Methods (==) :: Language -> Language -> Bool # (/=) :: Language -> Language -> Bool #
Ord Language Source #
Instance details Defined in Text.Jira.Markup Methods compare :: Language -> Language -> Ordering # (<) :: Language -> Language -> Bool # (<=) :: Language -> Language -> Bool # (>) :: Language -> Language -> Bool # (>=) :: Language -> Language -> Bool # max :: Language -> Language -> Language # min :: Language -> Language -> Language #
Show Language Source #
Instance details Defined in Text.Jira.Markup Methods showsPrec :: Int -> Language -> ShowS # show :: Language -> String # showList :: [Language] -> ShowS #

data Parameter Source #

Panel parameter

Constructors

Parameter
Fields parameterKey :: Text parameterValue :: Text

Instances

Eq Parameter Source #
Instance details Defined in Text.Jira.Markup Methods (==) :: Parameter -> Parameter -> Bool # (/=) :: Parameter -> Parameter -> Bool #
Ord Parameter Source #
Instance details Defined in Text.Jira.Markup Methods compare :: Parameter -> Parameter -> Ordering # (<) :: Parameter -> Parameter -> Bool # (<=) :: Parameter -> Parameter -> Bool # (>) :: Parameter -> Parameter -> Bool # (>=) :: Parameter -> Parameter -> Bool # max :: Parameter -> Parameter -> Parameter # min :: Parameter -> Parameter -> Parameter #
Show Parameter Source #
Instance details Defined in Text.Jira.Markup Methods showsPrec :: Int -> Parameter -> ShowS # show :: Parameter -> String # showList :: [Parameter] -> ShowS #

normalizeInlines :: [Inline] -> [Inline] Source #

Normalize a list of inlines, merging elements where possible.