CTAN Comprehensive TeX Archive Network

Direc­tory macros/latex/contrib/njurepo

README.md
Version

What's NJUrepo

NJUrepo stands for Nanjing Univer­sity ver­sa­tile Report.

NJUre­po是为南京大学本科生设计的一个免于配置的作业、实验报告模板。希望它可以使你的作业/实验报告不会因形式上的缺陷导致评分的下降。

该文档格式基于 ctex­book, 主要完成了除了主体内容以外的几乎全部工作。同时,通过使用 Github 版本宏包,你还可以更好的管理自己的 $$ 文档。

安装方法

本宏包已被收纳于 CTAN 中,凡安装完整版 Texlive 用户可直接使用 \usepackage{njurepo}进行使用。若想获得最新版本的 NJUrepo 请前往github主页下载:https://github.com/zhengzangw/njurepo

演示文档与帮助文档

  • 问题求解作业 : ps
  • ML/ICS/OS/数据通信 作业 : dc
  • 数字电路/PA/OS Lab 实验报告 : ml
  • 数学/物理 课程论文 : math
  • 软件文档 : dig­i­tal
  • 帮助文档 : make texdoctexdoc njurepo 以获得

使用方法

从 Github 上下载后使用命令 make cls 获得 .cls 宏包。可以仿照现成的文件 (python util.py -g essay -n examples 生成)直接使用该宏包,或者可以使用以下推荐方法。

Github 版本中同时包含了一个 Make­file 文件和 util.py 文件。这两个文件可以让你在一个文件夹内管理所有课程的作用和报告。具体方法为:

生成学科项目

parts 下每个文件夹代表着一个项目,每个项目由 cover.tex 配置文件和若干源文件组成。可以手动添加文件夹和配置文件,也可以使用命令 python util.py -c project_name 生成

生成完成后按提示配置 cover.tex。对于小作业而言,只需填需要的几个,其它全部留空即可

选择格式

Make­file 中内置了两个格式,可以通过 python util.py -g single -n project-name -s one-single-filemake PROJECT=project-name NAME=one-single-file generate 自动生成 sin­gle 格式,通过 python util.py -g essay -n project-namemake PROJECT=project-name TYPE=essay generate 自动生成 es­say 格式

sin­gle: 默认格式

\documentclass[language=english]{njurepo}
\begin{document}
\frontmatter
\input{parts/math/cover}
\mainmatter
	\input{parts/math/one-single-file}
\backmatter
\end{document}

es­say: 报告/论文格式

\documentclass[language=english]{njurepo}
\begin{document}
\frontmatter
\input{parts/examples/cover}
	\input{parts/examples/abstract}
	\maketitlepage % 封面
	\makeabstract % 摘要
	\tableofcontents % 目录
	\input{parts/examples/denotation} % 中英对照表
\mainmatter
	\input{parts/examples/chap01} % 主体内容
\backmatter
	\listoffigures % 图索引
	\listoftables % 表格索引
	\listofequations % 公式索引
	\bibliographystyle{ref/numeric} % 参考文献样式 ref/numeric,ref/author-year,plainnat,IEEEtran
	\bibliography{ref/refs} % 参考文献
	\include{parts/examples/ack} % 致谢
	\begin{appendix} % 附录
		\input{parts/examples/appendix01}
	\end{appendix}
\end{document}

生成文档

模板生成后,使用 make PROJECT=project-name TYPE=essaymake PROJECT=project-name NAME=one-single-file 来更新输出文档。

清理文件

make all PROJECT=project-name NAME=one-single-file 将在完成后自动清理过程文件,只留下 .tex.pdf 文件 make distclean 帮助删除主目录下所有 .tex.pdf 文件

选项

  • lan­guage: 目录(con­tent)/章节(chap­ter)语言。无论选择哪个选择,中英均可输入。
    • chi­nese
    • en­glish
  • open: 正规出版物的章节出现在奇数页,也就是右手边的页面。选择 open=any 时,如果前一章的最后一页也是奇数,那么模板会自动生成一个纯粹的空白页。
    • any
    • right
  • wide: 生成宽页面(可在作业时使用)
  • draft: 生成 Draft 水印

默认加载的宏包

模板自动引入以下宏包,对于宏包功能,可使用 texdoc 或 STFW 获得帮助。

宏包名 用途 举例
etool­box 开发使用
ifx­e­tex 开发使用
xparse 开发使用
kvop­tions 开发使用
ctex­book 文档
uni­code-math 数学字体
xcolor 颜色
fan­cy­hdr 页眉页脚
ge­om­e­try 页面设置
en­u­mitem 调整列表
en­v­i­ron 定义环境
nat­bib 参考文献
no­toc­cite 引用
wa­ter­mark 水印
hy­per­ref 超链接
tcol­or­box 边框
CJKfn­tef 字体样式 \CJKunderdot{},\CJKunderline{}
ams­math 数学支持
nthe­o­rem 数学定理
physics 物理符号 \grad{}
stmaryrd 更多数学符号 \trianglelefteqslant
bb­d­ing 符号 \FiveFlowerPetal
graph­icx 插入图片
sub­cap­tion 图片排版 subfigure 环境
pdf­pages pdf 插入 \includepdf{}
tikz tikz 绘图
dirtree 绘制文件树 \dirtree{}
ar­ray 数学模式表格支持 array 环境
longtable 表格支持 longtable 环境
book­tabs 表格支持 \toprule,\middlerule,\bottomrule
mul­ti­row 跨行 \multirow{2}{*}{content}
tab­u­larx 表格支持 X 选项
di­ag­box 斜线表格 \diagbox{}{}
make­cell 单元格布局 \thead{},\rothead{},\diagbox{}{}
float 表格位置 H 选项
list­ings 代码 lstinputlisting{}
al­go­rithm 伪代码 algorithm 环境
al­gpseu­docode 伪代码 algorithmic 环境
ver­ba­tim 无格式文本 verbatim 环境

默认加载的 tikz li­brary

  • dec­o­ra­tions
  • path­mor­ph­ing
  • graphs
  • calc

自定义宏

  • \nchapter{} 不带任何装饰的居中 chap­ter
  • nproblem 无标号问题环境(适用于作业不抄题目)
  • nsolution 无标号解答环境
  • cproblem 好看的问题环境
  • csolution 好看的解答环境
  • \sihao,\xiaosi 字体大小调整
  • \songti,\heiti 中文字体
  • \magenta{}, \red{} 字体颜色
  • 代码环境 \begin{cplus} \end{cplus}, 现支持:
    • code, cpseudo, cplus, shell, com­mand­shell, ver­ilog, python, la­tex
  • \blankpage 空页
  • \figoptadd{option}{address} 原地插入(H)图片
  • \figoptaddcap{option}{address}{caption} 原地插入(H)图片
  • \tabncc{number-of-columns}{content}{caption} 制作简易 n 列居中表格
  • \tabnc{number-of-columns}{content} 制作简易 n 列居中表格
  • \inlinecite{} 行内引用
  • \cite 普通引用
  • \rom{2} 罗马数字

Con­tact

如果你使用时发现任何 bug 或得不到的格式,可以联系我或开 is­sue 如果你有更好的作业/报告格式,欢迎添加或联系我帮忙添加

Li­cense

This file may be dis­tributed and/or mod­i­fied un­der the con­di­tions of the Project Public Li­cense, ei­ther ver­sion 1.3c of this li­cense or (at your op­tion) any later ver­sion. The lat­est ver­sion of this li­cense is in: http://www.la­tex-project.org/lppl.txt and ver­sion 1.3c or later is part of all dis­tri­bu­tions of ver­sion 2005/12/01 or later.

Down­load the con­tents of this pack­age in one zip archive (1.1M).

NJUrepo – Re­ports for Nan­jing Univer­sity

This doc­u­ment class pro­vides a the­sis tem­plate for Nan­jing Univer­sity in or­der to make it easy to write ex­per­i­ment re­ports and home­work for the bach­e­lor’s cur­ricu­lum.

NJUrepo stands for Nanjing Univer­sity ver­sa­tile Report.

Pack­ageNJUrepo
Ver­sion1.1.2
Li­censesThe Project Public Li­cense 1.3c
Copy­right2019 Zang­wei Zheng
Main­tainerZang­wei Zheng
Con­tained inTeX Live as njurepo
MiKTeX as njurepo
TopicsDis­ser­ta­tion
Class
See alsoseuthesix
...
Guest Book Sitemap Contact Contact Author