Home

Tricks on Using DLMUTHESIS

自本仓库开张以来，一直在纠结是否要经营对应的 wiki。考虑到的问题主要有两个：

1. wiki 到底能发挥什么作用；
2. wiki 是否能担当起它所声明的作用。

" wiki 到底能发挥什么作用 "：在部分开源项目中，wiki 充当了项目的说明文档、提供环境配置、API 介绍、常见问题解答等内容。然而，本项目却内置了PDF格式的说明文档、将上述要素基本覆盖。这是因为用户们要么在电脑本地写LaTeX、要么到 Overleaf 等在线编辑器中写，这种情形下，写着写着还得翻看 wiki 是较为折磨的。

" wiki 是否能担当起它所声明的作用 "：这一点相当于 wiki 内容的质量问题。一旦正式经营起 wiki，日后 DLMUTHESIS 的维护除了主仓库外又多了一样东西。一方面，涉及到“牵一发而动全身”的内容修改是较有压力的；另一方面，一旦因为疏忽而导致 wiki 这边的内容在表述上不正统，或存在漏改、错改，则可能会给用户们的参考带来各种隐患。

不过，随着遇到越来越多的 LaTeX 开源项目后，对专属于 LaTeX 模板的 wiki 的定位逐渐有了头绪：

1. 内置的说明文档虽然尽可能写明了 LaTeX 环境配置、命令使用等必要或重要内容，但对于一些关键需求（例如，VSCode上的LaTeX环境具体怎么搭建，常见命令/环境的变体具体怎么用），所提供的参考资源或未能细致介绍、或不直接适用于DLMUTHESIS、或相对过时。这时，wiki 便能辅助现有的说明文档，将这类需求的解决方案讲细。

   一句话概括：给一些权威资源“填坑”，将一些官方用法“本土化”。

2. DLMUTHESIS 的示例在尽可能还原原有论文规范各要素的基础上，额外补充了一些常见要素的编写示例（例如，多图排列、伪代码、程序代码）。但这里的“常见”是稍显主观的，因为一方面，要考虑到项目文件的代码量要尽可能轻量、不罗嗦；另一方面，不同学科、甚至不同用户可能有专属的要素要实现（例如，工程的同学想画花电路图/交换图，生化环材的同学想写化学方程式）。这时，wiki 便能适当的去解决这些情形、让有所需求的用户真的“拿来就用”。

   一句话概括：主动给一些特殊需求"开小灶"。

现在有感：不如直接实践，让用户们来“考验”真理。于是基于上述思考，初步打算启用DLMUTHESIS 的 wiki。围绕 “tricks（技巧）”，逐步实施：

• 补充DLMUTHESIS使用中的细节；
• 补充关联学科的需求实现；
• 扩展一些有关的外部工具的使用。

与此同时，郑重建议：

• 由于能力受限，不可避免的会出现不正统的表述。因此希望用户们批判地使用。
• 不要“贪快”而放弃表面篇幅大的高质量资源。“有二十年功夫的一拳”还是值得研究的。