Use article link markers for PDF indexing
This commit is contained in:
1 parent
09af3bd8c0
commit
33f15d9ce0
20 files changed
+1137
-293
No files matched your search
+49
-3
@@ -6,6 +6,46 @@ OpenPGP 签名。
|
||||
|
||||
## 代码目录
|
||||
|
||||
开发文档:
|
||||
|
||||
- [文档输入输出接口开发指南](docs/document-api.md):HTML 中间表示、接口契约与扩展示例。
|
||||
- [build.js 开发指南](docs/build-js.md):执行时机、注入对象、DOM 修改和配置传播边界。
|
||||
- [转换流程 draw.io 源图](docs/diagrams/document-workflow.drawio)
|
||||
- [build.js 流程 draw.io 源图](docs/diagrams/build-js-workflow.drawio)
|
||||
|
||||
文档转换统一使用 HTML 中间表示,公共接口从 `document/mod.ts` 导出:
|
||||
|
||||
```text
|
||||
DocumentInput.read() → HtmlDocument → DocumentOutput.write() → OutputResult
|
||||
```
|
||||
|
||||
`PublicationInput` 读取出版物并渲染 Markdown 和模板变量;`HtmlInput` 接收已有的
|
||||
`HtmlDocument`,无需读取 Markdown 文件。中间文档包含出版物元数据、按顺序排列的
|
||||
HTML 章节(ID、标题、专栏、来源路径)、资源基址,以及封面、样式和前后附加内容。
|
||||
章节 HTML 保留原始资源引用,不含 PDF 定位标记。
|
||||
|
||||
`TextOutput` 支持 HTML、Markdown、TXT;`PdfOutput`
|
||||
负责浏览器排版、目录和后处理; `EpubOutput`
|
||||
负责章节链接和资源打包。图片嵌入和格式专用标记在输出端处理。 现有 Builder
|
||||
方法保留作兼容入口,新代码建议使用以下接口:
|
||||
|
||||
```ts
|
||||
import {
|
||||
convertDocument,
|
||||
PublicationInput,
|
||||
TextOutput,
|
||||
} from "./document/mod.ts";
|
||||
|
||||
const input = new PublicationInput(config, variables);
|
||||
const result = await convertDocument(input, new TextOutput(config, "html"));
|
||||
console.log(result.path, result.mediaType);
|
||||
```
|
||||
|
||||
同一份中间文档可交给多个输出端。新增输入实现
|
||||
`DocumentInput.read()`,新增格式实现
|
||||
`DocumentOutput.write()`,无需修改其他格式。输出接口不修改传入的中间文档。
|
||||
HTML、TXT 可分别配置 `html.path`、`txt.path`;未配置时从 `md.path` 派生。
|
||||
|
||||
`main.ts` 保留为命令入口,配置和输出路径仍相对于 `tools/gp` 工作目录解析。
|
||||
各模块的测试与实现放在同一目录:
|
||||
|
||||
@@ -126,8 +166,8 @@ Markdown 和 HTML 导出会将本地图片嵌入为 Base64 data URL。EPUB 不
|
||||
而是将图片作为 EPUB 包内资源保存并从章节引用,兼容 EPUB 阅读器的资源模型。
|
||||
|
||||
EPUB 默认使用 `md.path` 将扩展名替换为 `.epub`;也可在每个配置中设置
|
||||
`[settings.epub]` 的 `path`、`title`、`author` 和 `language`。每篇文章会拆成独立章节,
|
||||
EPUB 导航目录按出版物排序链接到各章节。
|
||||
`[settings.epub]` 的 `path`、`title`、`author` 和
|
||||
`language`。每篇文章会拆成独立章节, EPUB 导航目录按出版物排序链接到各章节。
|
||||
|
||||
### 本地素材缓存
|
||||
|
||||
@@ -223,7 +263,13 @@ draft = false
|
||||
地址,默认值为 `../../assets`。例如 Markdown 中的 ``
|
||||
会从该目录读取,不需要单独启动附件文件服务器。
|
||||
|
||||
目录搜索策略可以在模板的 `build.js` 中通过 `cfg.indexSearch` 调整。默认是
|
||||
PDF 目录优先读取文章标题或首段上的唯一链接标记
|
||||
`https://wpep.invalid/article-start-编号`,直接取得起始页码;标记齐全时不会提取或搜索正文。
|
||||
合并目录时会删除这些临时链接注释及其 URL,保留标题文字和文章中的普通链接,
|
||||
并将目录链接、PDF 书签指向插入目录后的对应页面。
|
||||
|
||||
只有缺少标记的文章才回退到标题全文搜索(例如处理旧
|
||||
PDF)。回退搜索策略可以在模板的 `build.js` 中通过 `cfg.indexSearch` 调整。默认是
|
||||
`single_jump`:逐页扫描,每页只读取一次页面文本,并匹配该页上所有尚未匹配的文章;未匹配到标题的页面不会中断后续查找:
|
||||
|
||||
```js
|
||||
|
||||
Reference in new issue
Block a user