SJTUThesis 项目使用教程

SJTUThesis 项目使用教程

SJTUThesis上海交通大学 LaTeX 论文模板 | Shanghai Jiao Tong University LaTeX Thesis Template项目地址:https://gitcode.com/gh_mirrors/sj/SJTUThesis

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

SJTUThesis 项目的目录结构如下：

SJTUThesis/
├── assets/
├── contents/
├── figures/
├── scans/
├── texmf/
│   └── tex/
│       └── latex/
│           └── sjtuthesis/
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .latexmkrc
├── Compile.bat
├── LICENSE
├── Makefile
├── README.md
├── README_en-US.md
├── main.tex
├── refs.bib
└── setup.tex

目录结构介绍

• assets/: 存放项目资源文件。
• contents/: 存放论文内容文件。
• figures/: 存放论文中的图片文件。
• scans/: 存放扫描文件。
• texmf/: 存放 LaTeX 相关文件。
  • tex/: LaTeX 文件目录。
    • latex/: LaTeX 文档类文件目录。
      • sjtuthesis/: SJTUThesis 文档类文件。
• .editorconfig: 编辑器配置文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• .latexmkrc: LaTeX 编译配置文件。
• Compile.bat: Windows 编译脚本。
• LICENSE: 项目许可证文件。
• Makefile: Linux 和 macOS 编译脚本。
• README.md: 项目介绍文档。
• README_en-US.md: 英文项目介绍文档。
• main.tex: 主文档文件。
• refs.bib: 参考文献文件。
• setup.tex: 项目设置文件。

2. 项目的启动文件介绍

项目的启动文件是 main.tex，它是整个论文的入口文件。以下是 main.tex 的基本结构：

% 载入 SJTUThesis 模版
\documentclass[type=master]{sjtuthesis}

% 文档开始
\begin{document}

% 设置文档信息
\include{setup}

% 正文内容
\include{contents}

% 参考文献
\bibliography{refs}

% 文档结束
\end{document}

启动文件介绍

• \documentclass[type=master]{sjtuthesis}: 载入 SJTUThesis 模板，并指定文档类型为硕士论文。
• \include{setup}: 包含项目设置文件 setup.tex。
• \include{contents}: 包含论文内容文件 contents.tex。
• \bibliography{refs}: 包含参考文献文件 refs.bib。

3. 项目的配置文件介绍

项目的配置文件主要包括 setup.tex 和 .latexmkrc。

setup.tex

setup.tex 文件用于设置论文的基本信息，如标题、作者、日期等。以下是 setup.tex 的基本内容：

% 设置论文标题
\title{论文标题}

% 设置作者
\author{作者姓名}

% 设置日期
\date{\today}

% 设置指导教师
\supervisor{指导教师姓名}

% 设置学位类型
\degree{硕士}

% 设置学院
\school{学院名称}

% 设置专业
\major{专业名称}

.latexmkrc

.latexmkrc 文件用于配置 LaTeX 编译器的行为。以下是 .latexmkrc 的基本内容：

$pdf_mode = 1; # 使用 PDF 模式
$pdflatex = 'xelatex %O %S'; # 使用 XeLaTeX 编译
$bibtex_use = 2; # 使用 BibTeX 处理参考文献
$clean_ext = 'aux bbl blg log toc out'; # 清理的文件扩展名

配置文件介绍

• setup.tex: 设置论文的基本信息。
• .latexmkrc: 配置 LaTeX 编译器的行为，如编译引擎、参考文献处理等。

以上是 SJTUThesis 项目的基本使用教程，包括

SJTUThesis上海交通大学 LaTeX 论文模板 | Shanghai Jiao Tong University LaTeX Thesis Template项目地址:https://gitcode.com/gh_mirrors/sj/SJTUThesis