HUST-CS-Report-Template 使用教程

1. 项目的目录结构及介绍

HUST-CS-Report-Template/
├── README.md
├── .gitignore
├── main.tex
├── config/
│   ├── settings.tex
│   └── ...
├── chapters/
│   ├── chapter1.tex
│   ├── chapter2.tex
│   └── ...
├── figures/
│   ├── figure1.png
│   ├── figure2.png
│   └── ...
└── bibliography.bib

• README.md: 项目说明文件，包含项目的基本信息和使用指南。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被版本控制。
• main.tex: 主文件，包含文档的整体结构和引用其他部分的指令。
• config/: 配置文件目录，包含项目的设置和参数。
• chapters/: 章节文件目录，包含各个章节的详细内容。
• figures/: 图片文件目录，包含文档中使用的所有图片。
• bibliography.bib: 参考文献文件，包含文档引用的所有参考文献。

2. 项目的启动文件介绍

main.tex 是项目的启动文件，它负责组织整个文档的结构，并引用其他部分的文件。以下是 main.tex 的基本结构：

\documentclass{article}
\usepackage{config/settings}

\begin{document}

\input{chapters/chapter1}
\input{chapters/chapter2}
...

\bibliographystyle{plain}
\bibliography{bibliography}

\end{document}

• \documentclass{article}: 指定文档类型为文章。
• \usepackage{config/settings}: 引入配置文件中的设置。
• \input{chapters/chapter1}: 引入第一章的内容。
• \bibliographystyle{plain}: 指定参考文献的样式。
• \bibliography{bibliography}: 引入参考文献文件。

3. 项目的配置文件介绍

config/settings.tex 是项目的配置文件，它包含了一些全局设置和包的引入。以下是 config/settings.tex 的基本内容：

\usepackage[utf8]{inputenc}
\usepackage{geometry}
\usepackage{graphicx}
\usepackage{amsmath}
\usepackage{amssymb}
\usepackage{hyperref}

\geometry{a4paper, margin=1in}

\graphicspath{{figures/}}

\hypersetup{
    colorlinks=true,
    linkcolor=blue,
    filecolor=magenta,
    urlcolor=cyan,
}

\urlstyle{same}

• \usepackage[utf8]{inputenc}: 设置输入编码为 UTF-8。
• \usepackage{geometry}: 引入页面布局包。
• \usepackage{graphicx}: 引入图片处理包。
• \usepackage{amsmath}: 引入数学公式包。
• \usepackage{amssymb}: 引入数学符号包。
• \usepackage{hyperref}: 引入超链接包。
• \geometry{a4paper, margin=1in}: 设置页面为 A4 纸，边距为 1 英寸。
• \graphicspath{{figures/}}: 设置图片路径。
• \hypersetup{...}: 设置超链接的样式。
• \urlstyle{same}: 设置 URL 样式。