/Assignment-Template

可爱而优雅的 LaTeX 作业模板。Cute and elegant LaTeX template for assignments.

Primary LanguageTeXMIT LicenseMIT

作业模板 Assignment Template

可爱而优雅、功能齐全而稳定的 $\LaTeX$ 模板，适用于

  • 作业
  • 实验报告
  • 课程项目
  • 课程论文

等各种场景，支持

  • 中英双语
  • 数学公式
  • 图表
  • 量子线路图（会影响长表格环境）
  • 化学式
  • 程序代码
  • 文献引用 等功能.

Cute and elegant, poly-functional and robust $\LaTeX$ template, applicable to various scenarios such as

  • assignments
  • experiment reports
  • course projects
  • course essays

It is bilingual and supports functions including

  • mathematical formulas
  • figures
  • tables
  • quantum circuit diagram (may affect longtable environment)
  • chemistry formulas
  • program code
  • reference citing

同时支持 pdf$\LaTeX$ 和 Xe$\LaTeX$.

Both pdf$\LaTeX$ and Xe$\LaTeX$ work.

自定义题目、题解、证明环境，自定义绝对值（\abs{}）、范数（\norm{}）、反双曲三角函数（\arcsinh、\arccosh、\arctanh）、复数实/虚部（\re、\im）、符号函数（\sgn）、辛格函数（\sinc）、矩形函数（\rect）、矩阵的迹（\tr）等 $\LaTeX$ 原生宏包未支持的数学、物理专业常用符号.

Customized environments of problems, solutions and proofs; customized operators common used in mathematics and physics which are not originally supported by $\LaTeX$ packages, such as absolute value (\abs{}), norm (\norm{}), inverse hyperbolic function (\arcsinh, \arccosh, \arctanh), real / imaginary part of complex numbers (\re, \im), sign function (\sgn), sinc function(\sinc), rectangular function (\rect), trace of matrices (\tr), etc.

基本用法 Basic usage

中文版：

  1. 将类文件 assignment.cls 与 *.tex 文件置于同一路径下；
  2. *.tex 文件开头用 \documentclass{assignment} 调用本作业模板类；
  3. 导言区用 \ProjectInfos{<课程名称>}{<课程代码>}{<学期>}{<项目名称>}{<项目副标题或补充信息>}{<姓名>}[<姓名上的超链接>]{<学号>} 设置页眉、页脚；
  4. 分别用 \begin{prob}...\end{prob}、\begin{sol}...\end{sol} 和 \begin{pf}...\end{pf} 调用题目、题解、证明环境；
  5. 已添加支持数学公式、图表、化学式、程序代码、文献引用等的宏包，仿照示例文件 Assignment-zh* 使用即可；
  6. 用 pdf$\LaTeX$ 或 Xe$\LaTeX$ 编译. 因引用了末页页码，因此需连续编译两次. 如有文献引用，按照 pdf$\LaTeX\rightarrow$bib$\TeX\rightarrow$pdf$\LaTeX\rightarrow$pdf$\LaTeX$ 或 Xe$\LaTeX\rightarrow$bib$\TeX\rightarrow$Xe$\LaTeX\rightarrow$Xe$\LaTeX$ 顺序编译.

注意: 若 ctex 包依赖字体缺失, 则将导致 Critical Package ctex: CTeX fontset 'fandol' is unavailable in current (ctex) mode. 报错, 此时请选择 Xe$\LaTeX$ 编译.

English version:

  1. Make sure that this class file assignment.cls is in the same path as *.tex file;
  2. Call the assignment template class with \documentclass[en]{assignment} at the beginning of *.tex file;
  3. Set the headers and the footers with \ProjectInfos{<Course Name>}{<Course Code>}{<Semester>}{<Project Title>}{<Project Subtitle or Supplementary Information>}{<Student Name>}[<Hyperlink on Student Name>]{<Student ID>};
  4. Call environments of problems, solutions and proofs with \begin{prob}...\end{prob}, \begin{sol}...\end{sol} and \begin{pf}...\end{pf}, respectively;
  5. Packages for mathematical formulas, figures, tables, chemistry formulas, reference citing have been included. See their usages in example files Assignment-en.*;
  6. Compile with pdf$\LaTeX$ or Xe$\LaTeX$. Need to compile twice because of references to the page number of the last page. Compile in the order of pdf$\LaTeX\rightarrow$bib$\TeX\rightarrow$pdf$\LaTeX\rightarrow$pdf$\LaTeX$ or Xe$\LaTeX\rightarrow$bib$\TeX\rightarrow$Xe$\LaTeX\rightarrow$Xe$\LaTeX$, if there is any reference citing.

Attention: Lack of dependent fonts for ctex package will cause error Critical Package ctex: CTeX fontset 'fandol' is unavailable in current (ctex) mode.. Then please compile with Xe$\LaTeX$

效果展示 Examples

中文版效果图

English version example

注意 Note

文件夹 作业模板(中文版) 和 AssignmentTemplate(En-ver) 是已不再维护的旧版本.

In folder 作业模板(中文版) and AssignmentTemplate(En-ver) are the old-version templates which are not maintained anymore.

待做 TODO

暂无.

Null for now.