PhysWikiScan 是小时百科 wuli.wiki 文章编辑器后台负责把 latex 转换为 html 的程序。 一般需要另外一个仓库 PhysWiki， 一般和 littleshi.cn 和 PhysWiki （非开源）仓库放在同一个目录。
设置路径
- 在
set_path.txt中设置输入路径和输出路径（一般不用设置）。 - 输入路径可以是
PhysWiki文件夹， 只会读取所有.tex文件。main.tex文件用于生成目录。 - 在任何命令最后放
--path 数字可以指定set_path.txt中的某套路径和 url 设置。 - 若不指定
--path则默认使用--path 0。 - 在命令最后放
--path-user 用户id或者用户id/changed可以指定某个用户笔记文件夹（../user-notes/用户id/changed）， 使用用户id/online则可以把子目录/changed改为/online（发布）。 最后可以加一个/也可以不加。 - 也可以通过
--path-in-out-data-url 输入路径 输出路径 数据文件路径 url来指定输入，输出路径，和数据文件路径，网页所在 url 路径（如http://wuli.wiki/online/， 也可以为空， 用于文章，公式，图片，脚注等链接）。 该选项必须出现在命令最后， 不能和--path混用。 - 路径可以是绝对路径或相对路径（相对于当前路径）
日常命令
- 如果不输入任何参数， 程序运行后会提示从命令行输入参数。
--version显示版本.把全部contents/*.tex文件转换为online/*.html， 并使用main.tex生成完整目录index.html。main.tex中不存在的文章也会被转换（将警告）。--titles: 扫描所有 tex 文件， 扫描main.tex， 更新数据库。--toc: 生成完整目录index.html， 更新数据库。--toc-all: 检查所有 tex 文件，并使用--toc--tree: 生成dep.json文件用于知识树。--entry 文章1 文章2 ...：转换contents中指定的文章文章1.tex 文章2.tex ...。--autoref 文章 eq 8查找contents/文章.tex文章的网页公式序号8是否定义了\label{xxx}。 如果 label 不存在， 就试图对被引用的公式插入唯一的\label{eq_文章_*}， 把 labelxxx输出到命令行再另起一行输出added， 更新数据库。 如果 label 已经存在， 就直接把 label 输出到命令行且输出exist。 该功能一般被编辑器的 “引用” 按钮调用。--autoref-dry 文章 eq 8和上一条一模一样， 除了不会真的给文章文件添加 label。--backup 文章 作者id把contents/文章.tex备份到../PhysWiki-backup/YYYYMMDDHHMM_作者id_文章.tex， 若 hash 已经在数据库中则不备份并输出exist 已存在的文件名 history.id。 同一文章同一作者，若距离上次备份超过 30 分钟，则使用当前时间， 否则增加到上次备份时间加五分钟的整数倍，若已经存在，则覆盖。 如果新增了文件和记录，就会在 stdout 输出added 文件名 history.id； 若替换了文件和记录，就会输出replaced 文件名 history.id。--bib通过bibliography.tex生成文献列表bibliography.html， 更新数据库。--delete 文章1 文章2 ...相当于先把文章除了前两行的注释外的内容都清空，编译一次（如果其定义的标签等被引用，就会报错）。 然后检查是否文章本身被别处\upref， 如果有就报错。 确保和最后一次备份的 hash 相同， 否则就增加一个备份。 最后更新entries.deleted， 删除文章文件。--delete-cleanup（--delete本身就要求包含这些功能）删除数据库中已删除词条的 label，ref 等残留记录，删除 online/changed 中的相关文件。--delete-hard 文章1 文章2 ...如果文章没有标记删除就先使用--delete 文章， 然后删除指定文章所有数据和相关文件和备份（在多个文章之间共享的除外）。--delete-figure 图片1 图片2 ...删除数据库中已经被标记figures.deleted的图片以及所有相关images和图片文件。
批量修改文章文件
--inline-eq-space批量把 tex 文件中的行内公式两边添加空格（如果是中文）（有少量 bug，碰到会自动跳过该文章）,批量把正文中汉字两边的英文标点变为中文（有少量 bug，碰到会跳过该文章）--check-url 文章1 文章2 ...会转换输出路径中文章1.html 文章2.html的所有http开头的链接是否可以正常访问。 含wikipedia.org的除外。 如果不输入文章1 文章2 ...则检查输出目录中的所有html文件。--check-url-from 文章1检查输出目录的所有html文件， 但从文章1开始。- 【暂不使用】
--hide 文章把文章中的公式和代码全部替换成$四位编号$以及\verb|四位编号|, 防止 google 翻译改写。 数据写入eq_list.txt和verb_list.txt， 编号对应 txt 中的行号（从 0 开始） - 【暂不使用】
--unhide 文章把文章中的公式和代码恢复。
统计与数据库更新
--wc统计中文字符数（含标点）--history-all把../PhysWiki-backup/*.tex备份文件信息更新到数据库。 更新entries.authors，history.last， 未计算的history.add/del。 若在--history-all后面加一个任意参数， 则重新计算所有history.add/del。--stat yyyymmddhhmm yyyymmddhhmm统计一段时间内所有作者的贡献详情--author-char-stat yyyymmddhhmm yyyymmddhhmm 用户名统计某个作者在某段时间内（包括）的字符数增减（数据库 history.add/del）--history-normalize有时候编辑器不到 5 分钟就会产生备份（并非 bug）， 该功能把备份删除或重命名以模拟 5 分钟备份， 半小时不编辑重新开始计时。--fix-db重新生成数据库中标记为【生成】的数据（用于 debug）。--migrate-db /path/data1.db /path/data2.db用于把某个旧的数据库迁移到新格式的数据库中，data2.db将被覆盖。--migrate-user-db用于把../user-notes/用户名/cmd_data/scan.db转换为../user-notes/note-template/cmd_data/scan.db的格式。--all-users编译所有用户的笔记， 输出到用户的changed文件夹。 用--all-users-online输出到online文件夹。- 脚本
db_dump.sh用于备份数据库，db_restore.sh用于恢复（需要安装sqlite3）。 - 程序只会输出
html和图片文件到输出路径（覆盖同名文件）， 不会改变其他文件。 - 程序默认输出到
stdout， 如果有错误， 会输出到stderr。