epub-generator 0.1.3__py3-none-any.whl → 0.1.5__py3-none-any.whl

epub_generator/__init__.py

@@ -1,6 +1,7 @@
 from .generation import generate_epub
 from .options import LaTeXRender, TableRender
 from .types import (
+    BasicAsset,
     BookMeta,
     Chapter,
     ChapterGetter,
@@ -35,6 +36,7 @@ __all__ = [
     "Table",
     "Formula",
     "HTMLTag",
+    "BasicAsset",
     "Image",
     "Footnote",
     "Mark",

epub_generator/context.py

@@ -55,15 +55,14 @@ class Context:
         nodes = list(self._hash_to_node.values())
         nodes.sort(key=lambda node: node.file_name)
         return [(node.file_name, node.media_type) for node in nodes]
+    
+    @property
+    def chapters_with_mathml(self) -> set[str]:
+        return self._chapters_with_mathml
 
     def mark_chapter_has_mathml(self, chapter_file_name: str) -> None:
-        """Mark a chapter as containing MathML content for EPUB 3.0 manifest properties."""
         self._chapters_with_mathml.add(chapter_file_name)
 
-    def chapter_has_mathml(self, chapter_file_name: str) -> bool:
-        """Check if a chapter contains MathML content."""
-        return chapter_file_name in self._chapters_with_mathml
-
     def use_asset(
         self,
         source_path: Path,

epub_generator/data/nav.xhtml.jinja

@@ -20,7 +20,7 @@
         <a href="Text/head.xhtml">{{ head_chapter_title }}</a>
       </li>
 {% endif %}
-{{ toc_list|safe }}
+{{ toc_body|safe }}
     </ol>
   </nav>
 

epub_generator/data/style.css.jinja

@@ -65,4 +65,26 @@ span.formula-inline img {
   vertical-align: middle;
   margin: 0 0.2em;
   max-height: 1.2em;
+}
+
+div.asset {
+  page-break-inside: avoid;
+  margin: 1em 0;
+}
+
+div.asset-title {
+  text-align: center;
+  font-weight: 600;
+  font-size: 0.95em;
+  color: #333;
+  margin-bottom: 0.5em;
+  font-style: italic;
+}
+
+div.asset-caption {
+  text-align: center;
+  font-size: 0.9em;
+  color: #666;
+  margin-top: 0.5em;
+  font-style: italic;
 }

epub_generator/generation/gen_asset.py

@@ -8,7 +8,8 @@ from latex2mathml.converter import convert
 
 from ..context import Context
 from ..options import LaTeXRender, TableRender
-from ..types import Formula, Image, Table
+from ..types import BasicAsset, Formula, Image, Table
+from .gen_content import render_html_tag, render_inline_content
 
 _MEDIA_TYPE_MAP = {
     ".png": "image/png",
@@ -18,25 +19,40 @@ _MEDIA_TYPE_MAP = {
     ".svg": "image/svg+xml",
 }
 
-def process_table(context: Context, table: Table) -> Element | None:
-    if context.table_render == TableRender.CLIPPING:
-        return None
-    try:
-        wrapped_html = f"<div>{table.html_content}</div>"
-        parsed = fromstring(wrapped_html)
-        wrapper = Element("div", attrib={"class": "alt-wrapper"})
 
-        for child in parsed:
-            wrapper.append(child)
+def render_inline_formula(context: Context, formula: Formula) -> Element | None:
+    return _render_formula(
+        context=context, 
+        formula=formula, 
+        inline_mode=True,
+    )
 
-        return wrapper if len(wrapper) > 0 else None
-    except Exception:
+
+def render_asset_block(context: Context, block: Table | Formula | Image) -> Element | None: 
+    element: Element | None = None
+    if isinstance(block, Table):
+        element = _render_table(context, block)
+    elif isinstance(block, Formula):
+        element = _render_formula(context, block, inline_mode=False)
+    elif isinstance(block, Image):
+        element = _process_image(context, block)
+    return element
+
+
+def _render_table(context: Context, table: Table) -> Element | None:
+    if context.table_render == TableRender.CLIPPING:
         return None
 
+    return _wrap_asset_content(
+        context=context, 
+        asset=table, 
+        content_element=render_html_tag(context, table.html_content),
+    )
+
 
-def process_formula(
-        context: Context, 
-        formula: Formula, 
+def _render_formula(
+        context: Context,
+        formula: Formula,
         inline_mode: bool,
     ) -> Element | None:
 
@@ -47,9 +63,10 @@ def process_formula(
     if not latex_expr:
         return None
 
+    content_element = None
     if context.latex_render == LaTeXRender.MATHML:
-        return _latex2mathml(
-            latex=latex_expr, 
+        content_element = _latex2mathml(
+            latex=latex_expr,
             inline_mode=inline_mode,
         )
     elif context.latex_render == LaTeXRender.SVG:
@@ -64,31 +81,40 @@ def process_formula(
         img_element = Element("img")
         img_element.set("src", f"../assets/{file_name}")
         img_element.set("alt", "formula")
+        content_element = img_element
 
-        if inline_mode:
-            wrapper = Element("span", attrib={"class": "formula-inline"})
-        else:
-            wrapper = Element("div", attrib={"class": "alt-wrapper"})
+    if content_element is None:
+        return None
 
-        wrapper.append(img_element)
-        return wrapper
+    return _wrap_asset_content(
+        context=context,
+        asset=formula, 
+        content_element=content_element,
+        inline_mode=inline_mode,
+    )
 
-    return None
 
-def process_image(context: Context, image: Image) -> Element | None:
+def _process_image(context: Context, image: Image) -> Element:
     file_ext = image.path.suffix or ".png"
     file_name = context.use_asset(
-        source_path=image.path, 
-        media_type=_MEDIA_TYPE_MAP.get(file_ext.lower(), "image/png"), 
+        source_path=image.path,
+        media_type=_MEDIA_TYPE_MAP.get(file_ext.lower(), "image/png"),
         file_ext=file_ext,
     )
     img_element = Element("img")
     img_element.set("src", f"../assets/{file_name}")
-    img_element.set("alt", image.alt_text)
+    img_element.set("alt", "")  # Empty alt text, use caption instead
 
-    wrapper = Element("div", attrib={"class": "alt-wrapper"})
-    wrapper.append(img_element)
-    return wrapper
+    return _wrap_asset_content(
+        context=context, 
+        asset=image, 
+        content_element=img_element,
+    )
+
+def _normalize_expression(expression: str) -> str:
+    expression = expression.replace("\n", "")
+    expression = expression.strip()
+    return expression
 
 
 _ESCAPE_UNICODE_PATTERN = re.compile(r"&#x([0-9A-Fa-f]{5});")
@@ -148,9 +174,35 @@ def _latex_formula2svg(latex: str, font_size: int = 12):
         return output.getvalue()
     except Exception:
         return None
+    
+
+def _wrap_asset_content(
+    context: Context,
+    asset: BasicAsset,
+    content_element: Element,
+    inline_mode: bool = False,
+) -> Element:
+    
+    if inline_mode:
+        wrapper = Element("span", attrib={"class": "formula-inline"})
+    else:
+        wrapper = Element("div", attrib={"class": "alt-wrapper"})
 
+    wrapper.append(content_element)
 
-def _normalize_expression(expression: str) -> str:
-    expression = expression.replace("\n", "")
-    expression = expression.strip()
-    return expression
+    if not asset.title and not asset.caption:
+        return wrapper
+
+    container = Element("div", attrib={"class": "asset"})
+    if asset.title:
+        title_div = Element("div", attrib={"class": "asset-title"})
+        render_inline_content(context, title_div, asset.title)
+        container.append(title_div)
+
+    container.append(wrapper)
+    if asset.caption:
+        caption_div = Element("div", attrib={"class": "asset-caption"})
+        render_inline_content(context, caption_div, asset.caption)
+        container.append(caption_div)
+
+    return container

epub_generator/generation/gen_chapter.py

@@ -7,16 +7,17 @@ from ..types import (
     Chapter,
     ContentBlock,
     Formula,
-    HTMLTag,
     Image,
-    Mark,
     Table,
     TextBlock,
     TextKind,
 )
-from .gen_asset import process_formula, process_image, process_table
+from .gen_asset import render_asset_block
+from .gen_content import render_inline_content
 from .xml_utils import serialize_element, set_epub_type
 
+_MAX_HEADING_LEVEL = 6 # HTML standard defines heading levels from h1 to h6
+
 
 def generate_chapter(
     context: Context,
@@ -89,9 +90,13 @@ def _render_footnotes(
 
 
 def _render_content_block(context: Context, block: ContentBlock) -> Element | None:
-    if isinstance(block, TextBlock):
+    if isinstance(block, Table | Formula | Image):
+        return render_asset_block(context, block)
+
+    elif isinstance(block, TextBlock):
         if block.kind == TextKind.HEADLINE:
-            container = Element("h1")
+            heading_level = min(block.level + 1, _MAX_HEADING_LEVEL)
+            container = Element(f"h{heading_level}")
         elif block.kind == TextKind.QUOTE:
             container = Element("p")
         elif block.kind == TextKind.BODY:
@@ -99,9 +104,9 @@ def _render_content_block(context: Context, block: ContentBlock) -> Element | No
         else:
             raise ValueError(f"Unknown TextKind: {block.kind}")
 
-        _render_text_content(
-            context=context, 
-            parent=container, 
+        render_inline_content(
+            context=context,
+            parent=container,
             content=block.content,
         )
         if block.kind == TextKind.QUOTE:
@@ -110,68 +115,6 @@ def _render_content_block(context: Context, block: ContentBlock) -> Element | No
             return blockquote
 
         return container
-
-    elif isinstance(block, Table):
-        return process_table(context, block)
-
-    elif isinstance(block, Formula):
-        return process_formula(context, block, inline_mode=False)
-
-    elif isinstance(block, Image):
-        return process_image(context, block)
-
+    
     else:
         return None
-
-
-def _render_text_content(context: Context, parent: Element, content: list[str | Mark | Formula | HTMLTag]) -> None:
-    """Render text content with inline citation marks."""
-    current_element = parent
-    for item in content:
-        if isinstance(item, str):
-            if current_element is parent:
-                if parent.text is None:
-                    parent.text = item
-                else:
-                    parent.text += item
-            else:
-                if current_element.tail is None:
-                    current_element.tail = item
-                else:
-                    current_element.tail += item
-
-        elif isinstance(item, HTMLTag):
-            tag_element = Element(item.name)
-            for attr, value in item.attributes:
-                tag_element.set(attr, value)
-            _render_text_content(
-                context=context,
-                parent=tag_element,
-                content=item.content,
-            )
-            parent.append(tag_element)
-            current_element = tag_element
-
-        elif isinstance(item, Formula):
-            formula_element = process_formula(
-                context=context,
-                formula=item,
-                inline_mode=True,
-            )
-            if formula_element is not None:
-                parent.append(formula_element)
-                current_element = formula_element
-
-        elif isinstance(item, Mark):
-            # EPUB 3.0 noteref with semantic attributes
-            anchor = Element("a")
-            anchor.attrib = {
-                "id": f"ref-{item.id}",
-                "href": f"#fn-{item.id}",
-                "class": "super",
-            }
-            # Set epub:type using utility function (avoids global namespace pollution)
-            set_epub_type(anchor, "noteref")
-            anchor.text = f"[{item.id}]"
-            parent.append(anchor)
-            current_element = anchor

epub_generator/generation/gen_content.py

@@ -0,0 +1,59 @@
+from xml.etree.ElementTree import Element
+
+from ..context import Context
+from ..types import Formula, HTMLTag, Mark
+from .xml_utils import set_epub_type
+
+
+def render_inline_content(
+    context: Context,
+    parent: Element,
+    content: list[str | Mark | Formula | HTMLTag]
+) -> None:
+    current_element = parent
+    for item in content:
+        if isinstance(item, str):
+            if current_element is parent:
+                if parent.text is None:
+                    parent.text = item
+                else:
+                    parent.text += item
+            else:
+                if current_element.tail is None:
+                    current_element.tail = item
+                else:
+                    current_element.tail += item
+
+        elif isinstance(item, HTMLTag):
+            tag_element = render_html_tag(context, item)
+            parent.append(tag_element)
+            current_element = tag_element
+
+        elif isinstance(item, Formula):
+            from .gen_asset import render_inline_formula  # avoid circular import
+            formula_element = render_inline_formula(context, item)
+            if formula_element is not None:
+                parent.append(formula_element)
+                current_element = formula_element
+
+        elif isinstance(item, Mark):
+            # EPUB 3.0 noteref with semantic attributes
+            anchor = Element("a")
+            anchor.attrib = {
+                "id": f"ref-{item.id}",
+                "href": f"#fn-{item.id}",
+                "class": "super",
+            }
+            set_epub_type(anchor, "noteref")
+            anchor.text = f"[{item.id}]"
+            parent.append(anchor)
+            current_element = anchor
+
+
+def render_html_tag(context: Context, tag: HTMLTag) -> Element:
+    """Convert HTMLTag to XML Element with full inline content support."""
+    element = Element(tag.name)
+    for attr, value in tag.attributes:
+        element.set(attr, value)
+    render_inline_content(context, element, tag.content)
+    return element

epub_generator/generation/gen_epub.py

@@ -9,10 +9,10 @@ from ..context import Context, Template
 from ..html_tag import search_content
 from ..i18n import I18N
 from ..options import LaTeXRender, TableRender
-from ..types import Chapter, EpubData, Formula, TextBlock
+from ..types import BasicAsset, Chapter, ContentBlock, EpubData, Formula, TextBlock
 from .gen_chapter import generate_chapter
 from .gen_nav import gen_nav
-from .gen_toc import NavPoint, gen_toc
+from .gen_toc import TocPoint, gen_toc, iter_toc
 
 
 def generate_epub(
@@ -26,10 +26,8 @@ def generate_epub(
     i18n = I18N(lan)
     template = Template()
     epub_file_path = Path(epub_file_path)
-
-    # Generate navigation points from TOC structure
     has_cover = epub_data.cover_image_path is not None
-    nav_points = gen_toc(epub_data=epub_data, has_cover=has_cover)
+    toc_points = gen_toc(epub_data=epub_data)
 
     epub_file_path.parent.mkdir(parents=True, exist_ok=True)
 
@@ -49,7 +47,7 @@ def generate_epub(
         _write_chapters_from_data(
             context=context,
             i18n=i18n,
-            nav_points=nav_points,
+            toc_points=toc_points,
             epub_data=epub_data,
             latex_render=latex_render,
             assert_not_aborted=assert_not_aborted,
@@ -58,7 +56,7 @@ def generate_epub(
             template=template,
             i18n=i18n,
             epub_data=epub_data,
-            nav_points=nav_points,
+            toc_points=toc_points,
             has_cover=has_cover,
         )
         file.writestr(
@@ -71,7 +69,7 @@ def generate_epub(
             context=context,
             i18n=i18n,
             epub_data=epub_data,
-            nav_points=nav_points,
+            toc_points=toc_points,
         )
         assert_not_aborted()
 
@@ -81,6 +79,7 @@ def generate_epub(
             epub_data=epub_data,
         )
 
+
 def _write_assets_from_data(
     context: Context,
     i18n: I18N,
@@ -104,62 +103,67 @@ def _write_assets_from_data(
                 arcname="OEBPS/assets/cover.png",
             )
 
+
 def _write_chapters_from_data(
     context: Context,
     i18n: I18N,
-    nav_points: list[NavPoint],
+    toc_points: list[TocPoint],
     epub_data: EpubData,
     latex_render: LaTeXRender,
     assert_not_aborted: Callable[[], None],
 ):
-    if epub_data.get_head is not None:
-        chapter = epub_data.get_head()
+    for file_name, get_chapter in _search_chapters(epub_data, toc_points):
+        chapter = get_chapter()
         data = generate_chapter(context, chapter, i18n)
         context.file.writestr(
-            zinfo_or_arcname="OEBPS/Text/head.xhtml",
+            zinfo_or_arcname="OEBPS/Text/" + file_name,
             data=data.encode("utf-8"),
         )
         if latex_render == LaTeXRender.MATHML and _chapter_has_formula(chapter):
-            context.mark_chapter_has_mathml("head.xhtml")
+            context.mark_chapter_has_mathml(file_name)
         assert_not_aborted()
 
-    for nav_point in nav_points:
-        if nav_point.get_chapter is not None:
-            chapter = nav_point.get_chapter()
-            data = generate_chapter(context, chapter, i18n)
-            context.file.writestr(
-                zinfo_or_arcname="OEBPS/Text/" + nav_point.file_name,
-                data=data.encode("utf-8"),
-            )
-            if latex_render == LaTeXRender.MATHML and _chapter_has_formula(chapter):
-                context.mark_chapter_has_mathml(nav_point.file_name)
-            assert_not_aborted()
+
+def _search_chapters(epub_data: EpubData, toc_points: list[TocPoint]):
+    if epub_data.get_head is not None:
+        yield "head.xhtml", epub_data.get_head
+    for ref in iter_toc(toc_points):
+        yield ref.file_name, ref.get_chapter
 
 
 def _chapter_has_formula(chapter: Chapter) -> bool:
-    """Check if chapter contains any formulas (block-level or inline)."""
     for element in chapter.elements:
-        if isinstance(element, Formula):
+        if _content_block_has_formula(element):
             return True
-        if isinstance(element, TextBlock):
-            for item in search_content(element.content):
-                if isinstance(item, Formula):
-                    return True
     for footnote in chapter.footnotes:
         for content_block in footnote.contents:
-            if isinstance(content_block, Formula):
+            if _content_block_has_formula(content_block):
                 return True
-            if isinstance(content_block, TextBlock):
-                for item in search_content(content_block.content):
-                    if isinstance(item, Formula):
-                        return True
     return False
 
+
+def _content_block_has_formula(content_block: ContentBlock) -> bool:
+    if isinstance(content_block, Formula):
+        return True
+    if isinstance(content_block, TextBlock):
+        for item in search_content(content_block.content):
+            if isinstance(item, Formula):
+                return True
+    if isinstance(content_block, BasicAsset):
+        for item in search_content(content_block.title):
+            if isinstance(item, Formula):
+                return True
+        for item in search_content(content_block.caption):
+            if isinstance(item, Formula):
+                return True
+    return False
+
+
 def _write_basic_files(
     context: Context,
     i18n: I18N,
     epub_data: EpubData,
-    nav_points: list[NavPoint],
+    toc_points: list[TocPoint],
 ):
     meta = epub_data.meta
     has_cover = epub_data.cover_image_path is not None
@@ -175,22 +179,18 @@ def _write_basic_files(
     else:
         modified_timestamp = datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ")
 
-    chapters_with_mathml = {
-        nav_point.file_name
-        for nav_point in nav_points
-        if context.chapter_has_mathml(nav_point.file_name)
-    }
+    toc_refs = list(iter_toc(toc_points))
     content = context.template.render(
         template="content.opf",
         meta=meta,
         i18n=i18n,
         ISBN=isbn,
         modified_timestamp=modified_timestamp,
-        nav_points=nav_points,
+        nav_points=toc_refs,
         has_head_chapter=has_head_chapter,
         has_cover=has_cover,
         asset_files=context.used_files,
-        chapters_with_mathml=chapters_with_mathml,
+        chapters_with_mathml=context.chapters_with_mathml,
     )
     context.file.writestr(
         zinfo_or_arcname="OEBPS/content.opf",

epub_generator/generation/gen_nav.py

@@ -1,26 +1,30 @@
-from html import escape
+from xml.etree.ElementTree import Element
 
 from ..context import Template
 from ..i18n import I18N
-from ..types import BookMeta, EpubData, TocItem
-from .gen_toc import NavPoint
+from ..types import BookMeta, EpubData
+from .gen_toc import TocPoint, iter_toc
+from .xml_utils import indent, serialize_element
 
 
 def gen_nav(
     template: Template,
     i18n: I18N,
     epub_data: EpubData,
-    nav_points: list[NavPoint],
+    toc_points: list[TocPoint],
     has_cover: bool = False,
 ) -> str:
     meta: BookMeta | None = epub_data.meta
     has_head_chapter = epub_data.get_head is not None
-    toc_list = _generate_toc_list(epub_data.prefaces, epub_data.chapters, nav_points)
-    first_chapter_file = nav_points[0].file_name if nav_points else None
-    head_chapter_title = ""
+    toc_body = "\n".join(_render_toc_item(toc_points))
+    first_ref = next(iter_toc(toc_points), None)
+
+    first_chapter_file: str = ""
+    head_chapter_title: str = ""
+    if first_ref:
+        first_chapter_file = first_ref.file_name
     if has_head_chapter and epub_data.get_head:
-        # Try to extract title from first heading if available
-        head_chapter_title = "Preface"  # Default title
+        head_chapter_title = i18n.preface
 
     return template.render(
         template="nav.xhtml",
@@ -29,64 +33,38 @@ def gen_nav(
         has_cover=has_cover,
         has_head_chapter=has_head_chapter,
         head_chapter_title=head_chapter_title,
-        toc_list=toc_list,
+        toc_body=toc_body,
         first_chapter_file=first_chapter_file,
     )
 
 
-def _generate_toc_list(
-    prefaces: list[TocItem],
-    chapters: list[TocItem],
-    nav_points: list[NavPoint],
-) -> str:
-    nav_point_index = 0
-
-    html_parts = []
-    for chapters_list in (prefaces, chapters):
-        for toc_item in chapters_list:
-            nav_point_index, item_html = _generate_toc_item(
-                toc_item, nav_points, nav_point_index
-            )
-            html_parts.append(item_html)
-
-    return "\n".join(html_parts)
-
+def _render_toc_item(toc_points: list[TocPoint]):
+    for toc_point in toc_points:
+        element = _create_toc_li_element(toc_point)
+        element = indent(element)
+        yield serialize_element(element)
 
-def _generate_toc_item(
-    toc_item: TocItem,
-    nav_points: list[NavPoint],
-    nav_point_index: int,
-) -> tuple[int, str]:
-    title_escaped = escape(toc_item.title)
-    file_name = None
-    if toc_item.get_chapter is not None and nav_point_index < len(nav_points):
-        file_name = nav_points[nav_point_index].file_name
-        nav_point_index += 1
 
-    children_html = []
-    for child in toc_item.children:
-        nav_point_index, child_html = _generate_toc_item(
-            child, nav_points, nav_point_index
-        )
-        children_html.append(child_html)
+def _create_toc_li_element(toc_point: TocPoint) -> Element:
+    li = Element("li")
 
-    if file_name is None and children_html:
-        if nav_point_index > 0:
-            for i in range(nav_point_index - len(toc_item.children), nav_point_index):
-                if i < len(nav_points):
-                    file_name = nav_points[i].file_name
-                    break
-
-    if file_name:
-        html_parts = [f'      <li>\n        <a href="Text/{file_name}">{title_escaped}</a>']
+    if toc_point.ref is not None:
+        file_name = toc_point.ref.file_name
+        link = Element("a")
+        link.set("href", f"Text/{file_name}")
+        link.text = toc_point.title
+        li.append(link)
     else:
-        html_parts = [f'      <li>\n        <span>{title_escaped}</span>']
-
-    if children_html:
-        html_parts.append('        <ol>')
-        html_parts.extend(children_html)
-        html_parts.append('        </ol>')
-
-    html_parts.append('      </li>')
-
-    return nav_point_index, "\n".join(html_parts)
+        span = Element("span")
+        span.text = toc_point.title
+        li.append(span)
+
+    # 递归处理子节点
+    if toc_point.children:
+        ol = Element("ol")
+        for child in toc_point.children:
+            child_li = _create_toc_li_element(child)
+            ol.append(child_li)
+        li.append(ol)
+
+    return li

epub_generator/generation/gen_toc.py

@@ -1,36 +1,57 @@
 from dataclasses import dataclass
-from typing import Any, Callable
+from typing import Any, Callable, Generator
 
 from ..types import EpubData, TocItem
 
 
 @dataclass
-class NavPoint:
-    toc_id: int
-    file_name: str
+class TocPoint:
+    title: str
     order: int
-    get_chapter: Callable[[], Any] | None = None
+    ref: "TocPointRef | None"
+    children: list["TocPoint"]
+
+    @property
+    def is_placeholder(self) -> bool:
+        """是否为占位节点（无对应文件）"""
+        return self.ref is None
+
+    @property
+    def has_file(self) -> bool:
+        """是否有对应的 XHTML 文件"""
+        return self.ref is not None
+
+@dataclass
+class TocPointRef:
+    part_id: str
+    file_name: str
+    get_chapter: Callable[[], Any]
 
 
-def gen_toc(
-    epub_data: EpubData,
-    has_cover: bool = False,
-) -> list[NavPoint]:
+def iter_toc(toc_points: list[TocPoint]) -> Generator[TocPointRef, None, None]:
+    for toc_point in toc_points:
+        if toc_point.ref:
+            yield toc_point.ref
+        yield from iter_toc(toc_point.children)
+
+
+def gen_toc(epub_data: EpubData) -> list[TocPoint]:
     prefaces = epub_data.prefaces
     chapters = epub_data.chapters
 
-    nav_point_generation = _NavPointGenerator(
-        has_cover=has_cover,
+    toc_point_generation = _TocPointGenerator(
         chapters_count=(
             _count_toc_items(prefaces) +
             _count_toc_items(chapters)
         ),
     )
+    toc_points: list[TocPoint] = []
     for chapters_list in (prefaces, chapters):
         for toc_item in chapters_list:
-            nav_point_generation.generate(toc_item)
+            toc_point = toc_point_generation.generate(toc_item)
+            toc_points.append(toc_point)
 
-    return nav_point_generation.nav_points
+    return toc_points
 
 
 def _count_toc_items(items: list[TocItem]) -> int:
@@ -50,39 +71,35 @@ def _max_depth_toc_items(items: list[TocItem]) -> int:
     return max_depth
 
 
-class _NavPointGenerator:
-    def __init__(self, has_cover: bool, chapters_count: int):
-        self._nav_points: list[NavPoint] = []
-        self._next_order: int = 2 if has_cover else 1
+class _TocPointGenerator:
+    def __init__(self, chapters_count: int):
+        self._next_order: int = 0
         self._next_id: int = 1
         self._digits = len(str(chapters_count))
 
-    @property
-    def nav_points(self) -> list[NavPoint]:
-        return self._nav_points
-
-    def generate(self, toc_item: TocItem) -> None:
-        self._create_nav_point(toc_item)
+    def generate(self, toc_item: TocItem) -> TocPoint:
+        return self._create_toc_point(toc_item)
 
-    def _create_nav_point(self, toc_item: TocItem) -> NavPoint:
-        nav_point: NavPoint | None = None
+    def _create_toc_point(self, toc_item: TocItem) -> TocPoint:
+        ref: TocPointRef | None = None
         if toc_item.get_chapter is not None:
-            toc_id = self._next_id
+            part_id = self._next_id
             self._next_id += 1
-            part_id = str(toc_id).zfill(self._digits)
-            nav_point = NavPoint(
-                toc_id=toc_id,
+            part_id = str(part_id).zfill(self._digits)
+            ref = TocPointRef(
+                part_id=part_id,
                 file_name=f"part{part_id}.xhtml",
-                order=self._next_order,
                 get_chapter=toc_item.get_chapter,
             )
-            self._nav_points.append(nav_point)
-            self._next_order += 1
-
-        for child in toc_item.children:
-            child_nav_point = self._create_nav_point(child)
-            if nav_point is None:
-                nav_point = child_nav_point
-
-        assert nav_point is not None, "TocItem has no chapter and no valid children"
-        return nav_point
+        order = self._next_order # 确保 order 以中序遍历为顺序
+        self._next_order += 1
+
+        return TocPoint(
+            title=toc_item.title, 
+            order=order,
+            ref=ref, 
+            children=[
+                self._create_toc_point(child)
+                for child in toc_item.children
+            ],
+        )

epub_generator/generation/xml_utils.py

@@ -1,4 +1,5 @@
 import re
+from typing import Container
 from xml.etree.ElementTree import Element, tostring
 
 _EPUB_NS = "http://www.idpf.org/2007/ops"
@@ -29,3 +30,25 @@ def serialize_element(element: Element) -> str:
             xml_string = xml_string.replace(f"{ns_prefix}:", f"{prefix}:")
 
     return xml_string
+
+def indent(elem: Element, level: int = 0, skip_tags: Container[str] = ()) -> Element:
+    indent_str = "  " * level
+    next_indent_str = "  " * (level + 1)
+
+    if elem.tag in skip_tags:
+        if level > 0 and (not elem.tail or not elem.tail.strip()):
+            elem.tail = "\n" + indent_str
+        return elem
+
+    if len(elem):
+        if not elem.text or not elem.text.strip():
+            elem.text = "\n" + next_indent_str
+        for i, child in enumerate(elem):
+            indent(child, level + 1, skip_tags)
+            if i < len(elem) - 1:
+                child.tail = "\n" + next_indent_str
+            else:
+                child.tail = "\n" + indent_str
+    elif level > 0 and (not elem.tail or not elem.tail.strip()):
+        elem.tail = "\n" + indent_str
+    return elem

epub_generator/i18n.py

@@ -9,9 +9,11 @@ class I18N:
             self.table_of_contents: str = "目录"
             self.landmarks: str = "路标"
             self.start_of_content: str = "正文开始"
+            self.preface: str = "前言"
         elif lan == "en":
             self.unnamed: str = "Unnamed"
             self.cover: str = "Cover"
             self.table_of_contents: str = "Table of Contents"
             self.landmarks: str = "Landmarks"
             self.start_of_content: str = "Start of Content"
+            self.preface: str = "Preface"

epub_generator/types.py

@@ -84,32 +84,45 @@ class Mark:
     """Citation ID, matches Footnote.id"""
 
 @dataclass
-class Table:
-    """HTML table."""
-    html_content: str
-    """HTML table markup"""
+class BasicAsset:
+    """Asset as a base class for other assets."""
 
+    title: list["str | Mark | Formula | HTMLTag"] = field(default_factory=list, kw_only=True)
+    """Asset title (before content)"""
+    caption: list["str | Mark | Formula | HTMLTag"] = field(default_factory=list, kw_only=True)
+    """Asset caption (after content)"""
 
 @dataclass
-class Formula:
+class Table(BasicAsset):
+    """Table representation."""
+
+    html_content: "HTMLTag"
+    """HTML content of the table"""
+
+
+@dataclass
+class Formula(BasicAsset):
     """Mathematical formula."""
+
     latex_expression: str
     """LaTeX expression"""
 
 
 @dataclass
-class Image:
+class Image(BasicAsset):
     """Image reference."""
+
     path: Path
     """Absolute path to the image file"""
 
-    alt_text: str = "image"
-    """Alt text (defaults to "image")"""
-
 @dataclass
 class TextBlock:
+    """Text block representation."""
+
     kind: TextKind
     """Kind of text block."""
+    level: int
+    """Heading level starting from 0 (only for HEADLINE: level 0 → h1, level 1 → h2, max h6; ignored for BODY and QUOTE)."""
     content: list["str | Mark | Formula | HTMLTag"]
     """Text content with optional citation marks."""
 

{epub_generator-0.1.3.dist-info → epub_generator-0.1.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: epub-generator
-Version: 0.1.3
+Version: 0.1.5
 Summary: A simple Python EPUB 3.0 generator with a single API call
 License: MIT
 Keywords: epub,epub3,ebook,generator,publishing
@@ -61,9 +61,9 @@ epub_data = EpubData(
             title="Chapter 1",
             get_chapter=lambda: Chapter(
                 elements=[
-                    TextBlock(kind=TextKind.HEADLINE, content=["Chapter 1"]),
-                    TextBlock(kind=TextKind.BODY, content=["This is the first paragraph."]),
-                    TextBlock(kind=TextKind.BODY, content=["This is the second paragraph."]),
+                    TextBlock(kind=TextKind.HEADLINE, level=0, content=["Chapter 1"]),
+                    TextBlock(kind=TextKind.BODY, level=0, content=["This is the first paragraph."]),
+                    TextBlock(kind=TextKind.BODY, level=0, content=["This is the second paragraph."]),
                 ]
             ),
         ),
@@ -111,8 +111,8 @@ epub_data = EpubData(
             title="Chapter 1",
             get_chapter=lambda: Chapter(
                 elements=[
-                    TextBlock(kind=TextKind.HEADLINE, content=["Chapter 1"]),
-                    TextBlock(kind=TextKind.BODY, content=["Main content..."]),
+                    TextBlock(kind=TextKind.HEADLINE, level=0, content=["Chapter 1"]),
+                    TextBlock(kind=TextKind.BODY, level=0, content=["Main content..."]),
                 ]
             ),
         ),
@@ -136,7 +136,7 @@ epub_data = EpubData(
                     title="Chapter 1.1",
                     get_chapter=lambda: Chapter(
                         elements=[
-                            TextBlock(kind=TextKind.BODY, content=["Content 1.1..."]),
+                            TextBlock(kind=TextKind.BODY, level=0, content=["Content 1.1..."]),
                         ]
                     ),
                 ),
@@ -144,7 +144,7 @@ epub_data = EpubData(
                     title="Chapter 1.2",
                     get_chapter=lambda: Chapter(
                         elements=[
-                            TextBlock(kind=TextKind.BODY, content=["Content 1.2..."]),
+                            TextBlock(kind=TextKind.BODY, level=0, content=["Content 1.2..."]),
                         ]
                     ),
                 ),
@@ -168,7 +168,7 @@ epub_data = EpubData(
             title="Chapter 1",
             get_chapter=lambda: Chapter(
                 elements=[
-                    TextBlock(kind=TextKind.BODY, content=["Here's an image:"]),
+                    TextBlock(kind=TextKind.BODY, level=0, content=["Here's an image:"]),
                     Image(
                         path=Path("image.png"),  # Image path
                         alt_text="Image description",
@@ -195,6 +195,7 @@ epub_data = EpubData(
                 elements=[
                     TextBlock(
                         kind=TextKind.BODY,
+                        level=0,
                         content=[
                             "This is text with a footnote",
                             Mark(id=1),  # Footnote marker
@@ -206,7 +207,7 @@ epub_data = EpubData(
                     Footnote(
                         id=1,
                         contents=[
-                            TextBlock(kind=TextKind.BODY, content=["This is the footnote content."]),
+                            TextBlock(kind=TextKind.BODY, level=0, content=["This is the footnote content."]),
                         ],
                     ),
                 ],
@@ -229,7 +230,7 @@ epub_data = EpubData(
             title="Chapter 1",
             get_chapter=lambda: Chapter(
                 elements=[
-                    TextBlock(kind=TextKind.BODY, content=["Here's a table:"]),
+                    TextBlock(kind=TextKind.BODY, level=0, content=["Here's a table:"]),
                     Table(
                         html_content="""
                         <table>
@@ -261,7 +262,7 @@ epub_data = EpubData(
             title="Chapter 1",
             get_chapter=lambda: Chapter(
                 elements=[
-                    TextBlock(kind=TextKind.BODY, content=["Pythagorean theorem:"]),
+                    TextBlock(kind=TextKind.BODY, level=0, content=["Pythagorean theorem:"]),
                     Formula(latex_expression="x^2 + y^2 = z^2"),  # Block-level formula
                 ]
             ),
@@ -284,6 +285,7 @@ epub_data = EpubData(
                 elements=[
                     TextBlock(
                         kind=TextKind.BODY,
+                        level=0,
                         content=[
                             "The Pythagorean theorem ",
                             Formula(latex_expression="a^2 + b^2 = c^2"),  # Inline formula
@@ -314,6 +316,7 @@ epub_data = EpubData(
             title="Chapter 1",
             get_chapter=lambda: Chapter(elements=[TextBlock(
                 kind=TextKind.BODY,
+                level=0,
                 content=[
                     "This is normal text with ",
                     HTMLTag(
@@ -348,8 +351,8 @@ epub_data = EpubData(
             title="Preface",
             get_chapter=lambda: Chapter(
                 elements=[
-                    TextBlock(kind=TextKind.HEADLINE, content=["Preface"]),
-                    TextBlock(kind=TextKind.BODY, content=["This is the preface content..."]),
+                    TextBlock(kind=TextKind.HEADLINE, level=0, content=["Preface"]),
+                    TextBlock(kind=TextKind.BODY, level=0, content=["This is the preface content..."]),
                 ]
             ),
         ),
@@ -359,7 +362,7 @@ epub_data = EpubData(
             title="Chapter 1",
             get_chapter=lambda: Chapter(
                 elements=[
-                    TextBlock(kind=TextKind.BODY, content=["Main content..."]),
+                    TextBlock(kind=TextKind.BODY, level=0, content=["Main content..."]),
                 ]
             ),
         ),
@@ -457,6 +460,7 @@ class Chapter:
   @dataclass
   class TextBlock:
       kind: TextKind                                # BODY | HEADLINE | QUOTE
+      level: int                                    # Heading level (0→h1, 1→h2, max h6; only for HEADLINE)
       content: list[str | Mark | Formula | HTMLTag] # Text with optional marks, inline formulas, and HTML tags
   ```
 

epub_generator-0.1.5.dist-info/RECORD

@@ -0,0 +1,26 @@
+epub_generator/__init__.py,sha256=5fFpZdgB4-FfXgCpE5IshBfrfrMaxNQK4SRKaKV2RdI,682
+epub_generator/context.py,sha256=9jHRpnQsNooRUSBoY_tiQ7aQ_AMZmyKUO22gPoO8Koc,4324
+epub_generator/data/container.xml.jinja,sha256=SkACyZgsAVUS5lmiCEhq3SpbFspYdyCnRNjWnLztLt0,252
+epub_generator/data/content.opf.jinja,sha256=DDaR9GZnSBcpNk2BWUu56Uo_248TA91AxE4tKsBuKnQ,2839
+epub_generator/data/cover.xhtml.jinja,sha256=heounlnHfOd-RNFIeytZQtAQ11ByPOiM1aB1lVyY6V4,328
+epub_generator/data/mimetype.jinja,sha256=5GjjUNEUPrZI9gx7C9YDEQHsBUSjYcp07O8laskB9Is,20
+epub_generator/data/nav.xhtml.jinja,sha256=zk5hf-MYoKxd4pcshZV5VliVrtDIgfH7n9f3-1L1cY0,1132
+epub_generator/data/part.xhtml.jinja,sha256=FEQaUjHfCy7EJyyvYZj-6T-lkDcsmz1wvsk0b8LU3E0,558
+epub_generator/data/style.css.jinja,sha256=n_DE-z97ikGzD3qufSwX_1iqkQcE_5kXiCIhyoXNjRA,1400
+epub_generator/generation/__init__.py,sha256=UIscwHa8ocr2D1mk1KaP-zi3P1x9eYJzxTo0RJ2dnks,35
+epub_generator/generation/gen_asset.py,sha256=WYwfGUvHM_CrwTuIIH7dYm-SL-vdhkTnvaZDymZxXzg,5978
+epub_generator/generation/gen_chapter.py,sha256=P6kmB8hdQnJB6SCheHzu5cOmZrC5H0LqNV-uuuigX1M,3425
+epub_generator/generation/gen_content.py,sha256=2ojjTgalveRnk1MXQaKsY53hPCgb7NHTwbMpLOXVrss,2018
+epub_generator/generation/gen_epub.py,sha256=I7u8rrrslF9xoyDUsALarB2iWzY9zjKM9ZOR1wLMX1E,6184
+epub_generator/generation/gen_nav.py,sha256=_cjOP18C1CoTn_DELIB06pyMPZZ0CPbkk4oPEvICdKs,1955
+epub_generator/generation/gen_toc.py,sha256=MK2iTYBpF8VUtPHpwz5JB_H6nWsKRKpVuLzRPYGy0nw,2864
+epub_generator/generation/xml_utils.py,sha256=kyHBWUihT5se5n_425BcEvBpsIK6yC52W25t012QUn0,2084
+epub_generator/html_tag.py,sha256=P_Y0uRStCEEh7cCtpvK4t432NEcY9OLntAznvdxUF5k,343
+epub_generator/i18n.py,sha256=-L6J6hsy796_IQ4nLpNtAeXIkRM6oFSWSHDlRZXW8aA,705
+epub_generator/options.py,sha256=Er1dnaNvzDSnZRSRJGSqhkJsv1XtsCW2Ym_hUc8o_QI,181
+epub_generator/template.py,sha256=RdN2QRICIrYMzpxCU_x4m4V9WWZEP9VvT6QLp2YCm90,1556
+epub_generator/types.py,sha256=gBrdi1KYOVEnI0qEp1slLsyUw_Sd7v09uHvN8_Hf9Z8,4440
+epub_generator-0.1.5.dist-info/LICENSE,sha256=9Zt_a4mrzkvR2rc0UbqTgbboIjWuumDFgeQyKos0H2E,1066
+epub_generator-0.1.5.dist-info/METADATA,sha256=cwIGyOGFrt0hvtw_FHaaTjeoy-l-FP-SGZC4zP0MJyw,16555
+epub_generator-0.1.5.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+epub_generator-0.1.5.dist-info/RECORD,,

epub_generator-0.1.3.dist-info/RECORD

@@ -1,25 +0,0 @@
-epub_generator/__init__.py,sha256=CRtP7zjqNPxOA_m4S8Jgavuw_KgaKpoBW5kdgqUivLQ,648
-epub_generator/context.py,sha256=AggXhRiOg70WZTLXF78LHA4coo3fa77OvKVe5wtgP6A,4495
-epub_generator/data/container.xml.jinja,sha256=SkACyZgsAVUS5lmiCEhq3SpbFspYdyCnRNjWnLztLt0,252
-epub_generator/data/content.opf.jinja,sha256=DDaR9GZnSBcpNk2BWUu56Uo_248TA91AxE4tKsBuKnQ,2839
-epub_generator/data/cover.xhtml.jinja,sha256=heounlnHfOd-RNFIeytZQtAQ11ByPOiM1aB1lVyY6V4,328
-epub_generator/data/mimetype.jinja,sha256=5GjjUNEUPrZI9gx7C9YDEQHsBUSjYcp07O8laskB9Is,20
-epub_generator/data/nav.xhtml.jinja,sha256=FGunTu_cDJmSBxV8cfaIDjHVUNsyjogWg1jL4VK8ihU,1132
-epub_generator/data/part.xhtml.jinja,sha256=FEQaUjHfCy7EJyyvYZj-6T-lkDcsmz1wvsk0b8LU3E0,558
-epub_generator/data/style.css.jinja,sha256=HyGWoevaZD9xPDJeMQY_1xmM0f6aK0prmqoW3mhTGp0,1072
-epub_generator/generation/__init__.py,sha256=UIscwHa8ocr2D1mk1KaP-zi3P1x9eYJzxTo0RJ2dnks,35
-epub_generator/generation/gen_asset.py,sha256=0muwCvAohODC76F9G9_UBibRPQSpmMJkgQxlCsM7QcQ,4480
-epub_generator/generation/gen_chapter.py,sha256=3f8i-QekhCHkCkRWeMbg1QYWmeNwKGsSNjeONrwMUhU,5346
-epub_generator/generation/gen_epub.py,sha256=zkG0U5_g3FY-D6zkYGqp844IgWYJhbAqf6CnX2Do71Y,6412
-epub_generator/generation/gen_nav.py,sha256=D-ZNsbm26AEAovbXtx1wSwTfH4Q8H2WYfoYeQ1Sb9bk,2813
-epub_generator/generation/gen_toc.py,sha256=yt7GYu8Rfz9aw_GPZFUl9H3BKd1za1hSm2hhp8wyI68,2488
-epub_generator/generation/xml_utils.py,sha256=xMcNZl8CaV21XYx2yeykkHhvnq5N7yRHfIFu5KRlRHc,1261
-epub_generator/html_tag.py,sha256=P_Y0uRStCEEh7cCtpvK4t432NEcY9OLntAznvdxUF5k,343
-epub_generator/i18n.py,sha256=GQjpHO7t8_0rXNuoYmO-G7_9nCF7S5kluBG0ip_2jIA,622
-epub_generator/options.py,sha256=Er1dnaNvzDSnZRSRJGSqhkJsv1XtsCW2Ym_hUc8o_QI,181
-epub_generator/template.py,sha256=RdN2QRICIrYMzpxCU_x4m4V9WWZEP9VvT6QLp2YCm90,1556
-epub_generator/types.py,sha256=vxNXQ6ML-quf9fdybgfIe0HRcBL3zWwAm7SZGWKjw5g,3915
-epub_generator-0.1.3.dist-info/LICENSE,sha256=9Zt_a4mrzkvR2rc0UbqTgbboIjWuumDFgeQyKos0H2E,1066
-epub_generator-0.1.3.dist-info/METADATA,sha256=s74QvIsScCa87948JiwzLkRDvJI_yem5KvmizN7UXmY,16226
-epub_generator-0.1.3.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-epub_generator-0.1.3.dist-info/RECORD,,