pyorg.convert.html.converter module¶

class pyorg.convert.html.converter.OrgHtmlConverter(config=None, **kw)[source]¶

DEFAULT_CONFIG = {'date_format': '%Y-%m-%d %a', 'image_extensions': ('.png', '.jpg', '.gif', '.tiff'), 'latex_delims': ('$$', '$$'), 'latex_inline_delims': ('\$', '\$'), 'resolve_link': {}}¶

INLINE_NODES = frozenset({'latex-fragment', 'line-break', 'underline', 'code', 'fixed-width', 'bold', 'radio-target', 'export-snippet', 'inline-babel-call', 'entity', 'example-block', 'link', 'statistics-cookie', 'table-cell', 'italic', 'superscript', 'target', 'macro', 'subscript', 'strike-through', 'paragraph', 'inline-src-block', 'verbatim', 'timestamp', 'footnote-reference'})¶

TAGS = {'babel-call': None, 'bold': 'strong', 'center-block': 'div', 'code': 'code', 'comment': None, 'example-block': 'pre', 'fixed-width': 'pre', 'headline': 'article', 'horizontal-rule': 'hr', 'italic': 'em', 'item': 'li', 'keyword': None, 'link': 'a', 'org-data': 'article', 'paragraph': 'p', 'property-drawer': None, 'quote-block': 'blockquote', 'radio-target': 'span', 'section': 'section', 'statistics-cookie': 'span', 'strike-through': 's', 'subscript': 'sub', 'superscript': 'sup', 'timestamp': 'span', 'underline': 'u', 'verbatim': 'span', 'verse-block': 'p'}¶

convert(node, dom=False, **kwargs)[source]¶

Convert org node to HTML.

Parameters:	node (pyorg.ast.OrgNode) – Org node to convert. dom (bool) – Return HTML element instead of string.
Returns:
Return type:	str or HtmlElement

make_headline_text(node, ctx=None, dom=False)[source]¶: Make HTML element for text content of headline node.

resolve_link(linktype, raw, path, ctx=None)[source]¶: Resolve link into a proper URL.

pyorg.convert.html.converter.to_html(node, dom=False, **kwargs)[source]¶

Convert org node to HTML.

Parameters:	node (pyorg.ast.OrgNode) – Org node to convert. dom (bool) – Return HTML element instead of string. kwargs – Keyword arguments to `OrgHtmlConverter` constructor.
Returns:
Return type:	str or HtmlElement