更新教程

README.md

@@ -252,7 +252,58 @@ async def main():
 if __name__ == "__main__":
     asyncio.run(main())
 ```
-### 示例 3: 翻译一个 xlsx 文件 (使用 `XlsxWorkflow`)
+
+### 示例 4: 翻译一个 docx 文件 (使用 `DocxWorkflow`)
+
+这里以异步方式为例。
+
+```python
+import asyncio
+
+from docutranslate.exporter.docx.docx2html_exporter import Docx2HTMLExporterConfig
+from docutranslate.translator.ai_translator.docx_translator import DocxTranslatorConfig
+from docutranslate.workflow.docx_workflow import DocxWorkflowConfig, DocxWorkflow
+
+
+async def main():
+    # 1. 构建翻译器配置
+    translator_config = DocxTranslatorConfig(
+        base_url="https://api.openai.com/v1/",
+        api_key="YOUR_OPENAI_API_KEY",
+        model_id="gpt-4o",
+        to_lang="中文",
+        insert_mode= "replace",#备选项 "replace", "append", "prepend"
+        separator = "\n",# "append", "prepend"模式时使用的分隔符
+    )
+
+    # 2. 构建主工作流配置
+    workflow_config = DocxWorkflowConfig(
+        translator_config=translator_config,
+        html_exporter_config=Docx2HTMLExporterConfig(cdn=True)
+    )
+
+    # 3. 实例化工作流
+    workflow = DocxWorkflow(config=workflow_config)
+
+    # 4. 读取文件并执行翻译
+    workflow.read_path("path/to/your/notes.docx")
+    await workflow.translate_async()
+    # 或者使用同步的方法
+    # workflow.translate()
+
+    # 5. 保存结果
+    workflow.save_as_docx(name="translated_notes.docx")
+    print("docx文件已保存。")
+
+    # 也可以导出翻译后的docx的二进制
+    text_bytes = workflow.export_to_docx()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+### 示例 5: 翻译一个 xlsx 文件 (使用 `XlsxWorkflow`)
 
 这里以异步方式为例。
 

docutranslate/static/index.html

@@ -1 +1 @@
-<!DOCTYPE html>
<html lang="zh-CN" data-bs-theme="auto">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">

    <title>DocuTranslate - 交互式文档翻译</title>
    <link rel="icon" href="/static/favicon.ico" type="image/x-icon">
    <!-- Bootstrap CSS -->
    <link href="/static/bootstrap.css" rel="stylesheet" crossorigin="anonymous">
    <!-- Bootstrap Icons -->
    <link rel="stylesheet" href="/static/bootstrap-icons.css">

    <style>
        body {
            background-color: var(--bs-body-bg);
        }

        .main-container {
            display: flex;
            flex-direction: column;
            height: 100vh;
            padding-top: 1rem;
            padding-bottom: 1rem;
        }

        .settings-panel {
            height: calc(100vh - 2rem);
            overflow-y: auto;
            padding-right: 15px; /* for scrollbar */
        }

        .task-area {
            height: calc(100vh - 2rem);
            overflow-y: auto;
        }

        .task-card {
            transition: all 0.3s ease-in-out;
        }

        .task-id-placeholder {
            color: var(--bs-secondary-color);
            font-style: italic;
        }

        .log-area {
            height: 150px;
            background-color: var(--bs-tertiary-bg);
            border: 1px solid var(--bs-border-color);
            border-radius: .375rem;
            font-family: monospace;
            font-size: 0.8rem;
            padding: 10px;
            overflow-y: auto;
            white-space: pre-wrap;
            word-break: break-all;
        }

        .file-drop-area {
            border: 2px dashed var(--bs-secondary-bg);
            border-radius: .375rem;
            padding: 2rem;
            text-align: center;
            cursor: pointer;
            transition: all 0.2s ease-in-out;
            background-color: var(--bs-body-bg);
        }

        .file-drop-area.drag-over {
            border-color: var(--bs-primary);
            background-color: var(--bs-secondary-bg);
        }

        .file-drop-area.file-selected {
            border-style: solid;
            border-color: var(--bs-success);
            background-color: var(--bs-success-bg-subtle);
        }

        .file-drop-area.input-error {
            border-color: var(--bs-danger);
        }

        .file-name-display.input-error-text {
            color: var(--bs-danger);
            font-weight: bold;
        }

        #printFrame, #translatedPreviewFrame {
            border: none;
            width: 100%;
        }

        #previewOffcanvas {
            --bs-offcanvas-width: 95vw;
            max-width: 1600px;
        }

        .preview-split-container {
            display: flex;
            flex-direction: row;
            height: 100%;
        }

        .preview-pane-wrapper {
            display: flex;
            flex-direction: column;
            overflow: hidden; /* Important for split.js */
        }

        .preview-pane-wrapper h6 {
            flex-shrink: 0;
            padding: 0.25rem;
        }

        .preview-pane-wrapper .preview-pane {
            flex-grow: 1; /* Make the inner pane grow */
            border: 1px solid var(--bs-border-color);
            border-radius: .375rem;
            overflow: auto;
        }

        .gutter {
            background-color: var(--bs-tertiary-bg);
            background-repeat: no-repeat;
            background-position: 50%;
        }

        .gutter.gutter-horizontal {
            cursor: col-resize;
            border-left: 1px solid var(--bs-border-color);
            border-right: 1px solid var(--bs-border-color);
        }

        .gutter.gutter-vertical {
            cursor: row-resize;
            border-top: 1px solid var(--bs-border-color);
            border-bottom: 1px solid var(--bs-border-color);
        }


        .preview-pane iframe, .preview-pane pre {
            width: 100%;
            height: 95%;
            border: none;
            margin: 0;
            padding: 0;
            overflow: auto;
            background-color: var(--bs-body-bg);
        }

        .slider-reset-btn {
            visibility: hidden;
        }

        .theme-switch {
            position: fixed;
            bottom: 1rem;
            left: 1rem;
            z-index: 1050;
        }

        @media (max-width: 991.98px) {
            .main-container {
                height: auto;
                padding-bottom: 6rem;
            }

            .settings-panel, .task-area {
                height: auto;
                overflow-y: visible;
            }

            .settings-panel {
                padding-right: 0;
                margin-bottom: 2rem;
            }
        }

        @media (max-width: 767.98px) {
            .task-card .col-md-7 {
                margin-top: 1.5rem;
            }

            #previewOffcanvas {
                --bs-offcanvas-width: 100vw;
            }
        Line truncated
+<!DOCTYPE html>
<html lang="zh-CN" data-bs-theme="auto">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">

    <title>DocuTranslate - 交互式文档翻译</title>
    <link rel="icon" href="/static/favicon.ico" type="image/x-icon">
    <!-- Bootstrap CSS -->
    <link href="/static/bootstrap.css" rel="stylesheet" crossorigin="anonymous">
    <!-- Bootstrap Icons -->
    <link rel="stylesheet" href="/static/bootstrap-icons.css">

    <style>
        body {
            background-color: var(--bs-body-bg);
        }

        .main-container {
            display: flex;
            flex-direction: column;
            height: 100vh;
            padding-top: 1rem;
            padding-bottom: 1rem;
        }

        .settings-panel {
            height: calc(100vh - 2rem);
            overflow-y: auto;
            padding-right: 15px; /* for scrollbar */
        }

        .task-area {
            height: calc(100vh - 2rem);
            overflow-y: auto;
        }

        .task-card {
            transition: all 0.3s ease-in-out;
        }

        .task-id-placeholder {
            color: var(--bs-secondary-color);
            font-style: italic;
        }

        .log-area {
            height: 150px;
            background-color: var(--bs-tertiary-bg);
            border: 1px solid var(--bs-border-color);
            border-radius: .375rem;
            font-family: monospace;
            font-size: 0.8rem;
            padding: 10px;
            overflow-y: auto;
            white-space: pre-wrap;
            word-break: break-all;
        }

        .file-drop-area {
            border: 2px dashed var(--bs-secondary-bg);
            border-radius: .375rem;
            padding: 2rem;
            text-align: center;
            cursor: pointer;
            transition: all 0.2s ease-in-out;
            background-color: var(--bs-body-bg);
        }

        .file-drop-area.drag-over {
            border-color: var(--bs-primary);
            background-color: var(--bs-secondary-bg);
        }

        .file-drop-area.file-selected {
            border-style: solid;
            border-color: var(--bs-success);
            background-color: var(--bs-success-bg-subtle);
        }

        .file-drop-area.input-error {
            border-color: var(--bs-danger);
        }

        .file-name-display.input-error-text {
            color: var(--bs-danger);
            font-weight: bold;
        }

        #printFrame, #translatedPreviewFrame {
            border: none;
            width: 100%;
        }

        #previewOffcanvas {
            --bs-offcanvas-width: 95vw;
            max-width: 1600px;
        }

        .preview-split-container {
            display: flex;
            flex-direction: row;
            height: 100%;
        }

        .preview-pane-wrapper {
            display: flex;
            flex-direction: column;
            overflow: hidden; /* Important for split.js */
        }

        .preview-pane-wrapper h6 {
            flex-shrink: 0;
            padding: 0.25rem;
        }

        .preview-pane-wrapper .preview-pane {
            flex-grow: 1; /* Make the inner pane grow */
            border: 1px solid var(--bs-border-color);
            border-radius: .375rem;
            overflow: auto;
        }

        .gutter {
            background-color: var(--bs-tertiary-bg);
            background-repeat: no-repeat;
            background-position: 50%;
        }

        .gutter.gutter-horizontal {
            cursor: col-resize;
            border-left: 1px solid var(--bs-border-color);
            border-right: 1px solid var(--bs-border-color);
        }

        .gutter.gutter-vertical {
            cursor: row-resize;
            border-top: 1px solid var(--bs-border-color);
            border-bottom: 1px solid var(--bs-border-color);
        }


        .preview-pane iframe, .preview-pane pre {
            width: 100%;
            height: 95%;
            border: none;
            margin: 0;
            padding: 0;
            overflow: auto;
            background-color: var(--bs-body-bg);
        }

        .slider-reset-btn {
            visibility: hidden;
        }

        .theme-switch {
            position: fixed;
            bottom: 1rem;
            left: 1rem;
            z-index: 1050;
        }

        @media (max-width: 991.98px) {
            .main-container {
                height: auto;
                padding-bottom: 6rem;
            }

            .settings-panel, .task-area {
                height: auto;
                overflow-y: visible;
            }

            .settings-panel {
                padding-right: 0;
                margin-bottom: 2rem;
            }
        }

        @media (max-width: 767.98px) {
            .task-card .col-md-7 {
                margin-top: 1.5rem;
            }

            #previewOffcanvas {
                --bs-offcanvas-width: 100vw;
            }
        Line truncated