Skip to content

Commit

Permalink
docs: 参考同学建议修改
Browse files Browse the repository at this point in the history
Co-authored-by: zhenmianmua
Co-authored-by: CZLeader <[email protected]>
Co-authored-by: Cal-Darkman
  • Loading branch information
2 people authored and fky2015 committed Apr 23, 2024
1 parent 55a7cae commit ddd3c91
Show file tree
Hide file tree
Showing 4 changed files with 70 additions and 69 deletions.
2 changes: 1 addition & 1 deletion bithesis-doc.tex
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ \subsection{\BIThesis 宏包的安装和更新}
\end{shell}

\textbf{
在安装完发行版之后,还需要安装编辑 \LaTeX 所需的编辑器,在这里推荐 TexStudio
在安装完发行版之后,还需要安装编辑 \LaTeX 所需的编辑器,在这里推荐 TeXstudio
}

\textit{更多安装教程请访问我们的
Expand Down
48 changes: 25 additions & 23 deletions the-graduates-handbook/chapters/ch1-intro.tex
Original file line number Diff line number Diff line change
Expand Up @@ -3,49 +3,47 @@ \chapter{关于 \LaTeX 和 \BIThesis 的一些疑难解答}

\section{为什么要用 \LaTeX{} 和 \BIThesis{}?}

学术、学位论文有严格的格式要求。为了更多同学的方便使用,校方一般提供大家更为熟悉
的 Word 模板。虽然 Word 确实是大家最常用的排版工具,但是:
学术、学位论文有严格的格式要求。校方一般提供 Word 模板。虽然一般同学更常用 Word,但是:
\begin{center}
\kaishu
如果你有足够多使用 Word 的经历,一定会体验过「同一份 Word 文档,在不同地方打开
就变得不同」这样的魔幻现实主义色彩的经历。
\end{center}

\LaTeX{} 是专用于高质量的学术论文排版的排版工具,能让同学们更专注于内容本身,更
自信地排版符合格式要求的学术、学位论文。\BIThesis{} 项目旨在提供一套开箱即用的、
符合北京理工大学硕士(博士)学位论文的\LaTeX{} 模板,以助力高质量的学术写作。通
\BIThesis{} 模板,学生可以轻松撰写符合学校格式要求的学位论文,可避免繁琐的论
文格式调整,从而将关注点更多地放在高质量的内容本身。
\LaTeX{} 适用于学术论文排版,使用者能将关注点更多放在内容质量,避免繁琐的格式调整。
\BIThesis{} 提供了一套开箱即用的 \LaTeX{} 模板,符合北京理工大学\isGraduateTF{硕士(博士)学位论文}{本科生毕业设计(论文)}规范。

\section{为何需要这么多步骤,我该如何开始?}

首先,\LaTeX{} 并不是像 Word 一样的一个开箱即用的软件。\LaTeX{} 本质上是一门用于
排版的「语言」或「语法规则」。我们实际上,是以 \underline{纯文本文件}(以
\texttt{.tex} 结尾的文件)为基础,用这样的一套 \underline{拟定好的标记语法} 来
设定文字的格式,并 \underline{利用一些工具},将其转化为符合格式要求的 PDF 文档。

我们重新回顾一下这句话:
首先,\LaTeX{} 与 Word 不同,它本质上是用于
排版的「语言」或「语法规则」。我们实际上是编辑\underline{文本文件}(以
\texttt{.tex} 结尾的文件),用一套\underline{拟定好的标记语法}
设定文字的样式,并\underline{利用一些工具},将其转化为 PDF 文档。

\begin{itemize}[noitemsep]
\item \textbf{\underline{纯文本文件}} 意味着我们只需要创建一个以 \texttt{.tex}
\item \textbf{\underline{文本文件}} 意味着我们只需要创建一个以 \texttt{.tex}
结尾的文件,即可开始论文内容的撰写;
\item \textbf{\underline{拟定好的语法}} 则需要我们了解一些 \LaTeX{} 中常用的语
法语言规则,用来以纯文本的形式描述内容的格式,从而让下面提到的工具可以根据格式
需要,将文档转化为PDF
法语言规则,用来以文本的形式描述内容的格式,从而让下面提到的工具可以根据格式
需要,将文档转化为PDF
\item \textbf{\underline{利用一些工具}} 也就表示我们需要这些工具(程序),来将
纯文本内容转化为符合格式的 PDF 文档:我们或是下载安装他们到本地,或是使用在线
平台开箱即用;
文本内容转化为符合格式的 PDF 文档:我们或是下载安装他们到本地,或是使用在线平台。
\end{itemize}

因此,本手册也将以这样的逻辑,为大家分别介绍每处需要的知识 --- 我们将首先介绍如
何「安装这些工具」,并如何更舒服的创建、编写此「纯文本文件」(在自己的电脑上和使
因此,本手册也将以这样的逻辑,为大家分别介绍每处需要的知识——我们将首先介绍如
何「安装这些工具」,并如何更舒服地创建、编写此「文本文件」(在自己的电脑上和使
用在线的编辑器是不一样的);而后,我们将在后续的章节,简单的讲述常用的「拟定好的
语法」--- 以让大家快速上手,使用 \BIThesis{} 撰写自己的毕业论文。

\section{在自己的电脑上编写论文}

\textit{
\ref{sec:local-compile} 节介绍了如何安装 TeX Live(一些工具)和 TeXstudio(文本文件编辑器)。
若您已正常得到PDF,可直接跳到~\ref{sec:using-bithesis} 节编写论文。
}

在这里,我们将在自己的电脑上配置安装撰写 \LaTeX{} 的相关工具。首先,我们搞定
\underline{一些工具} 的安装,来更方便的撰写 \underline{纯文本文件} 并将其转化为
\underline{一些工具} 的安装,来更方便的撰写 \underline{文本文件} 并将其转化为
符合格式的 PDF 文档。

\paragraph{一些工具的安装} 在 \LaTeX{} 的世界中,我们的「一些工具」包括将
Expand All @@ -64,8 +62,8 @@ \section{在自己的电脑上编写论文}
MacTeX 2022} 并下载安装 \texttt{MacTeX.pkg};
\end{itemize}

\paragraph{纯文本文件} 我们撰写的 \LaTeX{} 文档,确实是「无格式」的纯文本文档
也因此,任何能够编辑纯文本的工具我们其实都可以使用。但是,专业的\LaTeX{} 编辑器
\paragraph{文本文件} 我们撰写的 \LaTeX{} 文档,确实是「无格式」的文本文档
也因此,任何能够编辑文本的工具我们其实都可以使用。但是,专业的\LaTeX{} 编辑器
一般会提供 \LaTeX{} 源码的编辑和预览功能。虽然不是必要的,但是使用编辑器可以大大
提高\LaTeX{} 的使用效率。

Expand All @@ -75,9 +73,11 @@ \section{在自己的电脑上编写论文}
的撰写体验。
更具体的指南可参考\href{https://bithesis.bitnp.net/guide/configure-and-compile.html}{编辑器配置与模板编译 | BIThesis-wiki}。

\textit{
到此,我们其实就可以直接使用本模板,在自己的电脑上进行论文的编写了。如果想再了解
有关在线编辑平台 Overleaf 的相关内容,请继续阅读~\ref{sec:online-overleaf} 节;
否则,大家可以直接跳转到~\ref{sec:using-bithesis} 节,了解模板的使用方法。
}

\section{本地编辑或是 Overleaf 在线平台,我改使用哪一个?}
\label{sec:online-overleaf}
Expand Down Expand Up @@ -108,7 +108,9 @@ \section{本地编辑或是 Overleaf 在线平台,我改使用哪一个?}

\section{如何将自己电脑上的论文转到 Overleaf}

\textit{
\ref{sec:overleaf-compile} 节介绍了如何从 \url{https://bithesis.bitnp.net} 新建项目,那样通常更简单;不过若您已在本地用了模板,想转到 Overleaf(例如为了调试),请参考此节。
}

\begin{enumerate}
\item 按网页提示上传文件到 Overleaf,注意\textbf{避免嵌套文件夹}。
Expand Down
64 changes: 35 additions & 29 deletions the-graduates-handbook/chapters/ch3-latex-syntax.tex
Original file line number Diff line number Diff line change
@@ -1,50 +1,56 @@
\chapter{公式、图像和表格}
\chapter{公式、图表等文档元素}
\label{chap:example}

公式、图表和插图广泛使用于学位论文中,并且在正文内存在较多的交叉引用,对他们的高效处理也是\LaTeX{}的优势之一。公式、图表和插图在定义时的共同特点包含:定义中需要设定引用标签、设置图表名称。定义时,图表摆放位置并无要求,\LaTeX{}会根据文稿内容自动计算图表摆放位置,不会出现表格窜行的问题。
\textit{
通常可先跳过这章,有需求再回来翻。
}

公式、图像和表格广泛用于学位论文,且会被正文频繁交叉引用,\LaTeX{}也能对它们高效处理。若想引用这些内容,定义时要注意设定引用标签。此外,图表并无严格摆放位置要求,\LaTeX{}会参考文字内容上下浮动,尽量避免表格窜行等问题。

\section{公式与数学环境}

\subsection{公式及术语表}
\label{sec:eqn}

公式定义的内容包含在\verb|\begin{equation}|\verb|\end{equation}|之间。为方便,公式的编辑可以采用\textbf{在线的\LaTeX{}公式编辑器}(截至2023年,\href{https://www.latexlive.com/}{latexlive.com}可以视为一个不错的例子)。一般的\LaTeX{}编辑器如 TexStudio 也都会提供语法补全。
公式有行内夹杂、独占整行两种。行内公式写在一对\verb|$|间,如 \verb|$m = \rho V$| 排版为 $m = \rho V$;独行公式则写在\verb|\begin{equation}|与\verb|\end{equation}|之间。

为方便,可用 \href{https://www.latexlive.com/}{latexlive.com} 等网站\textbf{在线编辑}公式,或用 \href{https://mathpix.com/snipping-tool}{Mathpix Snipping Tool} 等\textbf{从图片转换}。一般的\LaTeX{}编辑器如 TeXstudio 也都会提供语法补全。

{\bf{实例1:}} 以下是L-B非稳态流动升力模型,公式引用为公式\ref{eqn:LBmodel}。该公式的术语列表见 表 \ref{tab:LB-parameters}。
\begin{equation}
\label{eqn:LBmodel}
C_{L}=C_{L0}+C_{L\alpha }\left ( \frac{1+\sqrt{X}}{2} \right )\alpha
\label{eqn:LBmodel}
C_{L} = C_{L0} + C_{L \alpha} \left( \frac{1+\sqrt{X}}{2} \right) \alpha
\end{equation}

\begin{lstlisting}[language={[LaTeX]TeX}, caption={L-B非稳态流动升力模型}]
\begin{equation}
\label{eqn:LBmodel}
C_{L}=C_{L0}+C_{L\alpha }\left ( \frac{1+\sqrt{X}}{2} \right )\alpha
\label{eqn:LBmodel}
C_{L} = C_{L0} + C_{L \alpha} \left( \frac{1+\sqrt{X}}{2} \right) \alpha
\end{equation}
\end{lstlisting}

\subsection{长公式排版}


Math mode》里有举一个长公式排版的例子如下。《Math mode》有十分丰富实用的例子,感兴趣的同学可以参考一下
\textit{Math mode} 有丰富实用例子,其中长公式一例如下,有需要的的同学可参考

\begin {multline}
\frac {1}{2}\Delta (f_{ij}f^{ij})=
2\left (\sum _{i<j}\chi _{ij}(\sigma _{i}-
\sigma _{j}) ^{2}+ f^{ij}\nabla _{j}\nabla _{i}(\Delta f)+\right .\\
\left .+\nabla _{k}f_{ij}\nabla ^{k}f^{ij}+
f^{ij}f^{k}\left [2\nabla _{i}R_{jk}-
\nabla _{k}R_{ij}\right ]\vphantom {\sum _{i<j}}\right )
\begin{multline}
\frac{1}{2} \Delta (f_{ij} f^{ij}) =
2 \left(\sum_{i<j} \chi_{ij} (\sigma_{i} - \sigma_{j})^{2} +
f^{ij} \nabla_{j} \nabla_{i} (\Delta f) + \right. \\
\left. + \nabla_{k} f_{ij} \nabla^{k} f^{ij} + f^{ij} f^{k}
\left[2 \nabla_{i} R_{jk} - \nabla_{k} R_{ij} \right]
\vphantom {\sum_{i<j}} \right)
\end{multline}

\begin{lstlisting}[language={[LaTeX]TeX}, caption={长公式排版}]
\begin {multline}
\frac {1}{2}\Delta(f_{ij}f^{ij})=
2\left(\sum_{i<j}\chi_{ij}(\sigma_{i}-
\sigma_{j}) ^{2}+ f^{ij}\nabla_{j}\nabla_{i}(\Delta f)+\right.\\
\left.+\nabla_{k}f_{ij}\nabla ^{k}f^{ij}+
f^{ij}f^{k}\left [2\nabla_{i}R_{jk}-
\nabla_{k}R_{ij}\right]\vphantom{\sum_{i<j}}\right )
\begin{multline}
\frac{1}{2} \Delta (f_{ij} f^{ij}) =
2 \left(\sum_{i<j} \chi_{ij} (\sigma_{i} - \sigma_{j})^{2} +
f^{ij} \nabla_{j} \nabla_{i} (\Delta f) + \right. \\
\left. + \nabla_{k} f_{ij} \nabla^{k} f^{ij} + f^{ij} f^{k}
\left[2 \nabla_{i} R_{jk} - \nabla_{k} R_{ij} \right]
\vphantom {\sum_{i<j}} \right)
\end{multline}
\end{lstlisting}

Expand Down Expand Up @@ -88,7 +94,7 @@ \subsection{定理环境}

\begin{lstlisting}[language={[LaTeX]TeX}, caption={定理环境}]
\begin{them}[留数定理]
假设$U$是复平面上的一个单连通开子集......
假设$U$是复平面上的一个单连通开子集……
\end{them}
\end{lstlisting}

Expand Down Expand Up @@ -119,7 +125,7 @@ \subsection{支持的图片格式}

最基本的图片插入示例可见图\ref{fig:diagram},其代码如\ref{demo-figure1}所示。

其中\verb+\centering+表示图片居中,\verb+\includegraphics[...]{...}+导入图片并制定图片大小\verb+\caption{}+指定图片标题,而\verb+\label{...}+为图片加上引用标签。
其中\verb+\centering+表示图片居中,\verb+\includegraphics[…]{…}+导入图片并指定图片大小\verb+\caption{}+指定图片标题,而\verb+\label{}+为图片加上引用标签。

\begin{figure}
\centering
Expand Down Expand Up @@ -163,8 +169,8 @@ \subsection{支持的图片格式}
\subsection{长标题的换行}
\label{sec:longcaption}

\ref{fig:longcaptionbad}和图\ref{fig:longcaptiongood}都有比较长图标题,通过对比发现,图\ref{fig:longcaptiongood}的换行效果更好一些。
其中使用了minipage环境来限制整个浮动题的宽度
\ref{fig:longcaptionbad}和图\ref{fig:longcaptiongood}的标题都比较长。对比可发现图\ref{fig:longcaptiongood}的标题换行效果更好一些,
它使用了minipage环境来限制整个浮动体的宽度

不过在实际使用中,你可以根据排版的整体效果来自行决定。

Expand Down Expand Up @@ -327,10 +333,10 @@ \subsection{将参考文献的内容与表现分离}

\BIThesis{}论文模板使用 \href{https://www.ctan.org/pkg/biblatex}{BibLaTeX} 处理参考文献。它的出现让我们摆脱手写参考文献条目
的麻烦。
当然,使用者也可以手动编参考文献item,直接插入文档中。但是,有BibLaTeX帮助,处理起参考文献更为简单。
当然,使用者也可以手动编辑参考文献item,直接插入文档中。但是,有BibLaTeX帮助,处理起参考文献更为简单。

参考文献的具体内容就是\isGraduateTF{\texttt{reference}文件夹下的\texttt{main.bib}}{\texttt{misc}文件夹下的\texttt{ref.bib}},
参考文献的元数据(名称、作者、出处等)以一定的格式保存在这些纯文本文件中
参考文献的元数据(名称、作者、出处等)以一定的格式保存在这些文本文件中
.bib文件也可以理解为参考文献的``数据库'',正文中所有引用的参考文件条目都会从这些文件中``析出''
控制参考文献条目``表现形式''(格式)的代码通过 main.tex 中的 \\ \verb|\usepackage[style=gb7714-2015,...]{biblatex}| 引入。
按照学校要求,本模板使用的是国标GB/T 7714风格的参考文献析出格式(最新版本)。
Expand Down Expand Up @@ -366,7 +372,7 @@ \subsection{在正文中引用参考文献}
最后总结一些注意事项:
\begin{itemize}
\item 参考文献只有在正文中被引用了,才会在最后的参考文献列表中出现;
\item 参考文献``数据库文件''.bib是纯文本文件,请使用~UTF-8~编码,不要使用~GBK~编码;
\item 参考文献``数据库文件''.bib是文本文件,请使用~UTF-8~编码,不要使用~GBK~编码;
\item 参考文献条目同样有“内容”和“表现形式”之分,这种可控性是BibLaTeX带来的。
\end{itemize}

Expand Down
25 changes: 9 additions & 16 deletions the-graduates-handbook/chapters/conclusion.tex
Original file line number Diff line number Diff line change
@@ -1,21 +1,14 @@
\begin{conclusion}

学位论文的格式要求通常比较严格,既是为了确保学术交流规范高效,也是科学研究严谨性的直观体现。
然而市场上排版软件鱼龙混杂,使用者水平不一,学生对格式不够重视,写出的学位论文存在很多问题,常常不符合标准。
\BIThesis 为符合北京理工大学\isGraduateTF{硕士(博士)学位论文}{本科生毕业设计(论文)}规范的 \LaTeX 模板。
采用 \BIThesis,学生可轻松撰写出符合学校格式要求的学位论文,将关注点更多放在内容质量,而避免繁琐的格式调整。
目前 \BIThesis 还在不断完善更新,可能存在错误或不足。
欢迎广大师生提出宝贵意见,帮助我们发现并解决问题。
本项目的 GitHub 仓库是 \href{https://github.com/BITNP/BIThesis/}{BITNP/BIThesis},
\textbf{欢迎\href{https://github.com/BITNP/BIThesis/issues/new/choose}{提交 issue} 或 pull request,帮助 \BIThesis 变得更好。}

学位论文通常具有比较严格的格式要求,这是为了方便同行学术交流的起码要
求,同时也是科学研究严谨性的体现。然而,由于市场各种排版软件混杂,使用者水
平不一,学生对格式的重视程度不够,学生编写标准格式的学位论存在很多问题。
\BIThesis 为符合北京理工大学\isGraduateTF{硕士(博士)学位论文}{本科生毕业设计(论文)}的 \LaTeX 模板。通过 \BIThesis 模板,学生可以轻松撰写符合学校格式要求的学位论文,可将关注点更多地放在
高质量的内容本身,而避免繁琐的论文格式调整。
目前本模板还处于不断修改与更新阶段,
可能存在诸多错误与问题,
请提出宝贵意
见。
本项目的 GitHub 地址为:
https://github.com/BITNP/BIThesis ,\textbf{欢迎大家在 GitHub 上提交
Pull Request 或者 Issue 以帮助这个项目变得更好}。
希望同学们参考这份指南,能快速掌握如何使用 \BIThesis 模板,写出符合学校格式要求的\isGraduateTF{硕士(博士)学位论文}{本科生毕业设计(论文)},并基本了解 \LaTeX

本手册是针对北京理工大学\isGraduateTF{硕士(博士)学位论文}{本科生毕业设计(论文)} \LaTeX 模板 \BIThesis 的快速上手指南。
旨在使同学们通过该指南的介绍,能快速掌握使用 \BIThesis 模板,编辑符
合学校格式要求的\isGraduateTF{硕士(博士)学位论文}{本科生毕业设计(论文)},并能对 \LaTeX 有一定的了解。

\end{conclusion}

0 comments on commit ddd3c91

Please sign in to comment.