Danh mục từ viết tắt và ký hiệu

Bản phác thảo với glossaries-extra, hoặc một danh sách làm tay khi thế là đủ.

Danh mục từ viết tắt và ký hiệu

Tài liệu dài tích tụ nhiều từ viết tắt, và quy ước xoay quanh chúng khá nghiêm ngặt. Một từ viết tắt được viết đầy đủ ở lần dùng đầu, được viết tắt từ đó về sau, và một luận văn thường cần một danh mục từ viết tắt ở phần đầu. Duy trì danh mục đó bằng tay sẽ hỏng theo một cách dễ đoán. Bạn đổi thứ tự hai chương, lần dùng đầu bị dịch chỗ, và đột nhiên “ML” xuất hiện ba trang trước khi có “machine learning (ML)”. Gói glossaries-extra theo dõi lần dùng đầu giúp bạn.

Cách tự động

\usepackage[acronym]{glossaries-extra}
\makeglossaries
\newacronym{ml}{ML}{machine learning}

Tùy chọn acronym bật hỗ trợ từ viết tắt, và \makeglossaries kích hoạt cơ chế thu thập các mục trong lúc biên dịch. Mỗi \newacronym nhận ba đối số: một khóa mà bạn sẽ gõ trong văn bản, dạng viết tắt, và dạng đầy đủ. Hãy định nghĩa tất cả trong preamble hoặc trong một tệp riêng mà bạn \input, để chúng nằm ở một chỗ.

Trong thân bài, bạn không bao giờ gõ chính từ viết tắt:

\gls{ml} on first use expands; later uses stay short.
\printglossaries

\gls{ml} đầu tiên trong tài liệu in ra “machine learning (ML)”, và mọi lần sau chỉ in “ML”. Vì gói theo dõi việc sử dụng chứ không theo vị trí trong mã nguồn, phần mở rộng đi theo lần dùng đầu dù bạn sắp xếp lại cấu trúc thế nào. \printglossaries in danh mục từ viết tắt đã thu thập ở bất cứ chỗ nào bạn đặt, thường là sau mục lục. Các lệnh liên quan lo phần ngữ pháp xung quanh: \glspl cho số nhiều, \Gls cho chữ cái đầu viết hoa ở đầu câu.

Điểm vướng là quy trình dựng. Giữa các lượt chạy LaTeX, trình hỗ trợ makeglossaries phải chạy để sắp xếp và định dạng các mục, nếu không \printglossaries lặng lẽ không in ra gì. Các thiết lập latexmk đầy đủ xử lý việc này tự động. Các quy trình đơn giản hơn có thể không, và glossaries-extra có một phương án dự phòng cho chúng. Nếu danh mục của bạn cứ nhất quyết không hiện ra, lượt chạy trình hỗ trợ bị thiếu là nghi phạm đầu tiên, trước cả một lỗi trong tài liệu của bạn.

Cách làm tay

Với một danh sách ký hiệu đơn giản, một môi trường description duy trì bằng tay thường là đủ:

\section*{Notation}
\begin{description}
\item[$\eta$] learning rate
\item[$\theta$] model parameters
\end{description}

Mỗi \item[...] in đối số trong ngoặc vuông thành nhãn in đậm kèm phần giải thích theo sau, đúng là hình dạng của một danh sách ký hiệu. Không có việc theo dõi lần dùng đầu, nhưng một danh sách ký hiệu hiếm khi cần đến; ký hiệu được định nghĩa ở nơi chúng xuất hiện lần đầu trong công thức, bất kể thế nào.

Lời khuyên thẳng thắn là chọn công cụ khớp với quy mô. Một bài báo có năm từ viết tắt thì dễ quản lý bằng tay. Một luận văn 200 trang với bốn mươi từ thì không, và ở đó chi phí thiết lập của gói được đền bù nhiều lần. Bài học về danh sách trình bày môi trường description chi tiết hơn.

Quay lại Dạng dài