小时百科文章示例

                     

贡献者: addis; Giacomo; kahoyip; JierPeter; 零穹; _Eden_; Bohao Jiang; Siegfried

  • 用 issues 环境列出文章存在的所有问题。
  • 本文处于草稿阶段。
  • 本文存在未完成的内容。
  • 本文缺少预备知识,初学者可能会遇到困难。
  • 本文需要更多讲解,便于帮助理解。
  • 本文需要更多参考文献。
  • 本文含人工智能辅助创作,已审核。
  • 本文含人工智能辅助创作,待审核。
预备知识 二项式定理,LaTeX 结构简介,原子单位的第二个节点(自动跳到预备知识 2),原子单位的默认节点(依赖整篇文章,相当于依赖最后一个节点)原子单位第一个节点(变灰是因为是多余的,多余是因为原子单位第二个节点默认依赖第一个节点)

   本文需要与 LaTeX 源码对照阅读,请使用在线编辑器打开 Sample.tex

1. 文章信息

   文件开头可以用注释声明一些文章信息,但这些信息只能用 “修改文章信息” 按钮修改

2. 存在的问题

   接下来可以用 issue 环境列出当前所有存在的问题。支持的所有类型已在上方列出。

3. 预备知识

4. 蓝色的子节标题

   可以通过内部或外部引用按钮引用,如子节 4 。引用其他文章的子节如子节 1 ,注意后面会自动添加一个图标表示是其他文章的链接。

   任何 \autoref{标签}(无论本文还是其他文章)都支持对应的 \aref{链接文字}{标签},如这个子节,和那个子节

未完成:计划:所有标签(\label{标签})的引用,无论标签类型是什么(文章,公式,图片等),应该都支持三个命令:

  • \upref{标签} 显示为书签图标
  • \aref{任意文字}{标签}任意文字加链接到 标签 定义处。
  • \autoref{标签} 自动生成文字加链接,如式 1 (本文)或式 1 (其他文章)。

   在 pdf 中,需要考虑打印会使链接失效,所以变为以下效果:

  • \upref{标签} 变为一个脚注如 “见 103 页《向量空间》定义 2。”
  • \aref{任意文字}{标签} 相当于给 任意文字 加下划线然后使用 \upref{标签}
  • \autoref{标签} 显示效果如 式 1(本文)或 式 1 $^{\color{green}\small[103]}$(其他文章)

   其他命令合并到这三个之中:\enref 并入 \aref\nref 并入 \upref

   一个细节问题:\autoref 这个命令有点长而且经常使用,是否要改成 \tref。同理 \upref 也可以改成 \uref

黑色的子子节标题

   目前子子节标题无法引用。

5. 正文

   正文必须使用中文的括号,逗号,引号,冒号,分号,问号,感叹号,以及空心句号1,禁止使用英文标点。但为了打字方便,行间公式最后仍允许英文逗号和句号(例如 ~,~.),且逗号后面需要有足够的空白(\quad 或者 \qquad),例如

\begin{equation} a + b = c~, \quad d + e = f~. \end{equation}
正文中空行代表分段,所以不要为了代码好看在公式前后习惯性加上一个空行。另外行间公式同样属于句子的一部分,需要在中间和末尾加上适当的标点符号,否则会提示错误。如果根据语法,的确不需要加标点,可以在 \end{equation}(或者结束的 $$\])之前加一个 ~ 防止报错。禁止批量对所有公式加 ~。公式中标点的用法参考本文。

   像 “牛顿—莱布尼兹公式” 中的横线必须用中文单破折号。所有的标点符号前面不能有空格,后面尽量有空格。正文粗体如粗体。正文中禁止使用 \\ 换行,以及 \noindent\phantom 等命令强制修改格式。

   如果把 \footnote 加在一个名词或者短语后面,意思是对它们做注释。如果放在一个句号后面,就是对整句话做注释。

   正文的任何地方可以用 \addTODO{} 命令插入未完成提示。

未完成:在这里提示未完成的内容,如果不希望公开,注释掉即可,但仍然需要 \addTODO 命令

6. 引用

   引用公式和图表都统一使用 \autoref{标签} 命令,\autoref\label{标签} 都无需手动插入,可以用菜单栏中的 “内部引用” 和 “外部引用” 按钮(实心和空心的双引号图标)。注意 \autoref{} 前面不加空格后面要加空格(后面是标点符号除外),例如式 2 。如果要引用其他文章中的公式,可以引用 “其他文章” 的式 1 也可以用 “式 1 ”,为了区分内部和外部引用,\upref 不能忽略。在 pdf 上,\upref{} 会显示为页码。

   一个升级版的 \upref{文章id} 命令是 \enref{文字}{文章id},可以把 文字 直接链接到文章。例如一篇测试。新内容建议使用后者。

   行间公式的 label(标签)必须要按照 eq_公式id 的格式,只有需要引用的公式才加标签。图、表的标签分别以 fig_tab_ 开头,例题用 ex_,习题用 exe_,子节用 sub_。凡是有 \caption 命令的环境(图、表),\label 需要紧接其后。事实上标签不建议手动添加,可以用菜单栏上的 “内部引用” 和 “外部引用” 按钮在引用时同时自动插入 \label\autoref,详见编辑器使用说明

7. 公式

   行内公式用 $...$ 或者 \(...\),两边需要有空格,例如 $a^2+b^2=c^2$,后面有标点符号的除外。行间公式如

\begin{equation} (a+b)^n = \sum_{i=0}^n C_n^i a^i b^{n-i} \quad (\text{$n$ 为整数})~. \end{equation}

   百科中常用公式的示例(包括支持的宏包和自定义的命令)见小时百科常用 LaTeX 公式

   LaTeX 中各种符号的命令见官方符号对照表(pdf)

   行间公式如果确定以后都不需要被引用,可以用无编号的公式环境 $$...$$ 或者 \[...\]

8. 图表

   位图必须使用 png 格式,矢量图(推荐)必须以 pdf 和 svg 格式2放在 figures 文件夹中。文件名是文章 label 加下划线以及图片序号,如 da8815a7f79f2f52.pdf。即使只有一张图片也要加上 _1。生成 svg 时,字体一律用 outline,更多选项中保留 7 位小数,如果矢量图中包含位图,要把 Image Location 选成 embed。pdf 图片用于 latex 的 figure 环境,svg 图片用于 html 网页。图片宽度一律用 cm 为单位。注意当前图片最大尺寸只能是 14.25cm,对应 33 个汉字。这个比例在 pdf 和 html 中都必须保持一致,否则图中的文字大小可能会不协调。由于 pdf 每行字数只有 33 个,所以 html 中的图片不可能把页面占满。

图
图 1:一二三四五六七八九十一二三四五六七八九十一二三四五六七八九十一二三口口口

   引用图片如图 1 。在 figure 环境中,必须用 \caption{} 指定标题,\label{} 只能放在 caption 的后面,否则编号会出错。由于在 pdf 中图片是浮动的,避免使用 “上图”,“下图” 等词。

   再来看一个表格,如表 1 。注意 \label 同样要放在 \caption 后面。

表1:极限 $ \mathrm{e} $ 数值验证
$x$ ${10^{ - 1}}$ ${10^{ - 2}}$ ${10^{ - 3}}$ ${10^{ - 4}}$ ${10^{ - 5}}$ ${10^{ - 6}}$
$(1 + x)^{1/x}$ 2.59374 2.70481 2.71692 2.71815 2.71827 2.71828

   定义如定义 1

定义 1 名称(可省略)

   定义导数为

\begin{equation} f'(x) = \lim_{h \to 0} \frac{f(x + h) - f(x)}{h}~. \end{equation}

   引理如引理 1

引理 1 名称(可省略)

   三角形内角和为 $\pi$

   定理如定理 1

定理 1 名称(可省略)

   内错角相等

   推论如推论 1

推论 1 名称(可省略)

   1 + 2 = 3

   例子如例 1

例 1 名称(可省略)

   在例子中,我们的字体可以自定义,包括公式的字号会保持与内容一致。

\begin{equation} (a+b)^n = \sum_{i=0}^n C_n^i a^i b^{n-i} \quad (\text{$n$ 为整数})~. \end{equation}

   习题如习题 1

习题 1 名称(可省略)

   已知 $b$ 和 $c$,求 $a^2 + b^2 = c^2$。

9. 代码

   在行内显示代码用 \verb 命令。注意这个命令比较特殊,可以用任何两个相同的符号作为定界符(星号 * 除外),如 \verb?some|code? 会显示为 some|code。注意定界符必须是代码中没有的字符。

   自动高亮的代码块使用 lstlisting 环境(禁止用 \lstinputlisting 从文件输入)

s = 'abc'; % 一些评论
A =
     1     1    -1     1     3
     2     2    -2     1     7
     1     1     0     2     3
     2     2    -1     5     4

% 测试自定义关键字(必须是高亮)
matlabCTestKeyWord;

   如果 lstlisting 标明了文件名(下划线需要用 \_ 转义),代码文件夹中就会自动生成该文件。较长的代码文件必须含文件名,文件名需要反映代码的内容而不是与文章 label 同名。

未完成:未完成:后台处理 lstlisting 的 caption 时不应该在 html 显示空格转义的反斜杠
未完成:未完成:后台是否还不支持 lstlisting 环境的 label 以及引用。

代码 1:sample_code.m
% 验证二项式定理(非整数幂)
u = -3.5;
x = 0.6; % |x|<1 使级数收敛
N = 100; % 求和项数
Coeff = 1; % x^ii 项前面的系数
result = 1; % 求和结果
for ii = 1:N
    Coeff = Coeff*(u-ii+1) / ii;
    result = result + Coeff * x^(ii);
end
disp('直接计算结果为');
format long; % 显示全部小数位
disp((1+x)^u);
disp('求和结果为');
disp(result);
format short; % 恢复默认显示

% 测试自定义关键字(必须是高亮)
matlabTestKeyWord;

% 测试函数颜色(必须是黑色)
tan; cot; asin; acos; atan; arg; real; imag; sum;
mean; diff; floor; ceil; mod; sinh; cosh; round;
tanh; zeros; ones; rand; randn; eye; magic;

   C++ 代码例如

template <class T, class T1, class T2,
MY_IF(is_scalar<T>() && is_scalar<T1>() && is_scalar<T2>())>
void Plus(T &v, const T1 &v1, const T2 &v2)
{ v = v1 + v2; }

   Python 代码例如

def func1():
	return 'hello'

   Mathematica 代码如

(* 定义库仑函数 *)
CoulombF[l_, η_, ρ_] := 2^l E^(-π η/2) \
    Abs[Gamma[l + 1 + I η]]/(2 l + 1)! ρ^(l + 1) E^(-I ρ) \
    Hypergeometric1F1[l + 1 - I η, 2 l + 2, 2 I ρ]

   Julia 代码如

2^l *exp(-π η/2) (2 l + 1)! ρ^(l + 1) E^(-I ρ)

   Makefile 代码如

goal:
    g++ -O3 main.cpp -o main.x

   LaTeX 代码如

\begin{equation}
a^2 + b^2 = c^2
\end{equation}

   Bash 代码如

echo good > 123.txt

   JavaScript 代码如

var a = 3

   其他不支持高亮的代码都可以暂时用 none 语言,并注释实际的语言

abcde = 2^l E^(-π η/2)

10. Unicode 支持

   正文中的 unicode 支持如 mäthμ≥≤,代码中的 unicode 支持如 mathμ≤mäthμ≥≤,以及

mäthμ≥≤

11. 文献引用

   目前整个百科公用一个参考文献列表的文章。文章中引用文献格式如 [1],引用缺失如 “地球是圆的\needCite”。但是由于 PhysWikiScan 还未实现该命令,目前还是应该使用脚注。

未完成:needCite 还不能正常在 html 中显示

   网址的超链接如小时百科。注意 \href 命令中的网址如果存在百分号,需要在前面加反斜杠,否则会被当做注释。另一种方法是,将其解码(url 中的百分号后面两个一定是 hex,表示 utf-8 的一个字节)。这里列举一个在线解码网站

12. 付费内容

   付费内容仅限百科,测试见test.tex。用 \pay\paid 包围付费内容即可,若首行需要分段则要在 \pay 后面空一行。编辑器预览显示会员版本,发布到 online 目录后显示非会员的版本。


1. ^ 《GB_T15834_1995 中华人民共和国国家标准标点符号用法》标准中允许科技文献中使用实心句号,但 GB_T15834_2011 版的新标准规定都用空心。
2. ^ pdf 格式用于 pdf 版的百科,svg 用于网页显示


[1] ^ David Griffiths, Introduction to Electrodynamics, 4ed

                     

© 小时科技 保留一切权利