把论文放到 GitHub 上
初始化、忽略辅助文件、私有仓库,以及让与共同作者的合并保持顺畅的习惯。
把论文放到 GitHub 上
LaTeX 稿件是纯文本,这使它非常适合用 Git 管理。每一份草稿都是一次可以回到的提交,每处改动都以逐行差异的形式清晰可见,GitHub 还为你提供一份异地备份,并让共同作者能拉取最新状态。这一切都不需要高深的 Git 知识。一篇论文大概只需要五条命令,坚持用就行。
初始设置
git init# add a .gitignore for *.aux *.log *.out *.toc *.synctex.gzgit add main.tex refs.bib figures/git commit -m "Initial manuscript"gh repo create my-paper --private --source=. --push在项目文件夹里运行一次即可。.gitignore 这一步比看上去重要得多。每次编译都会重新生成 .aux、.log、.out、.toc 和 .synctex.gz 文件,提交它们会把你真正的改动埋在机器产生的噪音之下,还会在共同作者之间造成毫无意义的合并冲突。只跟踪你亲自写的东西:.tex 源文件、.bib 数据库、图,以及发表渠道给你的任何文档类或样式文件。PDF 同样是构建产物。多数团队不提交它,而是在本地重新构建,不过把一份 PDF 附加到带标签的发布版本上,是冻结已提交版本的合理做法。在工作公开之前,让仓库保持私有。未发表的稿件不该被索引。
让共同作者保持理智的习惯
让每次提交只包含一项逻辑上的改动,比如“修改第 3 节引言”或“添加消融实验表”。这样历史记录读起来就像论文的故事,一次糟糕的编辑也可以被撤销而不波及其他。开始一次写作之前先拉取,结束时再推送。合并冲突会随着分支分开的时间而增多。共同作者一旦拉取了某个共享分支,就永远不要对它强制推送:那会在他们脚下改写历史。不要把大型二进制文件(数据集、视频)放进论文仓库。链接到归档,或者用一个单独的数据仓库。Git 会永远保存每个二进制文件的每个版本。
有一个专属于 LaTeX 的习惯:源文件里每行只写一句话,能让差异(diff)可读得多,因为改一个词只显示为一行的改动,而不是整段被重新排版。
Oleafly 如何融入其中
每个 Oleafly 项目都是磁盘上的普通文件夹,所以这些命令可以原样使用。Oleafly 会把源文件有变化且符合条件的成功构建保存到已保存的检查点中,与 Git 彼此独立。在源代码管理中主动提交,然后与协作者推送或拉取。参见 Git 历史。关于在此基础上的协作方式,包括补丁交换和章节归属,参见没有实时光标也能合著。