From c4134888a9fd2f8276143af1ade2dd7b6f643628 Mon Sep 17 00:00:00 2001 From: Rizhong Lin Date: Tue, 5 Mar 2024 05:36:44 +0100 Subject: [PATCH] Update references format and examples --- CONTRIBUTING.md | 28 ++++++++-------------------- main.tex | 4 +--- sections/03_reference.tex | 14 +++++++++++--- sections/thanks.tex | 2 +- style/tongjithesis.cls | 5 ++++- style/tongjithesis.sty | 2 +- 6 files changed, 26 insertions(+), 29 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b424cfc..c802e2b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,39 +4,27 @@ * source files: as a template repository, "source files" are ".cls", ".sty" and some related files with other extension names. * doc files: including all ".tex" files and even "main.tex", which show how to use "source files". -* config files: These files make our development and use of templates more standardlized (e.g. .gitignore, .latexmkrc, .editorconfig). +* config files: These files make our development and use of templates more standardized (e.g. .gitignore, .latexmkrc, .editorconfig). ## How to contribute ### How to ask for help? -Providing conditions where people ask for help and solve problems is also part of community. We hope to provide technique support in [Discussions](https://github.com/TJ-CSCCG/tongji-undergrad-thesis/discussions). Read [this discussion](https://github.com/TJ-CSCCG/tongji-undergrad-thesis/discussions/6) and get start. +Providing conditions where people ask for help and solve problems is also part of the community. We hope to provide technique support in [Discussions](https://github.com/TJ-CSCCG/tongji-undergrad-thesis/discussions). Read [this discussion](https://github.com/TJ-CSCCG/tongji-undergrad-thesis/discussions/6) and get started. It has to be **NOTICED** that: **DO NOT CONTACT WITH ANY CONTRIBUTOR THROUGH IM**! ### How to report a bug? -If a bug is confirmed, you can raise it in the [Issues](https://github.com/TJ-CSCCG/tongji-undergrad-thesis/issues). +You can raise a bug in the [Issues](https://github.com/TJ-CSCCG/tongji-undergrad-thesis/issues) if a bug is confirmed. -### How to pull request? +### How to pull a request? -We recommend to follow this workflow step by step: +We recommend following this workflow step by step: -1. Fork this repository as upstream repository. +1. Fork this repository as the upstream repository. 2. Clone the repository forked from remote to local. 3. Create a new local branch as a work branch. -4. Commit some changes on the work branch. +4. Commit some changes to the work branch. 5. Push the new local branch to remote with commits. -6. Pull request, from the new remote branch to any branch of upstream repository. - -## History and Maintainers - -Thanks to the pioneers in the field of LaTeX thesis template development of Tongji University, [YukuanHu](https://github.com/YukuanHu) and [SXKDZ](https://github.com/SXKDZ). - -* 2019.05.24: [YukuanHu](https://github.com/YukuanHu) (School of Mathematical Sciences, class of 2016) created a [repository](https://github.com/YukuanHu/Bachelor) about his 8th semester and made his thesis template public in it. -* 2019.04.09: [SXKDZ](https://github.com/SXKDZ) (School of Software Engineering, class of 2016) created [tongjithesis](https://github.com/SXKDZ/tongjithesis) (:star: 100+) with various features implemented. - -And thanks to [ganler](https://github.com/ganler), who made [YukuanHu](https://github.com/YukuanHu)'s template compatible with XeLaTeX on multiple platforms (e.g. Overleaf, MacOS, Linux) and transfered "overleaf_tongji_thesis" to [TJ-CSCCG](https://github.com/TJ-CSCCG) as [tongji-undergrad-thesis](https://github.com/TJ-CSCCG/tongji-undergrad-thesis). - -* From 2021.05.09 to 2021.05.29: [ganler](https://github.com/ganler) -* From 2021.05.30 to Now: [TJ-CSCCG](https://github.com/TJ-CSCCG) +6. Pull a request from the new remote branch to any branch of the upstream repository. \ No newline at end of file diff --git a/main.tex b/main.tex index f4497c0..4a737d3 100644 --- a/main.tex +++ b/main.tex @@ -25,9 +25,7 @@ \input{sections/05_conclusion} \clearpage -\phantomsection % 添加占位符章节 -\addcontentsline{toc}{section}{参考文献} -\printbibliography[heading=bibliography,title=参考文献] +\printbibliography[heading=bibintoc,title=参考文献] \clearpage \input{sections/thanks} diff --git a/sections/03_reference.tex b/sections/03_reference.tex index 92f725f..9158d05 100644 --- a/sections/03_reference.tex +++ b/sections/03_reference.tex @@ -4,7 +4,7 @@ \section{引用}\label{sec:reference} \subsection{参考文献的引用} -在学术论文或科技报告中，通常需要引用相关文献以支持观点或论证。为了方便读者查阅，我们需要在论文中标注参考文献。在 \LaTeX\ 中，可使用 \verb|\cite| 命令引用参考文献。参考文献的外观应符合国标 GB/T 7714，可使用 \BibLaTeX{} 配合 \pkg{biblatex-gb7714-2015} 样式包来控制输出样式。\textbf{关于各类文献的标准格式和 \BibLaTeX\ 的使用方法，请参考 \href{https://ctan.org/pkg/biblatex-gb7714-2015}{\pkg{biblatex-gb7714-2015} 样式包文档}的第 4.3 节。} +在学术论文或科技报告中，通常需要引用相关文献以支持观点或论证。为了方便读者查阅，我们需要在论文中标注参考文献。在 \LaTeX\ 中，可使用 \verb|\cite| 命令引用参考文献。参考文献的外观应符合国标 GB/T 7714，可使用 \BibLaTeX{} 配合 \pkg{biblatex-gb7714-2015} 样式包来控制输出样式。关于各类文献的标准格式和 \BibLaTeX{} 的使用方法，请参考 \pkg{biblatex-gb7714-2015} 样式包文档的第 4.3 节。 在正文中，可使用 \verb|\cite| 命令引用参考文献。例如： @@ -51,6 +51,14 @@ \subsection{参考文献的引用} 可使用 \verb|\nocite{key1,key2,key3...}| 将参考文献条目加入文献表中，但不在正文中引用。使用 \verb|\nocite{*}| 可将参考文献数据库中的所有条目加入文献表中。 +当我们想在正文（非参考文献章节）中插入对某一参考文献的完整引用时，可以使用 \verb|\fullcite{key1}| 命令。下面是使用 \verb|\fullcite| 命令的引用示例： + +\begin{itemize} + \item \fullcite{qin2021} +\end{itemize} + +有时，我们想要用脚注的形式引用某参考文献，那么我们可以使用 \verb|\footfullcite{key1}| 命令\footfullcite{qin2021}。 + 另外，为了避免遗漏引用，有时候需要使用文献管理工具来管理参考文献，例如 Zotero 或 EndNote 等。这些工具可以帮助你轻松管理文献数据库，生成参考文献列表，甚至将参考文献直接插入到文档中。 无论使用何种方法，都应该注意文献的准确性和完整性。在引用文献时，应尽可能使用最新的版本，并注意对文献信息的正确引用和格式化。这样可以提高文献的可信度，也能为读者提供更多参考信息。 @@ -62,12 +70,12 @@ \subsection{脚注} 例如，在文本中需要添加脚注时，可以在需要添加脚注的单词或句子后面使用 \verb|\footnote| 命令，如下所示： \begin{Verbatim} -脚注是一种在文本底部添加注释或补充说明的方式。\footnote{通常，我们在脚注里也写完整的句子。在文本中使用脚注时，应该遵循学术规范，尽可能引用可信的来源，并注明出处。} +脚注是一种在文本底部添加注释或补充说明的方式\footnote{通常，我们在脚注里也写完整的句子。在文本中使用脚注时，应该遵循学术规范，尽可能引用可信的来源，并注明出处。}。 \end{Verbatim} 其中，花括号中的文本就是脚注的内容。编译文档后，脚注会出现在页面底部，并自动标上数字，如下所示： -脚注是一种在文本底部添加注释或补充说明的方式。\footnote{通常，我们在脚注里也写完整的句子。在文本中使用脚注时，应该遵循学术规范，尽可能引用可信的来源，并注明出处。} +脚注是一种在文本底部添加注释或补充说明的方式\footnote{通常，我们在脚注里也写完整的句子。在文本中使用脚注时，应该遵循学术规范，尽可能引用可信的来源，并注明出处。}。 需要注意的是，在使用脚注时，应该尽量避免使用过多的脚注，以免影响文本的阅读体验。同时，脚注的内容应该尽可能简洁明了，突出重点，有助于读者理解和记忆文本内容。 diff --git a/sections/thanks.tex b/sections/thanks.tex index 67d68ee..d8e1ec5 100644 --- a/sections/thanks.tex +++ b/sections/thanks.tex @@ -1,4 +1,4 @@ -\section*{谢\ 辞} +\section*{谢辞} \addcontentsline{toc}{section}{谢辞} 本节通常用于感谢在研究过程中给予帮助和支持的人们，例如指导老师、实验室同学、朋友和家人等。 diff --git a/style/tongjithesis.cls b/style/tongjithesis.cls index 58b89ff..e52fcd0 100644 --- a/style/tongjithesis.cls +++ b/style/tongjithesis.cls @@ -271,7 +271,10 @@ \setcounter{secnumdepth}{5} % 设置参考文献格式 -\RequirePackage[backend=biber,style=gb7714-2015]{biblatex} +\RequirePackage[ + backend=biber, + style=gb7714-2015, +]{biblatex} \addbibresource{bib/note.bib} \makeatletter diff --git a/style/tongjithesis.sty b/style/tongjithesis.sty index 8ff5259..0d73303 100644 --- a/style/tongjithesis.sty +++ b/style/tongjithesis.sty @@ -37,7 +37,7 @@ \providecommand{\jj}{\mathrm{j}} \usepackage{siunitx}[=v2] \DeclareRobustCommand\cs[1]{\texttt{\char`\\#1}} -\providecommand\pkg[1]{{\sffamily#1}} +\providecommand\pkg[1]{\href{https://ctan.org/pkg/#1}{\sffamily#1}} % 公式