jira-wiki-markup-1.1.0: Handle Jira wiki markup

Copyright© 2019–2020 Albert Krewinkel
LicenseMIT
MaintainerAlbert Krewinkel <tarleb@zeitkraut.de>
Stabilityalpha
Portabilityportable
Safe HaskellSafe
LanguageHaskell2010

Text.Jira.Markup

Description

Jira markup types.

Synopsis

Documentation

newtype Doc Source #

Jira document

Constructors

Doc 

Fields

Instances
Eq Doc Source # 
Instance details

Defined in Text.Jira.Markup

Methods

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

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

Ord Doc Source # 
Instance details

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 Source # 
Instance details

Defined in Text.Jira.Markup

Methods

showsPrec :: Int -> Doc -> ShowS #

show :: Doc -> String #

showList :: [Doc] -> ShowS #

data Block Source #

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 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

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 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

Show Inline Source # 
Instance details

Defined in Text.Jira.Markup

data InlineStyle Source #

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

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

newtype URL Source #

Unified resource location

Constructors

URL 

Fields

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 ColorName Source #

Text color

Constructors

ColorName Text 

data Icon Source #

Graphical emoticons

Instances
Enum Icon Source # 
Instance details

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 Source # 
Instance details

Defined in Text.Jira.Markup

Methods

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

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

Ord Icon Source # 
Instance details

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 Source # 
Instance details

Defined in Text.Jira.Markup

Methods

showsPrec :: Int -> Icon -> ShowS #

show :: Icon -> String #

showList :: [Icon] -> ShowS #

newtype Row Source #

Table row, containing an arbitrary number of cells.

Constructors

Row 

Fields

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

Ord Language Source # 
Instance details

Defined in Text.Jira.Markup

Show Language Source # 
Instance details

Defined in Text.Jira.Markup

data Parameter Source #

Panel parameter

Constructors

Parameter 

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

Normalize a list of inlines, merging elements where possible.

iconText :: Icon -> Text Source #

Gets the characters used to represent an emoji.