all2md.options.chm
Configuration options for CHM (Compiled HTML Help) parsing.
This module defines options for parsing Microsoft CHM files.
- class all2md.options.chm.ChmOptions
Bases:
BaseParserOptions,AttachmentOptionsMixinConfiguration options for CHM-to-Markdown conversion.
This dataclass contains settings specific to Microsoft Compiled HTML Help (CHM) document processing, including page handling, table of contents generation, and HTML parsing configuration. Inherits attachment handling from AttachmentOptionsMixin for embedded images and resources.
- Parameters:
include_toc (bool, default True) – Whether to generate and prepend a Markdown Table of Contents from the CHM’s internal TOC structure at the start of the document.
merge_pages (bool, default True) – Whether to merge all pages into a single continuous document. If False, pages are separated with thematic breaks.
html_options (HtmlOptions or None, default None) – Options for parsing HTML content within the CHM file. If None, uses default HTML parsing options.
- include_toc: bool = True
- merge_pages: bool = True
- html_options: HtmlOptions | None = None
- __init__(attachment_mode: AttachmentMode = 'alt_text', alt_text_mode: AltTextMode = 'default', attachment_output_dir: str | None = None, attachment_base_url: str | None = None, max_asset_size_bytes: int = 52428800, attachment_filename_template: str = '{stem}_{type}{seq}.{ext}', attachment_overwrite: AttachmentOverwriteMode = 'unique', attachment_deduplicate_by_hash: bool = False, attachments_footnotes_section: str | None = 'Attachments', extract_metadata: bool = False, include_toc: bool = True, merge_pages: bool = True, html_options: HtmlOptions | None = None) None