【总结】1875- HTML5 和word互转?这两个热门库就够了!

2023-11-25 15:09:43 浏览数 (2)

HTMLword 的互转功能一直是开发中的一个头疼需求。那么今天咱们就针对这个需求来看下,如何进行角色。

这里涉及到两个关键的 js 库

  1. html-docx-js
  2. mammoth.js

HTML转化为Word之 html-docx-js

什么是 html-docx-js

html-docx-js 是一个非常小的库,能够将 HTML 文档转换为 Microsoft Word 2007 及更高版本使用的 DOCX 格式。html-docx-js 设法使用称为“altchunks”的功能在浏览器中执行转换。

简而言之,它允许以不同的标记语言嵌入内容。开发者使用 MHT 文档将嵌入内容发送到 Word,因为它允许处理图像。Word 打开此类文件后,会将外部内容转换为 Word Processing ML(这是 DOCX 文件的标记语言的调用方式)并替换引用。

Microsoft Word for Mac 2008 不支持 Altchunk,LibreOffice 和 Google Docs 也不支持 Altchunk。

关于 html-docx-js 库有几点需要说明:

  • html-docx-js 适用于任何支持 Blob 的现代浏览器(无论是本机还是通过 Blob.js)。它在 Google Chrome 36、Safari 7 和 Internet Explorer 10 上进行了测试,也适用于使用 Buffer 而不是 Blob 的 Node.js(在 v0.10.12 上测试)。
  • html-docx-js 仅支持内联的 base64 图像(通过 DATA URI 获取)。但动态转换常规图像(来自静态文件夹)很容易,开发者可以自行完成。

目前 Mammoth 在 Github 上通过 MIT 协议开源,有超过 1k 的 star、0.3k 的 fork、0.7k 的项目依赖量、NPM 周平均下载量 9k,是一个值得关注的前端开源项目。

如何使用 html-docx-js

代码语言:javascript复制
var converted = htmlDocx.asBlob(content);
saveAs(converted, "test.docx");

asBlob 可以采用其他选项来控制文档的页面设置:

  • orientation:横向或纵向(默认)
  • margins:边距大小图
  • top:数字(默认:1440,即 2.54 厘米)
  • right:数字(默认:1440)
  • bottom:数字(默认:1440)
  • left:数字(默认:1440)
  • header:数字(默认值:720)
  • footer:数字(默认值:720)
  • gutter:数字(默认值:0)

比如下面的例子:

代码语言:javascript复制
var converted = htmlDocx.asBlob(content, {
  orientation: "landscape",
  margins: { top: 720 },
});
saveAs(converted, "test.docx");

需要注意的是,开发者需要传递完整、有效的 HTML(包括 DOCTYPE、html 和 body 标签)。这可能不太方便,但可以让开发者在样式标签中包含 CSS 规则。

html-docx-js 作为独立”Browserify 模块(UMD)分发。开发者可以将其作为 html-docx 要求。如果没有可用的模块加载器,它将把自己注册在 window.htmlDocx。

doc 转化为 HTML 之 mammoth.js

什么是 mammoth.js

Mammoth.js 旨 在转换 .docx 文档,例如:由 Microsoft Word、Google Docs 和 LibreOffice 创建的文档,并将其转换为 HTML

Mammoth 的目标是通过使用文档中的语义信息并忽略其他细节来生成简单且干净的 HTML。例如,Mammoth 将任何具有标题 1 样式的段落转换为 h1 元素,而不是尝试精确复制标题的样式(字体、文本大小、颜色等)。

.docx 使用的结构与 HTML 的结构之间存在很大的不匹配,这意味着对于更复杂的文档来说,转换不太可能完美。如果开发者仅使用样式来对文档进行语义标记,那么 Mammoth 效果最佳。

Mammoth.js 目前支持以下功能:

  • 标题、列表、评论
  • 从自己的 docx 样式到 HTML 的可定制映射。例如,可以通过提供适当的样式映射将 warningHeading 转换为 h1.warning。
  • Tables:当前忽略表格本身的格式(例如:边框),但文本的格式与文档其余部分的格式相同。
  • 脚注和尾注、图片、粗体、斜体、下划线、删除线、上标和下标、链接、Line、Line breaks
  • 文本框:文本框的内容被视为出现在包含文本框的段落之后的单独段落。

Mammoth 在众多平台可用,比如:Python、WordPress、Java/JVM、.NET 等等。目前 Mammoth 在 Github 上通过 BSD-2-Clause 开源,有超过 4.1k 的 star、0.5k 的 fork、4.4k 的项目依赖量、NPM 周平均下载量 76k,是一个值得关注的前端优质开源项目。

使用 mammoth.js

以文档转换为例。

Mammoth 允许在转换文档之前对其进行处理。例如,假设该文档尚未进行语义标记,但开发者知道任何居中对齐的段落都应该是标题,则可以使用 transformDocument 参数来适当地修改文档:

代码语言:javascript复制
function transformElement(element) {
  if (element.children) {
    var children = _.map(element.children, transformElement);
    element = { ...element, children: children };
  }
  if (element.type === "paragraph") {
    element = transformParagraph(element);
  }

  return element;
}
function transformParagraph(element) {
  if (element.alignment === "center" && !element.styleId) {
    return { ...element, styleId: "Heading2" };
  } else {
    return element;
  }
}
var options = {
  transformDocument: transformElement,
};

TransformDocument 的返回值在 HTML 生成期间使用。同时,上面的代码可以使用 mammoth.transforms.paragraph 函数进行优化,比如:

代码语言:javascript复制
function transformParagraph(element) {
  if (element.alignment === "center" && !element.styleId) {
    return { ...element, styleId: "Heading2" };
  } else {
    return element;
  }
}
var options = {
  transformDocument: mammoth.transforms.paragraph(transformParagraph),
};

或者,如果开发者希望已明确设置为使用等宽字体来表示代码的段落:

代码语言:javascript复制
const monospaceFonts = ["consolas", "courier", "courier new"];

function transformParagraph(paragraph) {
  var runs = mammoth.transforms.getDescendantsOfType(paragraph, "run");
  var isMatch =
    runs.length > 0 &&
    runs.every(function (run) {
      return run.font && monospaceFonts.indexOf(run.font.toLowerCase()) !== -1;
    });
  if (isMatch) {
    return {
      ...paragraph,
      styleId: "code",
      styleName: "Code",
    };
  } else {
    return paragraph;
  }
}
var options = {
  transformDocument: mammoth.transforms.paragraph(transformParagraph),
  styleMap: ["p[style-name='Code'] => pre:separator('n')"],
};

往期回顾 # 如何使用 TypeScript 开发 React 函数式组件? # 11 个需要避免的 React 错误用法 # 6 个 Vue3 开发必备的 VSCode 插件 # 3 款非常实用的 Node.js 版本管理工具 # 6 个你必须明白 Vue3 的 ref 和 reactive 问题 # 6 个意想不到的 JavaScript 问题 # 试着换个角度理解低代码平台设计的本质

0 人点赞