Як вичитувати LaTeX-статтю в Overleaf (не порушуючи математику)

Ви закінчуєте писати свій документ NeurIPS о 4 ранку та вставляєте його в граматичний інструмент. Половина ваших «помилок» — це LaTeX команди, які інструмент не розпізнає. Три з ваших міток рівняння тепер пошкоджено. Розділ посилань «поліпшили» до нісенітниці. Ви повертаєте все назад і надсилаєте статтю невідредагованою, оскільки крайній термін через шість годин.

Це типовий досвід LaTeX-і-коректора. Інструменти граматики загального призначення не розроблені для вихідних файлів, змішаних із розміткою. Хороші новини: за правильного робочого процесу перевірка ШІ на LaTeX є простою та безпечною. Головне — знати, що надіслати коректору, а що залишити, як розділити документ на частини, щоб контекст залишився недоторканим, і як повернути редагування назад у файли .tex, не порушуючи компіляції.

Чому LaTeX важкий для інструментів загальної граматики

Проблема проста: більшість граматичних інструментів читають ваш текст як прозу. Вихідні файли LaTeX не є прозою. Вони являють собою суміш прози, структурних команд, математичних виразів, цитат і посилань. Інструмент, який не розуміє структуру, сприймає команди як слова та намагається їх «виправити».

Three things typically break:

Математичні вирази перефразуються. Вбудована математика, як-от $\alpha < 0,05$, стає «альфа меншою за нуль кома нуль п’ять» або ще гірше, стає «спрощеною» до нісенітниці. Відображення математики в блоках \begin{equation}...\end{equation} розглядається як абзац, який інструмент хоче змінити.

Команди цитування спотворюються. \citep{smith2023} стає \citep smith2023, [smith2023] або навіть «розширюється» на вигадані імена авторів. Посилання мовчки розриваються, і ваш документ більше не компілюється.

Структурні команди переписано. \section{Methods} стає \section {Methods}. \textbf{результат ключа} стає \\textbf{результат ключа} після «виправлення» escape-символу. Результатом є помилки компіляції, і відстеження того, яке «виправлення» порушило роботу, є болісним.

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

Що слід копіювати, а що залишити

The basic rule: copy the words; leave everything that's a command, label, citation, or math.

Copy this:

We extend prior work on neural transformer architectures by introducing
a sparse attention mechanism that scales linearly with input length.
Our experiments on the standard benchmarks show consistent improvements
over the current state-of-the-art.

Don't copy this (in the same file):

\section{Introduction}
\label{sec:intro}

\input{intro_v3}

\begin{equation}
\mathcal{L}(\theta) = -\sum_{i=1}^{N} \log p_\theta(y_i | x_i)
\label{eq:loss}
\end{equation}

As shown in Equation~\ref{eq:loss}, the loss function...
\citep{vaswani2017attention,brown2020language}

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

На практиці ви копіюєте прозу абзац за абзацом (або розділ за розділом), редагуєте його ззовні, а потім вставляєте зміни назад у той самий абзац у вашому файлі .tex. Ви не змінюєте виклики \section{}, \label{}, \input{}, блоки рівнянь і \citep{}.

The chunking strategy

12-сторінкова стаття LaTeX — це не один прозовий документ — це 15-20 фрагментів прози, розділених розміткою. Правильна деталізація для вичитки – це розмір підрозділу: 200-500 слів на фрагмент.

Один розділ за раз є найкращим місцем. Менші фрагменти (один абзац) втрачають міжабзацний контекст — перехід, який добре звучить ізольовано, може бути неправильним у контексті. Більші фрагменти (весь папір) втрачають точність — коректор обробляє 500 слів краще, ніж 5000.

Розділи методології та результатів, можливо, потребуватимуть дрібнішого фрагментування. Вони, як правило, чергують прозу з математикою та таблицями. Фрагмент перед кожним блоком рівняння, після кожної таблиці, між підрозділами. Зберігайте фрагменти прози безперервними, де це можливо.

Анотація та висновок розглядаються як повний документ. Зазвичай вони короткі (200–400 слів) і їх потрібно читати зв’язно як окремі частини. Відредагуйте кожен як один фрагмент.

Підписи є окремими фрагментами. Підписи до малюнків і таблиць слід редагувати окремо. Вони часто досить короткі, щоб зробити їх швидко, і їх зазвичай пропускають під час пропусків на рівні секції.

Прагніть отримати приблизно 8-15 фрагментів для типової статті для конференції, 20-30 для журнальної статті, 50-100 для розділу дисертації.

Round-tripping edits back into LaTeX

На етапі реінтеграції більшість робочих процесів порушується. Кілька звичок роблять це безпечним.

Використовуйте інструмент diff, а не очні яблука. Вставте свій оригінальний фрагмент прози та відредаговану версію в переглядач відмінностей (будь-який пристойний текстовий редактор має вбудований; функція історії Overleaf також працює). Різниця підкреслює кожну зміну. Застосуйте кожну зміну вручну до вихідного файлу, зберігаючи навколишню розмітку.

Застосовуйте зміни по одному абзацу. Не вставляйте пакетно довгий відредагований розділ у вихідний код. Застосовуйте його абзац за абзацом, перевіряючи компіляцію після кожного значного абзацу. Якщо щось зламалося, ви зламали один абзац, а не весь розділ.

Стежте за спеціальними символами. Відредагований штучним інтелектом текст іноді повертається з розумними лапками (фігурні " замість прямих "), тире (— замість --) або нерозривними пробілами. Вони можуть некоректно відображатися в LaTeX. Перехід пошуку та заміни після редагування ловить їх.

Перевірте узгодженість \label{} і \ref{}. Якщо коректор дещо змінив формулювання навколо посилання Section~\ref{sec:methods}, переконайтеся, що цільове посилання все ще має сенс у контексті.

Компілювати після кожного розділу. Це звучить надмірно. Це не так. Зламаний документ о 3:00 перед надсиланням набагато гірший, ніж п’ять додаткових клацань компіляції під час редагування.

Робота з математикою без руйнування ваших рівнянь

Math is the highest-risk area. The rule is simple: never send math to a proofreader.

Вбудовані обчислення ($...$) залишаються у вихідному файлі. Коли ви копіюєте абзац для редагування, замініть вбудовані обчислення заповнювачем, як-от [MATH1], [MATH2]. Відредагуйте прозу навколо заповнювачів. Під час реінтеграції відновіть вихідну математику.

A paragraph like:

We define the loss as $\mathcal{L}(\theta) = -\sum_{i=1}^{N} \log p_\theta(y_i | x_i)$, where $\theta$ are the model parameters and $N$ is the batch size.

Becomes for editing:

We define the loss as [MATH1], where [MATH2] are the model parameters
and [MATH3] is the batch size.

Редагує прозу коректор. Ви відновлюєте математику під час реінтеграції.

Математичне відображення (\begin{equation}...\end{equation}) повністю виключено. Відредагуйте абзаци перед і після; залиште блок рівнянь недоторканим.

Посилання на рівняння (Equation~\ref{eq:loss}) є складними. Якщо ви використовували заповнювач для вбудованих математичних обчислень, також використовуйте заповнювачі для посилальних команд: як показано в [REF1]. Потім відновити.

Статистичні вирази в прозі є особливим випадком. Щось на зразок (p < 0,001) у прозі технічно є математикою, але рідко використовує синтаксис відображення. Якщо ви пишете (p < 0,001), використовуючи сутність HTML, щоб уникнути проблем із MDX, це інша проблема, ніж LaTeX. У джерелі LaTeX (p < 0,001) підходить; просто включіть його у свою систему заповнювачів, якщо ви не хочете, щоб коректор переписував його.

Відстежені зміни для співавторів, які не використовують LaTeX

Справжня проблема робочого процесу: ваш консультант не читає джерело LaTeX. Їм потрібен документ Word із відстежуваними змінами.

Стандартним рішенням є pandoc. Зкомпілюйте свій LaTeX у файл .docx, надішліть своєму консультанту, отримайте відстежені зміни назад, вручну застосуйте зміни до свого джерела .tex. Це працює, але повільно.

Найшвидше рішення — спочатку виконати редагування. Вставте фрагменти своєї прози в наш коректор зі штучним інтелектом і експортуйте відстежені зміни у .docx для кожної частини (або для зібраної прози). Надішліть це своєму консультанту для перевірки. Вони розмічають файл відстежених змін власними доповненнями. Ви застосовуєте комбіновані прийняті зміни до свого джерела LaTeX.

Це замінює два кроки інтеграції вручну на один. Перша інтеграція (редагування коректором у LaTeX) є механічною та швидкою. Друга інтеграція (доповнення радника) — це та сама робота, яку ви б виконували в будь-якому випадку.

Для співавторів, які читають LaTeX, використовуйте latexdiff. Це створює паралельне порівняння двох версій .tex із позначеними вставками та видаленнями. Він компілюється в PDF-файл, який візуально показує відстежені зміни. У поєднанні з пропуском редагування прози це найпростіший спосіб поділитися змінами з колегами, які вільно володіють LaTeX.

The full workflow, compressed

Ось послідовність у 90-секундному підсумку, який можна записати на монітор.

1. Відкрийте свій файл .tex у Overleaf або у локальному редакторі.
2. Для кожного фрагмента прозового тексту (зазвичай на рівні підрозділу, 200–500 слів): a. Скопіюйте прозу. Замініть вбудовану математику на плейсхолдери. b. Вставте в редактор-перевіряльник. Запустіть стандартний раунд редагування. c. Перегляньте відстежені зміни; прийміть або відхиліть кожну. d. Відновіть плейсхолдери для математики. e. Застосуйте правки абзац за абзацом до джерела .tex. f. Зберіть/скомпілюйте проєкт. Переконайтеся, що нічого не зламалося.
3. Повністю пропускайте блоки рівнянь.
4. Редагуйте підписи окремими невеликими фрагментами.
5. Остаточна компіляція. Переконайтеся, що посилання все ще коректно розв’язуються.
6. Якщо надсилаєте непрофільному для LaTeX співпрацівнику, експортуйте відстежені зміни .docx з редактора-перевіряльника для прози й надішліть їх. Якщо надсилаєте співпрацівнику з LaTeX, згенеруйте PDF latexdiff для перевірки.

12-сторінкова доповідь на конференції займає приблизно 90 хвилин. Розділ дипломної роботи займає 3-5 годин. Обидва вони швидші, ніж виправлення зламаного LaTeX після наївного вставлення — все пройде, а якість редагування набагато вища.

Щодо статей, які готуються до подання, також перегляньте наш посібник із супровідного листа до журналу — супровідний лист зазвичай потребує більше уваги, ніж приділяють йому автори, особливо для місць, де перші 60 секунд редактора вирішують вашу долю.

Frequently asked questions

З: Чи має Overleaf вбудований засіб перевірки граматики, який правильно обробляє LaTeX?

Overleaf комплектує Writefull, який підтримує LaTeX та знаходиться в редакторі Overleaf. Безкоштовна інтеграція обмежена; платний Writefull Premium розширює його. Для порівняння Writefull та спеціальної платформи коректури див. ProofreaderPro проти Writefull. Коротка версія: якщо ви пишете переважно мовою LaTeX і ваші потреби редагування стосуються лише мови, рідна інтеграція Writefull чудова. Якщо вам також потрібна гуманізація, багатомовне редагування або експорт відстежених змін для співавторів, які не користуються LaTeX, зовнішній коректор краще підходить для робочого процесу.

П: Чи копіювання моєї статті у зовнішній інструмент порушить правила анонімізації моєї конференції?

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

З: А як щодо записів BibTeX? Мені також потрібно вичитувати їх?

BibTeX записи не є прозою і не повинні надсилатися коректору. Це відформатовані записи цитування, які мають точно відповідати вимогам стилю цитування журналу. Використовуйте довідковий менеджер (Zotero, BibDesk) для підтримки BibTeX; перевірте записи на точність щодо оригінальної публікації. Робота коректора закінчується на прозі навколо ваших викликів \cite{}; сам файл BibTeX є іншим документом.

З: У моєму документі багато рівнянь. Чи насправді перевірка штучного інтелекту варта зусиль?

Для документів, що містять багато рівнянь, робочий процес редагування є важчим наперед, але цінність вища. Проза у важких математичних статтях часто привертає менше уваги, оскільки автори зосереджені на математиці — а це означає, що в прозі, швидше за все, будуть проблеми, які вловить коректор. 90-хвилинний пропуск на редагування 12-сторінкової статті для конференції стосується навіть важких математичних робіт; ви редагуєте однакову кількість прози в будь-якому випадку. Якщо ваша стаття справді складається з 80% рівнянь і 20% прози (що рідко трапляється навіть у теоретичній роботі), перевірка займає пропорційно менше часу. Ми ніколи не бачили важкої математичної статті, де ретельне редагування прози помітно не покращувало читацького досвіду.