Update documentation to reflect the pkuthss-extra merge.
This commit is contained in:
Casper Ti. Vector
parent
64d8a0dbdb
commit
cab269fa2a
@ -28,7 +28,7 @@
|
||||
|
||||
% 按学校要求设定参考文献列表中的条目之内及之间的距离。
|
||||
\setlength{\bibitemsep}{3bp}
|
||||
% 对于 linespread 值的计算过程有兴趣的同学可以参考 pkuthss-extra.sty。
|
||||
% 对于 linespread 值的计算过程有兴趣的同学可以参考 pkuthss.cls。
|
||||
\renewcommand*{\bibfont}{\zihao{5}\linespread{1.27}\selectfont}
|
||||
|
||||
% 设定文档的基本信息。
|
||||
|
||||
@ -29,20 +29,11 @@
|
||||
% chap/pkuthss-acknowledge.tex
|
||||
|
||||
\chapter{pkuthss 文档模版提供的功能}
|
||||
\section{pkuthss 文档模版提供的文档类和宏包选项}
|
||||
\subsection{pkuthss 文档类提供的选项}\label{ssec:options}
|
||||
\section{pkuthss 文档类提供的选项}\label{sec:options}
|
||||
|
||||
除非特别说明，否则这一节提到的选项中都是不带“\verb|no|”的版本被启用。
|
||||
|
||||
\begin{itemize}
|
||||
\item \textbf{\texttt{[no]extra}}：
|
||||
用于确定是否自动载入 pkuthss-extra 宏包。
|
||||
在默认情况下，pkuthss 文档类将使用 \verb|extra| 选项。
|
||||
用户如果不需要自动载入 pkuthss-extra 宏包，
|
||||
则需要在载入 pkuthss 时加上 \verb|noextra| 选项。
|
||||
|
||||
\item \textbf{\texttt{[no]pkufont}}：
|
||||
是否根据学校对论文格式的要求\mbox{\supercite{pku-thesisstyle}}%
|
||||
将英文字体改为类似于 Times New Roman / Arial 的字体。
|
||||
|
||||
\item \textbf{\texttt{[no]uppermark}}：
|
||||
是否在页眉中将章节名中的小写字母转换为大写字母。
|
||||
就目前而言，这样的转换存在着一些较为严重的缺陷\footnote{%
|
||||
@ -56,35 +47,10 @@
|
||||
即不在页眉中使用大写的章节名%
|
||||
}。
|
||||
|
||||
\item \textbf{pkuthss-extra 宏包提供的选项}：
|
||||
这些选项将被传递给 pkuthss-extra 宏包
|
||||
（用户需要启用 \verb|extra| 选项）。
|
||||
具体说明参见第 \ref{ssec:extra} 小节。
|
||||
\item \textbf{\texttt{[no]pkufont}}：
|
||||
是否根据学校对论文格式的要求\mbox{\supercite{pku-thesisstyle}}%
|
||||
将英文字体改为类似于 Times New Roman / Arial 的字体。
|
||||
|
||||
\item \textbf{其余文档类选项}：%
|
||||
pkuthss 文档类以 ctexbook 文档类为基础，
|
||||
其接受的其余所有文档类选项均被传递给 ctexbook。
|
||||
其中可能最常用的选项是 \verb|GBK| 和 \verb|UTF8|：
|
||||
它们选择源代码使用的字符编码，默认使用 \verb|GBK|。
|
||||
\end{itemize}
|
||||
|
||||
例如，如果需要使用 UTF-8 编码撰写论文，
|
||||
则需要在载入 pkuthss 文档类时加上 \verb|UTF8| 选项：
|
||||
\begin{Verbatim}[frame = single]
|
||||
\documentclass[UTF8, ...]{pkuthss} % “...”代表其它的选项。
|
||||
\end{Verbatim}
|
||||
|
||||
又例如，文档默认情况下是双面模式，每章都从右页（奇数页）开始。
|
||||
如果希望改成一章可以从任意页开始，可以这样设置：
|
||||
\begin{Verbatim}[frame = single]
|
||||
\documentclass[openany, ...]{pkuthss} % 每章从任意页开始。
|
||||
\end{Verbatim}
|
||||
|
||||
\subsection{pkuthss-extra 宏包提供的选项}\label{ssec:extra}
|
||||
|
||||
除非特别说明，下面提到的选项中都是不带“\verb|no|”的版本被启用。
|
||||
|
||||
\begin{itemize}
|
||||
\item \textbf{\texttt{[no]footfmt}}：
|
||||
是否根据学校对论文格式的要求\mbox{\supercite{pku-thesisstyle}}%
|
||||
修改和脚注相关的一些格式。
|
||||
@ -138,7 +104,7 @@
|
||||
此选项部分等价于 1.4 alpha2 及以前版本 pkuthss-extra 宏包
|
||||
的 \texttt{[no]tocbibind} 选项。
|
||||
因为 tocbibind 宏包和 biblatex 宏包冲突，%
|
||||
pkuthss-extra 宏包不再调用 tocbibind 宏包。%
|
||||
pkuthss 文档类不再调用 tocbibind 宏包。%
|
||||
}：
|
||||
启用 \verb|pdftoc| 选项后，
|
||||
用 \verb|\tableofcontents| 命令生成目录时会自动添加“目录”的 pdf 书签。
|
||||
@ -169,19 +135,36 @@
|
||||
故改为 \texttt{[no]colorlinks}。%
|
||||
}：
|
||||
是否在生成的 pdf 文档中使用彩色的链接。
|
||||
|
||||
\item \textbf{其余文档类选项}：%
|
||||
pkuthss 文档类以 ctexbook 文档类为基础，
|
||||
其接受的其余所有文档类选项均被传递给 ctexbook。
|
||||
其中可能最常用的选项是 \verb|GBK| 和 \verb|UTF8|：
|
||||
它们选择源代码使用的字符编码，默认使用 \verb|GBK|。
|
||||
\end{itemize}
|
||||
|
||||
例如，图书馆要求电子版论文的目录必须为黑色，
|
||||
例如，如果需要使用 UTF-8 编码撰写论文，
|
||||
则需要在载入 pkuthss 文档类时加上 \verb|UTF8| 选项：
|
||||
\begin{Verbatim}[frame = single]
|
||||
\documentclass[UTF8, ...]{pkuthss} % “...”代表其它的选项。
|
||||
\end{Verbatim}
|
||||
|
||||
又例如，文档默认情况下是双面模式，每章都从右页（奇数页）开始。
|
||||
如果希望改成一章可以从任意页开始，可以这样设置：
|
||||
\begin{Verbatim}[frame = single]
|
||||
\documentclass[openany, ...]{pkuthss} % 每章从任意页开始。
|
||||
\end{Verbatim}
|
||||
|
||||
又例如，图书馆要求电子版论文的目录必须为黑色，
|
||||
且某些教务要求打印版论文的文字部分为纯黑而非灰度打印。
|
||||
此时用户\myemph{%
|
||||
可以启用 pkuthss-extra 宏包的 \texttt{nocolorlinks} 选项，
|
||||
使所有的链接变为黑色，以免影响提交%
|
||||
可以启用 \texttt{nocolorlinks} 选项，使所有的链接变为黑色，以免影响提交%
|
||||
}：
|
||||
\begin{Verbatim}[frame = single]
|
||||
\documentclass[..., nocolorlinks]{pkuthss} % “...”代表其它的选项。
|
||||
\end{Verbatim}
|
||||
|
||||
\section{pkuthss 文档模版提供的命令和环境}
|
||||
\section{pkuthss 文档类提供的命令和环境}
|
||||
\subsection{设定文档信息的命令}
|
||||
|
||||
这一类命令的语法为
|
||||
@ -265,7 +248,7 @@
|
||||
}
|
||||
\end{Verbatim}
|
||||
|
||||
\subsection{pkuthss 文档模版提供的其它命令和环境}\label{ssec:misc}
|
||||
\subsection{其它命令和环境}\label{ssec:misc}
|
||||
|
||||
\texttt{\bfseries cabstract} 和 \texttt{\bfseries eabstract}
|
||||
环境用于编写中英文摘要。
|
||||
@ -274,8 +257,7 @@
|
||||
\texttt{\bfseries\string\specialchap} 命令
|
||||
用于开始不进行标号但计入目录的一章，
|
||||
并合理安排其页眉。\myemph{%
|
||||
注意：需要启用 pkuthss-extra 宏包的 \texttt{spechap}
|
||||
选项才能使用此命令。
|
||||
注意：需要启用 \texttt{spechap} 选项才能使用此命令。
|
||||
另外，在此章内的节或小节等命令应使用带星号的版本，
|
||||
例如 \texttt{\string\section\string*} 等，
|
||||
以免造成章节编号混乱。%
|
||||
@ -289,12 +271,9 @@
|
||||
因此通常不需要用户自己使用；
|
||||
但用户有时可能不需要输出封面，从而不会调用 \verb|\maketitle| 命令，
|
||||
此时就需要在设定完文档信息之后调用 \verb|\setpdfproperties|。%
|
||||
\myemph{%
|
||||
注意：需要启用 pkuthss-extra 宏包的 \texttt{pdfprop}
|
||||
选项才能使用此命令。%
|
||||
}
|
||||
\myemph{注意：需要启用 \texttt{pdfprop} 选项才能使用此命令。}
|
||||
|
||||
\subsection{从其它文档类和宏包继承的功能}\label{ssec:thirdparty}
|
||||
\section{从其它文档类和宏包继承的功能}\label{sec:thirdparty}
|
||||
|
||||
pkuthss 文档类建立在 ctexbook\supercite{ctex} 文档类之上，
|
||||
并调用了 CJKfntef、hyperref\supercite{hyperref}、%
|
||||
@ -306,10 +285,7 @@ xCJK2uni\supercite{xCJK2uni} 宏包\footnote{%
|
||||
不用在 pkuthss 文档类中重复调用；
|
||||
这里调用 xCJK2un 是为了兼容 ctex 1.x 而进行的设定，
|
||||
该设定将在 2017 年被去除。%
|
||||
}；
|
||||
启用 \verb|pkufont| 选项时会调用
|
||||
newtxtext 和 newtxmath\supercite{newtx} 宏包，
|
||||
否则会调用 latexsym\supercite{latexsym} 宏包。
|
||||
}。
|
||||
因此，ctexbook 文档类和这些宏包所提供的功能均可以使用。
|
||||
|
||||
例如，用户如果想将目录的标题改为“目{\quad\quad}录”，
|
||||
@ -334,8 +310,11 @@ pkuthss 文档模版使用作者编写的 biblatex\supercite{biblatex} 样式%
|
||||
而未引用的文献按照英文文献在前、中文文献在后排序这样的需求，
|
||||
详见 biblatex-caspervector 的文档\supercite{biblatex-caspervector}。
|
||||
|
||||
pkuthss-extra 宏包可能调用以下这些宏包：
|
||||
pkuthss 文档类可能调用以下这些宏包：
|
||||
\begin{itemize}
|
||||
\item 启用 \verb|pkufont| 选项时会调用
|
||||
newtxtext 和 newtxmath\supercite{newtx} 宏包，
|
||||
否则会调用 latexsym\supercite{latexsym} 宏包。
|
||||
\item 启用 \verb|footfmt| 选项时会调用
|
||||
tikz\supercite{tikz} 和 scrextend\supercite{scrextend} 宏包。
|
||||
\item 启用 \verb|pkuspace| 选项时会调用
|
||||
|
||||
@ -31,13 +31,13 @@
|
||||
\chapter{问题及其解决}
|
||||
\section{文档中已经提到的常见问题（按重要性排序）}
|
||||
|
||||
文档默认情况下是双面模式，章末可能产生空白页，详见第 \ref{ssec:options} 小节。
|
||||
最终打印和提交论文前，需使用 pkuthss-extra 宏包的 \verb|nocolorlinks| 选项。
|
||||
解决方式见第 \ref{ssec:extra} 小节。
|
||||
文档默认情况下是双面模式，章末可能产生空白页，详见第 \ref{sec:options} 节。
|
||||
最终打印和提交论文前，需设定 \verb|nocolorlinks| 选项，
|
||||
具体细节见第 \ref{sec:options} 节。
|
||||
|
||||
通过一些设置，还可以满足例如被引用的文献按照引用顺序排序，
|
||||
而未引用的文献按照英文文献在前、中文文献在后排序这样的需求，
|
||||
见第 \ref{ssec:thirdparty} 小节。
|
||||
见第 \ref{sec:thirdparty} 节。
|
||||
|
||||
一些高级设置，如封面中部分内容长度超过预设空间容量时的设置，
|
||||
见第 \ref{sec:advanced} 节。
|
||||
|
||||
@ -35,14 +35,13 @@
|
||||
版权所有 \copyright\ 2010--2015 Casper Ti. Vector
|
||||
\vskip 1em
|
||||
|
||||
pkuthss 文档类、pkuthss-extra 宏包及其说明文档均以
|
||||
\hologo{LaTeX} Project Public License 发布。
|
||||
pkuthss 文档类及其说明文档均以 \hologo{LaTeX} Project Public License 发布。
|
||||
随 pkuthss 提供的模版源代码中，除以下文件
|
||||
\begin{itemize}
|
||||
\item \verb|chap/copyright.tex|
|
||||
\item \verb|chap/originauth.tex|
|
||||
\end{itemize}
|
||||
以 New BSD License 发布，
|
||||
以及参考文献和引用使用的样式文件版权声明见相应文件中说明以外，
|
||||
以及参考文献和引用列表使用的样式文件版权声明见相应文件中说明以外，
|
||||
其余所有文件发布在公有领域（public domain）。
|
||||
|
||||
|
||||
@ -32,14 +32,12 @@
|
||||
|
||||
本文档是北京大学论文文档模版 pkuthss 的说明文档。
|
||||
|
||||
pkuthss 文档模版由四部分构成：
|
||||
pkuthss 文档模版由三部分构成：
|
||||
\begin{itemize}
|
||||
\item \textbf{pkuthss 文档类}：
|
||||
其中进行了学位论文所需要的一些最基本的设定，
|
||||
主要包括对基本排版格式的设定和提供设置论文信息的命令。
|
||||
\item \textbf{pkuthss-extra 宏包}：
|
||||
其中实现了学校的学位论文格式规范\mbox{\supercite{pku-thesisstyle}}%
|
||||
中需要借助一些非最常见宏包来实现的需求；
|
||||
其中根据学校的格式规范\mbox{\supercite{pku-thesisstyle}}%
|
||||
实现了学位论文所需的基本格式要求，
|
||||
主要包括对排版格式的设定和提供设置论文信息的命令；
|
||||
此外也实现了学位论文中用户可能较多用到的一些额外功能，
|
||||
例如自动在目录中加入参考文献和索引的条目和
|
||||
自动根据用户设定的文档信息对所生成 pdf 的作者、标题等属性进行设置等。
|
||||
@ -50,7 +48,7 @@ pkuthss 文档模版由四部分构成：
|
||||
\begin{Verbatim}[frame = single]
|
||||
texdoc pkuthss
|
||||
\end{Verbatim}
|
||||
\item \textbf{文档模版}：
|
||||
\item \textbf{论文模版}：
|
||||
模版的源代码（及由此生成的 pdf 文档）
|
||||
和本文档的 pdf 文件处于同一目录下。
|
||||
用户只需按照模版中的框架修改代码，即可写出自己的论文。
|
||||
|
||||
Loading…
Reference in New Issue
Block a user