Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: 改进几处文档 #559

Merged
merged 2 commits into from
Oct 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 22 additions & 6 deletions bithesis-doc.tex
Original file line number Diff line number Diff line change
Expand Up @@ -1844,17 +1844,33 @@ \subsection{后置部分}

\textit{通常在「攻读学位期间发表论文与研究成果清单」的 |.bib| 文件中使用。}
\begin{itemize}
\item 在普通模式下,输出作者姓名。
\item 普通模式:

(作者姓名由用户在 |info/author| 中配置。)
\begin{itemize}
\item 默认输出作者姓名。

(作者姓名由用户在 |info/author| 中配置。)

\item 如果指定了覆盖普通模式下内容,则输出覆盖内容。
\item 如果指定了覆盖普通模式下内容,则输出覆盖内容。
\end{itemize}

\item 在盲审模式下,输出「第n作者」。
\item 盲审模式:

\begin{itemize}
\item 默认输出「第n作者」。

(具体情况:|\Author| 输出中文,如|第一作者|;|\AuthorEn| 输出英文,如 |First Author|。)
(具体情况:|\Author| 输出中文,如|第一作者|;|\AuthorEn| 输出英文,如 |First Author|。)

\item 如果指定了覆盖盲审模式下内容,则输出覆盖内容。
\item 如果指定了覆盖盲审模式下内容,则输出覆盖内容。
\end{itemize}
\end{itemize}

使用示例:
\begin{itemize}
\item |\Author| 输出作者姓名(普通)或|第n作者|(盲审),具体编号取决于 |.bib| 文件中 |author+an| 字段标注的位置。
\item |\Author[][][第一发明人]| 输出作者姓名(普通)或|第一发明人|(盲审)。
\item |\AuthorEn[2]| 输出作者姓名(普通)或|Second Author|(盲审)。
\item |\Author[][][共同二作]| 输出作者姓名(普通)或|共同二作|(盲审)。
\end{itemize}
\end{function}

Expand Down
4 changes: 0 additions & 4 deletions handbook/chapters/ch2-example-pub.bib
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
@article{zhang2021,
author = {张三 and 李四 and 王五},
title = {论文标题},
journal = {期刊名},
year = {2021},
volume = {1},
pages = {1--10},
author+an = {1:myself="\Author"},
}
19 changes: 10 additions & 9 deletions handbook/chapters/ch2-template-usage.tex
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,11 @@ \subsection{主体内容文件夹}
\item 补充在\texttt{misc/}\isGraduateTF{、\texttt{references/}}{}文件夹中的其他内容。
\end{enumerate}

更棒的是,我们可以通过修改配置一键生成支持盲审的论文版本——一次写作,
更棒的是,我们可以\hyperref[sec:blind]{通过修改配置一键生成支持盲审的论文版本}——一次写作,
多种格式!

\section{个人信息录入}
\label{sec:BITSetup}

在 \texttt{main.tex} 中,我们可以看到如下的代码:
\begin{lstlisting}[language=TeX]
Expand All @@ -99,6 +100,7 @@ \section{个人信息录入}
author = 张三,
major = 材料科学与工程,
school = 材料学院,
keywords = {…;…},
% ...
},
% ...
Expand All @@ -117,10 +119,7 @@ \section{个人信息录入}

\section{摘要和关键字}

摘要内容,放置在 \texttt{chapters/} 文件夹中的 \texttt{\isGraduateTF{}{0\_}abstract.tex} 文件中。
其中,摘要的关键字可在 \texttt{main.tex} 中「信息录入」的部分进行配置。

中英文摘要通过如下方式进行书写:
中英文摘要在 \texttt{chapters/} 文件夹中的 \texttt{\isGraduateTF{}{0\_}abstract.tex} 编写:

\begin{lstlisting}[language=TeX]
\begin{abstract}
Expand All @@ -132,6 +131,7 @@ \section{摘要和关键字}
\end{abstractEn}
\end{lstlisting}

至于摘要后的关键字,可编辑 \texttt{main.tex},在\hyperref[sec:BITSetup]{「信息录入」}中配置 \texttt{info/keywords}、\texttt{info/keywordsEn}。

\section{论文主体}

Expand Down Expand Up @@ -169,9 +169,9 @@ \section{其他部分}
时,就已经知道了如何编写这些部分的内容了。

\isGraduateTF{
需要特殊注意的是,「成果清单」中的成果是通过引用 \texttt{pub.bib}
中的文献来生成的。因此,如果你需要在「成果清单」中添加
新的成果,那么你需要首先在 \texttt{pub.bib} 中添加新的文献条目。%
\subsection{「攻读学位期间发表论文与研究成果清单」}
这部分用 \texttt{pub.bib} 记录文献,用 \texttt{4\_pub.tex} 列出清单。
增添成果需首先在 \texttt{pub.bib} 中添加新的文献条目。%
%
而如果你想要在盲审模式中隐藏自己的名字,那么你需要
根据 pub.bib 中的示例以及注释说明,为每个文献条目添加并设置
Expand All @@ -181,7 +181,7 @@ \section{其他部分}
通过设置 \texttt{author+an} 字段,我们可以在盲审模式打开时,
将自己的名字自动替换为「第一作者」。
%
更具体的用法,可以参考 \texttt{pub.bib} 的注释内容或者 \texttt{bithesis.pdf} 中的说明。
此外,如需调整排序、分组、手动列表等,请参考 \texttt{pub.bib}、\texttt{4\_pub.tex} 等中的注释或者 \texttt{bithesis.pdf} 中的说明。
}{}
\subsection{交叉引用}

Expand Down Expand Up @@ -224,6 +224,7 @@ \subsubsection{文献引用}
\end{enumerate}

\section{生成盲审版论文}
\label{sec:blind}

提交论文用于匿名评阅(又名盲审或盲评)时,需要“隐去论文作者和导师姓名,以及致谢、论文成果等与作者有关的信息”。
% 以上引文源于《北京理工大学关于本科毕业设计(论文)评阅的规定(试行)》(2023年4月修订)。
Expand Down
9 changes: 6 additions & 3 deletions templates/graduate-thesis/misc/4_pub.tex
Original file line number Diff line number Diff line change
Expand Up @@ -36,16 +36,19 @@
% 如果想要分为多个列表,可以使用以下的命令。
% 主要针对博士生。
% \pubsection{文章}
%
% \printbibliography[heading=none,type=article,category=mypub,resetnumbers=true]{}
%
% \pubsection{一些书}
%
% \printbibliography[heading=none,type=book,category=mypub,resetnumbers=true,notkeyword=dummy]{}
%
% \pubsection{另一些书}
%
% \printbibliography[heading=none,type=book,category=mypub,keyword=dummy,resetnumbers=true]{}
%
% 关于 \printbibliography 的筛选参数:
% 0. 请保留“category=mypub”。(这样只列出成果,不列出正文参考文献。)
% 1. 设置“type=…”,每次只输出某一类型。
% 2. 若需继续细分,请在 pub.bib 的条目里记录“keywords = {…, …}”,然后在此用“keyword=…”筛选。
% 3. 如果还有要求,可用notkeyword、subtype等筛选方法,请参考 biblatex 手册。

% 以下内容提供了一个可以同时和 \printbibliography 共存的自定义列表格式。
% \zihao{5} % 字号改为五号
Expand Down