| Copyright | Copyright (C) 2012-2017 John MacFarlane |
|---|---|
| License | GNU GPL, version 2 or above |
| Maintainer | John MacFarlane <jgm@berkeley.edu> |
| Stability | alpha |
| Portability | portable |
| Safe Haskell | None |
| Language | Haskell98 |
Text.Pandoc.Extensions
Description
Data structures and functions for representing markup extensions.
- data Extension
- = Ext_footnotes
- | Ext_inline_notes
- | Ext_pandoc_title_block
- | Ext_yaml_metadata_block
- | Ext_mmd_title_block
- | Ext_table_captions
- | Ext_implicit_figures
- | Ext_simple_tables
- | Ext_multiline_tables
- | Ext_grid_tables
- | Ext_pipe_tables
- | Ext_citations
- | Ext_raw_tex
- | Ext_raw_html
- | Ext_tex_math_dollars
- | Ext_tex_math_single_backslash
- | Ext_tex_math_double_backslash
- | Ext_latex_macros
- | Ext_fenced_code_blocks
- | Ext_fenced_code_attributes
- | Ext_backtick_code_blocks
- | Ext_inline_code_attributes
- | Ext_raw_attribute
- | Ext_markdown_in_html_blocks
- | Ext_native_divs
- | Ext_fenced_divs
- | Ext_native_spans
- | Ext_bracketed_spans
- | Ext_markdown_attribute
- | Ext_escaped_line_breaks
- | Ext_link_attributes
- | Ext_mmd_link_attributes
- | Ext_autolink_bare_uris
- | Ext_fancy_lists
- | Ext_lists_without_preceding_blankline
- | Ext_four_space_rule
- | Ext_startnum
- | Ext_definition_lists
- | Ext_compact_definition_lists
- | Ext_example_lists
- | Ext_all_symbols_escapable
- | Ext_angle_brackets_escapable
- | Ext_intraword_underscores
- | Ext_blank_before_blockquote
- | Ext_blank_before_header
- | Ext_space_in_atx_header
- | Ext_strikeout
- | Ext_superscript
- | Ext_subscript
- | Ext_hard_line_breaks
- | Ext_ignore_line_breaks
- | Ext_east_asian_line_breaks
- | Ext_literate_haskell
- | Ext_abbreviations
- | Ext_emoji
- | Ext_auto_identifiers
- | Ext_gfm_auto_identifiers
- | Ext_ascii_identifiers
- | Ext_header_attributes
- | Ext_mmd_header_identifiers
- | Ext_implicit_header_references
- | Ext_line_blocks
- | Ext_epub_html_exts
- | Ext_shortcut_reference_links
- | Ext_smart
- | Ext_old_dashes
- | Ext_spaced_reference_links
- data Extensions
- emptyExtensions :: Extensions
- extensionsFromList :: [Extension] -> Extensions
- parseFormatSpec :: String -> Either ParseError (String, Extensions -> Extensions)
- extensionEnabled :: Extension -> Extensions -> Bool
- enableExtension :: Extension -> Extensions -> Extensions
- disableExtension :: Extension -> Extensions -> Extensions
- getDefaultExtensions :: String -> Extensions
- pandocExtensions :: Extensions
- plainExtensions :: Extensions
- strictExtensions :: Extensions
- phpMarkdownExtraExtensions :: Extensions
- githubMarkdownExtensions :: Extensions
- multimarkdownExtensions :: Extensions
Documentation
Individually selectable syntax extensions.
Constructors
| Ext_footnotes | PandocPHPMMD style footnotes |
| Ext_inline_notes | Pandoc-style inline notes |
| Ext_pandoc_title_block | Pandoc title block |
| Ext_yaml_metadata_block | YAML metadata block |
| Ext_mmd_title_block | Multimarkdown metadata block |
| Ext_table_captions | Pandoc-style table captions |
| Ext_implicit_figures | A paragraph with just an image is a figure |
| Ext_simple_tables | Pandoc-style simple tables |
| Ext_multiline_tables | Pandoc-style multiline tables |
| Ext_grid_tables | Grid tables (pandoc, reST) |
| Ext_pipe_tables | Pipe tables (as in PHP markdown extra) |
| Ext_citations | Pandoc/citeproc citations |
| Ext_raw_tex | Allow raw TeX (other than math) |
| Ext_raw_html | Allow raw HTML |
| Ext_tex_math_dollars | TeX math between $..$ or $$..$$ |
| Ext_tex_math_single_backslash | TeX math btw \(..\) \[..\] |
| Ext_tex_math_double_backslash | TeX math btw \(..\) \[..\] |
| Ext_latex_macros | Parse LaTeX macro definitions (for math only) |
| Ext_fenced_code_blocks | Parse fenced code blocks |
| Ext_fenced_code_attributes | Allow attributes on fenced code blocks |
| Ext_backtick_code_blocks | GitHub style ``` code blocks |
| Ext_inline_code_attributes | Allow attributes on inline code |
| Ext_raw_attribute | Allow explicit raw blocks/inlines |
| Ext_markdown_in_html_blocks | Interpret as markdown inside HTML blocks |
| Ext_native_divs | Use Div blocks for contents of div tags |
| Ext_fenced_divs | Allow fenced div syntax ::: |
| Ext_native_spans | Use Span inlines for contents of span |
| Ext_bracketed_spans | Bracketed spans with attributes |
| Ext_markdown_attribute | Interpret text inside HTML as markdown
iff container has attribute |
| Ext_escaped_line_breaks | Treat a backslash at EOL as linebreak |
| Ext_link_attributes | link and image attributes |
| Ext_mmd_link_attributes | MMD style reference link attributes |
| Ext_autolink_bare_uris | Make all absolute URIs into links |
| Ext_fancy_lists | Enable fancy list numbers and delimiters |
| Ext_lists_without_preceding_blankline | Allow lists without preceding blank |
| Ext_four_space_rule | Require 4-space indent for list contents |
| Ext_startnum | Make start number of ordered list significant |
| Ext_definition_lists | Definition lists as in pandoc, mmd, php |
| Ext_compact_definition_lists | Definition lists without space between items, and disallow laziness |
| Ext_example_lists | Markdown-style numbered examples |
| Ext_all_symbols_escapable | Make all non-alphanumerics escapable |
| Ext_angle_brackets_escapable | Make and escapable |
| Ext_intraword_underscores | Treat underscore inside word as literal |
| Ext_blank_before_blockquote | Require blank line before a blockquote |
| Ext_blank_before_header | Require blank line before a header |
| Ext_space_in_atx_header | Require space between # and header text |
| Ext_strikeout | Strikeout using ~~this~~ syntax |
| Ext_superscript | Superscript using ^this^ syntax |
| Ext_subscript | Subscript using ~this~ syntax |
| Ext_hard_line_breaks | All newlines become hard line breaks |
| Ext_ignore_line_breaks | Newlines in paragraphs are ignored |
| Ext_east_asian_line_breaks | Newlines in paragraphs are ignored between East Asian wide characters |
| Ext_literate_haskell | Enable literate Haskell conventions |
| Ext_abbreviations | PHP markdown extra abbreviation definitions |
| Ext_emoji | Support emoji like :smile: |
| Ext_auto_identifiers | Automatic identifiers for headers |
| Ext_gfm_auto_identifiers | Automatic identifiers for headers, using GitHub's method for generating identifiers |
| Ext_ascii_identifiers | ascii-only identifiers for headers |
| Ext_header_attributes | Explicit header attributes {#id .class k=v} |
| Ext_mmd_header_identifiers | Multimarkdown style header identifiers [myid] |
| Ext_implicit_header_references | Implicit reference links for headers |
| Ext_line_blocks | RST style line blocks |
| Ext_epub_html_exts | Recognise the EPUB extended version of HTML |
| Ext_shortcut_reference_links | Shortcut reference links |
| Ext_smart | Smart quotes, apostrophes, ellipses, dashes |
| Ext_old_dashes |
|
| Ext_spaced_reference_links | Allow space between two parts of ref link |
data Extensions Source #
extensionsFromList :: [Extension] -> Extensions Source #
parseFormatSpec :: String -> Either ParseError (String, Extensions -> Extensions) Source #
Parse a format-specifying string into a markup format and a function that takes Extensions and enables and disables extensions as defined in the format spec.
extensionEnabled :: Extension -> Extensions -> Bool Source #
enableExtension :: Extension -> Extensions -> Extensions Source #
disableExtension :: Extension -> Extensions -> Extensions Source #
getDefaultExtensions :: String -> Extensions Source #
Default extensions from format-describing string.
pandocExtensions :: Extensions Source #
Extensions to be used with pandoc-flavored markdown.
plainExtensions :: Extensions Source #
Extensions to be used with plain text output.
strictExtensions :: Extensions Source #
Language extensions to be used with strict markdown.
phpMarkdownExtraExtensions :: Extensions Source #
Extensions to be used with github-flavored markdown.
githubMarkdownExtensions :: Extensions Source #
Extensions to be used with github-flavored markdown.
multimarkdownExtensions :: Extensions Source #
Extensions to be used with multimarkdown.