Skip to content

huanyushi/SYSU-SPA-Labreport-Template

Repository files navigation

SYSU-SPA-Labreport-Template

中山大学物理与天文学院本科实验报告LaTeX模板

English version

GitHub license Github Version

大家好,我是中山大学物理与天文学院 2019 级物理系本科生 Huanyu Shi。

这份模板源于我大二一时兴起所做。学院当时提供的实验报告模板仅限于简单的 Word 文件,而 Word 在编辑效率和排版美观方面都存在一定的不足。基于学院模板的基本格式,我设计并完成了这个 LaTeX 模板,以提高报告的撰写效率和呈现效果。

临近毕业,我偶然发现此模板在学院内部仍有流传,但毕竟当时制作中并不规范,功能上也有不足之处。考虑到种种原因,我决定将此模板进行更新完善并打包公布在 GitHub 和知乎上,方便有需要的同学参考使用。希望它不仅能为本学院的后辈学子提供帮助,也能为其他院校的同学提供一些参考借鉴。

模板 Demo 请见 PDF ,源码可在 release 上下载。

1. 模板功能说明

1.1. 更新内容

这份模板经过本次更新后,除几个必要的实验报告部分:

  • 扉页
  • 预习报告
  • 实验记录
  • 分析与讨论

在此前的实验报告基础上我增加了以下几个内容:

  • 参考文献,注明引用内容是是作者对他人知识成果的承认和尊重,是保证学术诚信必须养成的习惯;

  • 代码附录,给出了使用 Lstlisting 环境展示代码的示例;

  • 常用命令展示,鉴于部分学生初次接触 LaTeX,本模板也给出了相应的常用命令展示以方便查阅。

1.2. 注意事项

  1. 参考文献应导入 bib 文件中,编译顺序请按 xelatex -> bibtex -> xelatex -> xelatex, 若要调整参考文献的格式在 main.tex 中修改 \bibliographystyle{} 即可;
  2. lstlisting 代码环境配置示例如下,其中导入的是 Python 语言,可手动更改或添加其他程序语言,其他相关配置可参考 listings 宏包的手册,
\usepackage{listings}
\definecolor{c1}{HTML}{2752C9} % 定义的颜色
\lstloadlanguages{python}
\lstdefinestyle{pythonstyle}{
backgroundcolor=\color{gray!5},
language=python,
frameround=tftt,
frame=shadowbox, 
keepspaces=true,
breaklines,
columns=spaceflexible,                   
basicstyle=\ttfamily\small, % 基本文本设置,字体为 teletype,大小为 small
keywordstyle=[1]\color{c1}\bfseries, 
keywordstyle=[2]\color{Red!70!black},   
stringstyle=\color{Purple},       
showstringspaces=false,
commentstyle=\ttfamily\scriptsize\color{green!40!black}, % 注释文本设置,字体为 teletype,大小为 scriptsize
tabsize=2,
morekeywords={as},
morekeywords=[2]{np, plt, sp},
numbers=left, % 代码行数,位置在左
numberstyle=\it\tiny\color{gray}, % 代码行数的数字字体设置
stepnumber=1,
rulesepcolor=\color{gray!30!white}
}

3. 本模板定义了两种形式的 box ,可参考 tcolorbox 宏包的手册进行修改,

\usepackage{tcolorbox}
\tcbuselibrary{skins,breakable}
\newtcolorbox{tbox}[2][]{
    colframe=black!70!,
    breakable,
    enhanced,
	boxrule =0.5pt,
    title = {#2},
    fonttitle = \large\bfseries,
	drop fuzzy shadow,
    #1
}
\newtcolorbox[auto counter,number within=section]{question}[1][]{
  top=2pt,bottom=2pt,arc=1mm,
  boxrule=0.5pt,
  breakable,
  enhanced, % 跨页后不会显示下边框
  coltitle=c1!80!gray,
  colframe=c1,
  colback=c1!3!white,
  drop fuzzy shadow,
  title={思考题~\thetcbcounter\quad},
  fonttitle=\bfseries,
  attach title to upper,
  #1
}

  1. TikZ 是一个知名的绘图宏包(不过它的文档说明高达 1000 多页,学习成本略高),在此补充了一些 TikZ 实例

2. 声明

  • 本模板仅供学习交流所用,非学院官方模板。
  • 本模板不再进行更新维护,若有任何额外需求请自行设计更改。
  • 欢迎报考中山大学物理与天文学院

3. 许可证

该项目是在 MIT 许可下发布的。