前言

本文是對LATEX 2ε for class and package writers的翻譯和概括。

可以參考以下鏈接得到原文檔
https://www.jianshu.com/p/12b4a4b3afce?from=singlemessage

也可以參考
https://zhuanlan.zhihu.com/p/19705200

文檔編寫的介紹從第三部分開始，文檔的命令從第四部分開始，參數的傳遞從第五部分開始。

1.sty和cls文檔簡介

a.可以使用docstrip生成sty和cls文件

b.如果命令可以在其他tex文件中使用，應該寫在sty文件中。
如果命令（排版格式）只適合某一文檔，應該寫在cls文件中。

2.編寫sty和cls

a.tex命令包含三種格式

tex作者使用的，即一般tex文件包含的命令，
sty和cls作者使用的，如\RequirePackge，
tex內部命令,如\@temcnta。
您不可以在tex文件中使用后兩種命令。

b.魯棒性

為了增強文檔魯棒性，使用較為嚴謹的命令。
文件加載命令：

\LoadClass{cls file name} %加載cls文件 \LoadClassWithOptions \RequirePackage{sty file name} %加載所需要的包 \RequirePackageWithOptions \input{file name}

不建議使用最后一種，會導致多次加載。

命令定義

\newcommand \renewcommand \providecommand \CheckCommand \def

上面四個差別不大，不建議使用第四種，會導致意外定義新命令

環境定義

\newenvironment \renewenvironment\def\foo{...} \def\endfoo{...}

上面兩個均可，不建議使用第三種

c.便攜性

文檔名盡量不要超過8字符，不包括3個字符的擴展名，
不能和已有的latex標準包重名，
盡量加上首字母前綴，比如XXX thesis.cls

d.重定義document

使用\AtBeginDocument和\AtEndDocument重定義docunment

3.cls和sty結構

一個完整的cls或者sty文件通常包含以下的結構。

a.文檔介紹

\NeedsTeXFormat{LaTeX2e} \ProvidesPackage{包的名稱}[時間及其他信息]\NeedsTeXFormat{LaTeX2e} \ProvidesClass{類名稱}[時間及其他信息]

時間使用YYYY/MM/DD格式

b.引用cls或者sty文件

\RequirePackage[options]{package}[date] \LoadClass[hoptionsi]{hclass-namei}[hdatei]

當載入的文件中options和當前文檔相同，使用以下命令：

\LoadClassWithOptions{article} \RequirePackageWithOptions{graphics}

c.定義選項

使用如下命令定義選項

\DeclareOption{option}{code}

如果出現了選項，則會執行選項中的代碼。
使用如下代碼，將error變為warning

\DeclareOption*{% \PackageWarning{fred}{Unknown option ‘\CurrentOption’}% }

使用如下命令使定義的選項被文檔調用執行

\ProcessOptions\relax

d.最小文檔

文檔必須包括四個內容：
\normalsize，\textwidth， \textheight，頁數的規范
一個最小文檔如下例：

\NeedsTeXFormat{LaTeX2e} \ProvidesClass{minimal}[1995/10/30 Standard LaTeX minimal class] \renewcommand{\normalsize}{\fontsize{10pt}{12pt}\selectfont} \setlength{\textwidth}{6.5in} \setlength{\textheight}{8in} \pagenumbering{arabic} % needed even though this class will % not show page numbers

信件文檔如下例：(文檔名為neplet.cls)

\NeedsTeXFormat{LaTeX2e} \ProvidesClass{neplet}[1995/04/01 NonExistent Press letter class]\DeclareOption*{\PassOptionsToClass{\CurrentOption}{letter}} \ProcessOptions\relax \LoadClass[a4paper]{letter}\renewcommand{\ps@firstpage}{% \renewcommand{\@oddhead}{letterhead goes here}% \renewcommand{\@oddfoot}{letterfoot goes here}% }

4.文檔命令

\NeedsTeXFormat {format-name} [release-date] %文檔的定義 \ProvidesClass {class-name} [release-info]%表示當前文檔提供了XX類的定義 \ProvidesPackage {package-name} [release-info]%表示當前文檔提供了XX包的定義 \ProvidesFile {file-name} [release-info]%表示當前文檔提供了XX文件的定義\RequirePackage [options-list] {package-name} [release-info] \RequirePackageWithOptions {package-name} [release-info]%引用包 \LoadClass [hoptions-listi] {class-name} [release-info] \LoadClassWithOptions {class-name} [release-info]%引用類\DeclareOption {option-name} {code}%選項定義 \DeclareOption* {code}%對于所有選項都為執行

以下命令只在定義option的code中使用

\CurrentOption%引用當前選項 \OptionNotUsed%當前選項加入未使用選項列表\PassOptionsToPackage {options-list} {package-name} \PassOptionsToClass {options-list} {class-name}%意味著如果調用這個包，就會執行optionlist中的選項\AtEndOfClass{code} \AtEndOfPackage{code}%代碼將在執行完整個包之后執行\AtBeginDocument {code} \AtEndDocument {code}%代碼將在執行\begin{document}或者\end{docpment}時執行\AtBeginDvi {specials} \ProcessOptions% \ProcessOptions* \\@options% \ExecuteOptions {hoptions-listi}

以上只在code中使用

\IfFileExists {file-name} {true} {false}%定義文件不存在時如何操作，這個命令本身不會加載文件 \InputIfFileExists {file-name} {true} {false}%如果存在，執行True中代碼，然后加載文件，否則執行faulse\ClassError {class-name} {error-text} {help-text} \PackageError {package-name} {error-text} {help-text}%如果在引入包中出現錯誤，將顯示text的內容。 %\protect加在命令之前，使得其被打印而不是執行，\MessageBreak打印換行，\space打印空格。\ClassWarning {class-name} {warning-text} \PackageWarning {package-name} {warning-text} \ClassWarningNoLine {class-name} {warning-text} \PackageWarningNoLine {package-name} {warning-text} \ClassInfo {class-name} {info-text} \PackageInfo {package-name} {info-text}\DeclareRobustCommand {cmd} [num] [default] {definition} \DeclareRobustCommand* {cmd} [num] [default] {definition}%定義更加魯棒的命令，和renewcommand類似。\CheckCommand {cmd} [num] [default] {definition} \CheckCommand* {cmd} [num] [default] {definition}%定義的同時會檢查,如果不同則會產生warning\paperheight \paperwidth%設定頁面大小\MakeUppercase {text} \MakeLowercase {text}%大小寫轉換\ignorespacesafterend%取消空格\normalsfcodes%恢復字間距\if@compatibility

可能需要重新定義如下命令

\rm \sf \tt \bf \it \sl \sc \normalsize \@normalsize

需要重新定義如下命令

\tiny \footnotesize \small \large \Large \LARGE \huge \Huge \tenrm \elvrm \twlrm . . . \tenbf \elvbf \twlbf . . . \tensf \elvsf \twlsf . . .

可能需要替換如下命令

\vpt \vipt \viipt . . . \prm, \pbf, \ppounds, \pLaTeX . . .

以下命令被移除

\footheight \@maxsep \@dblmaxsep

5.參數傳遞

參數傳遞使得tex寫作是不需要重復添加相同的信息。（比如頁眉上方的標題）。遺憾的是原文中并沒有介紹相關的內容。以下內容均來自于下方鏈接。
https://blog.csdn.net/RobertChenGuangzhi/article/details/50461514

在cls文件中，使用以下命令定義參數
\newcommand{\\@ang-name}{默認值}
參數名通常為\@后跟tex文件中使用的名稱
在cls文件中，使用以下命令關聯cls參數和tex參數

\newcommand{\tex-cmd}[參數數目][默認值]{\renewcommand{\\@avg-name1}{#1}\renewcommand{\\@avg-name2}{#2}\renewcommand{\\@avg-name3}{#3} ... }

命令名通常為\加上tex文件中引用的名稱。
在cls文件中使用\@avg-name1...調用參數

在tex文件中使用如下代碼獲取參數：
\tex-cmd{參數1的值}{參數2的值}{參數3的值}..

總結

以上是文檔的大概內容，我會更新一篇報告的cls文件。

總結

以上是生活随笔為你收集整理的sty和cls文档编写指南的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。