summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/pkuthss/doc/readme/chap/pkuthss-chap1.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/pkuthss/doc/readme/chap/pkuthss-chap1.tex')
-rw-r--r--macros/latex/contrib/pkuthss/doc/readme/chap/pkuthss-chap1.tex103
1 files changed, 39 insertions, 64 deletions
diff --git a/macros/latex/contrib/pkuthss/doc/readme/chap/pkuthss-chap1.tex b/macros/latex/contrib/pkuthss/doc/readme/chap/pkuthss-chap1.tex
index 3eaa29114b..2e5152ece5 100644
--- a/macros/latex/contrib/pkuthss/doc/readme/chap/pkuthss-chap1.tex
+++ b/macros/latex/contrib/pkuthss/doc/readme/chap/pkuthss-chap1.tex
@@ -1,7 +1,7 @@
% Documentation for pkuthss.
%
% Copyright (c) 2008-2009 solvethis
-% Copyright (c) 2010-2018 Casper Ti. Vector
+% Copyright (c) 2010-2019 Casper Ti. Vector
%
% This work may be distributed and/or modified under the conditions of the
% LaTeX Project Public License, either version 1.3 of this license or (at
@@ -33,24 +33,23 @@
\begin{itemize}
\item 一个基本的 \hologo{TeX} 发行版。
\item CJK 或 XeCJK(供 \hologo{XeLaTeX} 使用)宏包。
- \item ctex\supercite{ctex} 宏包(提供了 ctexbook 文档类)。
+ \item ctex\cupercite{ctex} 宏包(提供了 ctexbook 文档类)。
\item 中文字体。
\item 如果要使用 biblatex 进行文献列表和引用的排版的话,
- 还需要 biblatex\supercite{biblatex} 宏包;
+ 还需要 biblatex\cupercite{biblatex} 宏包;
\item 如果要对中文文献进行按汉语拼音的排序的话,
- 还需要 biber\supercite{biber} 程序。
+ 还需要 biber\cupercite{biber} 程序。
\item 如果使用默认的文献列表和引用样式的话,还需要作者编写的 biblatex 样式
- (biblatex-caspervector\supercite{biblatex-caspervector}),
+ (biblatex-caspervector\cupercite{biblatex-caspervector}),
此样式要求使用 biber 程序。
- \item 如果须要使用 Makefile 来实现自动编译,还需要 Make 工具;
- 但如果使用由批处理实现的伪“Makefile”就不用了。
+ \item 如果须要使用 latexmk 来实现自动编译,还需要 latexmk 工具。
\end{itemize}
\myemph{最新}的\myemph{完全版} \hologo{TeX} Live 系统(\myemph{%
注:某些 Linux 发行版软件仓库中的 \hologo{TeX} Live 有问题,
建议使用独立安装版的 \hologo{TeX} Live%
\unemph{\footnote{\url{https://www.tug.org/texlive/}.}}。%
-})都已经包含除中文字体和 Make 之外所有要求的项目。%
+})都已经包含除中文字体之外所有要求的项目。%
\myemph{%
为了获得最好的支持,
我们建议用户使用最新、完全版的 \hologo{TeX} 系统和各宏包。%
@@ -66,22 +65,16 @@
这些字体是 GB18030 字符集的,不存在上述问题。%
}
-Linux 用户可以从软件源获得 GNU 的 make;
-其它类 UNIX 系统应该也会提供 make 工具,请参阅相应的文档以获得帮助。%
-Windows 用户可以从以下地址下载 Windows 下的 GNU make 工具:\\
-\hspace*{\parindent}%
-\url{http://gnuwin32.sourceforge.net/packages/make.htm}
-
\section{模版文件}\label{sec:doc-dir}
在正确安装 pkuthss 文档模版之后,在终端/命令提示符中执行
-\begin{Verbatim}[frame = single]
+\begin{Verbatim}
texdoc pkuthss
\end{Verbatim}
所打开的 pdf 文件所在的同一目录中包含两个子目录和相应的两个 pdf 文件,
其中 \verb|readme/| 为说明文档(即本文档)的源代码,%
\verb|example/| 为文档模版的源代码,%
-\verb|readme.pdf| 和 \verb|example.pdf|
+\verb|pkuthss.pdf| 和 \verb|example.pdf|
分别为说明文档和文档模版的 pdf 文件。
\verb|example/| 目录下的源代码使用的是 UTF-8 编码,
@@ -98,44 +91,32 @@ texdoc pkuthss
因此 pkuthss 文档模版的作者建议用户使用支持 LF 换行的文本编辑器编辑文件。%
}
-模版中的重要文件有:
+模版中的关键文件有:
\begin{itemize}
- \item \verb|Makefile|:
- 被 Make 工具调用的 Makefile,用于使编译工作自动化。
+ \item \verb|ctexopts.cfg|、\verb|ctex-fontset-pkuthss.def|:
+ 比较常用的字体配置,适用于 2.0 及以后版本的
+ ctex\cupercite{ctex} 宏包。
+ \item \verb|latexmkrc|:
+ 被 latexmk 工具读取的配置文件,用于使编译工作自动化。
\item \verb|Make.bat|:%
- Windows 下的伪“Makefile”,用 Windows 批处理实现。
+ 方便 Windows 用户使用的批处理文件,会调用 latexmk。
+ \item \verb|spine.tex|:书脊的源文件,具体用法请参考其中代码。
+ \item \verb|thesis.tex|:示例模版的主文件。
\item \verb|chap/|:目录,包含各章节内容:
\begin{itemize}
- \item \verb|copyright.tex|:版权声明部分。
- \item \verb|originauth.tex|:
- 原创性声明和使用授权说明部分\supercite{pku-originauth}。
+ \item \verb|copy.tex|:版权声明部分。
+ \item \verb|origin.tex|:
+ 原创性声明和使用授权说明部分\cupercite{pku-originauth}。
\end{itemize}
\myemph{%
- 注:pkuthss 文档模版支持排版学校要求的二维码,
- 请参考 \texttt{copyright.tex} 和
- \texttt{originauth.tex} 中的相关注释。%
+ 注:pkuthss 文档模版可排版学校要求的二维码,
+ 请参考 \texttt{copy.tex} 和 \texttt{origin.tex} 中的相关注释。%
}
-
- \item \verb|misc/|:
- 目录,目前包含比较常用的字体配置:
- \begin{itemize}
- \item \verb|ctexopts.cfg|、\verb|ctex-fontset-pkuthss.def|:
- 适用于 2.0 及以后版本的 ctex\supercite{ctex} 宏包。
- \item \verb|ctex-xecjk-windows.def|:
- 适用于 2.0 以前版本的 ctex 宏包。
- \end{itemize}
- 使用时,
- 请将和用户系统中 ctex 宏包版本相匹配的\myemph{所有}配置文件
- 复制到模版的主目录中。
\end{itemize}
\section{编译方式}\label{sec:compile}
-首次编译前,请将 \verb|misc/| 目录中和用户系统中
-ctex 宏包版本相匹配的配置文件复制到模版的主目录中,
-详见第 \ref{sec:doc-dir} 节。
-
pkuthss 文档模版支持三种编译方式,即
\begin{itemize}
\item \hologo{LaTeX} -- dvipdfmx 方式:\\
@@ -149,42 +130,36 @@ pkuthss 文档模版支持三种编译方式,即
\verb|xelatex| 和 \verb|xelatex|。
\end{itemize}
\myemph{%
- 注意:\hologo{XeLaTeX} 对非 UTF-8 编码的支持不好,
+ 注意:在特定情形下,\texttt{latex}/\texttt{pdflatex}/\texttt{xelatex}
+ 步骤可能须要执行多于 2 次,而下文推荐的 latexmk 工具会自动处理这类情形。
+ 此外,\hologo{XeLaTeX} 对非 UTF-8 编码的支持不好,
因此 \hologo{XeLaTeX} 方式的编译不支持 GBK 编码。%
}
-pkuthss 文档模版附带的 Makefile 中已经对这三种编译方式进行了完整的配置。
-用户只须要在 Makefile 中通过设定变量 \verb|JOB| 的值指定被编译的主文件名,
-并通过设定变量 \verb|LATEX| 的值指定采用哪种编译方式,
-即可通过在主文件所在目录调用 Make 工具来实现自动编译:
-如果是在类 UNIX 环境下,则用户应该调用的命令名为 \verb|make|:
-\begin{Verbatim}[frame = single]
+pkuthss 文档模版附带的 \verb|latexmkrc| 中已经对这三种编译方式进行了完整的
+配置。用户只须要在 \verb|latexmkrc| 中通过设定变量 \verb|default_files|
+的值指定被编译的主文件名,并通过设定变量 \verb|pdf_mode| 的值指定采用
+哪种编译方式,即可通过在主文件所在目录调用 latexmk 工具来实现自动编译:
+类 UNIX 环境下大致如下
+\begin{Verbatim}
cd /path/to/directory/with/thesis.tex
-make
+latexmk
\end{Verbatim}
-而如果是在 Windows 环境下,则用户应该调用的命令名可能为 \verb|mingw32-make|:
-\begin{Verbatim}[frame = single]
+而在 Windows 环境下大致如下
+\begin{Verbatim}
cd \path\to\directory\with\thesis.tex
-mingw32-make
+latexmk
\end{Verbatim}
-用户如果不想配置 Windows 下的 GNU Make,
-则也可以使用由 Windows 批处理实现的伪“Makefile”,
-通过在主文件所在目录调用 \verb|make|\footnote{%
- Windows 将批处理文件作为可执行文件,调用时可以不显式地指出扩展名。%
-}:
-\begin{Verbatim}[frame = single]
-cd \path\to\directory\with\thesis.tex
-make
-\end{Verbatim}
-\myemph{%
+Windows 用户也可以使用批处理文件 \verb|Make.bat|:
+在主文件所在目录双击此文件,它便会调用 latexmk 进行编译。\myemph{%
注意:%
Windows 批处理对于 LF(\texttt{\string\n})换行的批处理文件支持有问题。
在命令提示符(cmd)下执行这些批处理文件时没有问题,
但双击文件图标执行时可能就会出错。
\hologo{TeX} Live 中安装的 \texttt{Make.bat} 和
CTAN 上提供的压缩包里的 \texttt{Make.bat}
- 有可能是 LF(\texttt{\string\n})换行的。%
+ 在正常情况下应该是 CRLF(\texttt{\string\r\string\n})换行的。%
}
% vim:ts=4:sw=4