Class Html5Converter

Base class for all Asciidoctor converters.

Subclass ConverterBase and implement convert_<nodeName> methods to handle specific node types. Register the subclass with the global registry via ConverterBase.registerFor.

Hierarchy (View Summary)

ConverterBase
- Html5Converter

Index

Constructors

constructor

new Html5Converter(backend: any, opts?: {}): Html5Converter
Parameters
- backend: any
- Optionalopts: {}
Returns Html5Converter
Inherited from ConverterBase.constructor
- Defined in converter.d.ts:122

Properties

_voidSlash

_voidSlash: string

_xmlMode

_xmlMode: boolean

backend

backend: any

Accessors

logger

get logger(): LoggerLike
The logger for this converter. The Logging mixin (logging.js) overrides this getter on the instance.

Returns LoggerLike
Inherited from ConverterBase.logger
- Defined in converter.d.ts:129

Methods

contentOnly

contentOnly(node: object): Promise<string>
Convert using only content (no wrapping).
Parameters
- node: object
  the node whose content to return
Returns Promise<string>
Inherited from ConverterBase.contentOnly
- Defined in converter.d.ts:179

convert

convert(node: AbstractNode, transform?: string, opts?: object): unknown
Convert a node by dispatching to a convert_<transform> method.
Parameters
- node: AbstractNode
  the AbstractNode to convert
- Optionaltransform: string
  hint for which method to call (default: node.nodeName)
- Optionalopts: object
  optional hints
Returns unknown
the result of the convert_<transform> handler; the actual type depends on the implementation
Inherited from ConverterBase.convert
- Defined in converter.d.ts:165

convert_admonition

convert_admonition(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:15

convert_audio

convert_audio(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:16

convert_colist

convert_colist(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:17

convert_dlist

convert_dlist(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:18

convert_document

convert_document(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:11

convert_embedded

convert_embedded(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:12

convert_example

convert_example(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:19

convert_floating_title

convert_floating_title(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:20

convert_image

convert_image(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:21

convert_inline_anchor

convert_inline_anchor(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:39

convert_inline_break

convert_inline_break(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:40

convert_inline_button

convert_inline_button(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:41

convert_inline_callout

convert_inline_callout(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:42

convert_inline_footnote

convert_inline_footnote(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:43

convert_inline_image

convert_inline_image(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:44

convert_inline_indexterm

convert_inline_indexterm(node: any): Promise<any>
Parameters
- node: any
Returns Promise<any>
- Defined in converter/html5.d.ts:45

convert_inline_kbd

convert_inline_kbd(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:46

convert_inline_menu

convert_inline_menu(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:47

convert_inline_quoted

convert_inline_quoted(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:48

convert_listing

convert_listing(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:22

convert_literal

convert_literal(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:23

convert_olist

convert_olist(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:25

convert_open

convert_open(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:26

convert_outline

convert_outline(node: any, opts?: {}): Promise<string>
Parameters
- node: any
- Optionalopts: {}
Returns Promise<string>
- Defined in converter/html5.d.ts:13

convert_page_break

convert_page_break(_node: any): Promise<string>
Parameters
- _node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:27

convert_paragraph

convert_paragraph(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:28

convert_pass

convert_pass(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:29

convert_preamble

convert_preamble(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:30

convert_quote

convert_quote(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:31

convert_section

convert_section(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:14

convert_sidebar

convert_sidebar(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:33

convert_stem

convert_stem(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:24

convert_table

convert_table(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:34

convert_thematic_break

convert_thematic_break(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:32

convert_toc

convert_toc(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:35

convert_ulist

convert_ulist(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:36

convert_verse

convert_verse(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:37

convert_video

convert_video(node: any): Promise<string>
Parameters
- node: any
Returns Promise<string>
- Defined in converter/html5.d.ts:38

createLogMessage

createLogMessage(
    text: any,
    context?: {},
): {
    include_location?: any;
    source_location?: any;
    text: string;
    inspect(): string;
    toString(): string;
}
Alias for messageWithContext (used in extensions).
Parameters
- text: any
- Optionalcontext: {}
Returns {
    include_location?: any;
    source_location?: any;
    text: string;
    inspect(): string;
    toString(): string;
}
Inherited from ConverterBase.createLogMessage
- Defined in converter.d.ts:150

getLogger

getLogger(): LoggerLike
Returns LoggerLike
Inherited from ConverterBase.getLogger
- Defined in converter.d.ts:131

handles

handles(transform: string): boolean
Report whether this converter can handle the given transform.
Parameters
- transform: string
  the transform name
Returns boolean
Inherited from ConverterBase.handles
- Defined in converter.d.ts:172

messageWithContext

messageWithContext(
    text: string,
    context?: { include_location?: any; source_location?: any },
): {
    include_location?: any;
    source_location?: any;
    text: string;
    inspect(): string;
    toString(): string;
}
Build an auto-formatting log message that carries structured source_location (rather than baking it into the text), for use with this.logger.warn(...).
Parameters
- text: string
- Optionalcontext: { include_location?: any; source_location?: any }
Returns {
    include_location?: any;
    source_location?: any;
    text: string;
    inspect(): string;
    toString(): string;
}
Inherited from ConverterBase.messageWithContext
- Defined in converter.d.ts:139

readSvgContents

readSvgContents(node: any, target: any): Promise<any>
Parameters
- node: any
- target: any
Returns Promise<any>
- Defined in converter/html5.d.ts:49

skip

skip(_node: any): void
Skip conversion (no-op).
Parameters
- _node: any
Returns void
Inherited from ConverterBase.skip
- Defined in converter.d.ts:181

`Static`create

create(backend?: string, opts?: any): Html5Converter
Create a new Html5Converter instance.
Parameters
- Optionalbackend: string
- Optionalopts: any
Returns Html5Converter
- Defined in converter/html5.d.ts:8

`Static`registerFor

registerFor(...backends: string[]): void
Register this converter class with the global registry.
Parameters
- ...backends: string[]
  backend names to register for
Returns void
Inherited from ConverterBase.registerFor
- Defined in converter.d.ts:121

Class Html5Converter

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Html5Converter

Properties

_voidSlash

_xmlMode

backend

Accessors

logger

Returns LoggerLike

Methods

contentOnly

Parameters

Returns Promise<string>

convert

Parameters

Returns unknown

convert_admonition

Parameters

Returns Promise<string>

convert_audio

Parameters

Returns Promise<string>

convert_colist

Parameters

Returns Promise<string>

convert_dlist

Parameters

Returns Promise<string>

convert_document

Parameters

Returns Promise<string>

convert_embedded

Parameters

Returns Promise<string>

convert_example

Parameters

Returns Promise<string>

convert_floating_title

Parameters

Returns Promise<string>

convert_image

Parameters

Returns Promise<string>

convert_inline_anchor

Parameters

Returns Promise<string>

convert_inline_break

Parameters

Returns Promise<string>

convert_inline_button

Parameters

Returns Promise<string>

convert_inline_callout

Parameters

Returns Promise<string>

convert_inline_footnote

Parameters

Returns Promise<string>

convert_inline_image

Parameters

Returns Promise<string>

convert_inline_indexterm

Parameters

Returns Promise<any>

convert_inline_kbd

Parameters

Returns Promise<string>

convert_inline_menu

Parameters

Returns Promise<string>

convert_inline_quoted

Returns {
include_location?: any;
source_location?: any;
text: string;
inspect(): string;
toString(): string;
}

Returns {
include_location?: any;
source_location?: any;
text: string;
inspect(): string;
toString(): string;
}