Skip to content

Commit

Permalink
Merge pull request #65 from BITNP/DeltaHao-master
Browse files Browse the repository at this point in the history
docs(doc):domain
  • Loading branch information
DeltaHao authored Dec 30, 2020
2 parents 04361eb + a9fe9fc commit fb2dddb
Show file tree
Hide file tree
Showing 21 changed files with 52 additions and 52 deletions.
6 changes: 3 additions & 3 deletions README-en.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Specifically, detailed guides on how to use a single one of the templates are av

### PDF handbook

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).
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).

### Online Video Tutorials

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

| CI | Build status |
| :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| GitHub Release | ![GitHub Release](https://github.com/spencerwooo/BIThesis/workflows/Release/badge.svg?branch=master) |
| GitHub Release | ![GitHub Release](https://github.com/BITNP/BIThesis/workflows/Release/badge.svg?branch=master) |
| 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) |


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

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

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

[@Portfolio](https://spencerwoo.com/) · [@Blog](https://blog.spencerwoo.com/) · [@GitHub](https://github.com/spencerwooo)
2 changes: 1 addition & 1 deletion contributing-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,4 @@
_[Github Help](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests)_

[slack channel invitation]: https://join.slack.com/t/bithesis/shared_invite/zt-epmzkyk0-fJRsUS36AlwMNB2AI_Q~Vw
[issue reporting link]: https://github.com/spencerwooo/BIThesis/issues/new
[issue reporting link]: https://github.com/BITNP/BIThesis/issues/new
2 changes: 1 addition & 1 deletion contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,4 @@ For more information, refer to the
_[Github Help](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests)_.

[slack channel invitation]: https://join.slack.com/t/bithesis/shared_invite/zt-epmzkyk0-fJRsUS36AlwMNB2AI_Q~Vw
[issue reporting link]: https://github.com/spencerwooo/BIThesis/issues/new
[issue reporting link]: https://github.com/BITNP/BIThesis/issues/new
2 changes: 1 addition & 1 deletion doc/chapters/1-how-to-begin.tex
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ \section{如何开始}
本“使用手册”希望为大家全面地介绍 {\LaTeX} 环境的搭建方法、{\BIThesis} 的使用方法,从而快速掌握使用 {\LaTeX} 排版引擎进行基本的论文撰写的方法,完成符合学校要求的学位论文。{\BIThesis} 目前使用 GitHub 进行维护,官方项目地址位于:

\begin{center}
\color{ForestGreen}\href{https://github.com/spencerwooo/BIThesis}{\texttt{https://github.com/spencerwooo/BIThesis}}
\color{ForestGreen}\href{https://github.com/BITNP/BIThesis}{\texttt{https://github.com/BITNP/BIThesis}}
\end{center}

下面,你可以按照如下图 \ref{flowchart} 所示的顺序开始阅读本文档,并使用 {\BIThesis} 进行你的论文撰写工作:
Expand Down
2 changes: 1 addition & 1 deletion doc/chapters/2-downloading-templates.tex
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ \subsection{在项目的 Release 页面下载你希望使用的模板}
你可以点击这个链接前往最新的 Release 版本进行模板下载:

\begin{center}
\color{ForestGreen}\href{https://github.com/spencerwooo/BIThesis/releases/latest}{https://github.com/spencerwooo/BIThesis/releases/latest}
\color{ForestGreen}\href{https://github.com/BITNP/BIThesis/releases/latest}{https://github.com/BITNP/BIThesis/releases/latest}
\end{center}

在 Release 页面,你会看到:
Expand Down
4 changes: 2 additions & 2 deletions doc/chapters/3-proposal-report.tex
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ \subsection{其他注意事项}
\tipbox{有关具体的 {\LaTeX} 语法,请参考前文中《第二章 \ref{subsec:latex-grammar}》给出的参考链接与学习文档。以下是模板中提供的一些示例性代码。}

\subsubsection{插入图片}
如果你希望加入图片,可以将图片直接放在根目录(比如此处的\\ \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} 处的图片:
如果你希望加入图片,可以将图片直接放在根目录(比如此处的\\ \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} 处的图片:

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

\subsubsection{插入表格}
如果你希望插入表格,可以统一使用 \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 行},可以进行参考。比如:
如果你希望插入表格,可以统一使用 \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 行},可以进行参考。比如:

\begin{minted}[frame=single,linenos,breaklines]{latex}
\begin{table}[!ht]
Expand Down
16 changes: 8 additions & 8 deletions doc/chapters/4-graduation-thesis.tex
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ \subsubsection{开始}

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

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

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

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

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

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

\begin{itemize}
\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 行} 定义摘要的中文关键词
\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 行} 定义摘要的英文关键词
\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 行} 定义摘要的中文关键词
\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 行} 定义摘要的英文关键词
\end{itemize}

\subsubsection{正文}

正文是一篇论文中最为重要的部分,是一篇论文的核心。正文部分可以分为多个章节,模板中仅创建了第一章节的示范性文件:\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 行} 处添加对应章节文件的相对路径引用:
正文是一篇论文中最为重要的部分,是一篇论文的核心。正文部分可以分为多个章节,模板中仅创建了第一章节的示范性文件:\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 行} 处添加对应章节文件的相对路径引用:

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

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

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

\subsection{表格插入}

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

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

\subsection{公式插入}

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

为了保证与 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 行} 是一个示范。
为了保证与 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 行} 是一个示范。

\subsection{其他}

Expand Down
Binary file modified doc/doc.pdf
Binary file not shown.
2 changes: 1 addition & 1 deletion doc/doc.tex
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@
\bfseries 北京理工大学本科生{\LaTeX}模板使用手册
}
\author{
\href{https://github.com/spencerwooo/BIThesis}{\color{RoyalBlue}{spencerwooo/BIThesis}}
\href{https://github.com/BITNP/BIThesis}{\color{RoyalBlue}{BITNP/BIThesis}}
\\
\zihao{5}{\kaishu 主编:北京理工大学 2016 级计算机学院 \href{https://github.com/spencerwooo}{武上博} \href{https://github.com/Silverster98}{王赞}}
}
Expand Down
2 changes: 1 addition & 1 deletion graduation-thesis/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Graduation Thesis 毕业设计(论文)![](https://raw.githubusercontent.com/spencerwooo/BIThesis/master/assets/bithesis_badge_solid.svg?sanitize=true)
# Graduation Thesis 毕业设计(论文)![](https://raw.githubusercontent.com/BITNP/BIThesis/master/assets/bithesis_badge_solid.svg?sanitize=true)

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

Expand Down
2 changes: 1 addition & 1 deletion lab-report/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 北京理工大学课程实验报告 ![](https://raw.githubusercontent.com/spencerwooo/BIThesis/master/assets/bithesis_badge_solid.svg?sanitize=true)
# 北京理工大学课程实验报告 ![](https://raw.githubusercontent.com/BITNP/BIThesis/master/assets/bithesis_badge_solid.svg?sanitize=true)

本目录中包含有北京理工大学课程实验报告模板,有关模板的使用方法更为详细的介绍,请参考:[BIThesis Wiki - 本科生实验报告:Lab report](https://bithesis.bitnp.net/guide/3-templates/lab-report)

Expand Down
2 changes: 1 addition & 1 deletion proposal-report/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Proposal Report 开题报告 ![](https://raw.githubusercontent.com/spencerwooo/BIThesis/master/assets/bithesis_badge_solid.svg?sanitize=true)
# Proposal Report 开题报告 ![](https://raw.githubusercontent.com/BITNP/BIThesis/master/assets/bithesis_badge_solid.svg?sanitize=true)

本目录中包含有北京理工大学本科生毕业设计(论文)的开题报告模板,有关模板的使用方法更为详细的介绍,请参考:[BIThesis Wiki - 本科生开题报告:Proposal report](https://bithesis.bitnp.net/Guide/3-Templates/Proposal-Report)

Expand Down
6 changes: 3 additions & 3 deletions wiki/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,19 +35,19 @@ module.exports = {
nav: [
{ text: "文档指南", link: "/Guide/" },
{ text: "系列视频指导", link: "/Video/" },
{ text: "模板下载", link: "https://github.com/spencerwooo/BIThesis/releases/latest" },
{ text: "模板下载", link: "https://github.com/BITNP/BIThesis/releases/latest" },
{ text: "加入讨论", items: [
{
text: "Slack",
link: "https://join.slack.com/t/bithesis/shared_invite/zt-epmzkyk0-fJRsUS36AlwMNB2AI_Q~Vw"
},
{
text: "Contributing",
link: "https://github.com/spencerwooo/BIThesis/blob/master/contributing.md"
link: "https://github.com/BITNP/BIThesis/blob/master/contributing.md"
}
]
},
{ text: "GitHub", link: "https://github.com/spencerwooo/BIThesis" }
{ text: "GitHub", link: "https://github.com/BITNP/BIThesis" }
],
sidebar: {
"/Guide/": [
Expand Down
4 changes: 2 additions & 2 deletions wiki/Guide/2-Usage/Downloading-and-using-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@

## 到 Release 页面下载你希望使用的模板

为了方便各位同学使用,项目按照 Release 发布的流程,将每个模板进行打包,并在每次发布后用 GitHub Release 进行模板分发。也就是,你可以直接前往本项目的 [GitHub Release 页面](https://github.com/spencerwooo/BIThesis/releases/),直接下载你所希望使用的模板压缩包,并解压到本地进行使用。
为了方便各位同学使用,项目按照 Release 发布的流程,将每个模板进行打包,并在每次发布后用 GitHub Release 进行模板分发。也就是,你可以直接前往本项目的 [GitHub Release 页面](https://github.com/BITNP/BIThesis/releases/),直接下载你所希望使用的模板压缩包,并解压到本地进行使用。

你可以点击这个链接前往最新的 Release 版本进行模板下载 👉 [BIThesis - Latest release](https://github.com/spencerwooo/BIThesis/releases/latest)
你可以点击这个链接前往最新的 Release 版本进行模板下载 👉 [BIThesis - Latest release](https://github.com/BITNP/BIThesis/releases/latest)

在 Release 页面,你会看到:

Expand Down
Loading

0 comments on commit fb2dddb

Please sign in to comment.