DOCX

DOCX 创建、编辑和分析

概述

.docx 文件是一个包含 XML 文件的 ZIP 压缩包。

快速参考

将 .doc 转换为 .docx

旧版 .doc 文件在编辑之前必须进行转换：

python scripts/office/soffice.py --headless --convert-to docx document.doc

阅读内容

# 提取文本并跟踪修订
pandoc --track-changes=all document.docx -o output.md

# 访问原始 XML
python scripts/office/unpack.py document.docx unpacked/

转换为图像

python scripts/office/soffice.py --headless --convert-to pdf document.docx
pdftoppm -jpeg -r 150 document.pdf page

接受跟踪修订

要生成接受所有跟踪修订的干净文档（需要 LibreOffice）：

python scripts/accept_changes.py input.docx output.docx

创建新文档

使用 JavaScript 生成 .docx 文件，然后进行验证。安装：npm install -g docx

设置

const { Document, Packer, Paragraph, TextRun, Table, TableRow, TableCell, ImageRun,
        Header, Footer, AlignmentType, PageOrientation, LevelFormat, ExternalHyperlink,
        InternalHyperlink, Bookmark, FootnoteReferenceRun, PositionalTab,
        PositionalTabAlignment, PositionalTabRelativeTo, PositionalTabLeader,
        TabStopType, TabStopPosition, Column, SectionType,
        TableOfContents, HeadingLevel, BorderStyle, WidthType, ShadingType,
        VerticalAlign, PageNumber, PageBreak } = require('docx');

const doc = new Document({ sections: [{ children: [/* 内容 */] }] });
Packer.toBuffer(doc).then(buffer => fs.writeFileSync("doc.docx", buffer));

验证

创建文件后，验证它。如果验证失败，请解压、修复 XML，然后重新打包。

python scripts/office/validate.py doc.docx

页面大小

// 重要: docx-js 默认为 A4，不是 US Letter
// 始终显式设置页面大小以获得一致的结果
sections: [{
  properties: {
    page: {
      size: {
        width: 12240,   // 8.5 英寸 (DXA 单位)
        height: 15840   // 11 英寸 (DXA 单位)
      },
      margin: { top: 1440, right: 1440, bottom: 1440, left: 1440 } // 1 英寸边距
    }
  },
  children: [/* 内容 */]
}]

常见页面尺寸（DXA 单位，1440 DXA = 1 英寸）：

横向： docx-js 在内部交换宽度/高度，因此传递纵向尺寸并让它处理交换：

size: {
  width: 12240,   // 将短边作为宽度传入
  height: 15840,  // 将长边作为高度传入
  orientation: PageOrientation.LANDSCAPE  // docx-js 会在 XML 中交换它们
},
// 内容宽度 = 15840 - 左边距 - 右边距 (使用长边)

样式（覆盖内置标题）

使用 Arial 作为默认字体（普遍支持）。将标题保留为黑色以提高可读性。

const doc = new Document({
  styles: {
    default: { document: { run: { font: "Arial", size: 24 } } }, // 12pt 默认
    paragraphStyles: [
      // 重要: 使用精确 ID 覆盖内置样式
      { id: "Heading1", name: "Heading 1", basedOn: "Normal", next: "Normal", quickFormat: true,
        run: { size: 32, bold: true, font: "Arial" },
        paragraph: { spacing: { before: 240, after: 240 }, outlineLevel: 0 } }, // outlineLevel 为 TOC 所需
      { id: "Heading2", name: "Heading 2", basedOn: "Normal", next: "Normal", quickFormat: true,
        run: { size: 28, bold: true, font: "Arial" },
        paragraph: { spacing: { before: 180, after: 180 }, outlineLevel: 1 } },
    ]
  },
  sections: [{
    children: [
      new Paragraph({ heading: HeadingLevel.HEADING_1, children: [new TextRun("标题")] }),
    ]
  }]
});

列表（切勿使用 unicode 项目符号）

// ❌ 错误 - 永远不要手动插入项目符号字符
new Paragraph({ children: [new TextRun("• Item")] })  // 错误
new Paragraph({ children: [new TextRun("\u2022 Item")] })  // 错误

// ✅ 正确 - 使用编号配置和 LevelFormat.BULLET
const doc = new Document({
  numbering: {
    config: [
      { reference: "bullets",
        levels: [{ level: 0, format: LevelFormat.BULLET, text: "\u2022", alignment: AlignmentType.LEFT,
          style: { paragraph: { indent: { left: 720, hanging: 360 } } } }] },
      { reference: "numbers",
        levels: [{ level: 0, format: LevelFormat.DECIMAL, text: "%1.", alignment: AlignmentType.LEFT,
          style: { paragraph: { indent: { left: 720, hanging: 360 } } } }] },
    ]
  },
  sections: [{
    children: [
      new Paragraph({ numbering: { reference: "bullets", level: 0 },
        children: [new TextRun("项目符号项")] }),
      new Paragraph({ numbering: { reference: "numbers", level: 0 },
        children: [new TextRun("编号项")] }),
    ]
  }]
});

// ⚠️ 每个引用创建独立的编号
// 相同的引用 = 继续 (1,2,3 然后 4,5,6)
// 不同的引用 = 重新开始 (1,2,3 然后 1,2,3)

表格

关键：表格需要双重宽度设置 - 在表格上设置 columnWidths，并在每个单元格上设置 width。如果缺少任何一个，表格在某些平台上将无法正确渲染。

// 关键: 始终设置表格宽度以保证渲染一致
// 关键: 使用 ShadingType.CLEAR (不是 SOLID) 防止黑色背景
const border = { style: BorderStyle.SINGLE, size: 1, color: "CCCCCC" };
const borders = { top: border, bottom: border, left: border, right: border };

new Table({
  width: { size: 9360, type: WidthType.DXA }, // 始终使用 DXA (百分比在 Google Docs 中会出错)
  columnWidths: [4680, 4680], // 必须等于表格宽度 (DXA: 1440 = 1 英寸)
  rows: [
    new TableRow({
      children: [
        new TableCell({
          borders,
          width: { size: 4680, type: WidthType.DXA }, // 每个单元格也要设置
          shading: { fill: "D5E8F0", type: ShadingType.CLEAR }, // CLEAR 不是 SOLID
          margins: { top: 80, bottom: 80, left: 120, right: 120 }, // 单元格内边距 (内部，不增加到宽度)
          children: [new Paragraph({ children: [new TextRun("单元格")] })]
        })
      ]
    })
  ]
})

表格宽度计算：

始终使用 WidthType.DXA - Google Docs 中 WidthType.PERCENTAGE 会出错。

// 表格宽度 = columnWidths 之和 = 内容宽度
// US Letter 带 1" 边距: 12240 - 2880 = 9360 DXA
width: { size: 9360, type: WidthType.DXA },
columnWidths: [7000, 2360]  // 必须相加等于表格宽度

宽度规则：

• 始终使用 WidthType.DXA — 切勿使用 WidthType.PERCENTAGE（与 Google Docs 不兼容）
• 表格宽度必须等于 columnWidths 的总和
• 单元格 width 必须匹配相应的 columnWidths
• 单元格 margins 是内部填充 - 它们减少内容区域，而不是增加单元格宽度
• 对于全宽表格：使用内容宽度（页面宽度减去左右边距）

图片

// 关键: type 参数是必需的
new Paragraph({
  children: [new ImageRun({
    type: "png", // 必需: png, jpg, jpeg, gif, bmp, svg
    data: fs.readFileSync("image.png"),
    transformation: { width: 200, height: 150 },
    altText: { title: "标题", description: "描述", name: "名称" } // 三个都是必需的
  })]
})

分页符

// 关键: PageBreak 必须位于段落内部
new Paragraph({ children: [new PageBreak()] })

// 或使用 pageBreakBefore
new Paragraph({ pageBreakBefore: true, children: [new TextRun("新页面")] })

超链接

// 外部链接
new Paragraph({
  children: [new ExternalHyperlink({
    children: [new TextRun({ text: "点击这里", style: "Hyperlink" })],
    link: "https://example.com",
  })]
})

// 内部链接 (书签 + 引用)
// 1. 在目标位置创建书签
new Paragraph({ heading: HeadingLevel.HEADING_1, children: [
  new Bookmark({ id: "chapter1", children: [new TextRun("第一章")] }),
]})
// 2. 链接到它
new Paragraph({ children: [new InternalHyperlink({
  children: [new TextRun({ text: "参见第一章", style: "Hyperlink" })],
  anchor: "chapter1",
})]})

脚注

const doc = new Document({
  footnotes: {
    1: { children: [new Paragraph("来源：2024 年年度报告")] },
    2: { children: [new Paragraph("方法论见附录")] },
  },
  sections: [{
    children: [new Paragraph({
      children: [
        new TextRun("收入增长 15%"),
        new FootnoteReferenceRun(1),
        new TextRun("使用调整后指标"),
        new FootnoteReferenceRun(2),
      ],
    })]
  }]
});

制表位

// 在同一行右对齐文本 (例如，日期与标题相对)
new Paragraph({
  children: [
    new TextRun("公司名称"),
    new TextRun("\t2025 年 1 月"),
  ],
  tabStops: [{ type: TabStopType.RIGHT, position: TabStopPosition.MAX }],
})

// 点线引导 (例如，TOC 样式)
new Paragraph({
  children: [
    new TextRun("简介"),
    new TextRun({ children: [
      new PositionalTab({
        alignment: PositionalTabAlignment.RIGHT,
        relativeTo: PositionalTabRelativeTo.MARGIN,
        leader: PositionalTabLeader.DOT,
      }),
      "3",
    ]}),
  ],
})

多列布局

// 等宽列
sections: [{
  properties: {
    column: {
      count: 2,          // 列数
      space: 720,        // 列间距 (DXA, 720 = 0.5 英寸)
      equalWidth: true,
      separate: true,    // 列之间画垂直线
    },
  },
  children: [/* 内容自然跨列流动 */]
}]

// 自定义宽度列 (equalWidth 必须为 false)
sections: [{
  properties: {
    column: {
      equalWidth: false,
      children: [
        new Column({ width: 5400, space: 720 }),
        new Column({ width: 3240 }),
      ],
    },
  },
  children: [/* 内容 */]
}]

使用 type: SectionType.NEXT_COLUMN 强制使用新节进行分栏。

目录

// 关键: 标题必须仅使用 HeadingLevel - 不能有自定义样式
new TableOfContents("目录", { hyperlink: true, headingStyleRange: "1-3" })

页眉/页脚

sections: [{
  properties: {
    page: { margin: { top: 1440, right: 1440, bottom: 1440, left: 1440 } } // 1440 = 1 英寸
  },
  headers: {
    default: new Header({ children: [new Paragraph({ children: [new TextRun("页眉")] })] })
  },
  footers: {
    default: new Footer({ children: [new Paragraph({
      children: [new TextRun("第 "), new TextRun({ children: [PageNumber.CURRENT] }), new TextRun(" 页")]
    })] })
  },
  children: [/* 内容 */]
}]

docx-js 的关键规则

• 明确设置页面大小 - docx-js 默认为 A4；对于美国文档，请使用 US Letter (12240 x 15840 DXA)
• 横向：传递纵向尺寸 - docx-js 在内部交换宽度/高度；将短边作为 width 传入，将长边作为 height 传入，并设置 orientation: PageOrientation.LANDSCAPE
• 切勿使用 \n - 使用独立的段落元素
• 永远不要使用 unicode 项目符号 - 使用带编号配置的 LevelFormat.BULLET
• PageBreak 必须位于段落中 - 独立创建会产生无效的 XML
• ImageRun 需要 type - 始终指定 png/jpg 等
• 始终使用 DXA 设置表格 width - 切勿使用 WidthType.PERCENTAGE（Google Docs 中会出错）
• 表格需要双重宽度 - columnWidths 数组和单元格 width，两者必须匹配
• 表格宽度 = 列宽度总和 - 对于 DXA，确保它们精确相加
• 始终添加单元格边距 - 使用 margins: { top: 80, bottom: 80, left: 120, right: 120 } 进行可读填充
• 使用 ShadingType.CLEAR - 对于表格着色从不使用 SOLID
• 切勿使用表格作为分隔线/规则 - 单元格具有最小高度并呈现为空框（包括在页眉/页脚中）；在段落上使用 border: { bottom: { style: BorderStyle.SINGLE, size: 6, color: "2E75B6", space: 1 } } 代替。对于两列页脚，请使用制表位（请参阅制表位部分），而不是表格
• TOC 仅需要 HeadingLevel - 标题段落没有自定义样式
• 覆盖内置样式 - 使用精确的 ID：Heading1、Heading2 等
• 包括 outlineLevel - TOC 所需（0 表示 H1，1 表示 H2 等）

编辑现有文档

按顺序执行所有 3 个步骤。

第 1 步：解包

python scripts/office/unpack.py document.docx unpacked/

提取 XML、美化打印、合并相邻的运行，并将智能引号转换为 XML 实体（“ 等），以便它们在编辑后仍然存在。使用 --merge-runs false 跳过运行合并。

第 2 步：编辑 XML

编辑 unpacked/word/ 中的文件。有关模式，请参阅下面的 XML 参考。

使用 "Claude" 作为作者跟踪修订和评论，除非用户明确请求使用不同的名称。

直接使用编辑工具进行字符串替换。不要编写 Python 脚本。 脚本会带来不必要的复杂性。编辑工具准确显示正在替换的内容。

关键：对新内容使用智能引号。 添加带有撇号或引号的文本时，请使用 XML 实体生成智能引号：

<!-- 使用这些实体进行专业排版 -->
<w:t>Here&#x2019;s a quote: &#x201C;Hello&#x201D;</w:t>

添加评论： 使用 comment.py 处理跨多个 XML 文件的样板文件（文本必须是预转义的 XML）：

python scripts/comment.py unpacked/ 0 "评论文本，包含 & 和 ’"
python scripts/comment.py unpacked/ 1 "回复文本" --parent 0  # 回复评论 0
python scripts/comment.py unpacked/ 0 "文本" --author "自定义作者"  # 自定义作者名称

然后将标记添加到 document.xml（请参阅 XML 参考中的评论）。

第 3 步：打包

python scripts/office/pack.py unpacked/ output.docx --original document.docx

通过自动修复进行验证、压缩 XML 并创建 DOCX。使用 --validate false 跳过。

自动修复将修复：

• durableId >= 0x7FFFFFFF（重新生成有效 ID）
• <w:t> 上缺少 xml:space="preserve" 并带有空格

自动修复无法修复：

• 格式错误的 XML、无效元素嵌套、缺失关系、架构违规

常见陷阱

• 替换整个 <w:r> 元素：添加跟踪修订时，将整个 <w:r>...</w:r> 块替换为 <w:del>...<w:ins>... 作为同级元素。不要在运行中注入跟踪修订标签。
• 保留 <w:rPr> 格式：将原始运行的 <w:rPr> 块复制到跟踪的修订运行中，以保持粗体、字体大小等。

XML 参考

架构合规性

• <w:pPr> 中的元素顺序：<w:pStyle>、<w:numPr>、<w:spacing>、<w:ind>、<w:jc>、<w:rPr> 最后
• 空白：将 xml:space="preserve" 添加到带有前导/尾随空格的 <w:t>
• RSID：必须是 8 位十六进制数字（例如 00AB1234）

跟踪修订

插入：

<w:ins w:id="1" w:author="Claude" w:date="2025-01-01T00:00:00Z">
  <w:r><w:t>插入的文本</w:t></w:r>
</w:ins>

删除：

<w:del w:id="2" w:author="Claude" w:date="2025-01-01T00:00:00Z">
  <w:r><w:delText>删除的文本</w:delText></w:r>
</w:del>

在 <w:del> 内部：使用 <w:delText> 代替 <w:t>，使用 <w:delInstrText> 代替 <w:instrText>。

最少编辑 - 仅标记更改内容：

<!-- 将 "30 days" 更改为 "60 days" -->
<w:r><w:t>The term is </w:t></w:r>
<w:del w:id="1" w:author="Claude" w:date="...">
  <w:r><w:delText>30</w:delText></w:r>
</w:del>
<w:ins w:id="2" w:author="Claude" w:date="...">
  <w:r><w:t>60</w:t></w:r>
</w:ins>
<w:r><w:t> days.</w:t></w:r>

删除整个段落/列表项 - 从段落中删除所有内容时，还将段落标记标记为已删除，以便它与下一个段落合并。在 <w:pPr><w:rPr> 内添加 <w:del/>：

<w:p>
  <w:pPr>
    <w:numPr>...</w:numPr>  <!-- 列表编号 (如果存在) -->
    <w:rPr>
      <w:del w:id="1" w:author="Claude" w:date="2025-01-01T00:00:00Z"/>
    </w:rPr>
  </w:pPr>
  <w:del w:id="2" w:author="Claude" w:date="2025-01-01T00:00:00Z">
    <w:r><w:delText>要删除的整个段落内容...</w:delText></w:r>
  </w:del>
</w:p>

如果没有 <w:pPr><w:rPr> 中的 <w:del/>，接受更改会留下一个空的段落/列表项。

拒绝其他作者的插入 - 在其插入内容中嵌套删除：

<w:ins w:author="Jane" w:id="5">
  <w:del w:author="Claude" w:id="10">
    <w:r><w:delText>他们插入的文本</w:delText></w:r>
  </w:del>
</w:ins>

恢复其他作者的删除 - 在之后添加插入（不要修改他们的删除）：

<w:del w:author="Jane" w:id="5">
  <w:r><w:delText>删除的文本</w:delText></w:r>
</w:del>
<w:ins w:author="Claude" w:id="10">
  <w:r><w:t>删除的文本</w:t></w:r>
</w:ins>

评论

运行 comment.py（请参阅步骤 2）后，将标记添加到 document.xml。对于回复，请使用 --parent 标志并将标记嵌套在父项中。

关键：<w:commentRangeStart> 和 <w:commentRangeEnd> 是 <w:r> 的同级，永远不会在 <w:r> 内部。

<!-- 评论标记是 w:p 的直接子元素，永远不要在 w:r 内部 -->
<w:commentRangeStart w:id="0"/>
<w:del w:id="1" w:author="Claude" w:date="2025-01-01T00:00:00Z">
  <w:r><w:delText>已删除</w:delText></w:r>
</w:del>
<w:r><w:t> 更多文本</w:t></w:r>
<w:commentRangeEnd w:id="0"/>
<w:r><w:rPr><w:rStyle w:val="CommentReference"/></w:rPr><w:commentReference w:id="0"/></w:r>

<!-- 评论 0 带回复 1 嵌套在其中 -->
<w:commentRangeStart w:id="0"/>
  <w:commentRangeStart w:id="1"/>
  <w:r><w:t>文本</w:t></w:r>
  <w:commentRangeEnd w:id="1"/>
<w:commentRangeEnd w:id="0"/>
<w:r><w:rPr><w:rStyle w:val="CommentReference"/></w:rPr><w:commentReference w:id="0"/></w:r>
<w:r><w:rPr><w:rStyle w:val="CommentReference"/></w:rPr><w:commentReference w:id="1"/></w:r>

图片

1. 将图像文件添加到 word/media/
2. 添加关系到 word/_rels/document.xml.rels：

<Relationship Id="rId5" Type=".../image" Target="media/image1.png"/>

3. 将内容类型添加到 [Content_Types].xml：

<Default Extension="png" ContentType="image/png"/>

4. 在 document.xml 中引用：

<w:drawing>
  <wp:inline>
    <wp:extent cx="914400" cy="914400"/>  <!-- EMU: 914400 = 1 英寸 -->
    <a:graphic>
      <a:graphicData uri=".../picture">
        <pic:pic>
          <pic:blipFill><a:blip r:embed="rId5"/></pic:blipFill>
        </pic:pic>
      </a:graphicData>
    </a:graphic>
  </wp:inline>
</w:drawing>

依赖关系

• pandoc：文本提取
• docx：npm install -g docx（新文档）
• LibreOffice：PDF 转换（通过 scripts/office/soffice.py 自动配置沙盒环境）
• Poppler：图像的 pdftoppm