1. SPEAKのご紹介

定義項目と構成項目

Version:
日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

定義アイテムを使用してSPEAKページを作成し、定義アイテムのプロパティと動作を設定するための構成アイテムを作成します。これらのアイテムはSitecoreコンテンツ ツリーで整理します。ここで示すアプリケーション項目の整理に関するガイドラインに従うと、アプリケーションの開発と保守が容易になります。

ページ定義アイテム

SPEAKページ定義アイテムは、SPEAKページを定義するSitecoreアイテムです。コンテンツ・ツリー内のページ定義アイテムの位置によって、ブラウザーでページにアクセスするために使用するURLが決まります。

ページ定義アイテムにはプロパティがあります。これらのプロパティの多くを設定する必要はありませんが、次の項目は必須です。

  • BrowserTitle: ブラウザ内のページのタイトル

  • Theme: ビジュアルテーマ (通常は "Harvard" として設定する必要があります)

ページ定義アイテムは、通常のSitecoreレイアウトを持ちます。ただし、SPEAKページでは、SPEAK用に設計されたレイアウトを使用する必要があります。これにより、ページの外観がSPEAK UIガイドラインに準拠するようになります。

ページ定義アイテムのテンプレート

Sitecore Rocksを使用してページ定義アイテムをコンテンツ ツリーに追加する場合、いくつかのテンプレートから選択できます。

テンプレートは基本的なページ定義アイテムを作成しますが、コンテンツは含まれていません。基本的なコンテンツを含めるには、代わりにブランチ テンプレートを使用できます。ブランチ テンプレートは標準テンプレートに基づいていますが、SPEAKページが機能するために必要な基本的な構成コンポーネントと構造コンポーネントも含まれています。

ページテンプレートとブランチには、より詳細な説明が別途あります

多くの共通点を持つ多数のページを持つアプリケーションで作業する場合は、独自のテンプレートを作成して、追加する各ページを簡単に開始できます。

構成項目

ページに追加するすべてのコンポーネントにはプロパティがあります。これらのプロパティは、コンポーネントの動作と、他のコンポーネントやアイテムとの相互作用を指定します。これらのプロパティは、コンポーネントのプロパティ シートで設定できます。

Sitecore Rocksのプロパティ シートでコンポーネントのプロパティを設定する代わりに、設定アイテムを作成し、プロパティをこの設定アイテムのフィールド値として設定し、コンポーネントを設定アイテムにポイントすることができます。これで、コンテンツ エディターでこれらのフィールドの値を変更できるようになりました。

コンポーネントを設定アイテムにポイントするには、コンポーネントのDataSourceプロパティの値を設定アイテムのSitecore IDに設定します。

通常、構成アイテムはPageSettingsアイテムの子として作成し、PageSettingsアイテムはページ定義アイテムの子として作成します。

一般に、構成アイテムのテンプレートには、「<name of component> Parameters」のような名前が付けられます。

複数のページを持つアプリケーションでは、ページに共通の構成がある場合があります。これらの共有または共通の構成項目のフォルダーを作成し、各ページの構成をレプリケートする代わりに、共有構成を必要とするすべてのページをこのフォルダーにポイントできます。

一部のコンポーネントでは、コンポーネントのプロパティをレプリケートする以上のことを行う構成アイテム テンプレートが使用されます。SPEAKコンポーネント リファレンスのコンポーネントの説明では、これらのテンプレートの内容と使用方法について説明します。

複数言語の構成項目

現在または将来のアプリケーションで複数の言語をサポートする場合は、エンドユーザーが表示できるすべてのテキストに構成アイテムを使用する必要があります。たとえば、このテキストは "Text" や "Tooltip" などのプロパティにあり、一部のコンポーネントでは他のプロパティにもあります。SPEAKコンポーネント リファレンスには、各コンポーネントについての詳細が記載されています。

テキストに設定アイテムを使用する場合、このテキストは通常のSitecoreアイテムのフィールドの値です。つまり、テキスト翻訳用の標準のSitecoreツールを使用してテキストを翻訳できます。

設定アイテムを使用しない場合、テキストはコンポーネントのプロパティとして保存され、翻訳ツールはこれらのテキストに対して機能しません。

アプリケーションアイテムの整理

一部のSPEAKアプリケーションには、多数のページと多数のページ定義項目があります。また、多くの構成アイテムを持つ傾向があります。したがって、開発を開始する前に情報アーキテクチャを定義して、開発プロセスを開始したらどこに保存してアイテムを見つけるかをすぐに理解できるようにすることをお勧めします。

たとえば、ページが比較的少ない単純なアプリケーションでは、次のような情報アーキテクチャを持つことができます。

<Application Folder>
    <Pages Folder>
        <Page1 Definition Item>
            PageSettings
                <Component1 Configuration Item>
                <Component2 Configuration Item>
        <Page2 Definition Item>
            PageSettings
                <Component1 Configuration Item>
                <Component2 Configuration Item>
    <Shared Settings Folder>
        <Common Component1 Configuration Item>
        <Common Component2 Configuration Item>
    <Templates>
        <X entity template>
        <Y entity template>
    <Test Data Folder>
        <X Entities>
            <X entity1>
            <X entity2>
        <Y Entities>
            <Y entity1>
            <Y entity2>
この記事を改善するための提案がある場合は、 お知らせください!