テンプレート:Begin

begin/endテンプレート

テンプレート:Begin/{{{1}}}を同じパラメータで呼び出します。Begin-Endペアによるネストをチェックします。必ず対になるテンプレート:Endも利用してください。

テンプレート引数

このテンプレートは、パラメーターを1行で記述することが推奨されています。

引数		説明	型	状態
環境名	1	サブテンプレート名を指定します。	文字列	必須
折り畳み	collapsible	セクションを折り畳み可能にする。任意の空でない値は真と解釈する。 例 collapsible=1	ブール値	省略可能
初期折り畳み状態	collapsed	セクションを最初から折り畳み状態にする。任意の空でない値は真と解釈する。collapsible引数と併用する。 例 collapsed=1	ブール値	省略可能
囲い	boxed	セクションに枠と背景色を付ける。任意の空でない値は真と解釈する。	ブール値	省略可能

section環境

section環境は一般的なセクション機能のみを提供します。この機能は内部的に他のproof環境などからも呼び出されますが、通常の記事などでもsectioningのために自由に使うことができます。

{{begin   |section |display=タイトル | boxed=1 }}
セクション
{{end     |section }}

タイトル

セクション

proof環境

proof環境は証明開始記号と証明終了記号を指定して証明セクションを明示できます。

{{begin   |proof | collapsible=1 }}
素晴らしい証明が素敵な方法で実現される：$$\sum_{n=0}^\infty \dfrac{1}{(n+1)^2} < \infty.$$
{{end     |proof }}

Proof.

素晴らしい証明が素敵な方法で実現される：$$\sum_{n=0}^\infty \dfrac{1}{(n+1)^2} < \infty.$$

□

preamble環境

preamble環境はただ表示されないセクションです。MathJaxマクロの定義や定理環境の宣言をこの中で行うと便利です。

{{begin |preamble }}
<math>
% 自分用のマクロを定義します
\newcommand\NN{\mathbf{N}}
</math>
{{end   |preamble }}

存在しないサブテンプレート呼び出し

存在しない誤った環境（テンプレート）名を第一引数に与えた場合、そのテンプレートへのリンクが表示され他の効果はありません。

{{begin |unknown-environment |collapsible=1 }}
{{end   |unknown-environment }}

対にならないネスト呼び出し

いかなる場合にもネストチェックだけは常に行います。存在しない環境（テンプレート）名を指定した場合も含みます。

{{begin |unknown-parent }}
{{begin   |proof | collapsible=1 }}
{{end     |proof-wrong-end }}
{{end   |unknown-parent }}

Proof.

警告：先に展開されたbeginテンプレートと対になっていません。テンプレート:End/proof-wrong-end テンプレート:End/unknown-parent

このような場合、文書の論理的なネスト構造も壊れてしまい、一部機能などが正常に動作しなくなります。この例では、折り畳み証明セクションが正常終了されず未知の環境名で閉じてしまったため、折り畳みセクションがこの位置まで継続してしまっています。

一般的なパラメータ引数

いくつかのbegin/endテンプレートには共通するパラメータがあります。

collapsible

collapsible=1をテンプレート引数に与えると、begin/endセクションが折り畳み可能になります。指定しなかった場合のデフォルトでは折り畳みUIは表示されません。引数collapsibleの任意の空でない文字列値が真として解釈されます。

注意：booleanをうまくパラメータ引数に与えて処理するベストプラクティスがいまいち分かっていないので、この仕様は今後変更する可能性があります。

collapsibleセクションの折り畳み初期状態指定collapsed

collapsed=1を併せて指定すると、begin/endセクションが初期状態で折り畳まれます。引数collapsedの任意の空でない文字列値が真として解釈されます。

boxed

boxed=1をテンプレート引数に与えると、begin/endセクションを枠で囲い背景色をつけます。指定しなかった場合のデフォルトでは囲いも背景色もつきません。引数boxedの任意の空でない文字列値が真として解釈されます。

注意：booleanをうまくパラメータ引数に与えて処理するベストプラクティスがいまいち分かっていないので、この仕様は今後変更する可能性があります。