| Copyright | © 2019–2023 Albert Krewinkel |
|---|---|
| License | MIT |
| Maintainer | Albert Krewinkel <tarleb@zeitkraut.de> |
| Stability | alpha |
| Portability | portable |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Text.Jira.Markup
Description
Jira markup types.
Synopsis
- newtype Doc = Doc {}
- data Block
- data Inline
- data InlineStyle
- data LinkType
- data ListStyle
- newtype URL = URL {}
- newtype ColorName = ColorName Text
- data Icon
- newtype Row = Row {}
- data Cell
- = BodyCell [Block]
- | HeaderCell [Block]
- newtype Language = Language Text
- data Parameter = Parameter {}
- normalizeInlines :: [Inline] -> [Inline]
- iconText :: Icon -> Text
Documentation
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 |
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 |
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 |
Instances
| Eq InlineStyle Source # | |
Defined in Text.Jira.Markup | |
| Ord InlineStyle Source # | |
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 Source # | |
Defined in Text.Jira.Markup Methods showsPrec :: Int -> InlineStyle -> ShowS # show :: InlineStyle -> String # showList :: [InlineStyle] -> ShowS # | |
Type of a link.
Constructors
| Attachment | link to an attachment |
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 |
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 # | |
| Ord ListStyle Source # | |
| Show ListStyle Source # | |
Text color
Instances
| Eq ColorName Source # | |
| Ord ColorName Source # | |
| Show ColorName Source # | |
Graphical emoticons
Constructors
Table row, containing an arbitrary number of cells.
Table cell with block content
Constructors
| BodyCell [Block] | |
| HeaderCell [Block] |
Programming language used for syntax highlighting.
Panel parameter
Constructors
| Parameter | |
Fields
| |
Instances
| Eq Parameter Source # | |
| Ord Parameter Source # | |
| Show Parameter Source # | |
normalizeInlines :: [Inline] -> [Inline] Source #
Normalize a list of inlines, merging elements where possible.