jira-wiki-markup-1.4.0: Handle Jira wiki markup
Copyright© 2019–2021 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

Instances details
Eq Doc Source # 
Instance details

Defined in Text.Jira.Markup

Methods

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

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

Ord Doc Source # 
Instance details

Defined in Text.Jira.Markup

Methods

compare :: Doc -> Doc -> Ordering Source #

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

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

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

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

max :: Doc -> Doc -> Doc Source #

min :: Doc -> Doc -> Doc Source #

Show Doc Source # 
Instance details

Defined in Text.Jira.Markup

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

Instances details
Eq Block Source # 
Instance details

Defined in Text.Jira.Markup

Methods

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

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

Ord Block Source # 
Instance details

Defined in Text.Jira.Markup

Show Block Source # 
Instance details

Defined in Text.Jira.Markup

data Inline Source #

Inline Jira markup elements.

Constructors

Anchor Text

anchor for internal links

AutoLink URL

URL which is also a link

Citation [Inline]

source of a citation

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

Instances details
Eq Inline Source # 
Instance details

Defined in Text.Jira.Markup

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

Type of a link.

Constructors

Attachment

link to an attachment

Email

link to an email address

External

external resource, like a website

SmartCard

smart-card link (external)

SmartLink

"smart" link with icon, short-name

User

link to a user

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

Instances details
Eq URL Source # 
Instance details

Defined in Text.Jira.Markup

Methods

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

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

Ord URL Source # 
Instance details

Defined in Text.Jira.Markup

Methods

compare :: URL -> URL -> Ordering Source #

(<) :: URL -> URL -> Bool Source #

(<=) :: URL -> URL -> Bool Source #

(>) :: URL -> URL -> Bool Source #

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

max :: URL -> URL -> URL Source #

min :: URL -> URL -> URL Source #

Show URL Source # 
Instance details

Defined in Text.Jira.Markup

newtype Row Source #

Table row, containing an arbitrary number of cells.

Constructors

Row 

Fields

Instances

Instances details
Eq Row Source # 
Instance details

Defined in Text.Jira.Markup

Methods

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

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

Ord Row Source # 
Instance details

Defined in Text.Jira.Markup

Methods

compare :: Row -> Row -> Ordering Source #

(<) :: Row -> Row -> Bool Source #

(<=) :: Row -> Row -> Bool Source #

(>) :: Row -> Row -> Bool Source #

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

max :: Row -> Row -> Row Source #

min :: Row -> Row -> Row Source #

Show Row Source # 
Instance details

Defined in Text.Jira.Markup

data Cell Source #

Table cell with block content

Constructors

BodyCell [Block] 
HeaderCell [Block] 

Instances

Instances details
Eq Cell Source # 
Instance details

Defined in Text.Jira.Markup

Methods

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

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

Ord Cell Source # 
Instance details

Defined in Text.Jira.Markup

Show Cell Source # 
Instance details

Defined in Text.Jira.Markup

newtype Language Source #

Programming language used for syntax highlighting.

Constructors

Language Text 

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.