Công cụ tài liệu
Thông tin chi tiết tài liệu
Liệt kê các tiêu đề, hình, bảng, phương trình, nhãn, trích dẫn và TODO của một tài liệu LaTeX, Typst hoặc Markdown, và sao chép siêu dữ liệu nộp bài của nó.
Trước khi nộp bài, việc xem tài liệu thực sự chứa gì sẽ rất hữu ích. Mỗi hình có chú thích chưa, và mỗi khóa được trích dẫn có nằm trong tài liệu tham khảo không? Document insights liệt kê tất cả trong một hộp thoại, với mỗi mục liên kết ngược về dòng của nó trong mã nguồn.
Mở nó bằng nút Document insights ở đầu bên phải của thanh công cụ trình soạn thảo, hoặc chạy Document insights từ bảng lệnh ⌘K. Nó hoạt động trong các dự án LaTeX, Typst và Markdown và đọc tài liệu bắt đầu từ tệp chính, nên một chương LaTeX được đưa vào bằng \input hoặc một tệp Typst được đưa vào bằng #include cũng được đếm.
Mỗi thẻ liệt kê gì
Phần tiêu đề “Mỗi thẻ liệt kê gì”Overview hiển thị số lượng cho mỗi danh sách dưới đây. Nhấp vào một số lượng để mở thẻ đó.
- Headings, thụt lề theo cấp.
- Figures và Tables, mỗi mục kèm chú thích của nó (hoặc No caption), nhãn của nó, và Unnumbered khi nó không có số.
- Equations: chỉ các phương trình dạng hiển thị, không phải toán inline.
- Labels: mọi nhãn, kèm thứ nó đánh dấu: tiêu đề, hình, bảng, phương trình, hay khác.
- Citations: mọi khóa được trích dẫn và số lần nó được trích dẫn. Một khóa không có trong tài liệu tham khảo được đánh dấu Not in the bibliography, và Overview cho biết có bao nhiêu khóa như vậy.
- To-dos: các ghi chú
TODO,FIXMEvàXXXtrong mã nguồn. Trong LaTeX, các ghi chú của\todo,\missingfigurevà gói fixme cũng được tính.
Nhấp một hàng để đóng hộp thoại và nhảy đến dòng đó. Một hàng màu xám là không truy ngược được về mã nguồn.
Số và trang
Phần tiêu đề “Số và trang”Số lấy từ đâu tùy thuộc vào engine:
- LaTeX: số của hình, bảng, phương trình và tiêu đề cùng trang của chúng đến từ lần biên dịch gần nhất, cho những mục có nhãn. Chân trang cho bạn biết chúng còn cập nhật hay không. Nếu bạn đã chỉnh sửa kể từ đó, hãy biên dịch lại để cập nhật.
- Typst: hộp thoại yêu cầu Typst đọc tài liệu ngay khi mở, với phiên bản Typst của dự án và biến thể bản dựng được chọn, nên các số và trang khớp với mã nguồn như hiện tại. Nếu Typst không thể biên dịch tài liệu, Overview liệt kê các lỗi thay thế, mỗi lỗi liên kết đến dòng của nó. Chỉ 5.000 phần tử đầu tiên được liệt kê. Chân trang nêu tên phiên bản Typst được dùng.
- Markdown: các mục được liệt kê theo thứ tự mã nguồn, không kèm số hay trang.
Refresh đọc lại tài liệu mà không đóng hộp thoại.
Siêu dữ liệu nộp bài
Phần tiêu đề “Siêu dữ liệu nộp bài”Overview cũng hiển thị Title, Authors, Keywords, Date và Abstract mà Oleafly tìm thấy. Những gì thiếu hiển thị Not set.
- Trong LaTeX, chúng đến từ
\title,\author,\date, môi trườngabstract, và một lệnh\keywordshoặc môi trườngkeywordshoặcIEEEkeywords. - Trong Typst, chúng đến từ các đối số của mẫu mà tài liệu áp dụng, hoặc từ
#set document(...). Một phần tóm tắt cũng có thể đến từ một tiêu đề tên “Abstract”. - Trong Markdown, chúng đến từ phần front matter:
title,authorhoặcauthors,date,keywordsvàabstract.
Copy submission metadata đặt tiêu đề, tác giả, từ khóa và tóm tắt lên bảng tạm thành các dòng có nhãn, sẵn sàng dán vào biểu mẫu nộp bài. Nút tắt khi không mục nào trong số đó được đặt.
Các trang liên quan
Phần tiêu đề “Các trang liên quan”- Kiểm tra Preflight: kiểm tra sâu hơn trên mã nguồn, nhật ký và PDF trước khi nộp bài
- Trích dẫn và tài liệu tham khảo: thêm những khóa mà Document insights báo là còn thiếu
- Cài đặt tài liệu: công cụ tài liệu còn lại trên thanh công cụ trình soạn thảo