把論文放上 GitHub
初始化、忽略 aux 檔案、私人儲存庫,以及讓共同作者合併不抓狂的習慣。
把論文放上 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 附在有標籤的發行版本(release)上,是凍結已投稿版本的合理做法。在作品公開之前,請讓儲存庫維持私人狀態。尚未發表的稿件不該被索引。
讓共同作者保持理智的習慣
讓每個提交只包含一項邏輯上的修改,例如「修訂第 3 節引言」或「新增消融實驗表格」。這樣歷史記錄讀起來就像這篇論文的故事,而且有問題的修改可以還原,不會牽連其他東西。開始一段寫作之前先提取,停下來的時候再推送。分支分開的時間越久,合併衝突就越多。共同作者提取過共用分支之後,絕對不要強制推送:那會在他們腳下改寫歷史。大型二進位成品(資料集、影片)不要放進論文儲存庫。改用連結指向某個封存位置,或另外使用專門放資料的儲存庫。Git 會永遠保存每個二進位檔案的每一個版本。
還有一個專屬於 LaTeX 的習慣:原始碼每一行只寫一句話,會讓差異比對的可讀性大幅提高,因為只改一個字,顯示出來就只是一行的變動,而不是整段重新折行。
Oleafly 如何配合
每個 Oleafly 專案都是磁碟上的一般資料夾,所以這些指令不用修改就能直接使用。Oleafly 會把原始碼有變動、符合條件的成功建置保存在已儲存的檢查點中,與 Git 分開。請在原始檔控制中有意識地進行提交,再與你的協作者推送或提取。請見 Git 歷史記錄。若想了解建立在此基礎上的協作模式,包括交換修補檔與章節歸屬,請見沒有即時游標也能共同撰寫。