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

Anda selesai merangka kertas NeurIPS anda pada pukul 4 pagi dan tampalkannya ke dalam alat tatabahasa. Separuh "ralat" anda ialah LaTeX arahan yang tidak dikenali oleh alat. Tiga daripada label persamaan anda kini rosak. Bahagian rujukan telah "diperbaiki" menjadi karut. Anda mengembalikan semuanya dan menghantar kertas itu tanpa disunting kerana tarikh akhir adalah dalam enam jam.

Ini ialah pengalaman LaTeX-dan-pembaca pruf lalai. Alat tatabahasa tujuan am tidak direka untuk fail sumber yang dicampur dengan penanda. Berita baik: dengan aliran kerja yang betul, pembacaan pruf AI pada LaTeX adalah mudah dan selamat. Perkara utama ialah mengetahui perkara yang perlu dihantar kepada pembaca pruf dan perkara yang perlu ditinggalkan sahaja, cara menggunting dokumen supaya konteks kekal utuh, dan cara mengedit suntingan pergi balik ke dalam fail .tex anda tanpa melanggar kompilasi.

Mengapa LaTeX sukar untuk alatan tatabahasa am

Masalahnya mudah: kebanyakan alat tatabahasa membaca teks anda sebagai prosa. LaTeX fail sumber bukan prosa. Ia adalah gabungan prosa, perintah struktur, ungkapan matematik, petikan dan rujukan. Alat yang tidak memahami struktur menganggap perintah sebagai perkataan dan cuba "membetulkannya".

Three things typically break:

Ungkapan matematik diparafrasa. Matematik sebaris seperti $\alfa < 0.05$ menjadi "alfa kurang daripada sifar koma sifar lima" atau lebih teruk, menjadi "dipermudahkan" menjadi karut. Paparkan matematik dalam blok \begin{equation}...\end{equation} akan dianggap sebagai perenggan yang ingin distruktur semula oleh alat.

Arahan petikan menjadi rosak. \citep{smith2023} menjadi \citep smith2023, [smith2023], atau malah "dikembangkan" menjadi nama pengarang ciptaan. Rujukan senyap pecah dan kertas anda tidak lagi disusun.

Arahan struktur akan ditulis semula. \section{Methods} menjadi \section {Methods}. \textbf{key result} menjadi \\textbf{key result} selepas "pembetulan" aksara melarikan diri. Hasilkan ralat kompilasi, dan menjejaki "pembetulan" yang memecahkan perkara adalah menyakitkan.

Penyelesaiannya bukan dengan menggunakan alat tatabahasa LaTeX-aware khas, walaupun alat tersebut wujud. Penyelesaiannya adalah untuk menghantar pembaca pruf hanya prosa, menyimpan penanda berasingan dan menyepadukan semula suntingan secara manual. Ini kedengaran membosankan. Ia tidak — aliran kerja mengambil masa kira-kira 20 minit tambahan setiap kertas berbanding dengan dokumen prosa tulen, dan ia lebih pantas daripada membetulkan ralat penyusunan selepas tampalan yang cuai.

What to copy and what to leave

Peraturan asas: salin perkataan; tinggalkan semua arahan, label, petikan atau matematik.

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

Seperti yang ditunjukkan dalam Persamaan~\ref{eq:loss}, fungsi kehilangan...
\citep{vaswani2017perhatian,bahasa coklat2020}

Blok pertama ialah prosa yang dikendalikan oleh pembaca pruf anda dengan bersih. Blok kedua mengandungi arahan, label, matematik dan kekunci petikan - tiada satu pun daripadanya yang harus disentuh oleh pembaca pruf.

Dalam amalan, anda menyalin prosa perenggan demi perenggan (atau bahagian demi bahagian), editnya secara luaran, kemudian tampal suntingan semula ke perenggan yang sama dalam fail .tex anda. Anda membiarkan \bahagian{}, \label{}, \input{}, blok persamaan dan \citep{} tidak disentuh.

The chunking strategy

Kertas LaTeX 12 muka surat bukan satu dokumen prosa — ia mengandungi 15-20 ketulan prosa yang dipisahkan oleh markup. Butiran yang betul untuk membaca pruf adalah bersaiz sub-bahagian: 200-500 patah perkataan setiap bahagian.

Satu bahagian pada satu masa adalah titik manis. Potongan yang lebih kecil (satu perenggan) kehilangan konteks merentas perenggan — peralihan yang berbunyi baik secara berasingan mungkin salah dalam konteks. Potongan yang lebih besar (seluruh kertas) kehilangan ketepatan — pembaca pruf mengendalikan 500 perkataan lebih baik daripada 5,000.

Bahagian metodologi dan keputusan mungkin memerlukan potongan yang lebih halus. Bahagian ini cenderung untuk menggantikan prosa dengan matematik dan jadual. Potong sebelum setiap blok persamaan, selepas setiap jadual, antara subseksyen. Pastikan potongan prosa bersebelahan di mana mungkin.

Abstrak dan kesimpulan mendapat rawatan dokumen penuh. Ini biasanya pendek (200-400 patah perkataan) dan perlu dibaca secara koheren sebagai potongan kendiri. Edit setiap satu sebagai satu bahagian.

Kapsyen ialah ketulan yang berasingan. Kapsyen rajah dan jadual hendaklah diedit secara individu. Mereka selalunya cukup pendek untuk dilakukan dengan cepat dan biasanya terlepas dalam pas peringkat bahagian.

Sasarkan kira-kira 8-15 ketul untuk kertas persidangan biasa, 20-30 untuk kertas jurnal, 50-100 untuk bab tesis.

Round-tripping edits back into LaTeX

Langkah penyepaduan semula ialah tempat kebanyakan aliran kerja terputus. Beberapa tabiat menjadikannya selamat.

Gunakan alat berbeza, bukan bola mata. Tampal ketulan prosa asal anda dan versi yang diedit ke dalam pemapar berbeza (mana-mana editor teks yang baik mempunyai satu terbina dalam; ciri sejarah Overleaf juga berfungsi). Perbezaan ini menyerlahkan setiap perubahan. Gunakan setiap perubahan secara manual pada fail sumber, mengekalkan penanda sekeliling.

Gunakan perubahan satu perenggan pada satu masa. Jangan tampalkan bahagian yang diedit yang panjang ke dalam sumber anda. Gunakannya perenggan demi perenggan, dengan semakan kompilasi selepas setiap perenggan yang penting. Jika sesuatu pecah, anda telah memecahkan satu perenggan, bukan keseluruhan bahagian.

Perhatikan aksara khas. Teks yang disunting AI kadangkala kembali dengan petikan pintar (keriting " bukannya lurus "), em sempang (— bukannya --), atau ruang tidak putus. Ini boleh dipaparkan secara tidak betul dalam LaTeX. Pas cari dan ganti selepas pengeditan menangkapnya.

Semak semula ketekalan \label{} dan \ref{} anda. Jika pembaca pruf secara halus menukar perkataan di sekitar rujukan Section~\ref{sec:methods}, sahkan sasaran rujukan masih masuk akal dalam konteks.

Kompilkan selepas setiap bahagian. Ini kedengaran berlebihan. Ia tidak. Kertas pecah pada pukul 3 pagi sebelum penyerahan adalah lebih teruk daripada lima klik kompilasi tambahan semasa penyuntingan.

Mengendalikan matematik tanpa memusnahkan persamaan anda

Matematik adalah bidang yang paling berisiko. Peraturannya mudah: jangan sekali-kali menghantar matematik kepada pembaca pruf.

Matematik sebaris ($...$) kekal dalam fail sumber. Apabila anda menyalin perenggan untuk mengedit, gantikan matematik sebaris dengan ruang letak seperti [MATH1], [MATH2]. Edit prosa di sekeliling ruang letak. Apabila menyepadukan semula, pulihkan matematik asal.

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.

Pembaca pruf menyunting prosa. Anda memulihkan matematik semasa penyepaduan semula.

Matematik paparan (\begin{equation}...\end{equation}) dikecualikan sepenuhnya. Edit perenggan sebelum dan selepas; biarkan blok persamaan tidak disentuh.

Rujukan persamaan (Equation~\ref{eq:loss}) adalah rumit. Jika anda telah menggunakan ruang letak untuk matematik sebaris, gunakan juga ruang letak untuk arahan rujukan: seperti yang ditunjukkan dalam [REF1]. Kemudian pulihkan.

Ungkapan statistik dalam prosa ialah kes khas. Sesuatu seperti (p < 0.001) dalam prosa secara teknikal adalah matematik tetapi jarang menggunakan sintaks paparan. Jika anda menulis (p < 0.001) menggunakan entiti HTML untuk mengelakkan isu MDX, itu adalah masalah yang berbeza daripada LaTeX. Dalam sumber LaTeX, (p < 0.001) adalah baik; hanya masukkannya dalam sistem pemegang tempat anda jika anda tidak mahu pembaca pruf menulisnya semula.

Perubahan yang dijejaki untuk rakan usaha sama yang tidak menggunakan LaTeX

Masalah aliran kerja sebenar: penasihat anda tidak membaca sumber LaTeX. Mereka mahukan dokumen Word dengan perubahan yang dijejaki.

Penyelesaian standard ialah pandoc. Susun LaTeX anda kepada fail .docx, hantar kepada penasihat anda, dapatkan kembali perubahan yang dijejaki, gunakan perubahan secara manual pada sumber .tex anda. Ini berfungsi tetapi perlahan.

Penyelesaian yang lebih pantas ialah melakukan pas pengeditan dahulu. Tampalkan ketulan prosa anda ke dalam pembaca pruf AI kami dan eksport .docx perubahan yang dijejaki untuk setiap ketul (atau untuk prosa yang dipasang). Hantar itu kepada penasihat anda untuk semakan. Mereka menandakan fail perubahan yang dijejaki dengan tambahan mereka sendiri. Anda menggunakan gabungan perubahan yang diterima kembali ke sumber LaTeX anda.

Ini memperdagangkan dua langkah penyepaduan manual untuk satu. Penyepaduan pertama (pembaca pruf suntingan ke LaTeX) adalah mekanikal dan pantas. Penyepaduan kedua (tambahan penasihat) adalah kerja yang sama yang anda akan lakukan juga.

Untuk rakan usaha sama yang membaca LaTeX, gunakan latexdiff. Ini menghasilkan perbandingan sebelah menyebelah dua versi .tex, dengan sisipan dan pemadaman ditandai. Ia menyusun kepada PDF yang menunjukkan perubahan yang dijejaki secara visual. Digabungkan dengan pas pengeditan prosa, ini adalah cara paling bersih untuk berkongsi perubahan dengan rakan usaha sama yang fasih LaTeX.

The full workflow, compressed

Berikut ialah urutan dalam ringkasan 90 saat, sesuai untuk merakam pada monitor anda.

1. Buka fail .tex anda di Overleaf atau dalam editor tempatan anda.
2. Untuk setiap kelompok prosa (biasanya bersaiz subseksyen, 200–500 patah kata): a. Salin prosa. Gantikan matematik sebaris dengan pemegang tempat. b. Tampal ke dalam proofreader. Jalankan penyuntingan « Standard ». c. Semak perubahan yang dijejaki; terima atau tolak setiap satu. d. Pulihkan pemegang tempat matematik. e. Gunakan suntingan secara perenggan demi perenggan pada sumber .tex. f. Kompil. Pastikan tiada kerosakan.
3. Langkau terus blok persamaan.
4. Sunting kapsyen sebagai kelompok kecil berasingan.
5. Kompil akhir. Pastikan rujukan masih berfungsi.
6. Jika menghantar kepada rakan usaha sama yang bukan LaTeX, eksport perubahan dijejaki .docx daripada proofreader untuk bahagian prosa; hantar itu. Jika menghantar kepada rakan usaha sama LaTeX, jana PDF latexdiff untuk semakan.

Kertas persidangan 12 halaman mengambil masa kira-kira 90 minit melalui aliran kerja ini. Satu bab tesis mengambil masa 3-5 jam. Kedua-duanya lebih pantas daripada membaiki LaTeX yang rosak selepas tampalan naif-semuanya lulus, dan kualiti pengeditan adalah lebih tinggi.

Untuk kertas kerja yang disediakan untuk penyerahan, lihat juga panduan surat kiriman jurnal kami — surat kiriman biasanya memerlukan perhatian yang lebih daripada yang diberikan oleh pengarang, terutamanya untuk tempat di mana 60 saat pertama editor menentukan nasib anda.

See the Full AI Proofreader

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

Frequently asked questions

S: Adakah Overleaf mempunyai penyemak tatabahasa terbina dalam yang mengendalikan LaTeX dengan betul?

Overleaf berkas Writefull, yang LaTeX-sedar dan tinggal di dalam editor Overleaf. Penyepaduan percuma adalah terhad; Premium Writefull yang dibayar memanjangkannya. Untuk perbandingan Writefull dan platform pembacaan pruf khusus, lihat ProofreaderPro lwn Writefull. Versi pendek: jika anda menulis terutamanya dalam LaTeX dan keperluan pengeditan anda adalah bahasa sahaja, integrasi asli Writefull adalah sangat baik. Jika anda juga memerlukan pemanusiaan, pengeditan berbilang bahasa atau eksport perubahan yang dijejaki untuk rakan usaha sama bukan LaTeX, pembaca pruf luaran lebih sesuai dengan aliran kerja.

S: Adakah menyalin kertas saya ke dalam alat luaran melanggar peraturan penganamaan persidangan saya?

Peraturan anonim digunakan pada versi yang diserahkan kepada penyemak, bukan pada proses pengeditan anda. Menggunakan alat pengeditan pada draf anda sendiri bukanlah pelanggaran anonimasi. Walau bagaimanapun, jika anda bimbang tentang alat yang dihoskan yang menyimpan kerja anda yang tidak diterbitkan, semak dasar data alat tersebut. Alat yang menyatakan secara jelas bahawa mereka tidak melatih input pengguna (seperti kami) secara amnya selamat untuk kerja yang tidak diterbitkan. Untuk kandungan yang sangat sensitif (berkaitan dengan pertahanan, data pesakit bersebelahan), sesetengah institusi memerlukan alat yang dihoskan sendiri — dalam hal ini model sumber terbuka yang boleh anda jalankan secara setempat adalah pilihan yang tepat.

S: Bagaimana pula dengan penyertaan BibTeX? Adakah saya perlu menyemaknya juga?

BibTeX penyertaan bukan prosa dan tidak boleh dihantar kepada pembaca pruf. Ia adalah rekod petikan berformat yang perlu sepadan dengan keperluan gaya petikan jurnal dengan tepat. Gunakan pengurus rujukan (Zotero, BibDesk) untuk mengekalkan BibTeX; semak entri untuk ketepatan berbanding penerbitan asal. Tugas pembaca pruf berakhir pada prosa sekitar panggilan \cite{} anda; fail BibTeX itu sendiri ialah dokumen yang berbeza.

S: Kertas saya mempunyai banyak persamaan. Adakah pembacaan pruf AI sebenarnya bernilai usaha?

Untuk makalah yang banyak menggunakan persamaan, alur kerja penyuntingan memerlukan usaha yang lebih berat di peringkat awal, namun nilainya lebih tinggi. Teks berbentuk prosa dalam makalah yang sarat matematik sering kurang diberi perhatian kerana penulis memberi fokus pada matematik—yang bermaksud prosa lebih berkemungkinan mempunyai isu yang akan dikesan oleh penyunting pruf. Pusingan penyuntingan selama 90 minit untuk makalah persidangan 12 halaman turut digunakan walaupun untuk makalah yang sarat matematik; anda menyunting jumlah prosa yang sama, tidak kira apa pun. Jika makalah anda benar-benar 80% persamaan dan 20% prosa (jarang berlaku walaupun dalam kajian teori), proses penyuntingan pruf mengambil masa yang jauh lebih sedikit secara berkadar. Kami tidak pernah melihat makalah yang sarat matematik di mana penyuntingan prosa yang teliti tidak meningkatkan pengalaman pembaca secara ketara.