Розмістіть документ на GitHub

Рукопис LaTeX — це простий текст, що робить його ідеальним для Git. Кожна чернетка стає комітом, до якого ви можете повернутися, кожна зміна відображається як відмінність на рівні рядка, а GitHub надає вам зовнішню копію, а також спосіб для співавторів отримати поточний стан. Для цього не потрібен розширений Git. Папір потребує, можливо, п’яти команд, які використовуються послідовно.

Початкове налаштування

git init
# add a .gitignore for *.aux *.log *.out *.toc *.synctex.gz
git 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 також є продуктом збірки. Більшість команд залишають це і перебудовують локально, хоча прикріплення до випуску з тегами є розумним способом заморозити подану версію. Зберігайте репозиторій приватним, доки робота не стане загальнодоступною. Неопублікований рукопис не підлягає індексуванню.

Звички, які тримають співавторів здоровими

Внесіть до кожного коміту одну логічну зміну, наприклад «переглянути вступ до розділу 3» або «додати таблицю абляції». Тоді історія читається як історія газети, і невдале редагування можна скасувати без супутніх збитків. Потягніть перед тим, як почати сеанс письма, і натисніть, коли зупинитесь. Конфлікти злиття зростають із часом, який гілки проводять окремо. Ніколи не натискайте силою на спільну гілку, коли співавтори потягнули її: це переписує історію під їхніми ногами. Зберігайте великі бінарні артефакти (набори даних, відео) поза паперовим сховищем. Посилання на архів або використання окремого сховища даних. Git зберігає кожну версію кожного двійкового файлу назавжди.

Одна звичка, характерна для LaTeX: написання одного речення на вихідний рядок робить відмінності значно легшими для читання, тому що редагування з одного слова відображається як зміна в один рядок замість перекомпонованого абзацу.

Як Oleafly підходить

Кожен проект Oleafly — це звичайна папка на диску, тому ці команди працюють над ним без змін. Програма також може автоматично створювати коміти Git після кожної успішної компіляції, що дає вам чітку мережу безпеки між вашими навмисними комітами. Перегляньте історію Git. Для моделей співпраці, створених на основі цього, включно з обміном виправленнями та володінням розділами, див. Співавтор без живого курсору.