-
Notifications
You must be signed in to change notification settings - Fork 4
/
MdxSourceBuilder.vim
272 lines (241 loc) · 11.1 KB
/
MdxSourceBuilder.vim
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
" ======================================================
" MdxSourceBuilder 一键制作图片词典
" 原始词条 ==> 标准化词条 ==> mdx源文件 ==> mdx词典文件
" https://github.com/VimWei/MdxSourceBuilder
" ======================================================
"
" Quick Guide -------------------------------------------------------------{{{1
" 1. 准备好词条文件
" 2. 打开MdxSourceBuilder.vim，并配置好词典参数
" 3. 使用 :new 创建新文件，并执行 :bro so，找到 MdxSourceBuilder.vim
" 或者 :new 创建新文件，并执行 :so MdxSourceBuilder.vim
"
" Requirement -------------------------------------------------------------{{{1
" 1. 必须：安装Vim（官网下载 https://www.vim.org）
" 并在vimrc配置文件中添加一行 set encoding=utf-8
" * 仅能输出CSS文件和mdx源文件
" 2. 可选：安装对应版本的python（官网下载 https://www.python.org）
" 可选：安装 mdict-utilis：pip install mdict-utils
" * 能输出mdx和mdd词典文件
"
" 配置词典参数 ------------------------------------------------------------{{{1
" 拟输出的mdx源文件名称
let s:mdxSourceFileName = "火星词典.txt"
" CSS名称，其具体定义请查阅 MdxSourceBuilderCSS.vim
let g:CSSName = "MarsDict.css"
" 词条/图片名等的页码位数，默认为4，支持3及以上
let g:pageNumDigit = 4
" 词典模块及其配置信息，格式如下：
" \[dictionaryPart, picNamePrefix, picFormat,
" \sourceStyle, navStyle, locationPercent, nearestKeyword],
let g:dictionaryParts = [
\["火星词典.Cover.txt", "MarsDictCover_", ".png", 0, 2, 0, 1],
\["火星词典.Prefix.txt", "MarsDictPrefix_", ".png", 0, 2, 0, 1],
\["火星词典.Body.Part1.txt", "MarsDict_", ".png", 0, 2, 1, 1],
\["火星词典.Body.Part2.txt", "MarsDict_", ".png", 1, 2, 1, 1],
\["火星词典.Body.Part3.txt", "MarsDict_", ".png", 3, 2, 1, 1],
\["火星词典.Appendix.txt", "MarsDictAppendix_", ".png", 0, 1, 0, 1],
\["火星词典.Pinyin.txt", "MarsDict_", ".png", 2, 0, 0, 0],
\]
" dictionaryPart：词典各个模块的词条文件名称
" picNamePrefix：图片前缀名，不同词典模块通常会采用不同的前缀名
" picFormat：图片后缀名
" sourceStyle：定义兼容的词条格式（MdxSourceBuilderCore.Vim）
" - 0：'一行页码 + 多行关键词（每行一个关键词）'的标准词条格式，跳转至页码
" - 1：'一个页码 + 多个中文单字符的关键词'的压缩词条格式，跳转至页码
" - 2：'页码 + 分隔符 + 单个中或英关键词'的啰嗦行格式，跳转至页码
" - 3：'单个中或英关键词 + 分隔符 + 页码'的啰嗦行格式，跳转至页码
" navStyle：定义个性化的词条导航样式（MdxSourceBuilderCore.Vim）
" - 0：自身没有页面和keywords导航，仅转LINK，适用于拼音之类的辅助检索
" - 1：仅有页面导航，无keywords导航，简洁，适用于封面/附录之类的Affix
" - 2：不仅有页面导航，而且有keywords导航，适用于每页关键词很多的正文
" locationPercent：词条导航是否显示百分比定位信息
" - 0：不显示百分比定位信息
" - 1：显示百分比定位信息
" nearestKeyword：词条导航是否显示距本页最近的前/后一个词条
" - 0：不显示最近的前后词条，适合词条较多的情形
" - 1：显示最近的前后词条，适合词条较少情形下的跨页跳转
" 补充额外的mdx源文件，兼容多种风格的来源
let s:anyMore = 1
" 格式：\[anyMorePart, sourceStyle, pagePrefix],
let g:anyMoreSources = [
\["火星词典.Link1.txt", 104, ""],
\["火星词典.Link2.txt", 105, "MarsDict_"],
\["火星词典.Link3.txt", 998, ""],
\["火星词典.Link4.txt", 107, ""],
\["火星词典.Link5.txt", 106, "MarsDictPrefix_"],
\["火星词典.Link6.txt", 998, ""],
\["火星词典.Link7.txt", 0, "MarsDict_"],
\["火星词典.Link888.txt", 888, ""],
\]
" anyMorePart：源文件的名称，包括后缀名
" sourceStyle：定义兼容的源文件或词条格式（MdxSourceBuilderLink.Vim）
" - 0：固定项目，'一行页码 + 多行关键词（每行一个关键词）'的标准词条格式
" - 1：固定项目，'一个页码 + 多个中文单字符的关键词'的压缩词条格式
" - 2：固定项目，'页码 + 分隔符 + 单个中或英关键词'的啰嗦行格式
" - 3：固定项目，'单个中或英关键词 + 分隔符 + 页码'的啰嗦行格式
" - 888: 固定项目，用于快速手工添加链接词条，"现有关键词\t链接词条"
" - 998: 固定项目，源文件为标准的mdx源格式，但欠缺CSS文件等必要元素
" - 999：固定项目，源文件为标准的mdx源格式，无需进一步处理，直接使用
" - 其他: 定制化项目，自定义词条样式及处理程序，建议用101-199以示区别
" pagePrefix：按需可选；但当sourceStyle为0/1/2/3时，必须配置
" 自定义固定链接的导航：\[链接名称, 链接目标],
let g:customNavList = [
\["封面", "MarsDictCover_0001"],
\["扉页", "MarsDictCover_0002"],
\["版权", "MarsDictCover_0003"],
\["获奖", "MarsDictCover_0006"],
\["目录", "MarsDictPrefix_0001"],
\["凡例", "MarsDictPrefix_0003"],
\["上册", "MarsDict_0001"],
\["下册", "MarsDict_0100"],
\["附录", "MarsDictAppendix_0001"],
\["封底", "MarsDictAppendix_0021"],
\]
" 将.txt格式的mdx源文件打包为.mdx格式的词典文件
" 打包设为1，不打包则设为0
let s:autoMdxPack = 1
" - 0：不输出.mdx词典文件，需要另行用MdxBuilder 3.x等工具手工打包
" - 特点：mdx官方打包工具，对各种词典的兼容性最好
" - 缺点：对大文件支持不够好；需要手工打包
" - 1，使用 mdict-utils 自动打包生成.mdx词典文件
" - 特点：自动化、速度快、大词库、跨平台
" - 缺点：需要安装如下软件，并配置信息
" + 安装 与 Vim 匹配的 python 版本
" + 安装 mdict-utilis：pip install mdict-utils
" 自动打包图片等资源到mdd
" 打包设为1，不打包则设为0
let s:autoMddPack = 0
" 图片等资源相对于词典所在的目录
let s:imageFolder = "images"
" 主程序 ------------------------------------------------------------------{{{1
" ==================================
" * 以下为主程序，适合高级用户定制 *
" ==================================
" 初始化 ------------------------------------------------------------------{{{2
" 防止自加载
if expand("%:p:t") == "MdxSourceBuilder.vim"
echo "请先 :new 创建新文件，再执行 :so MdxSourceBuilder.vim"
finish
endif
" 清空历史消息
messages clear
" 设置当前工作目录为本文档所在目录
let s:home = fnamemodify(resolve(expand('<sfile>:p')), ':h')
silent! exe 'cd ' . s:home
echomsg "已设置工作目录为：" . s:home
" 保存mdxSource文件
try
silent! exe "write! " . s:mdxSourceFileName
catch
silent! exe "bdelete! ". s:mdxSourceFileName
silent! exe "write! " . s:mdxSourceFileName
endtry
" 重置info.title和info.description文件的编码为utf-8
if s:autoMdxPack == 1
silent! set fileformat=unix
silent! set nobomb
silent! set fileencoding=utf-8
" 设置info.title.html文件为utf-8格式
silent! 0,$d
silent! exe "read "
\. substitute(s:mdxSourceFileName, ".txt$", ".info.title.html", "")
silent! 0d
try
silent! exe "write! "
\. substitute(s:mdxSourceFileName, ".txt$", ".info.title.html", "")
catch
silent! exe "bdelete! "
\. substitute(s:mdxSourceFileName, ".txt$", ".info.title.html", "")
silent! exe "write! "
\. substitute(s:mdxSourceFileName, ".txt$", ".info.title.html", "")
endtry
" 设置info.description.html文件为utf-8格式
silent! 0,$d
silent! exe "read "
\. substitute(s:mdxSourceFileName, ".txt$", ".info.description.html", "")
silent! 0d
try
silent! exe "write! "
\. substitute(s:mdxSourceFileName, ".txt$", ".info.description.html", "")
catch
silent! exe "bdelete! "
\. substitute(s:mdxSourceFileName, ".txt$", ".info.description.html", "")
silent! exe "write! "
\. substitute(s:mdxSourceFileName, ".txt$", ".info.description.html", "")
endtry
endif
" 输出CSS文件 -------------------------------------------------------------{{{2
silent! set fileformat=unix
silent! set nobomb
silent! set fileencoding=utf-8
" 输出CSS文件：若已打开，则先关闭旧的，再保存新的
silent! 0,$d
silent! exe "read ". "MdxSourceBuilderCSS.vim"
silent! 0d
try
silent! exe "write! " . g:CSSName
catch
silent! exe "bdelete! ". g:CSSName
silent! exe "write! " . g:CSSName
endtry
silent! 0,$d
echomsg "已输出CSS，请查阅：" . getcwd() . "\\" . g:CSSName
" 输出MdxSource文件 -------------------------------------------------------{{{2
silent! set fileformat=dos
silent! set nobomb
silent! set fileencoding=utf-8
let g:mdxSource = ""
" 补充更多的Mdx源文件
if s:anyMore == 1
for anyMoreSource in g:anyMoreSources
echomsg "正在处理：" . substitute(anyMoreSource[0], ".txt", "", "")
silent! 0,$d
silent! exe "read ". anyMoreSource[0]
silent! 0d
source MdxSourceBuilderLink.vim
silent! 0,$d
endfor
endif
" 图片词典正文部分
for dictionaryPart in g:dictionaryParts
echomsg "正在处理：" . substitute(dictionaryPart[0], ".txt", "", "")
silent! 0,$d
silent! exe "read ". dictionaryPart[0]
silent! 0d
source MdxSourceBuilderCore.vim
silent! 0,$d
endfor
echomsg "正在生成 MdxSource 文件……"
let @x = g:mdxSource
silent! $put x
silent! global/^$/d
silent! write!
silent! noh
echomsg "已输出 MdxSource，请查阅: " . getcwd() . "\\" . s:mdxSourceFileName
" 输出mdx文件 -------------------------------------------------------------{{{2
" src: https://github.com/liuyug/mdict-utils
" Linux下的参数不用引号，但要将空格转义，以下代码供参考，未测试
" let s:mdxSourceFileName = substitute(s:mdxSourceFileName, "\\s", "\\\\ ", 'g')
if s:autoMdxPack == 1
echomsg "正在生成 Mdx 文件..."
silent! exe '!mdict'
\. ' --title "'
\. substitute(s:mdxSourceFileName, ".txt$", ".info.title.html", "")
\. '" --description "'
\. substitute(s:mdxSourceFileName, ".txt$", ".info.description.html", "")
\. '" -a "' . s:mdxSourceFileName . '" "'
\. substitute(s:mdxSourceFileName, ".txt$", ".mdx", "") . '"'
echomsg "已输出 Mdx，请查阅: " . getcwd() . "\\"
\. substitute(s:mdxSourceFileName, ".txt$", ".mdx", "")
endif
if s:autoMddPack == 1
echomsg "正在生成 Mdd 文件..."
silent! exe '!mdict'
\. ' -a "' . s:imageFolder . '" "'
\. substitute(s:mdxSourceFileName, ".txt$", ".mdd", "") . '"'
echomsg "已输出 Mdd，请查阅: " . getcwd() . "\\"
\. substitute(s:mdxSourceFileName, ".txt$", ".mdd", "")
endif
finish
/* vim: set et sw=4 ts=4 sts=4 fdm=marker ff=unix ft=vim fenc=utf8 nobomb: */