[feature] 分离学位论文的使用文档和示例文档，准备提交到CTAN

[AlexaraWu]

模板的使用文档语言表述零散，插入了较多的代码展示，用“学位论文”的样式来展示不合适。建议分离出来，形成独立的使用文档。

学位论文示例文档将用于演示排版中常用的例子，包括公式、表格、代码、数据图标等。示例文档将简化宏包的使用和描述，让用户直接到tex源文件中查看代码，并使用填充文字让整个文档看起来像一篇“真的”学位论文。

[weijianwen]

sjtuthesis.pdf 模版说明文档，拾取README.pdf中的使用说明。方便使用 texdoc sjtuthesis 查看。
thesis.pdf 示例文档。

参考资料：
"LATEX2ε for class and package writers" http://www.latex-project.org/guides/clsguide.pdf
"How to Package Your LATEX Package" http://texdoc.net/texmf-dist/doc/latex/dtxtut/dtxtut.pdf
"A1. DTX and INS Files" http://www.dickimaw-books.com/latex/novices/html/dtxins.html

[caesar0301]

啥时候能提交到CTAN，准备用这个写到论文啦

[weijianwen]

提交到CTAN上的内容和git仓库是一样的(sjtuthesis.cfg和sjtuthesis.cls)，现在就可以在master分支上开始撰写学位论文。

[caesar0301]

嗯我还以为是个类似于其他的一个引用包，现在就在用了。。多谢多谢

[facaiy]

确实，thesis.tex和tex/目录下的文件不好维护，论文书写肯定要改这些文件，但反馈时又要剥离，才适合提交。

可以考虑新建个How-to文件夹，在里面书写和维护说明文档，每次编译后推到主目录How-to.pdf。

还是挺麻烦。

[weijianwen]

正在准备 1.0rc 的工作。

[gaocegege]

如果我的理解正确的话, 这个工作可以分为两部分:

• 形成使用独立的使用文档, 而非使用学位论文的样式
• 为了提交到 CTAN, 实现 DTX 和 INS

这样说对么

FYI https://github.com/xueruini/thuthesis 可以作为参考实现

[AlexaraWu]

着手推进 1.0.0rc 工作，已在 develop 分支上初步实现了 .dtx 源文件，采用的是自解压模式，.ins 文件包含在 .dtx 文件中，如有需要可以拆离。

Makefile 做了一些相应的修改，目前可以使用以下命令生成模版和使用文档：

make doc

[gaocegege]

@AlexaraWu Awesome work!

最近几天在旅游，20 号以后我去试一哈

[AlexaraWu]

原文档拆分建议：

intro.tex      (这是什么)
app_log.tex    (模板更新记录)

以上文件内容移入使用文档 sjtuthesis.pdf；

faq.tex        (常见问题)
app_setup.tex  (搭建模板编译环境)

以上文件内容移入 Wiki；

app_cjk.tex    (从 CJK–LaTeX 转向 XeTeX)

个人认为此章内容已经过时，可以删去。

@gaocegege @goodbest @at15

[gaocegege]

SGTM

[at15]

有个小问题，windows 用户还是可以 compile.bat 直接用么? 另外用 cgwin 和 linux subsystem 的人会不会遇到密汁bug? 没人试的话我晚上玩游戏的时候试一下 ....

[AlexaraWu]

@at15 用不了，compile.bat 我暂时还没改。你可以先使用命令：

latexmk -xelatex sjtuthesis.dtx     

生成使用文档 sjtuthesis.pdf 和模版 .cls & .cfg。

[at15]

@AlexaraWu 没事....我 windows 只是用来玩游戏的 ... 等有 windows 的同学出现再说吧，不过可以顺手加到 wiki 或者文档里? 其他我就 LGTM 了

[gaocegege]

@AlexaraWu 拆分在这个 PR 里做么

[AlexaraWu]

@gaocegege 嗯，更新记录我已经移过去了。

[gaocegege]

Any progress here?

[AlexaraWu]

@bubifengyun WIP，暂时不要用 develop 分支。我争取这周内搞出来。

@gaocegege master 分支的 cls 和 cfg 在重构完成前暂时冻结吧。

[gaocegege]

@AlexaraWu 好的

[AlexaraWu]

代码重构接近完成了，大家有兴趣的可以帮忙测试一下。详细改动我有空再说明。

[gaocegege]

这两天我来测试一下 Windows 和 Linux

[AlexaraWu]

代码重构基本完成了，简要说明一下用户层面的改动：

• 使用 kvoptions 宏包设置、处理文档选项，新增 degree、language、bibstyle 选项，移除 submit；
• 非核心宏包移入 sjtuthesis.sty。并根据 @zepinglee 的建议 ([feature][feasibility research] 利用 ctexhook 对额外的包提供支持 #379)，利用 ctexhook 在模版中加入一些额外的宏包的设置。这些设置只会在检测到相应宏包被调用才加载；
• 一些环境、命令重命名：makeDeclareOriginal --> makeDeclareOriginality，thanks --> acknowledgements，thm --> theorem，advisor --> supervisor，nomenclaturename --> nomenclature；
• 将选项的判断置于模版内部，致谢、简历等环境在盲审模式下自动隐藏，应当避免在主文档中使用条件判断；
• \makeDeclareOriginality 和 \makeDeclareAuthorization 现在接受一个可选参数，为需要插入的扫描版 PDF 的路径。没有参数时生成空白声明，盲审模式下不起任何作用；
• 重新设置了目录和页眉页脚的样式，使得与 Word 模版更为接近，插图目录、表格目录等不再加入目录；
• 使用 ntheorem 替换 amsthm 生成定理环境，这两个宏包功能大致相当，但 ntheorem 没有与字体相关宏包的冲突问题；
• 代码环境基于 listings 宏包重新设计一个更加简单的 codeblock 环境，接受一个可选参数为语言格式，代码环境不再添加题注和行号。

[zepinglee]

话说 acknowledgements 在美国英语中的拼法是 acknowledgments，没有那个 e

[zepinglee]

感觉 \makeDeclareOriginality 和 \makeDeclareAuthorization 读起来怪怪的，\declareOriginality \makeAuthorization 更符合语法

[AlexaraWu]

本来也不是我起的，估计原来起这个名的是受 \maketitle 的影响吧；真用 make 开头的话就是 \makeDeclarationOfOriginality 了。

[AlexaraWu]

@gaocegege 大体完成了，生成的使用文档 sjtuthesis.pdf。

[stone-zeng]

\ref{tab:files} 后面少了空格

还有：

SJTUThesis/sjtuthesis.dtx

Line 218 in 52859e2

% 第~\ref{sec:howtoask}节说明提问，有兴趣者都可以参与完善此手册，也非常欢迎对代

[stone-zeng]

另外这边 sjtuthesis-bachelor.ltx 和 sjtuthesis-graduate.ltx 为什么要用 .ltx 做后缀名？作为配置文件感觉并不是很合适，个人建议直接用 .tex。

以及，既然是生成的文件，是不是可以考虑移出 git repo，或者单独扔到一个文件夹里面？

[zepinglee]

@stone-zeng 你也在 watch 这个 repo……感觉可以联合起来实现 stone-zeng/fduthesis#42 了，我可以代表 USTC 和 THU

[AlexaraWu]

@stone-zeng 本来是用 .tex 的，不过想和其他的 .tex 文件有所区别，所以改成 .ltx 了。我自己也觉得 .ltx 怪怪的，下次改成 .def 好了。
现在这个分支算是 1.0 的预览版，还有很多地方要改，生成的文件暂时先放在里面。

[hushidong]

联合是好事，弄个高校联盟模板出来。

[gaocegege]

From @AlexaraWu

嗯，剩下的基本就是文档、readme 这些，还有 wiki 要整理一下，模版本身我觉得差不多了。

先 Merge 这个 PR 了，后续的工作可以迭代着来 fix。终于，我们迎来了 1.0.0 RC

@AlexaraWu Thanks for your contribution! 🎉 👍

也谢谢 @zepinglee @stone-zeng @hushidong 的 review 和评论

[bubifengyun]

研究生论文页眉如上所说，改了哦。没有找到各个学院的word模板。