模板: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。