com.vladsch.flexmark.convert.html

Class FlexmarkHtmlParser

java.lang.Object

com.vladsch.flexmark.convert.html.FlexmarkHtmlParser

public class FlexmarkHtmlParser
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static com.vladsch.flexmark.util.options.DataKey<Boolean>	ADD_TRAILING_EOL
static com.vladsch.flexmark.util.options.DataKey<Boolean>	BR_AS_EXTRA_BLANK_LINES
static com.vladsch.flexmark.util.options.DataKey<Boolean>	BR_AS_PARA_BREAKS
static com.vladsch.flexmark.util.options.DataKey<String>	CODE_INDENT
static com.vladsch.flexmark.util.options.DataKey<Integer>	DEFINITION_MARKER_SPACES
static com.vladsch.flexmark.util.options.DataKey<Boolean>	DIV_AS_PARAGRAPH
static com.vladsch.flexmark.util.options.DataKey<Boolean>	DOT_ONLY_NUMERIC_LISTS
static com.vladsch.flexmark.util.options.DataKey<String>	EOL_IN_TITLE_ATTRIBUTE
static com.vladsch.flexmark.util.options.DataKey<ExtensionConversion>	EXT_INLINE_CODE
static com.vladsch.flexmark.util.options.DataKey<ExtensionConversion>	EXT_INLINE_DEL
static com.vladsch.flexmark.util.options.DataKey<ExtensionConversion>	EXT_INLINE_EMPHASIS
static com.vladsch.flexmark.util.options.DataKey<ExtensionConversion>	EXT_INLINE_INS
static com.vladsch.flexmark.util.options.DataKey<ExtensionConversion>	EXT_INLINE_STRONG
static com.vladsch.flexmark.util.options.DataKey<ExtensionConversion>	EXT_INLINE_SUB
static com.vladsch.flexmark.util.options.DataKey<ExtensionConversion>	EXT_INLINE_SUP
static com.vladsch.flexmark.util.options.DataKey<Boolean>	EXTRACT_AUTO_LINKS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	IGNORE_TABLE_HEADING_AFTER_ROWS If true then will ignore rows with th columns after rows with td columns have been emitted to the table.
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LIST_CONTENT_INDENT
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_END_ON_DOUBLE_BLANK
static com.vladsch.flexmark.util.options.DataKey<Integer>	MIN_SETEXT_HEADING_MARKER_LENGTH
static com.vladsch.flexmark.util.options.DataKey<String>	NBSP_TEXT
static com.vladsch.flexmark.util.options.DataKey<Character>	ORDERED_LIST_DELIMITER
static com.vladsch.flexmark.util.options.DataKey<Boolean>	OUTPUT_ATTRIBUTES_ID
static com.vladsch.flexmark.util.options.DataKey<String>	OUTPUT_ATTRIBUTES_NAMES_REGEX
static com.vladsch.flexmark.util.options.DataKey<String>	OUTPUT_ID_ATTRIBUTE_REGEX
static com.vladsch.flexmark.util.options.DataKey<Boolean>	OUTPUT_UNKNOWN_TAGS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	PRE_CODE_PRESERVE_EMPHASIS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	RENDER_COMMENTS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SETEXT_HEADINGS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SKIP_ATTRIBUTES
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SKIP_HEADING_1
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SKIP_HEADING_2
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SKIP_HEADING_3
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SKIP_HEADING_4
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SKIP_HEADING_5
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SKIP_HEADING_6
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SKIP_INLINE_CODE Deprecated. Use SKIP_INLINE_CODE set to ExtensionConversion.TEXT instead
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SKIP_INLINE_DEL Deprecated. Use SKIP_INLINE_DEL set to ExtensionConversion.TEXT instead
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SKIP_INLINE_EMPHASIS Deprecated. Use SKIP_INLINE_EMPHASIS set to ExtensionConversion.TEXT instead
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SKIP_INLINE_INS Deprecated. Use SKIP_INLINE_INS set to ExtensionConversion.TEXT instead
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SKIP_INLINE_STRONG Deprecated. Use SKIP_INLINE_STRONG set to ExtensionConversion.TEXT instead
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SKIP_INLINE_SUB Deprecated. Use SKIP_INLINE_SUB set to ExtensionConversion.TEXT instead
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SKIP_INLINE_SUP Deprecated. Use SKIP_INLINE_SUP set to ExtensionConversion.TEXT instead
static com.vladsch.flexmark.util.options.DataKey<Map<Object,com.vladsch.flexmark.util.html.CellAlignment>>	TABLE_CELL_ALIGNMENT_MAP
static com.vladsch.flexmark.util.options.DataKey<Boolean>	TABLE_LEAD_TRAIL_PIPES
static com.vladsch.flexmark.util.options.DataKey<Integer>	TABLE_MIN_SEPARATOR_COLUMN_WIDTH
static com.vladsch.flexmark.util.options.DataKey<Integer>	TABLE_MIN_SEPARATOR_DASHES
static com.vladsch.flexmark.util.options.DataKey<Boolean>	TABLE_SPACE_AROUND_PIPES
static com.vladsch.flexmark.util.options.DataKey<String>	THEMATIC_BREAK
static com.vladsch.flexmark.util.options.DataKey<Boolean>	TYPOGRAPHIC_QUOTES
static com.vladsch.flexmark.util.options.DataKey<Boolean>	TYPOGRAPHIC_SMARTS
static com.vladsch.flexmark.util.options.DataKey<Character>	UNORDERED_LIST_DELIMITER
static com.vladsch.flexmark.util.options.DataKey<Boolean>	WRAP_AUTO_LINKS

Method Summary

Modifier and Type	Method and Description
static FlexmarkHtmlParser	build() Build parser with default options
static FlexmarkHtmlParser	build(com.vladsch.flexmark.util.options.DataHolder options) Build parser
void	dumpHtmlTree(com.vladsch.flexmark.util.html.FormattingAppendable out, org.jsoup.nodes.Node node)
HtmlParserOptions	getOptions()
boolean	isTrace()
void	parse(com.vladsch.flexmark.util.html.FormattingAppendable out, String html) Parse HTML append to out
static String	parse(String html) Parse HTML with default options
static String	parse(String html, int maxBlankLines) Parse HTML with default options and max trailing blank lines
static String	parse(String html, int maxBlankLines, com.vladsch.flexmark.util.options.DataHolder options) Parse HTML with given options and max trailing blank lines
void	setTrace(boolean trace)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LIST_CONTENT_INDENT

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LIST_CONTENT_INDENT

SETEXT_HEADINGS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SETEXT_HEADINGS

OUTPUT_UNKNOWN_TAGS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> OUTPUT_UNKNOWN_TAGS

TYPOGRAPHIC_QUOTES

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> TYPOGRAPHIC_QUOTES

TYPOGRAPHIC_SMARTS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> TYPOGRAPHIC_SMARTS

EXTRACT_AUTO_LINKS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> EXTRACT_AUTO_LINKS

OUTPUT_ATTRIBUTES_ID

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> OUTPUT_ATTRIBUTES_ID

OUTPUT_ATTRIBUTES_NAMES_REGEX

public static final com.vladsch.flexmark.util.options.DataKey<String> OUTPUT_ATTRIBUTES_NAMES_REGEX

WRAP_AUTO_LINKS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> WRAP_AUTO_LINKS

RENDER_COMMENTS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> RENDER_COMMENTS

DOT_ONLY_NUMERIC_LISTS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> DOT_ONLY_NUMERIC_LISTS

PRE_CODE_PRESERVE_EMPHASIS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> PRE_CODE_PRESERVE_EMPHASIS

ORDERED_LIST_DELIMITER

public static final com.vladsch.flexmark.util.options.DataKey<Character> ORDERED_LIST_DELIMITER

UNORDERED_LIST_DELIMITER

public static final com.vladsch.flexmark.util.options.DataKey<Character> UNORDERED_LIST_DELIMITER

DEFINITION_MARKER_SPACES

public static final com.vladsch.flexmark.util.options.DataKey<Integer> DEFINITION_MARKER_SPACES

MIN_SETEXT_HEADING_MARKER_LENGTH

public static final com.vladsch.flexmark.util.options.DataKey<Integer> MIN_SETEXT_HEADING_MARKER_LENGTH

CODE_INDENT

public static final com.vladsch.flexmark.util.options.DataKey<String> CODE_INDENT

NBSP_TEXT

public static final com.vladsch.flexmark.util.options.DataKey<String> NBSP_TEXT

EOL_IN_TITLE_ATTRIBUTE

public static final com.vladsch.flexmark.util.options.DataKey<String> EOL_IN_TITLE_ATTRIBUTE

THEMATIC_BREAK

public static final com.vladsch.flexmark.util.options.DataKey<String> THEMATIC_BREAK

OUTPUT_ID_ATTRIBUTE_REGEX

public static final com.vladsch.flexmark.util.options.DataKey<String> OUTPUT_ID_ATTRIBUTE_REGEX

TABLE_MIN_SEPARATOR_COLUMN_WIDTH

public static final com.vladsch.flexmark.util.options.DataKey<Integer> TABLE_MIN_SEPARATOR_COLUMN_WIDTH

TABLE_MIN_SEPARATOR_DASHES

public static final com.vladsch.flexmark.util.options.DataKey<Integer> TABLE_MIN_SEPARATOR_DASHES

TABLE_LEAD_TRAIL_PIPES

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> TABLE_LEAD_TRAIL_PIPES

TABLE_SPACE_AROUND_PIPES

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> TABLE_SPACE_AROUND_PIPES

LISTS_END_ON_DOUBLE_BLANK

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_END_ON_DOUBLE_BLANK

DIV_AS_PARAGRAPH

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> DIV_AS_PARAGRAPH

BR_AS_PARA_BREAKS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> BR_AS_PARA_BREAKS

BR_AS_EXTRA_BLANK_LINES

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> BR_AS_EXTRA_BLANK_LINES

ADD_TRAILING_EOL

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> ADD_TRAILING_EOL

SKIP_INLINE_STRONG

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SKIP_INLINE_STRONG

Deprecated. Use SKIP_INLINE_STRONG set to ExtensionConversion.TEXT instead

SKIP_INLINE_EMPHASIS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SKIP_INLINE_EMPHASIS

Deprecated. Use SKIP_INLINE_EMPHASIS set to ExtensionConversion.TEXT instead

SKIP_INLINE_CODE

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SKIP_INLINE_CODE

Deprecated. Use SKIP_INLINE_CODE set to ExtensionConversion.TEXT instead

SKIP_INLINE_DEL

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SKIP_INLINE_DEL

Deprecated. Use SKIP_INLINE_DEL set to ExtensionConversion.TEXT instead

SKIP_INLINE_INS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SKIP_INLINE_INS

Deprecated. Use SKIP_INLINE_INS set to ExtensionConversion.TEXT instead

SKIP_INLINE_SUB

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SKIP_INLINE_SUB

Deprecated. Use SKIP_INLINE_SUB set to ExtensionConversion.TEXT instead

SKIP_INLINE_SUP

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SKIP_INLINE_SUP

Deprecated. Use SKIP_INLINE_SUP set to ExtensionConversion.TEXT instead

SKIP_HEADING_1

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SKIP_HEADING_1

SKIP_HEADING_2

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SKIP_HEADING_2

SKIP_HEADING_3

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SKIP_HEADING_3

SKIP_HEADING_4

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SKIP_HEADING_4

SKIP_HEADING_5

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SKIP_HEADING_5

SKIP_HEADING_6

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SKIP_HEADING_6

SKIP_ATTRIBUTES

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SKIP_ATTRIBUTES

EXT_INLINE_STRONG

public static final com.vladsch.flexmark.util.options.DataKey<ExtensionConversion> EXT_INLINE_STRONG

EXT_INLINE_EMPHASIS

public static final com.vladsch.flexmark.util.options.DataKey<ExtensionConversion> EXT_INLINE_EMPHASIS

EXT_INLINE_CODE

public static final com.vladsch.flexmark.util.options.DataKey<ExtensionConversion> EXT_INLINE_CODE

EXT_INLINE_DEL

public static final com.vladsch.flexmark.util.options.DataKey<ExtensionConversion> EXT_INLINE_DEL

EXT_INLINE_INS

public static final com.vladsch.flexmark.util.options.DataKey<ExtensionConversion> EXT_INLINE_INS

EXT_INLINE_SUB

public static final com.vladsch.flexmark.util.options.DataKey<ExtensionConversion> EXT_INLINE_SUB

EXT_INLINE_SUP

public static final com.vladsch.flexmark.util.options.DataKey<ExtensionConversion> EXT_INLINE_SUP

IGNORE_TABLE_HEADING_AFTER_ROWS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> IGNORE_TABLE_HEADING_AFTER_ROWS

If true then will ignore rows with th columns after rows with td columns have been emitted to the table.

If false then will convert these to regular columns.

TABLE_CELL_ALIGNMENT_MAP

public static final com.vladsch.flexmark.util.options.DataKey<Map<Object,com.vladsch.flexmark.util.html.CellAlignment>> TABLE_CELL_ALIGNMENT_MAP

Method Detail

getOptions

public HtmlParserOptions getOptions()

isTrace

public boolean isTrace()

setTrace

public void setTrace(boolean trace)

parse

public void parse(com.vladsch.flexmark.util.html.FormattingAppendable out,
                  String html)

Parse HTML append to out

Parameters:

out - formatting appendable to append the resulting Markdown

html - html to be parsed

build

public static FlexmarkHtmlParser build()

Build parser with default options

Returns:

html parser instance

build

public static FlexmarkHtmlParser build(com.vladsch.flexmark.util.options.DataHolder options)

Build parser

Parameters:

options - parser options

Returns:

html parser instance

dumpHtmlTree

public void dumpHtmlTree(com.vladsch.flexmark.util.html.FormattingAppendable out,
                         org.jsoup.nodes.Node node)

parse

public static String parse(String html)

Parse HTML with default options

Parameters:

html - html to be parsed

Returns:

resulting markdown string

parse

public static String parse(String html,
                           int maxBlankLines)

Parse HTML with default options and max trailing blank lines

Parameters:

html - html to be parsed

Returns:

resulting markdown string

parse

public static String parse(String html,
                           int maxBlankLines,
                           com.vladsch.flexmark.util.options.DataHolder options)

Parse HTML with given options and max trailing blank lines

Parameters:

html - html to be parsed

maxBlankLines - max trailing blank lines, -1 will suppress trailing EOL

options - data holder for parsing options

Returns:

resulting markdown string