How to Proofread a LaTeX Paper in Overleaf (Without Breaking Math)

Hajnali 4 órakor fejezi be a NeurIPS dolgozatát, és illessze be egy nyelvtani eszközbe. A „hibáid” fele olyan LaTeX parancs, amelyet az eszköz nem ismerte fel. Három egyenletcímkéje megsérült. A referenciák részt hülyeséggé "javították". Mindent visszaállít, és szerkesztetlenül elküldi a papírt, mert hat óra múlva jár le a határidő.

Ez az alapértelmezett LaTeX-és-lektori élmény. Az általános célú nyelvtani eszközöket nem jelöléssel kevert forrásfájlokhoz tervezték. A jó hír: a megfelelő munkafolyamat mellett az AI-lektorálás a LaTeX-on egyszerű és biztonságos. A kulcs az, hogy tudjuk, mit kell küldeni a lektornak, és mit hagyjunk békén, hogyan lehet a dokumentumot feldarabolni úgy, hogy a kontextus érintetlen maradjon, és hogyan lehet visszahelyezni a szerkesztéseket a .tex fájljaiba a fordítás megszakítása nélkül.

Miért nehéz a LaTeX az általános nyelvtani eszközök számára

A probléma egyszerű: a legtöbb nyelvtani eszköz prózaként olvassa fel a szöveget. A LaTeX forrásfájlok nem prózai fájlok. Próza, szerkezeti parancsok, matematikai kifejezések, idézetek és hivatkozások keveréke. Egy olyan eszköz, amely nem érti a szerkezetet, a parancsokat szavakként kezeli, és megpróbálja „megjavítani” azokat.

Three things typically break:

A matematikai kifejezéseket átfogalmazzák. A soron belüli matematika, mint például a $\alpha < 0,05$ "alfa nulla pont nulla ötnél kisebb" lesz, vagy ami még rosszabb, értelmetlenné válik. A matematikai megjelenítés a \begin{equation}...\end{equation} blokkban olyan bekezdésként kezelendő, amelyet az eszköz át akar szerkeszteni.

Az idézőparancsok összezavarodnak. A \citep{smith2023} karakterláncból \citep smith2023, [smith2023] lesz, vagy akár kitalált szerzőnevekre is "kibővül". A hivatkozások csendben megszakadnak, és a dolgozat nem fordítódik többé.

A strukturális parancsok átírásra kerülnek. A \section{Methods} \section {Methods} lesz. A \textbf{key result} \\textbf{key result} lesz az escape karakter "javítása" után. Fordítási hibák adódnak, és fájdalmas annak nyomon követése, hogy melyik "javítás" rontotta el a dolgokat.

A javítás nem egy speciális LaTeX-tudatos nyelvtani eszköz használata, bár ezek léteznek. A javítás az, hogy a lektornak csak a prózát küldi el, a jelöléseket külön kell tartani, és a szerkesztéseket manuálisan integrálja újra. Ez fárasztónak hangzik. Nem – a munkafolyamat papíronként körülbelül 20 extra percet vesz igénybe egy tiszta prózai dokumentumhoz képest, és gyorsabb, mint a fordítási hibák kijavítása egy gondatlan beillesztés után.

What to copy and what to leave

Az alapszabály: másolja a szavakat; hagyjon mindent, ami parancs, címke, idézet vagy matematika.

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{egyenlet}
\mathcal{L}(\theta) = -\sum_{i=1}^{N} \log p_\theta(y_i | x_i)
\label{eq:loss}
\end{egyenlet}

Amint azt az Egyenlet~\ref{eq:loss} mutatja, a veszteségfüggvény...
\citep{vaswani2017figyelem,barna2020nyelv}

Az első blokk az, hogy a korrektor tisztán kezeli a prózát. A második blokk parancsokat, címkéket, matematikai és idéző ​​kulcsokat tartalmaz – ezek közül a lektornak egyiket sem szabad megérinteni.

A gyakorlatban a prózai szöveget bekezdésenként (vagy szakaszonként) másolja ki, külsőleg szerkeszti, majd a szerkesztéseket visszailleszti ugyanabba a bekezdésbe a .tex' fájlba. Érintetlenül hagyja a \section, \label, \input, egyenletblokkokat és \citep` hívásokat.

The chunking strategy

Egy 12 oldalas LaTeX dolgozat nem egy prózai dokumentum, hanem 15-20 prózadarab, jelölésekkel elválasztva. A korrektúra megfelelő részletessége az alszakasz mérete: 200-500 szó darabonként.

Egyszerre egy szakasz az édes pont. A kisebb darabok (egy bekezdés) elveszítik a bekezdések közötti kontextust – az önmagában jól hangzó átmenet kontextusban rossz lehet. A nagyobb darabok (az egész papír) elvesztik a pontosságot – a korrektor 500 szót jobban kezel, mint 5000.

A módszertan és az eredmények szakaszok finomabb darabolásra szorulhatnak. Ezek általában a prózát a matematikával és a táblázatokkal váltják fel. Részlet minden egyenletblokk előtt, minden táblázat után, alszakaszok között. A prózai darabok lehetőleg egymás mellett legyenek.

Az absztraktok és a következtetések teljes dokumentumkezelést kapnak. Ezek általában rövidek (200-400 szó), és különálló darabként koherensen kell olvasni. Szerkessze mindegyiket egy darabként.

A feliratok külön darabok. Az ábrák és táblázatok feliratait külön kell szerkeszteni. Gyakran elég rövidek ahhoz, hogy gyorsan megcsinálják, és gyakran kimaradnak a szakaszszintű bérleteknél.

Egy tipikus konferenciaelőadás esetén törekedj kb. 8–15 szövegrészre, folyóiratcikknél 20–30-ra, míg egy szakdolgozati fejezetnél 50–100-ra.

Round-tripping edits back into LaTeX

Az újraintegrálási lépésben a legtöbb munkafolyamat megszakad. Néhány szokás biztonságossá teszi.

Használjon differenciáló eszközt, ne szemgolyót. Illessze be az eredeti prózai darabot és a szerkesztett változatot egy differenciálmegjelenítőbe (minden tisztességes szövegszerkesztőben van beépítve; a Overleaf előzményfunkciója is működik). A különbség minden változást kiemel. Alkalmazzon minden változtatást manuálisan a forrásfájlra, megőrizve a környező jelölést.

Egyszerre csak egy bekezdést alkalmazza a módosításokat. Ne illesszen be köteggel hosszú szerkesztett részt a forrásba. Alkalmazza bekezdésről bekezdésre, és minden lényeges bekezdés után ellenőrizze a fordítást. Ha valami eltörik, akkor egy bekezdést sértett meg, nem az egész részt.

Figyeljen a speciális karakterekre. A mesterséges intelligencia által szerkesztett szöveg néha intelligens idézőjelekkel tér vissza (göndör " az egyenes " helyett), em kötőjelekkel (-- -- helyett) vagy nem törő szóközökkel. Ezek helytelenül jelenhetnek meg a LaTeX-ban. A szerkesztés utáni keresés és csere lépés elkapja őket.

Ellenőrizze újra a \label{} és \ref{} konzisztenciáját. Ha a lektor finoman megváltoztatta a Section~\ref{sec:methods} hivatkozás szövegét, ellenőrizze, hogy a hivatkozási cél továbbra is értelmes-e a kontextusban.

** Minden szakasz után fordítsa le.** Ez túlzónak hangzik. Nem az. Egy törött papír hajnali 3-kor a beküldés előtt sokkal rosszabb, mint öt plusz fordítási kattintás szerkesztés közben.

A matematika kezelése az egyenletek megsemmisítése nélkül

A matematika a legnagyobb kockázatú terület. A szabály egyszerű: soha ne küldj matematikát lektornak.

A soron belüli matematika ($...$) a forrásfájlban marad. Ha egy bekezdést szerkesztés céljából másol, cserélje ki a soron belüli matematikát egy helyőrzővel, például [MATH1], [MATH2]. Szerkessze a prózát a helyőrzők köré. Újraintegráláskor állítsa vissza az eredeti matematikát.

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.

A lektor szerkeszti a prózát. Visszaállítja a matematikát a reintegráció során.

A matematikai megjelenítés (\begin{equation}...\end{equation}) teljes mértékben ki van zárva. Szerkessze az előtti és utáni bekezdéseket; érintetlenül hagyja az egyenletblokkot.

Az egyenlethivatkozások (Equation~\ref{eq:loss}) trükkösek. Ha helyőrzőt használt a soron belüli matematikához, használjon helyőrzőket a hivatkozási parancsokhoz is: a [REF1]-ben látható módon. Ezután állítsa vissza.

A statisztikai kifejezések prózában különleges esetek. A prózában a (p < 0,001)-hoz hasonló technikailag matematikai jellegű, de ritkán használ megjelenítési szintaxist. Ha az MDX-problémák elkerülése érdekében a HTML-entitás használatával írja be a "(p < 0,001)" értéket, akkor az más probléma, mint a LaTeX. A LaTeX forrásban a (p < 0,001) megfelelő; csak vegye be a helyőrző rendszerébe, ha nem akarja, hogy a lektor átírja.

Nyomon követett változások azon együttműködők számára, akik nem használják a LaTeX

Valódi munkafolyamat-probléma: a tanácsadója nem olvassa be a LaTeX forrást. Olyan Word-dokumentumot akarnak, amelyen nyomon követhetők a változások.

A szabványos megoldás a pandoc. Fordítsa le a LaTeX fájlt .docx fájlba, küldje el a tanácsadójának, kérje vissza a nyomon követett változtatásokat, manuálisan alkalmazza a változtatásokat a .tex forrásra. This works but is slow.

A gyorsabb megoldás az, ha először a szerkesztési lépést hajtod végre. Illessze be a prózai darabokat az AI-lektorunkba, és exportálja a tracked-changes .docx fájlt minden egyes darabhoz (vagy az összeállított prózához). Küldje el a tanácsadójának felülvizsgálatra. Megjelölik a tracked-changes fájlt saját kiegészítéseikkel. Ön alkalmazza a kombinált elfogadott módosításokat a LaTeX forrásra.

Ez két manuális integrációs lépést cserél egyre. Az első integráció (a korrektor szerkeszti a LaTeX-ba) mechanikus és gyors. A második integráció (a tanácsadó kiegészítései) ugyanaz a munka, amelyet egyébként is végezne.

Azoknak az együttműködőknek, akik olvassák a LaTeX-t, használja a "latexdiff"-et. Ez két ".tex" verzió egymás melletti összehasonlítását generálja, megjelölve a beillesztéseket és a törléseket. PDF-fájlba fordítja, amely vizuálisan mutatja a nyomon követett változásokat. A prózai szerkesztési bérlettel kombinálva ez a legtisztább módja a változtatások megosztásának a LaTeX folyékony munkatársakkal.

The full workflow, compressed

Íme a sorozat 90 másodperces összefoglalójában, amely alkalmas a monitorra rögzítésre.

1. Nyissa meg a .tex fájlt a Overleaf-ban vagy a helyi szerkesztőben.
2. Minden egyes prózai darabhoz (általában alfejezet méretű, 200–500 szó): a. Másold le a prózát. Cserélje le a soron belüli matematikát helyőrzőkkel. b. Illessze be a lektorba. Futtasson szabványos szerkesztési lépést. c. Tekintse át a nyomon követett változásokat; mindegyiket elfogadja vagy elutasítja. d. A matematikai helyőrzők visszaállítása. e. Alkalmazza a szerkesztéseket bekezdésenként a ".tex" forrásra. f. Összeállítás. Ellenőrizze, hogy nincs törés.
3. Hagyja ki teljesen az egyenletblokkokat.
4. Szerkessze a feliratokat különálló kis darabokként.
5. Végső összeállítás. Ellenőrizze, hogy a hivatkozások továbbra is megoldódnak.
6. Ha nem LaTeX munkatársnak küldi, exportálja a tracked-changes `.docx' fájlt a prózai szöveg lektorából; küldd el azt. Ha egy LaTeX együttműködőnek küldi, hozzon létre egy "latexdiff" PDF-et ellenőrzésre.

Egy 12 oldalas konferencia előadás körülbelül 90 percet vesz igénybe ezen a munkafolyamaton. Egy szakdolgozat fejezet 3-5 órát vesz igénybe. Mindkettő gyorsabb, mint a hibás LaTeX kijavítása egy naiv beillesztés után – minden megy, és a szerkesztési minőség is sokkal jobb.

A beküldésre készülő dolgozatokhoz tekintse meg a folyóirat kísérőlevél-útmutatóját – a kísérőlevél általában több figyelmet igényel, mint amennyit a szerzők fordítanak rá, különösen olyan helyszíneken, ahol a szerkesztő első 60 másodperce dönti el a sorsát.

See the Full AI Proofreader

Tracked-changes editing for academic prose. Free tier includes every feature.

Frequently asked questions

K: A Overleaf rendelkezik beépített nyelvtani ellenőrzővel, amely megfelelően kezeli a LaTeX fájlt?

Overleaf csomagolja a Writefull-t, amely LaTeX-tudatos és a Overleaf szerkesztőben található. Az ingyenes integráció korlátozott; a fizetett Writefull Prémium meghosszabbítja. A Writefull és a dedikált lektori platform összehasonlításához lásd: ProofreaderPro vs Writefull. A rövid változat: ha elsősorban LaTeX nyelven ír, és csak nyelvi szerkesztési igénye van, akkor a Writefull natív integrációja kiváló. Ha humanizálásra, többnyelvű szerkesztésre vagy nyomon követett változtatások exportálására is szüksége van a nem LaTeX együttműködők számára, egy külső lektor jobban illeszkedik a munkafolyamathoz.

K: Az előadásom külső eszközbe másolása sérti a konferencia anonimizálási szabályait?

Az anonimizálási szabályok a véleményezőknek benyújtott verzióra vonatkoznak, nem a szerkesztési folyamatra. Szerkesztőeszköz használata saját piszkozatán nem jelenti az anonimizálás megsértését. Ennek ellenére, ha aggódik egy hosztolt eszköz miatt, amely a közzé nem tett munkáit tárolja, ellenőrizze az eszköz adatszabályzatát. Azok az eszközök, amelyek kifejezetten kijelentik, hogy nem tanítanak a felhasználói bemenetekre (mint a miénk), általában biztonságosak a nem publikált munkákhoz. A rendkívül érzékeny tartalmakhoz (védelemmel kapcsolatos, betegadatokkal szomszédos) egyes intézmények saját üzemeltetésű eszközöket igényelnek – ebben az esetben a helyben futtatható nyílt forráskódú modellek a megfelelő választás.

K: Mi a helyzet a BibTeX bejegyzésekkel? Ezeket is lektorálnom kell?

A BibTeX bejegyzések nem prózai jellegűek, és nem küldhetők lektornak. Ezek formázott hivatkozási rekordok, amelyeknek pontosan meg kell felelniük a folyóirat hivatkozási stílus követelményeinek. Használjon referenciakezelőt (Zotero, BibDesk) a BibTeX karbantartásához; ellenőrizze a bejegyzések pontosságát az eredeti kiadványhoz képest. A lektor feladata a \cite{} hívások körüli prózánál ér véget; maga a BibTeX fájl egy másik dokumentum.

K: A dolgozatom sok egyenletet tartalmaz. Valóban megéri az AI-lektorálás az erőfeszítést?

Nehéz egyenletű dolgozatok esetén a szerkesztési munkafolyamat előzetesen nehezebb, de az érték magasabb. A sok matematikai dolgozatban szereplő próza gyakran kevesebb figyelmet kap, mert a szerzők a matematikára összpontosítanak – ami azt jelenti, hogy a prózában nagyobb valószínűséggel kapnak problémákat a lektor. A 12 oldalas konferencia dolgozat 90 perces szerkesztési jegye még a matematikailag nehéz dolgozatokra is vonatkozik; akárhogyan is ugyanannyi prózát szerkesztesz. Ha a dolgozat valóban 80%-ban egyenlet és 20%-ban próza (még az elméleti munkában is ritka), a lektorálás arányosan kevesebb időt vesz igénybe. Soha nem láttunk még matematikailag nehéz dolgozatot, ahol a gondos prózaszerkesztés ne javította volna mérhetően az olvasói élményt.