├── !!!用xelatex编译!!! ├── 记得先读纯文本文件README.md ├── fig ├── figsample.pdf └── instruments.png ├── .gitignore ├── fig.mplstyle ├── figgen.py ├── bibli.bib ├── CHANGELOG.md ├── mpltx.cls ├── README.md ├── template.tex └── LICENSE /!!!用xelatex编译!!!: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /记得先读纯文本文件README.md: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /fig/figsample.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CastleStar14654/PKUMpLtX/HEAD/fig/figsample.pdf -------------------------------------------------------------------------------- /fig/instruments.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CastleStar14654/PKUMpLtX/HEAD/fig/instruments.png -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.aux 2 | *.bbl 3 | *.blg 4 | *.log 5 | *.out 6 | *.gz 7 | *Notes.bib 8 | *.zip 9 | *.pdf 10 | !fig/** 11 | *.fls 12 | *.fdb_latexmk 13 | *.xdv 14 | -------------------------------------------------------------------------------- /fig.mplstyle: -------------------------------------------------------------------------------- 1 | figure.figsize: 5., 3.75 2 | figure.dpi: 150 3 | mathtext.fontset: cm 4 | font.family: serif 5 | font.size: 10.0 6 | xtick.labelsize: small 7 | ytick.labelsize: small 8 | legend.fontsize: small 9 | -------------------------------------------------------------------------------- /figgen.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import numpy as np 4 | import matplotlib.pyplot as plt 5 | plt.style.use('fig.mplstyle') 6 | 7 | ts = np.linspace(0., 8.) 8 | plt.plot(ts, .5*4*ts**2, label='Uniformly accelerated motion, $x=\\frac{1}{2}at^2$') 9 | plt.plot(ts, 15*ts, '--', label='Uniform linear motion, $x=vt$') 10 | 11 | plt.xlabel('$t$ (s)') 12 | plt.ylabel('$x$ (m)') 13 | plt.legend() 14 | 15 | plt.tight_layout() 16 | plt.savefig('fig/figsample.pdf') 17 | -------------------------------------------------------------------------------- /bibli.bib: -------------------------------------------------------------------------------- 1 | @book{jindaishiyan, 2 | author = {吴思诚 and 荀坤}, 3 | title = {近代物理实验}, 4 | edition = 4, 5 | publisher = {高等教育出版社}, 6 | address = {北京}, 7 | year = {2015} 8 | } 9 | 10 | @techreport{ISO80000-2, 11 | type = {Standard}, 12 | author = {{ISO~80000-2:2019}}, 13 | year = {2021}, 14 | title = {{Quantities and units --- Part~2: Mathematics}}, 15 | institution = {International Organization for Standardization} 16 | } 17 | 18 | @techreport{GBT3102.11, 19 | type = {Standard}, 20 | author = {{GB/T~3102.11-1993}}, 21 | year = {1993}, 22 | title = {物理科学和技术中使用的数学符号}, 23 | institution = {国家技术监督局} 24 | } 25 | 26 | @techreport{GBT7714, 27 | type = {Standard}, 28 | author = {{GB/T~7714-2015}}, 29 | year = {2015}, 30 | title = {信息与文献\quad{}参考文献著录规则}, 31 | institution = {中华人民共和国国家质量监督检验检疫总局; 中国国家标准化管理委员会}, 32 | note = {第 10.1 节}, 33 | } 34 | 35 | @manual{pr, 36 | author = {Anne Waldron and Peggy Judd and Valerie Miller}, 37 | year = {2011}, 38 | title = {Physical Review: Style and Notation Guide}, 39 | organization = {The American Physical Society}, 40 | edition = {4}, 41 | url = {https://cdn.journals.aps.org/files/styleguide-pr.pdf}, 42 | note = {第 II.J. 节}, 43 | } 44 | 45 | @manual{fntguide, 46 | author = {{\LaTeX{} Project Team}}, 47 | year = {2021}, 48 | title = {\LaTeXe{} font selection}, 49 | note = {第 7 节}, 50 | url = {https://ctan.math.illinois.edu/macros/latex/base/fntguide.pdf} 51 | } 52 | 53 | @techreport{si, 54 | author = {{Bureau International des Poids et Mesures}}, 55 | year = {2019}, 56 | title = {The International System of Units (SI)}, 57 | edition = {9}, 58 | institution = {{Bureau International des Poids et Mesures}}, 59 | url = {https://www.bipm.org/documents/20126/41483022/SI-Brochure-9-EN.pdf} 60 | } 61 | 62 | @incollection{unicode, 63 | author = {{The Unicode Consortium}}, 64 | title = {Symbols}, 65 | chapter = {22}, 66 | pages = {839}, 67 | booktitle = {{The Unicode Standard Version 14.0 -- Core Specification}}, 68 | year = {2021}, 69 | publisher = {The Unicode Consortium}, 70 | url = {https://www.unicode.org/versions/Unicode14.0.0/ch22.pdf} 71 | } 72 | 73 | @article{PhysRevLett.116.061102, 74 | title = {Observation of Gravitational Waves from a Binary Black Hole Merger}, 75 | author = {Abbott, B. P. and Abbott, R. and Abbott, T. D. and others}, 76 | collaboration = {LIGO Scientific Collaboration and Virgo Collaboration}, 77 | journal = {Phys. Rev. Lett.}, 78 | volume = {116}, 79 | issue = {6}, 80 | pages = {061102}, 81 | numpages = {16}, 82 | year = {2016}, 83 | month = {Feb}, 84 | publisher = {American Physical Society}, 85 | doi = {10.1103/PhysRevLett.116.061102}, 86 | url = {https://link.aps.org/doi/10.1103/PhysRevLett.116.061102} 87 | } 88 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | ## 2025-03-15, [v2.1.6] 4 | 5 | ### Fixed 6 | 1. 修复了 `font=default` 选项下 `quanjiao` 选项无效的问题. (#2) 7 | 8 | ### Added 9 | 10 | 1. 添加了对需使用 `xelatex` 的强调. 11 | 2. 添加了数学模式中正体圆周率符号的支持. (#1) 12 | 13 | ## 2023-08-29, [v2.1.5] 14 | 15 | ### Fixed 16 | 17 | 1. 修复了 2023-06-17 的系列宏包更新 (包括 `hyperref`, `revtex` 以及 `ltxbase`) 带来的 `\autoref` 无法正常工作的问题. 18 | 19 | ### Added 20 | 21 | 1. 添加了对 `siunitx` 宏包中表格数值对齐功能的介绍. 22 | 23 | ## 2023-02-13, [v2.1.4] 24 | 25 | ### Added 26 | 27 | 1. 添加了对 `physics2` 宏包的广告 (by @AlphaZTX ). 28 | + 如果试图导入 `physics` 宏包，会警告并推荐 `physics2`. 29 | 30 | ## 2022-09-24, [v2.1.3] 31 | 32 | ### Changed 33 | 34 | 1. 字体选项变化 35 | + `default` (默认选项) 的行为变为采用 `xeCJK` 的默认配置. 亦即，全系为 fandol 字体, 用楷体作为衬线意大利体, 无衬线字体没有意大利体. 也就是说, 现在 `default` 和 `diy` 行为一致. 36 | + 所以, 如果什么选项都不传, 用户可以自行用 `\setCJK*font` 配置. 37 | + 原 `default` 选项变为 `fandol`, 亦即作者配置的版本, 用仿宋作为衬线意大利体. 38 | + 考虑到初次使用的用户体验, `template.tex` 的示例字体选项不再是 `notofandol`, 而是 `default`. 39 | + 文档有相应修改. 40 | 41 | ### Added 42 | 43 | 1. 一个提示阅读 [`README.md`](README.md) 的空文件. 44 | 45 | ## 2022-08-27, [v2.1.2] 46 | 47 | ### Changed 48 | 49 | 1. 一些格式化. 50 | 2. 不再默认导入 `physics`, 而是改为可选项; `\qty` 恢复为 `siunitx` 的命令, `physics` 的命名为 `\qtyp`. (Thanks @AlphaZTX ) 51 | 52 | ### Added 53 | 54 | 1. 新提到了 `fixdif` 宏包. 55 | 56 | ### Fixed 57 | 58 | 1. 去除示例文档中的英文破折号 em-dash 两侧空格, 以符合大多数格式规范的要求. 59 | 60 | ## 2022-06-16, [v2.1.1] 61 | 62 | ### Added 63 | 64 | 1. 对模板文件添加了大量必要的引用与超链接. 65 | 2. 对说明文档添加了更详细的安装等说明. 66 | 2. 对说明文档添加了英文字体说明. 67 | 68 | ### Fixed 69 | 70 | 1. 修复 PDF 书签中摘要为空白的问题. 71 | 72 | ## 2022-06-12, [v2.1] 73 | 74 | ### Changed 75 | 76 | 1. 代码重构, 重命名了内部变量, 为兼容性更多使用 `\patchcmd` 77 | 2. 字体选项现通过关键字参数传入. 78 | 3. 调整了部分字体配置. 79 | 4. 为兼容性将 `\IfPackageLoadedTF` 改回 `\@ifpackageloaded` 80 | 81 | ### Added 82 | 83 | 1. 用户若尝试调用 `caption` 会报错. 84 | 2. 调用了 `tabularx`. 85 | 3. 文档中增加了对下载, 安装和字体的说明; 增加了命令列表. 86 | 4. 对字体配置存在的影响显示效果的问题做了说明. 87 | 88 | ### Removed 89 | 90 | 1. `git` 文件夹不再保留编译后的 PDF. 将仅通过 [Releases](https://github.com/CastleStar14654/PKUMpLtX/releases) 发布. 91 | 92 | ## 2022-06-06, [v2.0.2] 93 | 94 | ### cls 95 | 96 | 1. 微调了一些行距参数. 97 | 2. 表格脚注格式调整. 98 | 3. 使各 autorefname 通过 babel 重定义, 更可移值. 99 | 4. 删除了导致错误的 `\makeatother` 100 | 101 | ### doc 102 | 103 | 1. 修改了表格示例. 104 | 2. 改进了文档. 105 | 3. 增加了对部分半角标点的输入提示. 106 | 107 | ### readme 108 | 109 | 1. 修改了 typo 与格式. 110 | 111 | ## 2022-05-25, [v2.0.1] 112 | 113 | ### cls 114 | 115 | 1. 修复了 `diy` 选项的逻辑错误. 116 | 117 | ### doc 118 | 119 | 1. 修正了若干 typo. 120 | 121 | ## 2022-05-25, [v2.0] 122 | 123 | ### cls 124 | 1. 去除了非必要的外部宏包. 125 | 2. 添加了 `siunitx` 方便物理量输入. 126 | 3. 使得对附录中的节的 `\autoref` 产生 '附录' 字样而非 '小节'. 127 | 4. 去除在 `*.cls` 文件中冗余的 `\makeatletter` 命令. 128 | 5. 中文等宽字体改用仿宋系列. 129 | 6. 增加 `notofandol` 字体配置. 130 | 7. 引入 `babel` 管理部分中文化. 131 | 8. 引入 `quanjiao` 选项. 132 | 133 | ### doc 134 | 1. 添加了对外部宏包可能冲突的说明. 135 | 2. 使引用标记的位置符合规范. 136 | 3. Changelog 独立 137 | 4. 发布至 GitHub. 138 | 139 | ## 2022-04-30 140 | 141 | 1. 在 `README` 中增加了文件内容. 142 | 2. 基本完全依据 `bgmb.doc` 重写了 `template.pdf`. 143 | 3. 增加了 `matplotlib` 作图示例 `figgen.py`. 144 | 4. 改变了配置字体的实现方法. 145 | 5. 更改了页边距. 146 | 6. 更改了摘要宽度. 147 | 7. 纸张大小改为 A4 而非默认的 Letter. 148 | 8. 优化了 PDF 自动生成的书签以及元数据. 149 | 9. 新增 `\emailphone` 命令, 以合理显示手机号. 150 | 10. 将段落开头间距改为两个汉字字符. 151 | 152 | ## 2022-03-19 153 | 154 | `*.cls` 初版本. 155 | 156 | [Unreleased]: https://github.com/CastleStar14654/PKUMpLtX/compare/v2.1.6...HEAD 157 | [v2.1.6]: https://github.com/CastleStar14654/PKUMpLtX/compare/v2.1.5...v2.1.6 158 | [v2.1.5]: https://github.com/CastleStar14654/PKUMpLtX/compare/v2.1.4...v2.1.5 159 | [v2.1.4]: https://github.com/CastleStar14654/PKUMpLtX/compare/v2.1.3...v2.1.4 160 | [v2.1.3]: https://github.com/CastleStar14654/PKUMpLtX/compare/v2.1.2...v2.1.3 161 | [v2.1.2]: https://github.com/CastleStar14654/PKUMpLtX/compare/v2.1.1...v2.1.2 162 | [v2.1.1]: https://github.com/CastleStar14654/PKUMpLtX/compare/v2.1...v2.1.1 163 | [v2.1]: https://github.com/CastleStar14654/PKUMpLtX/compare/v2.0.2...v2.1 164 | [v2.0.2]: https://github.com/CastleStar14654/PKUMpLtX/compare/v2.0.1...v2.0.2 165 | [v2.0.1]: https://github.com/CastleStar14654/PKUMpLtX/compare/v.2.0...v2.0.1 166 | [v2.0]: https://github.com/CastleStar14654/PKUMpLtX/releases/tag/v.2.0 167 | -------------------------------------------------------------------------------- /mpltx.cls: -------------------------------------------------------------------------------- 1 | % 2 | % PKUMpLtX --- A LaTeX document class for 'Modern Physics Laboratory' in PKU based on `revtex4-2` 3 | % 4 | % Please read `README.md' and the template file before using 5 | 6 | % ========== Identification ========== 7 | \NeedsTeXFormat{LaTeX2e} 8 | \ProvidesClass{mpltx}[2025/03/15 v2.1.6 XeLaTeX class for MP Lab in PKU] 9 | 10 | % ========== Preliminary declarations ========== 11 | % copy from \GetFileInfo from LaTeX `doc` program 12 | \def\mpltx@filevergen#1{% 13 | \def\mpltx@filename{#1}% 14 | \def\@tempb##1 ##2 ##3\relax##4\relax{% 15 | \def\mpltx@filedate{##1}% 16 | \def\mpltx@fileversion{##2}% 17 | \def\mpltx@fileinfo{##3}}% 18 | \edef\@tempa{\csname ver@#1\endcsname}% 19 | \expandafter\@tempb\@tempa\relax? ? \relax\relax} 20 | % generate \mpltx@filename \mpltx@filedate etc. 21 | \mpltx@filevergen{mpltx.cls} 22 | 23 | 24 | % 基于 APS 的文档类 revtex4-2; 参数含义: 25 | % APS 系列期刊 Phys. Rev. E 格式预印本, 显示关键词, A4, 载入 ams 系列 26 | \let\old@label\label 27 | \LoadClass[aps,pre,preprint,showkeys,a4paper,amssymb]{revtex4-2} 28 | \let\label\old@label 29 | \RequirePackage{amsmath} 30 | % 选项处理 31 | \RequirePackage{kvoptions} 32 | % [外部宏包] 字符串处理 33 | \RequirePackage{xstring} 34 | % 更改 revtex 命令定义 35 | \RequirePackage{etoolbox} 36 | % [外部宏包] 平台类型检测 37 | \RequirePackage{ifplatform} 38 | % [外部宏包] 中文支持 39 | \RequirePackage{xeCJK} 40 | 41 | 42 | % ===== Options ===== 43 | \DeclareBoolOption{quanjiao} 44 | \DeclareBoolOption{physics} 45 | \DeclareStringOption[default]{font} 46 | \ProcessKeyvalOptions*\relax 47 | 48 | 49 | % 全角句点映射 50 | \ifmpltx@quanjiao% 51 | \defaultCJKfontfeatures{Mapping={fullwidth-stop}}% 52 | \fi 53 | % 提供字体配置 54 | \def\mpltx@fonttest@fandol{% 检测 fandol 宏包有没有安装 55 | \IfFontExistsTF{FandolSong}{}{ 56 | \ClassError{mpltx}{'fandol' is not installed}{Please install package 'fandol'} 57 | } 58 | } 59 | \def\mpltx@fonttest@noto{% 检测 noto 字体有没有安装 60 | \IfFontExistsTF{Noto Serif CJK SC}{}{ 61 | \ClassError{mpltx}{Noto fonts are not installed}{% 62 | Please install package `notocjksc`\MessageBreak 63 | or download at https://github.com/googlefonts/noto-cjk/releases} 64 | } 65 | } 66 | % 处理字体配置 67 | \IfStrEqCase{\mpltx@font}{% 68 | {default}{}% 69 | {fandol}{% 70 | \mpltx@fonttest@fandol% 71 | \setCJKmainfont[BoldFont={FandolSong Bold},ItalicFont={FandolFang}]{FandolSong}% 72 | \setCJKsansfont[BoldFont={FandolHei Bold},ItalicFont={FandolKai}]{FandolHei}% 73 | \setCJKmonofont[AutoFakeBold=true,ItalicFont={FandolKai}]{FandolFang}% 74 | }{noto}{% 75 | \mpltx@fonttest@noto% 76 | \ifwindows{ 77 | \setCJKmainfont[BoldFont={Noto Serif CJK SC Bold},ItalicFont={FangSong}]{Noto Serif CJK SC}% 78 | \setCJKsansfont[BoldFont={Noto Sans CJK SC Bold},ItalicFont={KaiTi}]{Noto Sans CJK SC}% 79 | \setCJKmonofont[AutoFakeBold=true,ItalicFont={KaiTi}]{FangSong}}% 80 | \else{ 81 | \setCJKmainfont[BoldFont={Noto Serif CJK SC Bold},ItalicFont={STFangsong}]{Noto Serif CJK SC}% 82 | \setCJKsansfont[BoldFont={Noto Sans CJK SC Bold},ItalicFont={KaiTi SC},BoldItalicFont={KaiTi SC Bold},]{Noto Sans CJK SC}% 83 | \setCJKmonofont[AutoFakeBold=true,ItalicFont={KaiTi SC},BoldItalicFont={KaiTi SC Bold}]{STFangsong}}% 84 | \fi 85 | }{notofandol}{% 86 | \mpltx@fonttest@noto\mpltx@fonttest@fandol% 87 | \setCJKmainfont[BoldFont={Noto Serif CJK SC Bold},ItalicFont={FandolFang}]{Noto Serif CJK SC}% 88 | \setCJKsansfont[BoldFont={Noto Sans CJK SC Bold},ItalicFont={FandolKai}]{Noto Sans CJK SC}% 89 | \setCJKmonofont[AutoFakeBold=true,ItalicFont={FandolKai}]{FandolFang} 90 | }{windows}{% 91 | \setCJKmainfont[BoldFont={STZhongsong},ItalicFont={STFangsong}]{STSong}% 92 | \setCJKsansfont[BoldFont={DengXian Bold},ItalicFont={STKaiti}]{DengXian}% 93 | \setCJKmonofont[AutoFakeBold=true,ItalicFont={STKaiti}]{STFangsong} 94 | }{macos}{% 95 | \setCJKmainfont[BoldFont={Songti SC Bold},ItalicFont={STFangsong}]{Songti SC}% 96 | \setCJKsansfont[BoldFont={PingFang SC Semibold},ItalicFont={Kaiti SC},BoldItalicFont={KaiTi SC Bold}]{PingFang SC}% 97 | \setCJKmonofont[AutoFakeBold=true,ItalicFont={KaiTi SC},BoldItalicFont={KaiTi SC Bold}]{STFangsong} 98 | }{diy}{} 99 | }[\ClassError{mpltx}{unkown 'font' value}{check for 'font' option}] 100 | 101 | 102 | % ===== More declarations ===== 103 | % ----- Format ----- 104 | % 首段缩进 105 | \RequirePackage{indentfirst} 106 | % 将页边距减小 107 | \RequirePackage[hmargin=2.5cm,top=2cm,bottom=1.6cm,footskip=1cm,includefoot]{geometry} 108 | % 参考文献格式 109 | \bibliographystyle{apsrev4-2} 110 | % 让 email 加上手机号 111 | \NewDocumentCommand{\emailphone}{O{} m m}{% 112 | \begingroup\sanitize@url\mpltx@emaildouble{#1}{#2}{#3}} 113 | \def\mpltx@emaildouble#1#2#3{% 114 | \endgroup 115 | \@AF@join{#1\href{mailto:#2}{#2}; #3}% 116 | }% 117 | % 摘要 118 | \def\frontmatter@abstractwidth{400\p@}%摘要收窄 119 | \patchcmd{\frontmatter@abstractfont} 120 | {1em} 121 | {2em}%摘要开头空两格 122 | {} 123 | {} 124 | % 防止首页大段空白 125 | % 来自 https://tex.stackexchange.com/questions/413116/how-to-prevent-page-break-in-revtex-4-1 126 | \patchcmd{\frontmatter@abstract@produce} 127 | {\vskip200\p@\@plus1fil 128 | \penalty-200\relax 129 | \vskip-200\p@\@plus-1fil} 130 | {} 131 | {} 132 | {} 133 | % 开头空两格 134 | \AtBeginDocument{\setlength{\parindent}{2em}} 135 | % 行距调整 136 | \linespread{1.3} 137 | \setlength{\footnotesep}{1em} 138 | \patchcmd{\footnotesize} 139 | {\@xpt{14.5pt}} 140 | {\@xpt{\@xiipt}} 141 | {} 142 | {} 143 | \patchcmd{\small} 144 | {\@xipt{14.5pt}} 145 | {\@xipt{13\p@}} 146 | {} 147 | {} 148 | 149 | % ----- Math & physics ----- 150 | % [外部宏包] 国际单位制与数值支持 151 | \RequirePackage[unit-mode=text]{siunitx} 152 | \ifmpltx@physics 153 | \AtBeginDocument{ 154 | % [外部宏包] 提供很多物理符号和微积分符号; 默认不导入; 需打开 `physics` 选项 155 | \NewCommandCopy{\mpltx@SIqty}{\qty} 156 | \RequirePackage{physics} 157 | % 处理 siunitx 和 physics 对 qty 重名: 后者变成 \qtyp 158 | \NewCommandCopy{\qtyp}{\quantity} 159 | \RenewCommandCopy{\qty}{\mpltx@SIqty} 160 | \let\mpltx@SIqty\@undefined 161 | } 162 | \fi 163 | % 定义虚数单位简写 164 | \newcommand{\jj}{\mathrm{j}} 165 | \newcommand{\ii}{\mathrm{i}} 166 | \newcommand{\ee}{\mathrm{e}} 167 | % 英文字体与正体 \pi 定义 168 | \RequirePackage{fontsetup} 169 | \RequirePackage{alphabeta} 170 | \newcommand{\uppi}{\text{\pi}} 171 | 172 | % ----- Figure ----- 173 | % 插入图片 174 | \RequirePackage{graphicx} 175 | 176 | % ----- Table ----- 177 | % revtex4-2 推荐的数据展示表格工具 178 | \RequirePackage{dcolumn} 179 | % 表格宏包 180 | \RequirePackage{array,rotating,tabularx} 181 | % 定义表格中的数字格式, d{a.b} 即为按小数点区分, 前留 a 位, 后留 b 位 182 | \newcolumntype{d}[1]{D{.}{.}{#1}} 183 | % 简写 multicolumn 184 | \let\mc\multicolumn 185 | 186 | % ----- Chinese localization ------ 187 | % [外部宏包] 中文支持 188 | \RequirePackage{zhnumber} 189 | \RequirePackage[chinese,provide=*]{babel} 190 | % 额外结构名处理 191 | \setlocalecaption{chinese}{abstract}{} 192 | \setlocalecaption{chinese}{acknowledgments}{致谢} 193 | \def\@pacs@name{\textbf{PACS码: }} 194 | \def\@keys@name{\textbf{关键词: }} 195 | \def\Dated@name{实验日期: } 196 | % 使 hyperref 的 \autoref 本地化 197 | \addto\extraschinese{% here the use of % is necessary 198 | \def\equationautorefname~#1\null{式~(#1)\null}% 199 | \renewcommand{\footnoteautorefname}{脚注}% 200 | \renewcommand{\itemautorefname}{项}% 201 | \renewcommand{\figureautorefname}{\figurename}% 202 | \renewcommand{\tableautorefname}{\tablename}% 203 | \def\partautorefname~#1\null{\prepartname~#1\ \postpartname\null}% 204 | \renewcommand{\appendixautorefname}{\appendixname}% 205 | \renewcommand{\sectionautorefname}{小节}% 206 | \renewcommand{\theoremautorefname}{定理}% 207 | \def\pageautorefname\nobreakspace\pageref*#1{第~\pageref*{#1}\ 页\null}% 用于 \autopageref 208 | } 209 | 210 | % ----- PDF & hyperref ----- 211 | % PDF 超链接以及元数据 212 | \RequirePackage[pdfusetitle=true,bookmarksnumbered=true,bookmarksopen=true]{hyperref} 213 | % 为了超链接指向图的开头; hypcap 要求在 hyperref 后调用 214 | \RequirePackage[all]{hypcap} 215 | % PDF 书签摘要名字 216 | \newcommand{\bookmarkabstractname}{摘要} 217 | \patchcmd{\addcontents@abstract}{% 218 | \abstractname% 219 | }{% 220 | \bookmarkabstractname% 221 | }{}{} 222 | % revtex 内部对 \section 的更改使得 hyperref 对 \appendix 的修改没有产生效果 223 | % 这里做了修复 224 | \appto\appendix{ 225 | \patchcmd{\phantomsection}{% 226 | \Hy@MakeCurrentHrefAuto{section*}% 227 | }{% 228 | \Hy@MakeCurrentHrefAuto{\Hy@chapapp*}% 229 | }{}{}% 230 | } 231 | 232 | % ----- Compatibility ----- 233 | \AtBeginDocument{ 234 | % \IfPackageLoadedTF{caption}{% 235 | \@ifpackageloaded{caption}{% 236 | \ClassError{mpltx}{package `caption' is incompatible}{do not use `caption'} 237 | }{} 238 | \@ifpackageloaded{physics}{% 239 | \ClassWarning{mpltx}{% 240 | package `physics' might be broken in the future,\MessageBreak 241 | try `physics2' by Tingxuan Zhang! 242 | } 243 | }{} 244 | } 245 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # `PKUMpLtX`, [项目页] 2 | 3 | *A LaTeX document class for 'Modern Physics Laboratory' in PKU based on [`revtex4-2`]* 4 | 5 | + Copyright (C) 2013--2025. Modern Phys. Lab, School of Phys., Peking Univ. 6 | + Copyright (C) 2013--2014. Sun Sibai 7 | + Copyright (C) 2013. Cao Chuanwu <> 8 | + Copyright (C) 2021--2025. Lin Xuchen 9 | 10 | This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International 11 | License. To view a copy of this license, visit [`LICENSE`] 12 | or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. 13 | 14 | 希望本模板能帮助同学们专注报告内容, 减少在格式等问题上不必要的时间消耗. 15 | (虽然使用 $\mathrm{\LaTeX{}}$ 会带来另外一些细节问题) 16 | 本模板不保证可靠性. 17 | 18 | **重要提示**: 请使用 `xelatex` 编译. 19 | 20 | - [下载](#下载) 21 | - [\[可选\] 安装](#可选-安装) 22 | - [文件内容](#文件内容) 23 | - [使用方法](#使用方法) 24 | - [编译](#编译) 25 | - [字体选项](#字体选项) 26 | - [关于中文字体的进一步说明](#关于中文字体的进一步说明) 27 | - [英文字体与 `unicode-math`](#英文字体与-unicode-math) 28 | - [标点选项](#标点选项) 29 | - [`physics` 宏包导入选项](#physics-宏包导入选项) 30 | - [新定义的命令列表](#新定义的命令列表) 31 | - [自动调用的宏包](#自动调用的宏包) 32 | - [其他需要注意的外部宏包](#其他需要注意的外部宏包) 33 | - [反馈](#反馈) 34 | 35 | ## 下载 36 | 37 | + 稳定版: 前往 [Releases] 页面下载最新版本的 `Source code` 文件. 38 | + 最新: 在[项目页]下载最新源代码. 39 | + `git clone`: 如果会使用 git, 可以直接 `git clone` 本项目. 之后可以直接 `pull` 获取更新. 40 | + 加上 `--filter=blob:none` 选项可以减小下载大小 (比如不下载曾经被 `git` 跟踪的 PDF 文件). 41 | 42 | ### \[可选\] 安装 43 | 44 | + 不想折腾的话直接将 [`mpltx.cls`] 复制/链接到编写报告的当前文件夹, 然后按[使用方法](#使用方法)中描述的那样在 `*.tex` 中调用即可. 45 | + 如果想要正经地安装这个宏包, 从而不用每次手动复制/链接: 46 | + 请找到用户的 $\mathrm{\TeX}$ 根目录位置 (`$TEXMF`). 47 | + $\mathrm{\TeX\ Live}$ 用户: 应该就是 `$HOME/texmf` (*nix) 或者 `%USERPROFILE%\texmf` (Windows). 48 | + $\mathrm{MiK\TeX}$ 用户: 建议如 $\mathrm{\TeX\ Live}$ 那样在用户文件夹创建 `texmf` 文件夹, **然后在 $\mathrm{MiK\TeX}$ Console 中注册该文件夹**, 请参考[文档说明](https://miktex.org/faq/local-additions). 49 | + 将整个 `PKUMpLtX` 文件夹移动到 `$TEXMF/tex/latex`. 50 | + 所以, 实际上可以直接在 `$TEXMF/tex/latex` 进行 `git clone`. 51 | + 需要使用 `mktexlsr` 命令刷新文件名数据库缓存. 52 | + (可选) 将 [`template.tex`], [`bibli.bib`] 和 [`fig/`] 复制到其他文件夹, 测试能否正常编译. 注意修改开头的[字体选项](#字体选项). 53 | + 为测试本模板可以正常工作, 请在**修改开头的[字体选项](#字体选项)后**尝试[编译](#编译) [`template.tex`]. 结果文档应该除了字体外, 与 [Releases] 页面供下载的 PDF 文件完全一致. 54 | 55 | ## 文件内容 56 | 57 | + [`mpltx.cls`]\: 模板文件. 58 | + `README.md`: 本文件, 说明文档. 59 | + [`template.tex`]\: 示例报告模板兼说明文档, 可编译得到 `template.pdf`. 60 | + [`bibli.bib`]\: 用于参考文献生成的文件. 61 | + [`fig/`]\: 示例报告用到的图片. 62 | + [`figgen.py`]\: 生成其中一张图片用的脚本. 63 | + [`fig.mplstyle`]\: 相应的格式设置. 64 | 65 | ## 使用方法 66 | 67 | 只需将 [`mpltx.cls`] 复制/链接到当前文件夹, (如果[安装](#可选-安装)了, 则不用做复制或链接), 然后使用该文档类 68 | ```latex 69 | \documentclass[]{mpltx} 70 | ``` 71 | `[]` 为可选的选项列表, 可以给入标准文档类 `article` 以及 [`revtex4-2`] 可接受的任何参数. 72 | 但只建议传 [`mpltx.cls`] 定义的中文字体参数和标点符号参数 (见下). 73 | 使用前推荐先仔细查看 [`template.tex`] 文件. 74 | 如果有魔改需求可以自定义 [`mpltx.cls`] 75 | 76 | 如果初次使用 $\mathrm{\LaTeX{}}$, 推荐以下入门文档: 77 | 1. [lshort-zh-cn] 78 | 2. [lnotes2] 79 | 80 | ### 编译 81 | 82 | 由于使用了 [`xeCJK`], 需用 `xelatex` 编译. 83 | 为避免编码的问题, 所有源代码请用 UTF-8 保存 (这应该是大多数现代纯文本编辑器的默认配置). 84 | 1. 常规编译: `xelatex %DOC%` 一次; 85 | 2. 更新超链接: `xelatex %DOC%` 两次; 86 | 3. 更新参考文献引用: `xelatex %DOC%` 一次, `bibtex %DOC%` 一次, `xelatex %DOC%` 两次. 87 | 88 | 以上的 `%DOC%` 均为 `*.tex` 主文件去掉拓展名后的剩余部分. 89 | 绝大多数 $\mathrm{\LaTeX{}}$ 编辑器在适当配置后可以为你完成这些工作, 还能帮你自动添加 synctex 等选项. 90 | 91 | 比如, 示例文档的编译为 92 | ```bash 93 | xelatex template 94 | bibtex template 95 | xelatex template 96 | xelatex template 97 | ``` 98 | 99 | ### 字体选项 100 | 101 | `font={`**`default`**`|noto|notofandol|windows|macos|diy}` 102 | + `default`: 默认选项, 使用 [`xeCJK`] 默认配置. 小白友好. 103 | + `fandol`: 作者搭配的使用 [`fandol`] 的字体配置, 与默认的配法不同. 需要事先安装 [`fandol`] 宏包, $\mathrm{MiK\TeX}$ 在这个选项下并不会自动下载 `fandol`. 104 | + `noto`: 使用 Noto CJK SC 系列的宋体与黑体. 这是一款优秀的开源中文字体, 可在[其主页](https://github.com/googlefonts/noto-cjk/releases)下载最新版的 Noto CJK Serif SC (即思源宋体) 和 Noto CJK Sans SC (即思源黑体), 105 | 或者安装 [`notocjksc`] 宏包 (但宏包的字体版本是 18 年的). 106 | 但仿宋体和楷体 Noto 未提供, 故将自动使用 Windows 或 macOS 自带的相应字体. **Linux 用户很可能会因为没有相应的商业仿宋体和楷体字体而出错**, 请改用下方的 `notofandol`, 或改用 `diy` 自行使用 `\setCJK*font` 等命令配置. 107 | + `notofandol`: 用 Fandol 的仿宋体和楷体搭配 Noto 系列的宋体与黑体. **Fandol 和 Noto 的基线不齐**. 108 | + `windows`: 使用 Windows 系统自带字体 (都使用华文系列; 除了黑体为等线). 109 | + `macos`: 使用 macOS 系统自带字体 (黑体为苹方). **苹方和其他字体的基线不对齐. 但 macOS 的所有黑体类字体都有这个问题.** 110 | + `diy`: 历史遗留选项, 与 `default` 完全一致. 111 | 112 | 使用以上任意选项后, 都仍可用 `\setCJK*font` 自行调整字体. 113 | 114 | 比如, Windows 用户就可以这样子调用 115 | ```latex 116 | \documentclass[font=windows]{mpltx} 117 | ``` 118 | 同时, 在任何系统上这应该都可以编译 119 | ```latex 120 | \documentclass{mpltx} 121 | ``` 122 | 123 | 以上各选项 (`default` 除外) 的字体配置风格如下 (与 `xeCJK` 默认的配置方式有所不同) 124 | | | Roman | Sans Serif | Monospace | 125 | | :-----: | :----: | :--------: | :-------: | 126 | | Upright | 宋体类 | 黑体类 | 仿宋类 | 127 | | Italic | 仿宋类 | 楷体类 | 楷体类 | 128 | 129 | `default` 的字体配置则为 130 | | | Roman | Sans Serif | Monospace | 131 | | :-----: | :----: | :--------: | :-------: | 132 | | Upright | 宋体类 | 黑体类 | 仿宋类 | 133 | | Italic | 楷体类 | 没有 | 没有 | 134 | 135 | 各平台可以支持的字体选项如下 (叹号表示需要安装特定的字体宏包或开源字体) 136 | | 选项 | Windows | macOS | Linux | Overleaf | 137 | | :--------: | :-----: | :---: | :---: | :------: | 138 | | default | ✓ | ✓ | ✓ | ✓ | 139 | | fandol | ✓! | ✓! | ✓! | ✓ | 140 | | noto | ✓! | ✓! | ✗ | ✗ | 141 | | notofandol | ✓! | ✓! | ✓! | ✓ | 142 | | windows | ✓ | ✗ | ✗ | ✗ | 143 | | macos | ✗ | ✓ | ✗ | ✗ | 144 | 145 | #### 关于中文字体的进一步说明 146 | 147 | 除了上面已经提到的基线不齐的问题外, 还有可能影响输出效果的问题有: 148 | 除 macOS 自带的楷体外, 其他所有的楷体字体都没有粗体, 因此 Sans Serif 和 Monospace 的 `\textit` 与 `\textbf` 连用仅产生 `\textbf` 效果. 149 | 所有的仿宋体字体也是如此, Roman 的 `\textit` 与 `\textbf` 连用也仅产生 `\textbf` 效果. 150 | 对于 Monospace 字体, `AutoFakeBold` 选项被本模板开启, 因此粗体的 Monospace 为伪粗体的仿宋, 效果可能不佳. 151 | 但鉴于对实验报告来说, 使用各种 fancy 字体样式的需求不大, 因此问题应该不是很显著. 152 | 153 | [`template.tex`] 在附录给了一段供检查字体效果的排版内容. 154 | 155 | #### 英文字体与 `unicode-math` 156 | 157 | 本模板未对英文字体做设置, 输出的为 XeTeX 下默认的 Latin Modern 系列字体. 158 | 如有修改英文字体需求, 请自行使用 [`fontspec`] 宏包提供的命令修改 ([`xeCJK`] 自动调用了此宏包). 159 | 160 | 如有修改数学字体的需求, 请自行使用 [`fontspec`] 相关功能或调用 [`unicode-math`] 并下载相应的数学 OTF 字体宏包. 161 | 162 | ### 标点选项 163 | 164 | 报告要求是 "全文标点符号除 '顿号' 外, 其他用英文半角标点符号". 165 | 但也可能有人想使用全角标点, 或者使用全角标点但把句号从 "。" 改为 "．". 166 | + 如果你想完全用半角标点, 不用任何选项, 直接用半角标点输入. 167 | + 如果你想完全用符合 GB/T 15834-2011 的全角标点, 直接用全角标点输入. 168 | + 如果你想像 GB/T 15834-1995 所说, "在科技文档中用实心全角圆点 '．' 替代句号 '。'", 169 | + 如果你有方便的直接输入 "．" 的方法, 直接输入; 170 | + 如果没有, 使用 `quanjiao` 选项, 在源文件中直接用 "。" 做句号. 171 | [`xeCJK`] 会自动帮你做替换. 172 | 173 | ### `physics` 宏包导入选项 174 | 175 | **[`physics`] 宏包使用了一些可能在未来被弃用的 $\mathrm{\LaTeX{}}$ 功能，请考虑使用 Tingxuan Zhang 编写的 [`physics2`]。** 176 | 177 | [`physics`] 提供了众多方便的物理符号与公式输入, 如导数符号命令 `\dv{f}{x}`, 自动调整大小的括号 `\qtyp()` 等. 178 | **但本宏包已十年没有维护, 故默认没有导入**, 如需要请使用 `physics` 文档类选项, 而非自行导入! 179 | 此宏包定义的 "自动调整括号大小" 命令 `\qty` 与 `siunitx` 的 "物理量" 命令重名. 180 | 所以, 本模板导入时将该宏包的命令**重命名**为 `\qtyp`. 181 | 具体其他功能请参考其文档. 182 | 183 | ### 新定义的命令列表 184 | 185 | + `\emailphone[]{}{}`: 在当前位置插入脚注, 内容为 `; ` 且电子邮件地址转为链接. 186 | + `\jj`, `\ii`, `\ee`: 数学模式下 j, i 和 e 的 `\mathrm` 版本. 187 | + `\mc`: `\multicolumn` 的别名. 188 | 189 | ## 自动调用的宏包 190 | 191 | 模板已提前调用了很多为撰写报告提供便利的宏包, 请前往 [`mpltx.cls`] 查看, 其中含有解释其功能的注释. 192 | 一些特殊说明如下: 193 | 194 | + [`siunitx`] 用于便利地打出格式良好的物理量的值和单位, 如 `\qty{299792.458}{\km\per\s}`， `$g=\qty{9.801}{m.s^{-2}}$`. 195 | + [`dcolumn`] $\mathrm{\LaTeX{}}2\epsilon$ 基础包的一个, 提供按小数点对齐的表格列格式. 196 | `siunitx` 其实也提供了类似功能, 感兴趣的可以参考两者文档. 197 | 198 | ### 其他需要注意的外部宏包 199 | 200 | + [`caption`] 存在与本模板的基础 `revtex4-2` 不兼容的情况, 请勿使用. 201 | + [`subfig`] 默认会自动调用 `caption`. 202 | 调用时请使用选项 `caption=false`. 203 | + [`fixdif`] 宏包提供了正体微分符号命令, 如有需求可以调用. 204 | 205 | ## 反馈 206 | 207 | 如果使用中发现问题或有建议, 请联系 Lin Xuchen , 或到[项目页]提 issue. 208 | 如果有大佬愿意改进这个写得稀烂的文档类, 也欢迎动手. 209 | 210 | [项目页]: https://github.com/CastleStar14654/PKUMpLtX 211 | [Releases]: https://github.com/CastleStar14654/PKUMpLtX/releases 212 | 213 | [`mpltx.cls`]: mpltx.cls 214 | [`template.tex`]: template.tex 215 | [`bibli.bib`]: bibli.bib 216 | [`fig/`]: fig/ 217 | [`figgen.py`]: figgen.py 218 | [`fig.mplstyle`]: fig.mplstyle 219 | [`LICENSE`]: LICENSE 220 | 221 | [`revtex4-2`]: https://www.ctan.org/pkg/revtex 222 | [`unicode-math`]: https://www.ctan.org/pkg/unicode-math 223 | [`fontspec`]: https://www.ctan.org/pkg/fontspec 224 | [lshort-zh-cn]: http://mirrors.ctan.org/info/lshort/chinese/lshort-zh-cn.pdf 225 | [lnotes2]: https://github.com/huangxg/lnotes/blob/master/lnotes2.pdf 226 | [`xeCJK`]: https://www.ctan.org/pkg/xecjk 227 | [`fandol`]: https://www.ctan.org/pkg/fandol 228 | [`notocjksc`]: https://www.ctan.org/pkg/notocjksc 229 | [`physics`]: https://www.ctan.org/pkg/physics 230 | [`physics2`]: https://www.ctan.org/pkg/physics2 231 | [`siunitx`]: https://www.ctan.org/pkg/siunitx 232 | [`caption`]: https://www.ctan.org/pkg/caption 233 | [`subfig`]: https://www.ctan.org/pkg/subfig 234 | [`dcolumn`]: https://www.ctan.org/pkg/dcolumn 235 | [`fixdif`]: https://www.ctan.org/pkg/fixdif 236 | -------------------------------------------------------------------------------- /template.tex: -------------------------------------------------------------------------------- 1 | % 2 | % PKUMpLtX --- A LaTeX document class for 'Modern Physics Laboratory' in PKU based on `revtex4-2` 3 | % 4 | % Please read `README.md' and the template file before using 5 | % 需要确保 font 选项指定的字体已安装! 具体参见 `README.md' 的说明. 6 | \documentclass[font=default]{mpltx} 7 | 8 | % 以下至 \begin{document} 都仅是本文件为了方便额外定义的命令, 写报告时不需要. 9 | \hypersetup{colorlinks=true}% 超链接带颜色 10 | \usepackage{xcolor} 11 | \newcommand{\note}[1]{{\color{gray}#1}} 12 | \NewDocumentCommand{\pkg}{s o m}{% 13 | \IfBooleanF{#1}{% 14 | \IfNoValueTF{#2}% 15 | {\href{https://www.ctan.org/pkg/#3}}% 16 | {\href{https://www.ctan.org/pkg/#2}}% 17 | }% 18 | {\textsf{#3}}% 19 | } 20 | \newcommand*\cs[1]{\texttt{\textbackslash #1}} 21 | \newcommand*\env[1]{\textit{\texttt{#1}}} 22 | \newcommand*\code[1]{\texttt{#1}} 23 | \newcommand*\file[1]{\textbf{\texttt{#1}}} 24 | \makeatletter 25 | \newcommand\releasedate{% 26 | \href{https://github.com/CastleStar14654/PKUMpLtX/releases/tag/\mpltx@fileversion}% 27 | {\mpltx@filedate, \mpltx@fileversion}} 28 | \makeatother 29 | % 以上是本文件为了方便额外定义的命令, 写报告时不需要. 30 | 31 | \begin{document} 32 | 33 | \title{实验题目} % 切合报告内容, 简短明确, 可以不同于讲义 34 | \author{姓名} % 这里 \emailphone 一定要紧跟在 \author 后方 35 | \emailphone{email@pku.edu.cn}{(86)152XXXXXXXX} 36 | % 如果改用 \email 则仅需要邮箱参数 37 | \affiliation{北京大学物理学院\quad 学号: 20000xxxxx} 38 | % % 可以使用 \zhdate 自动生成中文日期, 如 39 | % \date{\zhdate{2020/12/1}} 40 | % % 也可使用 babel 的 \localedate, 如 41 | % \date{\localedate{2020}{12}{1}} 42 | % % 两者均会输出 `2020 年 12 月 1 日' 43 | % 下面的 \date 的参数是为了自动输出正确版本号, 正式报告请替换为上面的两种 \date 之一 44 | \date{\releasedate} 45 | \begin{abstract} 46 | 此部分为摘要. 47 | 200--300字, 说明用什么方法做了什么事, 由此得到什么结果和结论, 有何意义. 48 | 摘要中不用缩略词, 不用第一人称. 49 | \note{本文档为对 \href{https://github.com/CastleStar14654/PKUMpLtX}{\pkg*{PKUMpLtX}} 的使用示例, 灰色部分为额外针对 \LaTeX{} 模板使用的说明或是一些能提升输出效果的琐碎细节. 50 | 也请注意查看源文档 \file{template.tex} 中的注释.} 51 | \end{abstract} 52 | \keywords{关键词1, 关键词2, 共2--4个} 53 | 54 | \maketitle 55 | 56 | \section{引言} 57 | 58 | 研究论文引言一般包含以下内容: 59 | 所研究领域背景和现状, 60 | 有待研究的问题, 61 | 本研究的物理目的和主要方法. 62 | % 通过空行或者 \par 命令分段. 本行不是空行, 没有分段效果 63 | 引言一定要切合报告正文, 不能漫无目的地介绍背景, 要快速地将读者引导到报告主题上. 64 | 引言篇幅可以在较大范围内变化, 但最长不应超过报告文字篇幅的1/3. 65 | 66 | 引言撰写可以参考实验讲义和资料, 可以概括复述, 但不能抄. 67 | \note{这里是一个对实验教材 \cite{jindaishiyan} 的引用示例.} 68 | \note{注意在 \cs{cite} 命令前后适当添加空格. 69 | 可以连续引用. 70 | 引用标记要出现在标点之前 \cite{GBT7714,pr}. 71 | 引用处理使用 \textsc{Bib\TeX}; 72 | 对于外文期刊, \file{*.bib} 格式的引用数据很容易从出版商获得; 73 | \href{https://scholar.google.com}{Google 学术}和\href{https://xueshu.baidu.com}{百度学术}等文献搜索引擎也提供以\file{*.bib} 格式导出的功能. 74 | 这里是对首次探测到引力波的报道的引用 \cite{PhysRevLett.116.061102}.} 75 | 76 | \section{理论}\label{sec:theory} 77 | 78 | 可选, 概括本实验必须的理论. 79 | 也可以适当地给出必要的公式, 公式应编号. 80 | \note{自然对数的底、虚数单位以及圆周率国标 \cite{GBT3102.11} 和 ISO \cite{ISO80000-2} 都推荐为正体 (虽然国际学界并不怎么实行这点), 本模板提供了 \cs{ii}, \cs{ee}, \cs{jj}, \cs{uppi} 作为简写, 如 81 | \begin{equation}\label{eq:1} 82 | \ee^{\ii\uppi}+1=0. 83 | \end{equation} 84 | 注意公式应作为句子的一部分在末尾给出必要的标点符号. 85 | 上式可以交叉引用为\autoref{eq:1}.} 86 | 87 | \note{此外, 摄氏度和度在2020年初后已可在 \LaTeX{} 中的非数学模式直接打出 \cite{fntguide}, 88 | 比如 \cs{textdegree} (\textdegree) 和 \cs{textcelsius} (\textcelsius, 虽然国际计量局 \cite{si} 和 Unicode 联盟 \cite{unicode} 都更推荐使用 \code{\textbackslash{}textdegree\{\}C} 的写法, 写成 \textdegree{}C). 89 | 再比如, \cs{textmu} (\textmu) 可以给出微米需要的正体词头符号. 90 | 你也可以使用 \pkg{siunitx} 宏包 (参见 \file{README.md}) 来帮助你管理单位格式.} 91 | 92 | \section{实验装置} 93 | 在此部分需要成段介绍实验方法和条件 (不是罗列操作步骤), 交待清楚到别人能重复你的实验结果的程度. 94 | 此外, 还需表明你已尽了最大努力来提高实验精度和结果的可靠性 (简单的不确定度估计可以在此节给出, 复杂一些的可以放到分析讨论部分). 95 | 96 | 首先应给出一个实验装置示意图. 97 | 例如, 如下同学的示意图\autoref{fig:instruments} 非常清晰, 值得借鉴 (各关键部件也可标在图中). 98 | 99 | \begin{figure} 100 | \centering 101 | \includegraphics[width=0.85\linewidth]{fig/instruments.png} 102 | \caption{这个例子展示了如何插入图片以及加说明文字. 103 | \note{推荐使用相对大小插入图片, 比如这里是 0.8 倍当前区域文字宽度 (\cs{linewidth}). 104 | 推荐对实验装置图和数据图使用矢量图插入}} 105 | \label{fig:instruments} 106 | \end{figure} 107 | 108 | \note{这里使用了 \cs{autoref} 命令来自动给出带类型的交叉引用, 注意在命令前后适当使用空格以给出最好的显示效果. 109 | 小节, 表格, 公式等都可如此引用, 如: \autoref{sec:theory}, \autoref{ssec:table}, \autoref{sssec:table}, \autoref{eq:1}, \autoref{tab:table_eg}, \autoref{app:exercise}, \autopageref{tab:table_eg}. 110 | 交叉引用的标签尽量取得有意义.} 111 | 112 | 实验仪器和方法不是像普物实验报告那样将所有实验器材列出, 而是要用介绍功用的方式成段给出. 113 | 实验条件不仅是指直接影响实验结果的实验参量, 而且还包括影响实验质量和可靠性的因素, 如室温、空气湿度、基真空、原材料纯度等. 114 | 115 | \section{结果及讨论} 116 | 117 | 此部分是实验报告的主体, 应占报告篇幅的一半以上. 118 | \note{依自己意愿, 结果与分析部分可以分多个小节, 甚至可以将实验结果和对结果的分析讨论拆分为两节.} 119 | 120 | 实验结果应尽量以图表的形式给出. 每一个图表都应该是完整的, 即阅读图表时可以不必依赖正文. 121 | 以图表为中心叙述实验结果和讨论. 122 | 123 | \subsection{表格}\label{ssec:table} 124 | \subsubsection{表格}\label{sssec:table} 125 | 126 | 127 | 表是被一系列横线隔开的有序排列的数据, 报告格式要求最上和最下两条横线为双横线. 128 | \note{此双横线格式可以通过 \env{ruledtabular} 环境和 \cs{colrule} 命令实现.} 129 | 例表为\autoref{tab:table_eg}. 130 | 131 | \begin{table} 132 | \caption{表格示例% 133 | \footnote{表格标题要简明扼要; 注意使用 \pkg[revtex]{revtex4-2} 提供的 \env{ruledtabular} 环境生成首尾双横线的表格. 134 | 表格中的脚注会自动加在表尾. 135 | 为方便, 提供了 \cs{mc} 作为 \cs{multicolumn} 的简写. 136 | \href{https://www.tablesgenerator.com}{Tables Generator 网站}可以方便地生成 \LaTeX 表格.}} 137 | \label{tab:table_eg} 138 | \begin{ruledtabular}% ruledtabular 环境自动生成首尾双横线, 并调整宽度至占满全行 139 | \begin{tabular}{cd{4.2}lr} 140 | % d{a.b} 能使该列中的数据按小数点对齐, 前方留 a 个字符, 后方留 b 个字符 141 | % 已将 multicolumn 简写为 mc 142 | 居中 & \mc{1}{c}{数值 % 143 | \footnote{``数值'' 列使用了 \code{d} 列格式来按小数点位置对齐. 144 | 记得将 \code{d} 列的列标题单独设为居中. 145 | \pkg{siunitx} 提供了更为复杂的小数点对齐功能, 请参考其文档.} 146 | } & 靠左 & 靠右 \\ 147 | \colrule% 中间横线 148 | a & 0.12 & a & a \\ 149 | bbb & -100 & bbb & bbb \\ 150 | ccccc & 50.8 & ccccc & ccccc 151 | \end{tabular} 152 | \end{ruledtabular} 153 | \end{table} 154 | 155 | 从\autoref{tab:table_eg} 可以看出, 对表中各项的注释应作为表的一部分放在表后, 而不是页脚或文尾. 156 | \note{在表格中使用 \cs{footnote} 命令时 \LaTeX 会自动将注释放在表尾. 157 | 但正文中的注释按照 AIP 的要求 (以及 \pkg[revtex]{revtex4-2} 的实现) 是会和各引用项共同编号并作为参考文献列表的一部分的. 158 | 因此, 只要你在正文使用了 \cs{footnote}, 即使你没有引用任何文献 (这一般不太可能), 也需要用 B\textsc{ib}\TeX 处理. 159 | 这里是一个尾注的例子 \footnote{这里是一个尾注的例子}.} 160 | 161 | 当原始数据和处理过的数据常需要出现在同一表中时, 用软件来处理会非常方便. 162 | 但出现在实验报告中的表应具有上面给出的例子的格式. 163 | 164 | \subsection{数据图} 165 | 166 | \textbf{每个图应尽量让读者不看正文就能基本理解图的含意.} 167 | 应包含: 图名、轴名、轴、刻度、标尺、数据点、曲线、图例、标注和图注等部分. 168 | 最常用的作图软件有 Origin 或 MATLAB. 169 | 学习使用基本的数据处理和作图工具软件也是课程的基本内容. 170 | 课程也鼓励大家使用 Python 语言编程作图. 171 | 逐点测量得到的函数关系要同时用表格和图给出. 172 | \note{数据点过多可以将数据放到附录. 173 | 这里 ``逐点测量得到的函数关系'' 还是要自己把握一下, 像那种几千个数据点的能谱当然就没必要放原始数据表了.} 174 | \textbf{需要作比较的多条曲线要画在同一图上.} 175 | 为避免读者在图表和正文间反复跳跃阅读, 正文叙述应紧邻图表, 正文中也要对图表作必要的说明. 176 | 177 | \begin{figure} 178 | \centering 179 | \includegraphics[width=0.8\textwidth]{fig/figsample.pdf} 180 | \caption{这是数据图的例子. 181 | \note{在图的 \cs{caption} 中应简要说明图中表达的内容, 并对各种符号、线型、颜色的意义做出说明. 182 | 如果有多格数据图, 应清晰地分别做出解释说明. 183 | 图中的关键性文字 (比如轴名和图例) 的大小最好能和说明文字中的文字大小相当. 184 | 关于坐标轴名和单位的标法, 可以参看\href{https://journals.aps.org/authors/axis-labels-and-scales-on-graphs-h18}{美国物理学会的说明}. 185 | 本图是用脚本 \file{figgen.py} 生成的}} 186 | \label{fig:data} 187 | \end{figure} 188 | 189 | \autoref{fig:data} 是一张例图. 190 | 191 | \subsection{对分析的要求} 192 | 193 | 对于预料之外的实验结果, 必须首先小心证明其可靠性. 194 | 读者只有在相信你的实验结果时才愿意花时间看你的分析. 195 | 196 | \textbf{必须用文字归纳整理出正式的实验结果或结论.} 197 | 可信的实验结果是课程报告最重要的内容. 198 | 作为一个实验物理工作者, 分析解释出错并不丢脸, 实验结果不被采信则是致命的. 199 | 教学实验的结论往往是预先知道的. 200 | 所以, 教师更关心的是你的说理过程. 201 | 一般说来, 单由课内实验的结果不足以能得到明确的结论. 202 | 此时, 你可以引用他人的研究结果来帮助帮助自己的论证, 但必须注明出处. 203 | 确实不能得到明确结论时, 可以给出几种可能结论并指出可以再做哪些实验来帮助作进一步的判断. 204 | 总之, 分析讨论部分要做到: 论据要valid, 论证要reasonable, 结论要convincing. 205 | 206 | \section{结论} 207 | \textbf{文字写一段.} 208 | 首先要给出实验结果, 然后再给出由实验结果分析得到的结果和结论． 209 | 此部分给出的内容要比摘要中的全面, 用词要更准确． 210 | 211 | \begin{acknowledgments} 212 | 感谢对实验和报告有具体重要帮助的, 又没被列为作者的人. 213 | \note{撰写致谢时请使用 \env{acknowledgments} 环境.} 214 | \end{acknowledgments} 215 | 216 | % bibliography 的参数是你的 *.bib 文件去掉后缀名后的部分 217 | \bibliography{bibli} 218 | 219 | \clearpage % 附录前另起一页 220 | \appendix % 附录开始 221 | \section{思考题}\label{app:exercise} 222 | \subsection{可以把每道思考题的题目分别作为小标题} 223 | 然后书写解答. 224 | 225 | \section{近代物理实验报告写作要求} 226 | 227 | 物理实验的结果最终需要以论文或报告的形式向同行或公众报道. 228 | 外界也主要基于这些论文或报告来评价一个实验物理工作者. 229 | 所以, 课程实验报告的撰写是北大 ``近代物理实验'' 课的一个重要内容和主要的评分依据. 230 | 231 | 北大近代物理实验课要求按研究论文的形式来撰写课程实验报告. 232 | 和任何期刊一样, 近代物理实验课对学生提交的课程实验报告也有内容和格式上的要求. 233 | 学生应依照课程提供的课程实验报告模板来撰写自己的实验报告. 234 | 235 | 课程提供的课程实验报告模板综合了 American Institute of Physics (AIP) 期刊和中国《物理学报》对稿件格式的要求. 236 | 237 | 本实验报告模板各部分的文字给出了相应节写作时应注意的问题. 238 | 239 | \subsection*{报告写作的一般事项} 240 | 241 | \begin{enumerate} 242 | \item 课程实验报告应假定读者既不是已知全部实验细节的指导教师, 也不是缺少专业知识的公众, 而是同领域的实验研究者, 或审稿人. 243 | 不能要求读者要在读过课程讲义后才能读懂课程实验报告. 244 | \item 文本和物理量单位用正体, 物理变量符号用斜体, 矢量矩阵符号用黑斜体. 245 | \note{(\pkg{physics} 宏包提供了大量的方便的物理中常用符号的排版工具, 请参考其文档使用)} 246 | \item 使用国际标准的缩略词, 符号和法定计量单位时应全文一致, 正文中的缩略 247 | 词在\textbf{首次出现时写出全称}, 后附缩略词, 并用括号括起; 之后直接用缩略词, 不 248 | 再写全称, 如 American Institute of Physics (AIP). 249 | \item 全文标点符号除 ``顿号'' 外, 其他用英文半角标点符号. 250 | \note{(推荐的格式中, 英文单词和数字应与汉字之间插入一个空格; 251 | 半角标点符号应如英文一般, 在逗号, 句号, 分号等后方插入一个空格; 252 | 在引号, 括号外侧各插入一个空格; 253 | 连续出现的标点符号之间的多余空格则应删除. 254 | 但是, \pkg{xeCJK} 宏包基本上自动为你在最终的 PDF 文稿中完成了这些事情. 255 | 此外, 如果你觉得半角符号配中文太丑, 请参见 \file{README.md} 中介绍的标点选项)} 256 | \item 公式、图和表要分别用阿拉伯数字编列序号. \note{(这点 \LaTeX 可以为你代劳)} 257 | 公式和图表要达到可发表的质量. 258 | \item 凡不是自己独立思考得到的内容都应该引参考文献. 259 | 不能大段引用同一参考文献. 260 | 对复杂问题, 应该优先考虑引用参考文献得到结果. 261 | 对简单一些的问题才鼓励独立思考. 262 | 只能引用正式出版物, 不能引用他人实验报告. 263 | \item 模板中的未尽事项可以参考 AIP Style Manual 4th-edition (可从课程网站下载). 264 | \note{(也可参考 \pkg[revtex]{revtex4-2} 的文档)} 265 | \item 较长的推导和说明可以作为附件提交, 不占用报告篇幅. 266 | \item 思考题不是报告的组成部分. 267 | 应另起一页附在报告的最后. \note{(比如作为附录)} 268 | \end{enumerate} 269 | 270 | \section{对 \LaTeX{} 中标点输入的额外说明} 271 | \LaTeX 中对 dash 有所区分, 272 | \begin{center} 273 | \begin{tabular}{c@{\quad}c@{\ $\rightarrow$\ }c} 274 | 连字符 hyphen & \verb|co-operate| & co-operate \\ 275 | 连接号 en-dash & \verb|14--19| & 14--19 \\ 276 | 英文破折号 em-dash & \verb|Yes---or no?| & Yes---or no? \\ 277 | 减号 & \verb|$-1$| & $-1$ \\ 278 | \end{tabular} 279 | \end{center} 280 | 中文破折号 (——) 就按一般习惯的用输入法输入即可. 281 | \note{其实中文破折号就是两个连着的 em-dash, 但两种输入方式使他们输出字体不同.} 282 | 283 | \LaTeX 中半角引号使用如下映射进行输入. 284 | 左引号的符号为 \textsf{Esc} 键下方的锐音符. 285 | \begin{center} 286 | \begin{tabular}{c@{\quad}c@{\ $\rightarrow$\ }c@{\quad}c@{\ $\rightarrow$\ }c} 287 | 单引号 & \verb|`| & ` & \verb|'| & ' \\ 288 | 双引号 & \verb|``| & `` & \verb|''| & '' \\ 289 | 美式连续嵌套引号 & \verb|```| & ``` & \verb|'{}''| & '{}'' \\ 290 | 英式连续嵌套引号 & \verb|`{}``| & `{}`` & \verb|'''| & ''' \\ 291 | \end{tabular} 292 | \end{center} 293 | 注意其中 \code{\{\}} 起到的分组作用. 294 | 295 | 此外, 如果想使用全角符号同时想使用实心点格式的句号, 可以使用 \code{quanjiao} 选项. 296 | 源文档中的 ``。'' 会被自动替换成 ``．''. 297 | 这时, 也就可以风格统一地直接使用中文输入法给出的引号 ``“”‘’'' 而不用管前面提到的映射了. 298 | 具体请参见 \file{README.md} 中介绍的标点选项. 299 | 300 | \note{其实“和``以及”和''分别是同一个 Unicode 字符, 只是被分配了不同的字体.} 301 | 302 | \section{DIY 字体效果测试} 303 | 304 | \newcommand{\testword}{报告} 305 | \newcommand{\andbold}{\testword{}\textbf{\testword{}}} 306 | \newcommand{\testline}{\testword{}\emph{\andbold{}}\andbold{}} 307 | 308 | 下面分别展示衬线, 无衬线和等宽中文字体效果, 便于检查基线高度等问题. 309 | \begin{center} 310 | \textrm{\testline}\\ 311 | \textsf{\testline}\\ 312 | \texttt{\testline} 313 | \end{center} 314 | 315 | \end{document} 316 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Attribution-ShareAlike 4.0 International 2 | 3 | ======================================================================= 4 | 5 | Creative Commons Corporation ("Creative Commons") is not a law firm and 6 | does not provide legal services or legal advice. Distribution of 7 | Creative Commons public licenses does not create a lawyer-client or 8 | other relationship. Creative Commons makes its licenses and related 9 | information available on an "as-is" basis. Creative Commons gives no 10 | warranties regarding its licenses, any material licensed under their 11 | terms and conditions, or any related information. Creative Commons 12 | disclaims all liability for damages resulting from their use to the 13 | fullest extent possible. 14 | 15 | Using Creative Commons Public Licenses 16 | 17 | Creative Commons public licenses provide a standard set of terms and 18 | conditions that creators and other rights holders may use to share 19 | original works of authorship and other material subject to copyright 20 | and certain other rights specified in the public license below. The 21 | following considerations are for informational purposes only, are not 22 | exhaustive, and do not form part of our licenses. 23 | 24 | Considerations for licensors: Our public licenses are 25 | intended for use by those authorized to give the public 26 | permission to use material in ways otherwise restricted by 27 | copyright and certain other rights. Our licenses are 28 | irrevocable. Licensors should read and understand the terms 29 | and conditions of the license they choose before applying it. 30 | Licensors should also secure all rights necessary before 31 | applying our licenses so that the public can reuse the 32 | material as expected. Licensors should clearly mark any 33 | material not subject to the license. This includes other CC- 34 | licensed material, or material used under an exception or 35 | limitation to copyright. More considerations for licensors: 36 | wiki.creativecommons.org/Considerations_for_licensors 37 | 38 | Considerations for the public: By using one of our public 39 | licenses, a licensor grants the public permission to use the 40 | licensed material under specified terms and conditions. If 41 | the licensor's permission is not necessary for any reason--for 42 | example, because of any applicable exception or limitation to 43 | copyright--then that use is not regulated by the license. Our 44 | licenses grant only permissions under copyright and certain 45 | other rights that a licensor has authority to grant. Use of 46 | the licensed material may still be restricted for other 47 | reasons, including because others have copyright or other 48 | rights in the material. A licensor may make special requests, 49 | such as asking that all changes be marked or described. 50 | Although not required by our licenses, you are encouraged to 51 | respect those requests where reasonable. More considerations 52 | for the public: 53 | wiki.creativecommons.org/Considerations_for_licensees 54 | 55 | ======================================================================= 56 | 57 | Creative Commons Attribution-ShareAlike 4.0 International Public 58 | License 59 | 60 | By exercising the Licensed Rights (defined below), You accept and agree 61 | to be bound by the terms and conditions of this Creative Commons 62 | Attribution-ShareAlike 4.0 International Public License ("Public 63 | License"). To the extent this Public License may be interpreted as a 64 | contract, You are granted the Licensed Rights in consideration of Your 65 | acceptance of these terms and conditions, and the Licensor grants You 66 | such rights in consideration of benefits the Licensor receives from 67 | making the Licensed Material available under these terms and 68 | conditions. 69 | 70 | 71 | Section 1 -- Definitions. 72 | 73 | a. Adapted Material means material subject to Copyright and Similar 74 | Rights that is derived from or based upon the Licensed Material 75 | and in which the Licensed Material is translated, altered, 76 | arranged, transformed, or otherwise modified in a manner requiring 77 | permission under the Copyright and Similar Rights held by the 78 | Licensor. For purposes of this Public License, where the Licensed 79 | Material is a musical work, performance, or sound recording, 80 | Adapted Material is always produced where the Licensed Material is 81 | synched in timed relation with a moving image. 82 | 83 | b. Adapter's License means the license You apply to Your Copyright 84 | and Similar Rights in Your contributions to Adapted Material in 85 | accordance with the terms and conditions of this Public License. 86 | 87 | c. BY-SA Compatible License means a license listed at 88 | creativecommons.org/compatiblelicenses, approved by Creative 89 | Commons as essentially the equivalent of this Public License. 90 | 91 | d. Copyright and Similar Rights means copyright and/or similar rights 92 | closely related to copyright including, without limitation, 93 | performance, broadcast, sound recording, and Sui Generis Database 94 | Rights, without regard to how the rights are labeled or 95 | categorized. For purposes of this Public License, the rights 96 | specified in Section 2(b)(1)-(2) are not Copyright and Similar 97 | Rights. 98 | 99 | e. Effective Technological Measures means those measures that, in the 100 | absence of proper authority, may not be circumvented under laws 101 | fulfilling obligations under Article 11 of the WIPO Copyright 102 | Treaty adopted on December 20, 1996, and/or similar international 103 | agreements. 104 | 105 | f. Exceptions and Limitations means fair use, fair dealing, and/or 106 | any other exception or limitation to Copyright and Similar Rights 107 | that applies to Your use of the Licensed Material. 108 | 109 | g. License Elements means the license attributes listed in the name 110 | of a Creative Commons Public License. The License Elements of this 111 | Public License are Attribution and ShareAlike. 112 | 113 | h. Licensed Material means the artistic or literary work, database, 114 | or other material to which the Licensor applied this Public 115 | License. 116 | 117 | i. Licensed Rights means the rights granted to You subject to the 118 | terms and conditions of this Public License, which are limited to 119 | all Copyright and Similar Rights that apply to Your use of the 120 | Licensed Material and that the Licensor has authority to license. 121 | 122 | j. Licensor means the individual(s) or entity(ies) granting rights 123 | under this Public License. 124 | 125 | k. Share means to provide material to the public by any means or 126 | process that requires permission under the Licensed Rights, such 127 | as reproduction, public display, public performance, distribution, 128 | dissemination, communication, or importation, and to make material 129 | available to the public including in ways that members of the 130 | public may access the material from a place and at a time 131 | individually chosen by them. 132 | 133 | l. Sui Generis Database Rights means rights other than copyright 134 | resulting from Directive 96/9/EC of the European Parliament and of 135 | the Council of 11 March 1996 on the legal protection of databases, 136 | as amended and/or succeeded, as well as other essentially 137 | equivalent rights anywhere in the world. 138 | 139 | m. You means the individual or entity exercising the Licensed Rights 140 | under this Public License. Your has a corresponding meaning. 141 | 142 | 143 | Section 2 -- Scope. 144 | 145 | a. License grant. 146 | 147 | 1. Subject to the terms and conditions of this Public License, 148 | the Licensor hereby grants You a worldwide, royalty-free, 149 | non-sublicensable, non-exclusive, irrevocable license to 150 | exercise the Licensed Rights in the Licensed Material to: 151 | 152 | a. reproduce and Share the Licensed Material, in whole or 153 | in part; and 154 | 155 | b. produce, reproduce, and Share Adapted Material. 156 | 157 | 2. Exceptions and Limitations. For the avoidance of doubt, where 158 | Exceptions and Limitations apply to Your use, this Public 159 | License does not apply, and You do not need to comply with 160 | its terms and conditions. 161 | 162 | 3. Term. The term of this Public License is specified in Section 163 | 6(a). 164 | 165 | 4. Media and formats; technical modifications allowed. The 166 | Licensor authorizes You to exercise the Licensed Rights in 167 | all media and formats whether now known or hereafter created, 168 | and to make technical modifications necessary to do so. The 169 | Licensor waives and/or agrees not to assert any right or 170 | authority to forbid You from making technical modifications 171 | necessary to exercise the Licensed Rights, including 172 | technical modifications necessary to circumvent Effective 173 | Technological Measures. For purposes of this Public License, 174 | simply making modifications authorized by this Section 2(a) 175 | (4) never produces Adapted Material. 176 | 177 | 5. Downstream recipients. 178 | 179 | a. Offer from the Licensor -- Licensed Material. Every 180 | recipient of the Licensed Material automatically 181 | receives an offer from the Licensor to exercise the 182 | Licensed Rights under the terms and conditions of this 183 | Public License. 184 | 185 | b. Additional offer from the Licensor -- Adapted Material. 186 | Every recipient of Adapted Material from You 187 | automatically receives an offer from the Licensor to 188 | exercise the Licensed Rights in the Adapted Material 189 | under the conditions of the Adapter's License You apply. 190 | 191 | c. No downstream restrictions. You may not offer or impose 192 | any additional or different terms or conditions on, or 193 | apply any Effective Technological Measures to, the 194 | Licensed Material if doing so restricts exercise of the 195 | Licensed Rights by any recipient of the Licensed 196 | Material. 197 | 198 | 6. No endorsement. Nothing in this Public License constitutes or 199 | may be construed as permission to assert or imply that You 200 | are, or that Your use of the Licensed Material is, connected 201 | with, or sponsored, endorsed, or granted official status by, 202 | the Licensor or others designated to receive attribution as 203 | provided in Section 3(a)(1)(A)(i). 204 | 205 | b. Other rights. 206 | 207 | 1. Moral rights, such as the right of integrity, are not 208 | licensed under this Public License, nor are publicity, 209 | privacy, and/or other similar personality rights; however, to 210 | the extent possible, the Licensor waives and/or agrees not to 211 | assert any such rights held by the Licensor to the limited 212 | extent necessary to allow You to exercise the Licensed 213 | Rights, but not otherwise. 214 | 215 | 2. Patent and trademark rights are not licensed under this 216 | Public License. 217 | 218 | 3. To the extent possible, the Licensor waives any right to 219 | collect royalties from You for the exercise of the Licensed 220 | Rights, whether directly or through a collecting society 221 | under any voluntary or waivable statutory or compulsory 222 | licensing scheme. In all other cases the Licensor expressly 223 | reserves any right to collect such royalties. 224 | 225 | 226 | Section 3 -- License Conditions. 227 | 228 | Your exercise of the Licensed Rights is expressly made subject to the 229 | following conditions. 230 | 231 | a. Attribution. 232 | 233 | 1. If You Share the Licensed Material (including in modified 234 | form), You must: 235 | 236 | a. retain the following if it is supplied by the Licensor 237 | with the Licensed Material: 238 | 239 | i. identification of the creator(s) of the Licensed 240 | Material and any others designated to receive 241 | attribution, in any reasonable manner requested by 242 | the Licensor (including by pseudonym if 243 | designated); 244 | 245 | ii. a copyright notice; 246 | 247 | iii. a notice that refers to this Public License; 248 | 249 | iv. a notice that refers to the disclaimer of 250 | warranties; 251 | 252 | v. a URI or hyperlink to the Licensed Material to the 253 | extent reasonably practicable; 254 | 255 | b. indicate if You modified the Licensed Material and 256 | retain an indication of any previous modifications; and 257 | 258 | c. indicate the Licensed Material is licensed under this 259 | Public License, and include the text of, or the URI or 260 | hyperlink to, this Public License. 261 | 262 | 2. You may satisfy the conditions in Section 3(a)(1) in any 263 | reasonable manner based on the medium, means, and context in 264 | which You Share the Licensed Material. For example, it may be 265 | reasonable to satisfy the conditions by providing a URI or 266 | hyperlink to a resource that includes the required 267 | information. 268 | 269 | 3. If requested by the Licensor, You must remove any of the 270 | information required by Section 3(a)(1)(A) to the extent 271 | reasonably practicable. 272 | 273 | b. ShareAlike. 274 | 275 | In addition to the conditions in Section 3(a), if You Share 276 | Adapted Material You produce, the following conditions also apply. 277 | 278 | 1. The Adapter's License You apply must be a Creative Commons 279 | license with the same License Elements, this version or 280 | later, or a BY-SA Compatible License. 281 | 282 | 2. You must include the text of, or the URI or hyperlink to, the 283 | Adapter's License You apply. You may satisfy this condition 284 | in any reasonable manner based on the medium, means, and 285 | context in which You Share Adapted Material. 286 | 287 | 3. You may not offer or impose any additional or different terms 288 | or conditions on, or apply any Effective Technological 289 | Measures to, Adapted Material that restrict exercise of the 290 | rights granted under the Adapter's License You apply. 291 | 292 | 293 | Section 4 -- Sui Generis Database Rights. 294 | 295 | Where the Licensed Rights include Sui Generis Database Rights that 296 | apply to Your use of the Licensed Material: 297 | 298 | a. for the avoidance of doubt, Section 2(a)(1) grants You the right 299 | to extract, reuse, reproduce, and Share all or a substantial 300 | portion of the contents of the database; 301 | 302 | b. if You include all or a substantial portion of the database 303 | contents in a database in which You have Sui Generis Database 304 | Rights, then the database in which You have Sui Generis Database 305 | Rights (but not its individual contents) is Adapted Material, 306 | including for purposes of Section 3(b); and 307 | 308 | c. You must comply with the conditions in Section 3(a) if You Share 309 | all or a substantial portion of the contents of the database. 310 | 311 | For the avoidance of doubt, this Section 4 supplements and does not 312 | replace Your obligations under this Public License where the Licensed 313 | Rights include other Copyright and Similar Rights. 314 | 315 | 316 | Section 5 -- Disclaimer of Warranties and Limitation of Liability. 317 | 318 | a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE 319 | EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS 320 | AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF 321 | ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, 322 | IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, 323 | WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR 324 | PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, 325 | ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT 326 | KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT 327 | ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. 328 | 329 | b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE 330 | TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, 331 | NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, 332 | INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, 333 | COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR 334 | USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN 335 | ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR 336 | DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR 337 | IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. 338 | 339 | c. The disclaimer of warranties and limitation of liability provided 340 | above shall be interpreted in a manner that, to the extent 341 | possible, most closely approximates an absolute disclaimer and 342 | waiver of all liability. 343 | 344 | 345 | Section 6 -- Term and Termination. 346 | 347 | a. This Public License applies for the term of the Copyright and 348 | Similar Rights licensed here. However, if You fail to comply with 349 | this Public License, then Your rights under this Public License 350 | terminate automatically. 351 | 352 | b. Where Your right to use the Licensed Material has terminated under 353 | Section 6(a), it reinstates: 354 | 355 | 1. automatically as of the date the violation is cured, provided 356 | it is cured within 30 days of Your discovery of the 357 | violation; or 358 | 359 | 2. upon express reinstatement by the Licensor. 360 | 361 | For the avoidance of doubt, this Section 6(b) does not affect any 362 | right the Licensor may have to seek remedies for Your violations 363 | of this Public License. 364 | 365 | c. For the avoidance of doubt, the Licensor may also offer the 366 | Licensed Material under separate terms or conditions or stop 367 | distributing the Licensed Material at any time; however, doing so 368 | will not terminate this Public License. 369 | 370 | d. Sections 1, 5, 6, 7, and 8 survive termination of this Public 371 | License. 372 | 373 | 374 | Section 7 -- Other Terms and Conditions. 375 | 376 | a. The Licensor shall not be bound by any additional or different 377 | terms or conditions communicated by You unless expressly agreed. 378 | 379 | b. Any arrangements, understandings, or agreements regarding the 380 | Licensed Material not stated herein are separate from and 381 | independent of the terms and conditions of this Public License. 382 | 383 | 384 | Section 8 -- Interpretation. 385 | 386 | a. For the avoidance of doubt, this Public License does not, and 387 | shall not be interpreted to, reduce, limit, restrict, or impose 388 | conditions on any use of the Licensed Material that could lawfully 389 | be made without permission under this Public License. 390 | 391 | b. To the extent possible, if any provision of this Public License is 392 | deemed unenforceable, it shall be automatically reformed to the 393 | minimum extent necessary to make it enforceable. If the provision 394 | cannot be reformed, it shall be severed from this Public License 395 | without affecting the enforceability of the remaining terms and 396 | conditions. 397 | 398 | c. No term or condition of this Public License will be waived and no 399 | failure to comply consented to unless expressly agreed to by the 400 | Licensor. 401 | 402 | d. Nothing in this Public License constitutes or may be interpreted 403 | as a limitation upon, or waiver of, any privileges and immunities 404 | that apply to the Licensor or You, including from the legal 405 | processes of any jurisdiction or authority. 406 | 407 | 408 | ======================================================================= 409 | 410 | Creative Commons is not a party to its public licenses. 411 | Notwithstanding, Creative Commons may elect to apply one of its public 412 | licenses to material it publishes and in those instances will be 413 | considered the “Licensor.” The text of the Creative Commons public 414 | licenses is dedicated to the public domain under the CC0 Public Domain 415 | Dedication. Except for the limited purpose of indicating that material 416 | is shared under a Creative Commons public license or as otherwise 417 | permitted by the Creative Commons policies published at 418 | creativecommons.org/policies, Creative Commons does not authorize the 419 | use of the trademark "Creative Commons" or any other trademark or logo 420 | of Creative Commons without its prior written consent including, 421 | without limitation, in connection with any unauthorized modifications 422 | to any of its public licenses or any other arrangements, 423 | understandings, or agreements concerning use of licensed material. For 424 | the avoidance of doubt, this paragraph does not form part of the public 425 | licenses. 426 | 427 | Creative Commons may be contacted at creativecommons.org. 428 | --------------------------------------------------------------------------------