Haddock 转 DBK转换器
所有处理都在你的设备上完成,大文件可能需要一点时间。
DBK 与 DocBook 的转换方式完全一致:转 Word、Markdown 或 HTML。如果你的文件还是 Haddock 格式,这个页面就是最快的捷径:Haddock 是 Haskell 生态的文档标记:附着在函数上的 -- 注释块,渲染成每个 Hackage 包自带的 API 文档。
本转换器通过 WebAssembly 完全在你的浏览器内运行——文件不会离开你的设备,全程无上传、无水印、无注册、无排队。支持一次拖入多个文件批量转换。
Haddock 与 DBK 的对比
| Haddock | DBK | |
|---|---|---|
| 数据结构 | 注释标记(--、'links'、@mono@) | 语义 XML(<chapter>/<section>/<para>) |
| 类型与校验 | UTF-8 文本 | XML,DTD/RelaxNG 校验 |
| 兼容性 | Haskell、Hackage、Pandoc | XSL-FO、Pandoc、docbook-xsl |
| 最适合 | Haskell API 文档 | 书籍、手册、企业文档 |
如何将 Haddock 转换为 DBK
- 1
选择文件
选择你的 Haddock 文件。
- 2
立即转换
文件先转换成 Markdown(保留标题、列表与段落的中间格式),再重建为目标格式。
- 3
下载结果
下载 DBK——结构保留,复杂排版被简化。
关于 Haddock 格式
Haddock 是 Haskell 解释自己的方式:-- 注释块里的文档,用 '标识符链接'、@等宽@ 和 /斜体/ 标记,编译成 Hackage 上每个包都发布的 API 参考页。标记活在源码里,但格式自成一们小语言。
从源码注释里转出后,Haddock 文本变成普通结构化散文:Pandoc 把标题、代码块和标识符链接映射到 Markdown 或 HTML,API 知识得以进入手册、wiki 或静态站点生成器,无需重新打字。
+优点
- ✓文档与所描述的代码同处一地
- ✓跨 API 的标识符感知链接
- ✓整个 Haskell 生态的标准
!局限
- −只在 Haskell 项目里有意义
- −语法小,Haddock 之外输出器少
- −嵌在注释里——需先提取
关于 DBK 格式
DocBook 是工业技术出版所依赖的 XML 方案。它标记的不是外观而是语义:<chapter>、<section>、<para>、<figure>、<indexterm>。单一 DocBook 源可渲染成 PDF(FO 处理器)、HTML 帮助系统、EPUB 和印刷书——O'Reilly、Red Hat 以及几乎所有企业手册管线都依赖它,你 Linux 机器上的 man 页也源自同一血脉。
DocBook 的严谨就是它的重量:手写冗长,把内容搬进更轻的系统是常年的杂务。Pandoc 直接读取元素结构,书的一章能原样变成 Word 手稿或 Markdown 文档页——章节、表格、代码块完好——单源交付出去,编辑舒适度进来。
+优点
- ✓语义化、无外观耦合的唯一事实源
- ✓单源渲染出印刷、网页与 EPUB
- ✓数十年的企业级工具链
!局限
- −XML 冗长——手写痛苦
- −沉重的处理器工具链(XSL-FO)
- −比手册短的内容用它是杀鸡用牛刀
为什么把 Haddock 转换成 DBK?
可以把它理解为:把文件搬进更合适它的容器。只在 Haskell 项目里有意义DBK 的做法不同:语义化、无外观耦合的唯一事实源如果这听起来正是你要做的事,直接转——几秒钟,文件不离开你的设备。
常见问题
Haddock 转 DBK 真的免费吗?
完全免费,无需注册、无水印、也没有每日次数限制。网站依靠广告维持运营。
我的文件会被上传到服务器吗?
不会。转换通过 WebAssembly 完全在你的浏览器内完成,文件不会离开你的设备——这正是它既快又私密的原因。
Windows、Mac、iPhone、安卓都能用吗?
可以。任何装有现代浏览器的设备都适用:Windows、macOS、Linux、安卓和 iOS,无需安装任何软件。
Haddock 转 DBK 有文件大小限制吗?
由于不上传,唯一的限制是你设备的内存。现代桌面浏览器处理几百 MB 的文件都没问题,超大文件只是需要稍等片刻。
转换可以离线进行吗?
可以。页面加载完成后,转换完全在浏览器内运行——你甚至可以断网继续转换。任何文件都不会经过服务器。
转换出来的 DBK 之后还能编辑吗?
取决于目标格式:DBK 为自己的用途而生,本转换器忠实还原其内容,而不是凭空制造可编辑结构。需要大量再编辑时,请从面向编辑的格式入手,最后在这里导出终稿。