Jdoc statements/ja
出典: Joomla! ドキュメンテーション
jdocステートメントは すべてのJoomla! テンプレートに含まれており、Joomla!の他のパーツのアウトプットあるいはエクステンションを全体的なウェブページのどこに位置指定するかを示します。
典型的なjdocステートメントはこのようになります:
<jdoc:include type="component" />
詳細はjdocステートメントについて を参照ください。
目次 |
jdoc:include
<jdoc:include /> ステートメントはページに特定のコンテンツを表示するJoomla!テンプレートの表示方法です。
<jdoc:include /> ステートメントにはいろいろあります。それぞれが異なったJoomla!ページのパーツを返します（表示します）。
type属性
type属性は<jdoc:include />要素の場所にレンダリングされるコンテンツの種類を指定します。例えば、<jdoc:include type="head" />ステートメントはtype属性に head (type="head")を使います。
(注釈: Jdoc の表記には属性の周りにダブルクオーテーションが必要です。シングルクォーテーションでは動作しません。 )
コンポーネント
<jdoc:include type="component" />現在のページに対してメインコンテンツをレンダリングさせるためのこの要素は、テンプレートの<body>要素の中に一度しか定義できません。
ヘッド
<jdoc:include type="head" />現在のページに関連付けられたスタイル、スクリプト、メタデータのコンテンツをレンダリングさせるためのこの要素は、テンプレートの<head>要素の中に一度しか定義できません。
インストール
<jdoc:include type="installation" />この要素はJoomla!インストーラテンプレートにのみ使用され、フロントエンドあるいはバックエンドテンプレートでの特定の使用用途はありません。多少'component' タイプと同様であり、インストール手順のメインコンテンツをレンダリングします。
メッセージ
<jdoc:include type="message" />要求に対して起きたシステムやエラーメッセージをレンダリングさせるためのこの要素は、テンプレートの<body>要素の中に一度しか定義できません。
システムメッセージに対するCSSスタイルは次の場所にあります。 templates\system\css\system.css
モジュール
<jdoc:include type="module" name="breadcrumbs" /> <jdoc:include type="module" name="menu" /> <jdoc:include type="module" name="submenu" style="rounded" id="submenu-box" />
この要素はname属性で与えられた単一モジュールをレンダリングします。指定した場所にあるモジュールは公開され、表示するために現在のユーザがアクセス可能である必要があります。サポートされていれば、追加の属性でレイアウトやモジュールの見た目を制御することができます。
モジュール
モジュールは、ページに次のコード例を使用してレンダリングされます。モジュールはtemplatedetails.xmlファイル内のテンプレート位置設定を使用してテンプレートのさまざまなエリアに分けられます。jdoc:includeの name="[template position name]"属性を使って、それぞれの位置に様々なモジュールが呼び出され、個々のスタイルでレンダリングされます。サポートされていれば、追加の属性でレイアウトやモジュールの見た目を制御することができます。
以下がJoomla!テーマ開発者が頻繁に用いるいくつかのモジュールポジションが付いたモジュールステートメントの例です。
<jdoc:include type="modules" name="debug" /> <jdoc:include type="modules" name="icon" /> <jdoc:include type="modules" name="left" style="rounded" /> <jdoc:include type="modules" name="left" style="xhtml" /> <jdoc:include type="modules" name="right" style="xhtml" /> <jdoc:include type="modules" name="status" /> <jdoc:include type="modules" name="syndicate" /> <jdoc:include type="modules" name="title" /> <jdoc:include type="modules" name="toolbar" /> <jdoc:include type="modules" name="top" /> <jdoc:include type="modules" name="top" style="xhtml" /> <jdoc:include type="modules" name="user1" style="xhtml" /> <jdoc:include type="modules" name="user2" style="xhtml" /> <jdoc:include type="modules" name="user3" /> <jdoc:include type="modules" name="user4" />
注釈: name="user3" モジュールポジションは通常は(デフォルトでは)トップメニューとして利用されます。
style属性
オプションの style="" 属性は<jdoc:include />ステートメントのmoduleとmodules typeで利用されます。 この属性値はモジュールで生成されたアウトプットをラップするために chrome スタイルを参照します。スタイルを定義しない場合は、デフォルトで"none" を使います。
テンプレートデザイナーが Applying custom module chromeで説明されているように追加クロム名を追加することもあります。
