Các tệp trong một dự án thực tế
.tex, .bib, .cls, .sty và những tệp sinh tự động bạn không nên commit.
Các tệp trong một dự án thực tế
Hãy mở thư mục của một dự án LaTeX thực tế sau khi biên dịch và bạn sẽ thấy nhiều tệp hơn hẳn số tệp bạn tự viết. Điều này làm hầu hết người mới ngạc nhiên, và nỗi sợ xóa nhầm khiến thư mục lộn xộn mãi mãi. Sự phân biệt giúp làm sáng tỏ chuyện này: một số tệp là mã nguồn bạn chỉnh sửa, một số là các kiểu do mẫu hoặc gói cung cấp, và phần còn lại là không gian nháp được sinh ra mà trình biên dịch tạo lại ở mỗi lần chạy.
Các tệp bạn tự viết
Các tệp .tex của bạn chứa chính tài liệu: văn bản, các mục, hình vẽ và công thức toán. Tệp .bib là cơ sở dữ liệu tài liệu tham khảo của bạn, mỗi mục ứng với một bài báo hoặc cuốn sách bạn có thể trích dẫn; bạn có thể tự duy trì bằng tay hoặc xuất từ một phần mềm quản lý tài liệu tham khảo như Zotero. Đây là những tệp đáng sao lưu và đưa vào quản lý phiên bản, vì mọi thứ còn lại đều có thể dựng lại từ chúng.
Các tệp do mẫu cung cấp
Một tệp .cls định nghĩa một lớp tài liệu, thứ bạn ghi tên trong \documentclass{...}. Tạp chí và hội nghị cung cấp lớp riêng để mọi bài nộp trông giống hệt nhau, và bạn hầu như không bao giờ sửa nó. Một tệp .sty là một gói: các macro và thiết lập dùng lại được, nạp bằng \usepackage. Bạn chỉ tự viết một tệp như vậy khi muốn dùng chung các lệnh tùy chỉnh cho nhiều tài liệu. Tệp .bst mô tả một kiểu trích dẫn BibTeX và cũng thường do nơi công bố đưa sẵn vào.
Các tệp do trình biên dịch tạo ra
Tệp .aux lưu dữ liệu tham chiếu chéo và trích dẫn giữa các lượt biên dịch; đừng bao giờ sửa nó, và cứ thoải mái xóa, vì lần biên dịch sau sẽ ghi lại. Tệp .log ghi lại mọi thứ trình biên dịch đã làm và chỉ đáng mở khi có sự cố. Tệp .pdf là kết quả bạn thực sự muốn.
| Phần mở rộng | Vai trò | Có sửa bằng tay không? |
|---|---|---|
.tex | Tài liệu nguồn và các chương | Có |
.bib | Cơ sở dữ liệu tài liệu tham khảo | Có (hoặc xuất từ Zotero) |
.cls | Lớp tài liệu | Hiếm khi, với mẫu của nhà cung cấp |
.sty | Gói / tệp kiểu | Khi viết macro của riêng bạn |
.bst | Kiểu BibTeX | Hiếm khi |
.aux | Dữ liệu tham chiếu chéo | Không: tự sinh |
.log | Nhật ký trình biên dịch | Đọc khi gỡ lỗi |
.pdf | Đầu ra | Xem / nộp |
Cấu trúc dự án mở rộng được
paper/ main.tex chapters/ figures/ refs.bibMột tệp main.tex ở cấp cao nhất đóng vai trò điểm vào, các chương nằm trong thư mục riêng và được kéo vào bằng \input hoặc \include, hình ảnh để trong figures/, và tài liệu tham khảo nằm trong một tệp refs.bib. Cấu trúc này vẫn dễ quản lý dù dự án là bài báo bốn trang hay một luận văn. Tách các tệp chương cho thấy các phần kết nối với nhau thế nào.
Nếu bạn dùng Git, hãy thêm *.aux, *.log và các tệp sinh tự động khác vào .gitignore để lịch sử của bạn chỉ theo dõi mã nguồn thật. Dự án Oleafly là các thư mục thông thường trên đĩa, nên lời khuyên này áp dụng nguyên vẹn ở đó. Sai lầm phổ biến nhất lại là chiều ngược lại: khi săn một lỗi biên dịch kỳ lạ, xóa các tệp .aux thường chính là cách sửa, vì một tệp cũ còn sót lại từ lần chạy hỏng có thể làm hỏng mọi lần biên dịch sau nó.