Skip to content

Commit fb2dddb

Browse files
authored
Merge pull request #65 from BITNP/DeltaHao-master
docs(doc):domain
2 parents 04361eb + a9fe9fc commit fb2dddb

21 files changed

+52
-52
lines changed

README-en.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Specifically, detailed guides on how to use a single one of the templates are av
6161

6262
### PDF handbook
6363

64-
We also provide a PDF handbook on how to use BIThesis. You can download the PDF version of the BIThesis handbook here: [`bithesis-documentation.pdf`](https://github.com/spencerwooo/BIThesis/releases/latest).
64+
We also provide a PDF handbook on how to use BIThesis. You can download the PDF version of the BIThesis handbook here: [`bithesis-documentation.pdf`](https://github.com/BITNP/BIThesis/releases/latest).
6565

6666
### Online Video Tutorials
6767

@@ -91,7 +91,7 @@ For details, please see the [contributing doc](./contributing.md).
9191

9292
| CI | Build status |
9393
| :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
94-
| GitHub Release | ![GitHub Release](https://github.com/spencerwooo/BIThesis/workflows/Release/badge.svg?branch=master) |
94+
| GitHub Release | ![GitHub Release](https://github.com/BITNP/BIThesis/workflows/Release/badge.svg?branch=master) |
9595
| Vercel Build | [![Vercel Build Status](https://badgen.net/https/now.swoo.workers.dev/dpl_JAAPnJYBFWWqVLjtNXcxaU8FJDk6?label=Vercel&labelColor=2b2b2b&icon=zeit)](https://vercel.com/spencerwoo/bithesis) |
9696

9797

@@ -103,6 +103,6 @@ This project is not validated by the _Department of Undergraduate Academic Affai
103103

104104
📖 **BIThesis** ©Spencer Woo. Released under the [LaTeX Project Public License](LICENSE).
105105

106-
Authored by Spencer Woo. Maintained with help from [contributors](https://github.com/spencerwooo/BIThesis/graphs/contributors).
106+
Authored by Spencer Woo. Maintained with help from [contributors](https://github.com/BITNP/BIThesis/graphs/contributors).
107107

108108
[@Portfolio](https://spencerwoo.com/) · [@Blog](https://blog.spencerwoo.com/) · [@GitHub](https://github.com/spencerwooo)

contributing-zh.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,4 @@
5555
_[Github Help](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests)_
5656

5757
[slack channel invitation]: https://join.slack.com/t/bithesis/shared_invite/zt-epmzkyk0-fJRsUS36AlwMNB2AI_Q~Vw
58-
[issue reporting link]: https://github.com/spencerwooo/BIThesis/issues/new
58+
[issue reporting link]: https://github.com/BITNP/BIThesis/issues/new

contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,4 @@ For more information, refer to the
5757
_[Github Help](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests)_.
5858

5959
[slack channel invitation]: https://join.slack.com/t/bithesis/shared_invite/zt-epmzkyk0-fJRsUS36AlwMNB2AI_Q~Vw
60-
[issue reporting link]: https://github.com/spencerwooo/BIThesis/issues/new
60+
[issue reporting link]: https://github.com/BITNP/BIThesis/issues/new

doc/chapters/1-how-to-begin.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ \section{如何开始}
44
本“使用手册”希望为大家全面地介绍 {\LaTeX} 环境的搭建方法、{\BIThesis} 的使用方法,从而快速掌握使用 {\LaTeX} 排版引擎进行基本的论文撰写的方法,完成符合学校要求的学位论文。{\BIThesis} 目前使用 GitHub 进行维护,官方项目地址位于:
55

66
\begin{center}
7-
\color{ForestGreen}\href{https://github.com/spencerwooo/BIThesis}{\texttt{https://github.com/spencerwooo/BIThesis}}
7+
\color{ForestGreen}\href{https://github.com/BITNP/BIThesis}{\texttt{https://github.com/BITNP/BIThesis}}
88
\end{center}
99

1010
下面,你可以按照如下图 \ref{flowchart} 所示的顺序开始阅读本文档,并使用 {\BIThesis} 进行你的论文撰写工作:

doc/chapters/2-downloading-templates.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ \subsection{在项目的 Release 页面下载你希望使用的模板}
2727
你可以点击这个链接前往最新的 Release 版本进行模板下载:
2828

2929
\begin{center}
30-
\color{ForestGreen}\href{https://github.com/spencerwooo/BIThesis/releases/latest}{https://github.com/spencerwooo/BIThesis/releases/latest}
30+
\color{ForestGreen}\href{https://github.com/BITNP/BIThesis/releases/latest}{https://github.com/BITNP/BIThesis/releases/latest}
3131
\end{center}
3232

3333
在 Release 页面,你会看到:

doc/chapters/3-proposal-report.tex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ \subsection{其他注意事项}
7171
\tipbox{有关具体的 {\LaTeX} 语法,请参考前文中《第二章 \ref{subsec:latex-grammar}》给出的参考链接与学习文档。以下是模板中提供的一些示例性代码。}
7272

7373
\subsubsection{插入图片}
74-
如果你希望加入图片,可以将图片直接放在根目录(比如此处的\\ \texttt{merge-sort-recursion-tree.png}),或者统一将图片安置在一个文件夹下,在正文里按照相对路径进行引用。模板中有一处插入图片的参考样例,位于 \texttt{main.tex} 的 \href{https://github.com/spencerwooo/BIThesis/blob/master/proposal-report/main.tex#L138}{第 138 行},可以进行参考。比如,我填入一个放在 \texttt{images/BIT\_Name.jpg} 处的图片:
74+
如果你希望加入图片,可以将图片直接放在根目录(比如此处的\\ \texttt{merge-sort-recursion-tree.png}),或者统一将图片安置在一个文件夹下,在正文里按照相对路径进行引用。模板中有一处插入图片的参考样例,位于 \texttt{main.tex} 的 \href{https://github.com/BITNP/BIThesis/blob/master/proposal-report/main.tex#L138}{第 138 行},可以进行参考。比如,我填入一个放在 \texttt{images/BIT\_Name.jpg} 处的图片:
7575

7676
\begin{minted}[frame=single,linenos,breaklines]{latex}
7777
\begin{figure}[!ht]
@@ -92,7 +92,7 @@ \subsubsection{插入图片}
9292
\end{figure}
9393

9494
\subsubsection{插入表格}
95-
如果你希望插入表格,可以统一使用 \href{https://www.tablesgenerator.com/}{LaTeX Tables Generator} 进行生成,再粘贴进入模板之中。模板中有两处表格的参考样例,分别位于 \href{https://github.com/spencerwooo/BIThesis/blob/master/proposal-report/main.tex#L151}{第 151 行} 和 \href{https://github.com/spencerwooo/BIThesis/blob/master/proposal-report/main.tex#L176}{第 176 行},可以进行参考。比如:
95+
如果你希望插入表格,可以统一使用 \href{https://www.tablesgenerator.com/}{LaTeX Tables Generator} 进行生成,再粘贴进入模板之中。模板中有两处表格的参考样例,分别位于 \href{https://github.com/BITNP/BIThesis/blob/master/proposal-report/main.tex#L151}{第 151 行} 和 \href{https://github.com/BITNP/BIThesis/blob/master/proposal-report/main.tex#L176}{第 176 行},可以进行参考。比如:
9696

9797
\begin{minted}[frame=single,linenos,breaklines]{latex}
9898
\begin{table}[!ht]

doc/chapters/4-graduation-thesis.tex

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ \subsubsection{开始}
8383

8484
首先,你需要定义毕业设计论文的“中文标题”和“英文标题”,这两个“变量”将影响模板封面的渲染,以及后续摘要中出现的标题的渲染。
8585

86-
中英文标题的定义位于 \texttt{main.tex} 的 \href{https://github.com/spencerwooo/BIThesis/blob/master/graduation-thesis/main.tex#L65-L67}{第 65 至第 67 行}:
86+
中英文标题的定义位于 \texttt{main.tex} 的 \href{https://github.com/BITNP/BIThesis/blob/master/graduation-thesis/main.tex#L65-L67}{第 65 至第 67 行}:
8787

8888
\begin{itemize}
8989
\item 你可以通过控制 \texttt{\textbackslash thesisTitle} 这一变量来控制整个论文的“中文标题”
@@ -92,7 +92,7 @@ \subsubsection{开始}
9292

9393
接下来,你需要定义你的个人信息,这些信息将被渲染在毕业设计论文的封面。个人信息包括你所在学院,你的专业、学号、姓名和指导教师。
9494

95-
个人信息的定义位于 \texttt{main.tex} 的 \href{https://github.com/spencerwooo/BIThesis/blob/master/graduation-thesis/main.tex#L69-L74}{第 69 行至第 74 行}:
95+
个人信息的定义位于 \texttt{main.tex} 的 \href{https://github.com/BITNP/BIThesis/blob/master/graduation-thesis/main.tex#L69-L74}{第 69 行至第 74 行}:
9696

9797
\begin{itemize}
9898
\item \texttt{\textbackslash deptName}:你所在学院
@@ -107,13 +107,13 @@ \subsubsection{中英摘要}
107107
接下来,你需要撰写论文的摘要。模板中英文摘要位于\\ \texttt{chapters/0\_abstract.tex}:
108108

109109
\begin{itemize}
110-
\item 中文摘要位于 \texttt{0\_abstract.tex} 的 \href{https://github.com/spencerwooo/BIThesis/blob/master/graduation-thesis/chapters/0_abstract.tex#L41-L48}{第 41 行至第 48 行}。其中 \href{https://github.com/spencerwooo/BIThesis/blob/master/graduation-thesis/chapters/0_abstract.tex#L48}{第 48 行} 定义摘要的中文关键词
111-
\item 英文摘要位于 \texttt{0\_abstract.tex} 的 \href{https://github.com/spencerwooo/BIThesis/blob/master/graduation-thesis/chapters/0_abstract.tex#L71-L76}{第 71 行至第 76 行}。其中 \href{https://github.com/spencerwooo/BIThesis/blob/master/graduation-thesis/chapters/0_abstract.tex#L76}{第 76 行} 定义摘要的英文关键词
110+
\item 中文摘要位于 \texttt{0\_abstract.tex} 的 \href{https://github.com/BITNP/BIThesis/blob/master/graduation-thesis/chapters/0_abstract.tex#L41-L48}{第 41 行至第 48 行}。其中 \href{https://github.com/BITNP/BIThesis/blob/master/graduation-thesis/chapters/0_abstract.tex#L48}{第 48 行} 定义摘要的中文关键词
111+
\item 英文摘要位于 \texttt{0\_abstract.tex} 的 \href{https://github.com/BITNP/BIThesis/blob/master/graduation-thesis/chapters/0_abstract.tex#L71-L76}{第 71 行至第 76 行}。其中 \href{https://github.com/BITNP/BIThesis/blob/master/graduation-thesis/chapters/0_abstract.tex#L76}{第 76 行} 定义摘要的英文关键词
112112
\end{itemize}
113113

114114
\subsubsection{正文}
115115

116-
正文是一篇论文中最为重要的部分,是一篇论文的核心。正文部分可以分为多个章节,模板中仅创建了第一章节的示范性文件:\texttt{chapters/1\_chapter1.tex},你可以将它作为正文章节的“模板”,继续在 \texttt{./chapters} 目录下自行创建第二章节 \texttt{2\_chapter2.tex}、第三章节 \texttt{3\_chapter3.tex} 等等,并需要在 \texttt{main.tex} 的 \href{https://github.com/spencerwooo/BIThesis/blob/master/graduation-thesis/main.tex#L199-L203}{第 199 行} 处添加对应章节文件的相对路径引用:
116+
正文是一篇论文中最为重要的部分,是一篇论文的核心。正文部分可以分为多个章节,模板中仅创建了第一章节的示范性文件:\texttt{chapters/1\_chapter1.tex},你可以将它作为正文章节的“模板”,继续在 \texttt{./chapters} 目录下自行创建第二章节 \texttt{2\_chapter2.tex}、第三章节 \texttt{3\_chapter3.tex} 等等,并需要在 \texttt{main.tex} 的 \href{https://github.com/BITNP/BIThesis/blob/master/graduation-thesis/main.tex#L199-L203}{第 199 行} 处添加对应章节文件的相对路径引用:
117117

118118
\begin{minted}[frame=single]{tex}
119119
% 第一章
@@ -204,13 +204,13 @@ \subsection{图片素材}
204204

205205
请注意,为了保证图片引用的格式和 Word 模板完全一致,我们手动设置了 \verb|\vspace{13pt}| 的垂直空白,你引用新图片时,也需要添加这一垂直空白。
206206

207-
在第一章节 \texttt{chapters/1\_chapter1.tex} 中的 \href{https://github.com/spencerwooo/BIThesis/blob/master/graduation-thesis/chapters/1_chapter1.tex#L38-L43}{第 38 行至第 43 行} 是一个示范。
207+
在第一章节 \texttt{chapters/1\_chapter1.tex} 中的 \href{https://github.com/BITNP/BIThesis/blob/master/graduation-thesis/chapters/1_chapter1.tex#L38-L43}{第 38 行至第 43 行} 是一个示范。
208208

209209
\subsection{表格插入}
210210

211211
表格一直是 {\LaTeX} 排版系统非常强大又非常不好实现的一个模块,如果你希望方便的插入表格,可以统一使用 \href{https://www.tablesgenerator.com/}{LaTeX Tables Generator} 进行生成,再粘贴进入模板之中。
212212

213-
在第一章节 \texttt{chapters/1\_chapter1.tex} 中的 \href{https://github.com/spencerwooo/BIThesis/blob/master/graduation-thesis/chapters/1_chapter1.tex#L47-L60}{第 47 行至第 60 行} 是一个示范。
213+
在第一章节 \texttt{chapters/1\_chapter1.tex} 中的 \href{https://github.com/BITNP/BIThesis/blob/master/graduation-thesis/chapters/1_chapter1.tex#L47-L60}{第 47 行至第 60 行} 是一个示范。
214214

215215
\subsection{公式插入}
216216

@@ -252,7 +252,7 @@ \subsection{公式插入}
252252
LRI=1\ \ \sqrt{1+{\left(\frac{{\mu }_{R}}{{\mu }_{s}}\right)}^{2}{\left(\frac{{\delta }_{R}}{{\delta }_{s}}\right)}^{2}}
253253
\end{equation}
254254

255-
为了保证与 Word 模板中的数学公式要求一致,我们的 {\LaTeX} 模板中的公式默认会进行相应的编号(比如上面的例子)。在第一章节 \texttt{chapters/1\_chapter1.tex} 中的 \href{https://github.com/spencerwooo/BIThesis/blob/master/graduation-thesis/chapters/1_chapter1.tex#L67-L69}{第 67 行至第 69 行} 是一个示范。
255+
为了保证与 Word 模板中的数学公式要求一致,我们的 {\LaTeX} 模板中的公式默认会进行相应的编号(比如上面的例子)。在第一章节 \texttt{chapters/1\_chapter1.tex} 中的 \href{https://github.com/BITNP/BIThesis/blob/master/graduation-thesis/chapters/1_chapter1.tex#L67-L69}{第 67 行至第 69 行} 是一个示范。
256256

257257
\subsection{其他}
258258

doc/doc.pdf

-307 Bytes
Binary file not shown.

doc/doc.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@
9595
\bfseries 北京理工大学本科生{\LaTeX}模板使用手册
9696
}
9797
\author{
98-
\href{https://github.com/spencerwooo/BIThesis}{\color{RoyalBlue}{spencerwooo/BIThesis}}
98+
\href{https://github.com/BITNP/BIThesis}{\color{RoyalBlue}{BITNP/BIThesis}}
9999
\\
100100
\zihao{5}{\kaishu 主编:北京理工大学 2016 级计算机学院 \href{https://github.com/spencerwooo}{武上博} \href{https://github.com/Silverster98}{王赞}}
101101
}

graduation-thesis/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Graduation Thesis 毕业设计(论文)![](https://raw.githubusercontent.com/spencerwooo/BIThesis/master/assets/bithesis_badge_solid.svg?sanitize=true)
1+
# Graduation Thesis 毕业设计(论文)![](https://raw.githubusercontent.com/BITNP/BIThesis/master/assets/bithesis_badge_solid.svg?sanitize=true)
22

33
<h6>🚩 注意:目前版本的毕业设计论文已经按照北京理工大学 2016 级(2020 届)毕业论文模板进行了设计与排版的更新。</h6>
44

0 commit comments

Comments
 (0)