模板:NumBlk2/doc

此页面是Template:NumBlk2的模板文档。
此页面可能包含了模板的使用说明、分类和其他内容。

此模板是{{NumBlk}}的包装模板（wrapper template）。粗略来说，可将此模板视为{{NumBlk}}与{{EquationRef}}的结合。因此在一般的情况下，此模板可以直接和{{EquationNote}}一起使用，而不需动用到{{EquationRef}}。

此模板提供与{{Visible anchor}}类似的醒目标记——借由指定id属性的方式来使整个{{NumBlk2}}模板成为一个HTML的锚，也就是一个可链接到的目标，当点选到某个{{NumBlk2}}模板右侧显示为编号的自我链接或其他链接到该{{NumBlk2}}模板之链接（例如[[#id|...]]）时，会使得该{{NumBlk2}}模板背景颜色改变而在视觉上将整个模板凸显出来。

参数

参数|1=、|2=和|3=是必须的。另外还有可选参数|Attr=、|RawN=、|Cl=、|LnSty=、|Border=、|Id=、|IdPfx=、|IdSfx=和|Lbl=。

|3=：默认作为决定id属性、标签的依据，参见|IdSfx=与|Lbl=之说明。
|Id=
指定模板的id属性，将|IdPfx=之值与|IdSfx=之值依序串接在一起所得之字符串为此参数的默认值。id属性在HTML文件中必需是唯一的。
|IdPfx=：指定id属性的前缀（prefix），默认值为math_。
|IdSfx=：指定id属性的后缀（suffix），默认值为|3=之值。
|Lbl=：指定标签（label），即模板右侧的自我链接所要显示的内容，默认值为|3=之值。
|Attr=
默认值是一些适当的属性设定以使模板符合此文件之说明，不建议一般的用户对此参数赋值而将默认值覆盖掉。

关于参数|1=、|2=、|RawN=、|Cl=、|LnSty=和|Border=的意义请参见{{NumBlk}}之说明。

示例

本章节会先列出呼叫{{NumBlk}}的示例，接着列出改写为呼叫{{NumBlk2}}的示例，作为互相对照，最后可能再列出链接到前述{{NumBlk}}与{{NumBlk2}}的示例。可以试着点选所列出的链接或模板右侧的编号，以观察通过背景颜色改变凸显模板的效果。

说明：编号部分可能有修改而与来源中的编号不同，以确保id属性都是独一无二的。

示例1

此示例中可以看到以下两种方案之间的对照：

{{NumBlk}} + {{EquationRef}} + {{EquationNote}}
{{NumBlk2}} + {{EquationNote}}

NumBlk

{{NumBlk|:|<math>\Delta{}E = W + Q + E </math>|{{EquationRef|1A}}}}

\Delta {}E=W+Q+E

1A

NumBlk2

{{NumBlk2|:|<math>\Delta{}E = W + Q + E </math>|1B}}

\Delta {}E=W+Q+E

1B

可以看到{{NumBlk2}}呈现出来的结果其右侧的标签是一个显示为编号的自我链接(1B)。

因为|Id=、|IdPfx=与|IdSfx=未赋值，所以皆是默认值。|IdPfx=默认值是math_，|IdSfx=默认值是|3=之值即1B，|Id=默认值是|IdPfx=与|IdSfx=之值的串接即math_1B，所以这里{{NumBlk2}}模板的id属性为math_1B。

链接

可借由{{EquationNote}}或直接以[[#id|...]]的方式链接到模板。

1A
- {{EquationNote|1A}}得到1A。
- {{EquationNote|1A|式1A}}得到式1A。
- [[#math_1A]]得到#math_1A。
- [[#math_1A|1A]]得到1A。
- [[#math_1A|式1A]]得到式1A。
1B
- {{EquationNote|1B}}得到1B。
- {{EquationNote|1B|式1B}}得到式1B。
- [[#math_1B]]得到#math_1B。
- [[#math_1B|1B]]得到1B。
- [[#math_1B|式1B]]得到式1B。

示例2

NumBlk

{{NumBlk|:|<math>
\begin{array}{rcl}
x_1 \left( s = 0 \right) &=& h_1 \left( t_1, t_2, \ldots, t_{N - 1} \right)\\
x_2 \left( s = 0 \right) &=& h_2 \left( t_1, t_2, \ldots, t_{N - 1} \right)\\
\vdots \\
u \left( s = 0 \right) &=& v \left( t_1, t_2, \ldots, t_{N - 1} \right)
\end{array}
</math>|{{EquationRef|2A}}}}

{\begin{array}{rcl}x_{1}\left(s=0\right)&=&h_{1}\left(t_{1},t_{2},\ldots ,t_{N-1}\right)\\x_{2}\left(s=0\right)&=&h_{2}\left(t_{1},t_{2},\ldots ,t_{N-1}\right)\\\vdots \\u\left(s=0\right)&=&v\left(t_{1},t_{2},\ldots ,t_{N-1}\right)\end{array}}

2A

NumBlk2

{{NumBlk2|:|<math>
\begin{array}{rcl}
x_1 \left( s = 0 \right) &=& h_1 \left( t_1, t_2, \ldots, t_{N - 1} \right)\\
x_2 \left( s = 0 \right) &=& h_2 \left( t_1, t_2, \ldots, t_{N - 1} \right)\\
\vdots \\
u \left( s = 0 \right) &=& v \left( t_1, t_2, \ldots, t_{N - 1} \right)
\end{array}
</math>|2B}}

{\begin{array}{rcl}x_{1}\left(s=0\right)&=&h_{1}\left(t_{1},t_{2},\ldots ,t_{N-1}\right)\\x_{2}\left(s=0\right)&=&h_{2}\left(t_{1},t_{2},\ldots ,t_{N-1}\right)\\\vdots \\u\left(s=0\right)&=&v\left(t_{1},t_{2},\ldots ,t_{N-1}\right)\end{array}}

2B

链接

{{EquationNote|2A}}得到2A。
{{EquationNote|2B}}得到2B。

示例3

NumBlk

{{NumBlk|:|<math>F_\text{net} = F_\text{external} - F_\text{friction}</math>|<math>(\text{3A})</math>|RawN=y}}

F_{\text{net}}=F_{\text{external}}-F_{\text{friction}}

({\text{3A}})

NumBlk2

{{NumBlk2|:|<math>F_\text{net} = F_\text{external} - F_\text{friction}</math>|（無作用）|RawN=y|IdSfx=3B|Lbl=<math>(\text{3B})</math>}}

F_{\text{net}}=F_{\text{external}}-F_{\text{friction}}

({\text{3B}})

上面的示例中，右侧编号（标签）依然是可点选之链接。其实以下的示例利用不同的参数设定方式，也可以得到几乎相同的结果：

{{NumBlk2|:|<math>F_\text{net} = F_\text{external} - F_\text{friction}</math>|3C|RawN=y|Lbl=<math>(\text{3C})</math>}}

F_{\text{net}}=F_{\text{external}}-F_{\text{friction}}

({\text{3C}})

{{NumBlk2|:|<math>F_\text{net} = F_\text{external} - F_\text{friction}</math>|<math>(\text{3D})</math>|RawN=y|IdSfx=3D}}

F_{\text{net}}=F_{\text{external}}-F_{\text{friction}}

({\text{3D}})

{{NumBlk2|:|<math>F_\text{net} = F_\text{external} - F_\text{friction}</math>|<math>(\text{3E})</math>|RawN=y|Id=math_3E}}

F_{\text{net}}=F_{\text{external}}-F_{\text{friction}}

({\text{3E}})

链接

(3A)未使用{{EquationRef}}，无法链接。
{{EquationNote|3B}}得到3B，[[#math_3B|3B]]得到3B。
{{EquationNote|3C}}得到3C，[[#math_3C|3C]]得到3C。
{{EquationNote|3D}}得到3D，[[#math_3D|3D]]得到3D。
{{EquationNote|3E}}得到3E，[[#math_3E|3E]]得到3E。

示例4

NumBlk

{{NumBlk|:|<math chem>\underbrace\ce{PCl5}_{(1)}\ \ce{->[t\text{-}\ce{Bu-\overset{\oplus}{NH3}.\overset{\ominus}{Cl}}]}\ \underbrace{t\text{-}\ce{Bu-N=PCl3}}_{(5)}</math>|[{{EquationRef|4A}}]|RawN=y}}

\underbrace {\ce {PCl5}} _{(1)}\ {\ce {->[t{\text{-}}{\ce {Bu-{\overset {\oplus }{NH3}}.{\overset {\ominus }{Cl}}}}]}}\ \underbrace {t{\text{-}}{\ce {Bu-N=PCl3}}} _{(5)}

[4A]

NumBlk2

{{NumBlk2|:|<math chem>\underbrace\ce{PCl5}_{(1)}\ \ce{->[t\text{-}\ce{Bu-\overset{\oplus}{NH3}.\overset{\ominus}{Cl}}]}\ \underbrace{t\text{-}\ce{Bu-N=PCl3}}_{(5)}</math>|（無作用）|RawN=y|IdSfx=4B|Lbl={{colors|black|[}}'''4B'''{{colors|black|]}}}}

\underbrace {\ce {PCl5}} _{(1)}\ {\ce {->[t{\text{-}}{\ce {Bu-{\overset {\oplus }{NH3}}.{\overset {\ominus }{Cl}}}}]}}\ \underbrace {t{\text{-}}{\ce {Bu-N=PCl3}}} _{(5)}

[4B]

上面的示例中，使用了{{colors}}将左右方括号的颜色改为黑色，否则左右方括号将会是链接的颜色。所以只要做适当的格式设定也能让标签看起来如同普通的文字：

{{NumBlk2|:|<math chem>\underbrace\ce{PCl5}_{(1)}\ \ce{->[t\text{-}\ce{Bu-\overset{\oplus}{NH3}.\overset{\ominus}{Cl}}]}\ \underbrace{t\text{-}\ce{Bu-N=PCl3}}_{(5)}</math>|（無作用）|RawN=y|IdSfx=4C|Lbl={{color|black|'''[4C]'''}}}}

\underbrace {\ce {PCl5}} _{(1)}\ {\ce {->[t{\text{-}}{\ce {Bu-{\overset {\oplus }{NH3}}.{\overset {\ominus }{Cl}}}}]}}\ \underbrace {t{\text{-}}{\ce {Bu-N=PCl3}}} _{(5)}

[4C]

链接

{{EquationNote|4A}}得到4A。
{{EquationNote|4B}}得到4B。
{{EquationNote|4C}}得到4C。

示例5

NumBlk

{{NumBlk|:|<chem>CO2(aq) + H2O -> H2CO3</chem>|{{EquationRef|5A}}}}

{\ce {CO2(aq) + H2O -> H2CO3}}

5A

NumBlk2

{{NumBlk2|:|<chem>CO2(aq) + H2O -> H2CO3</chem>|5B|IdPfx=chem-}}

{\ce {CO2(aq) + H2O -> H2CO3}}

5B

因为这里是对化学式而不是对数学式加编号，我们希望改用更适当的id属性前缀chem-而不是原本的math_，这时只要对|IdPfx=适当地赋值即可达成。

链接

{{EquationNote|5A}}得到5A。
'''[[#chem-5B|5B]]'''得到5B。