Text.Jira.Markup

Jira markup types.

Documentation

newtype Doc

Jira document

Constructors

Doc

Fields

• fromDoc :: [Block]

Instances

Eq Doc

Defined in Text.Jira.Markup

Methods

(==) :: Doc -> Doc -> Bool

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

Ord Doc

Defined in Text.Jira.Markup

Methods

compare :: Doc -> Doc -> Ordering

(<) :: Doc -> Doc -> Bool

(<=) :: Doc -> Doc -> Bool

(>) :: Doc -> Doc -> Bool

(>=) :: Doc -> Doc -> Bool

max :: Doc -> Doc -> Doc

min :: Doc -> Doc -> Doc

Show Doc

Defined in Text.Jira.Markup

Methods

showsPrec :: Int -> Doc -> ShowS

show :: Doc -> String

showList :: [Doc] -> ShowS

data Block

Blocks of text.

Constructors

Code Language [Parameter] Text

Code block with panel parameters

Color ColorName [Block]

text displayed in a specific color

BlockQuote [Block]

Block of quoted content

Header Int [Inline]

Header with level and text

HorizontalRule

horizontal ruler

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

Defined in Text.Jira.Markup

Methods

(==) :: Block -> Block -> Bool

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

Ord Block

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

Defined in Text.Jira.Markup

Methods

showsPrec :: Int -> Block -> ShowS

show :: Block -> String

showList :: [Block] -> ShowS

data Inline

Inline Jira markup elements.

Constructors

Anchor Text

anchor for internal links

AutoLink URL

URL which is also a link

ColorInline ColorName [Inline]

colored inline text

Emoji Icon

emoticon

Entity Text

named or numeric HTML entity

Image [Parameter] URL

an image

Linebreak

hard linebreak

Link [Inline] URL

hyperlink with alias

Monospaced [Inline]

text rendered with monospaced font

Space

space between words

SpecialChar Char

single char with special meaning

Str Text

simple, markup-less string

Styled InlineStyle [Inline]

styled text

Instances

Eq Inline

Defined in Text.Jira.Markup

Methods

(==) :: Inline -> Inline -> Bool

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

Ord Inline

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

Defined in Text.Jira.Markup

Methods

showsPrec :: Int -> Inline -> ShowS

show :: Inline -> String

showList :: [Inline] -> ShowS

data InlineStyle

Supported inline text effect styles.

Constructors

Emphasis

emphasized text

Insert

text marked as having been inserted

Strikeout

deleted (struk-out) text

Strong

strongly emphasized text

Subscript

subscript text

Superscript

superscript text

Instances

Eq InlineStyle

Defined in Text.Jira.Markup

Methods

(==) :: InlineStyle -> InlineStyle -> Bool

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

Ord InlineStyle

Defined in Text.Jira.Markup

Methods

compare :: InlineStyle -> InlineStyle -> Ordering

(<) :: InlineStyle -> InlineStyle -> Bool

(<=) :: InlineStyle -> InlineStyle -> Bool

(>) :: InlineStyle -> InlineStyle -> Bool

(>=) :: InlineStyle -> InlineStyle -> Bool

max :: InlineStyle -> InlineStyle -> InlineStyle

min :: InlineStyle -> InlineStyle -> InlineStyle

Show InlineStyle

Defined in Text.Jira.Markup

Methods

showsPrec :: Int -> InlineStyle -> ShowS

show :: InlineStyle -> String

showList :: [InlineStyle] -> ShowS

data ListStyle

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

Defined in Text.Jira.Markup

Methods

(==) :: ListStyle -> ListStyle -> Bool

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

Ord ListStyle

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

Defined in Text.Jira.Markup

Methods

showsPrec :: Int -> ListStyle -> ShowS

show :: ListStyle -> String

showList :: [ListStyle] -> ShowS

newtype URL

Unified resource location

Constructors

URL

Fields

• fromURL :: Text

Instances

Eq URL

Defined in Text.Jira.Markup

Methods

(==) :: URL -> URL -> Bool

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

Ord URL

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

Defined in Text.Jira.Markup

Methods

showsPrec :: Int -> URL -> ShowS

show :: URL -> String

showList :: [URL] -> ShowS

newtype ColorName

Text color

Constructors

ColorName Text

Instances

Eq ColorName

Defined in Text.Jira.Markup

Methods

(==) :: ColorName -> ColorName -> Bool

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

Ord ColorName

Defined in Text.Jira.Markup

Methods

compare :: ColorName -> ColorName -> Ordering

(<) :: ColorName -> ColorName -> Bool

(<=) :: ColorName -> ColorName -> Bool

(>) :: ColorName -> ColorName -> Bool

(>=) :: ColorName -> ColorName -> Bool

max :: ColorName -> ColorName -> ColorName

min :: ColorName -> ColorName -> ColorName

Show ColorName

Defined in Text.Jira.Markup

Methods

showsPrec :: Int -> ColorName -> ShowS

show :: ColorName -> String

showList :: [ColorName] -> ShowS

data Icon

Graphical emoticons

Constructors

IconSlightlySmiling

IconFrowning

IconTongue

IconSmiling

IconWinking

IconThumbsUp

IconThumbsDown

IconInfo

IconCheckmark

IconX

IconAttention

IconPlus

IconMinus

IconQuestionmark

IconOn

IconOff

IconStar

IconStarRed

IconStarGreen

IconStarBlue

IconStarYellow

IconFlag

IconFlagOff

Instances

Enum Icon

Defined in Text.Jira.Markup

Methods

succ :: Icon -> Icon

pred :: Icon -> Icon

toEnum :: Int -> Icon

fromEnum :: Icon -> Int

enumFrom :: Icon -> [Icon]

enumFromThen :: Icon -> Icon -> [Icon]

enumFromTo :: Icon -> Icon -> [Icon]

enumFromThenTo :: Icon -> Icon -> Icon -> [Icon]

Eq Icon

Defined in Text.Jira.Markup

Methods

(==) :: Icon -> Icon -> Bool

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

Ord Icon

Defined in Text.Jira.Markup

Methods

compare :: Icon -> Icon -> Ordering

(<) :: Icon -> Icon -> Bool

(<=) :: Icon -> Icon -> Bool

(>) :: Icon -> Icon -> Bool

(>=) :: Icon -> Icon -> Bool

max :: Icon -> Icon -> Icon

min :: Icon -> Icon -> Icon

Show Icon

Defined in Text.Jira.Markup

Methods

showsPrec :: Int -> Icon -> ShowS

show :: Icon -> String

showList :: [Icon] -> ShowS

newtype Row

Table row, containing an arbitrary number of cells.

Constructors

Row

Fields

• fromRow :: [Cell]

Instances

Eq Row

Defined in Text.Jira.Markup

Methods

(==) :: Row -> Row -> Bool

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

Ord Row

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

Defined in Text.Jira.Markup

Methods

showsPrec :: Int -> Row -> ShowS

show :: Row -> String

showList :: [Row] -> ShowS

data Cell

Table cell with block content

Constructors

BodyCell [Block]

HeaderCell [Block]

Instances

Eq Cell

Defined in Text.Jira.Markup

Methods

(==) :: Cell -> Cell -> Bool

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

Ord Cell

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

Defined in Text.Jira.Markup

Methods

showsPrec :: Int -> Cell -> ShowS

show :: Cell -> String

showList :: [Cell] -> ShowS

newtype Language

Programming language used for syntax highlighting.

Constructors

Language Text

Instances

Eq Language

Defined in Text.Jira.Markup

Methods

(==) :: Language -> Language -> Bool

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

Ord Language

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

Defined in Text.Jira.Markup

Methods

showsPrec :: Int -> Language -> ShowS

show :: Language -> String

showList :: [Language] -> ShowS

data Parameter

Panel parameter

Constructors

Parameter

Fields

• parameterKey :: Text
• parameterValue :: Text

Instances

Eq Parameter

Defined in Text.Jira.Markup

Methods

(==) :: Parameter -> Parameter -> Bool

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

Ord Parameter

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

Defined in Text.Jira.Markup

Methods

showsPrec :: Int -> Parameter -> ShowS

show :: Parameter -> String

showList :: [Parameter] -> ShowS

normalizeInlines :: [Inline] -> [Inline]

Normalize a list of inlines, merging elements where possible.

iconText :: Icon -> Text

Gets the characters used to represent an emoji.