コンテンツ・リスト問合せのマクロの展開

サポートされているコンポーネント・プロパティ

次のプロパティがMustache JSテンプレート構文をサポートしています:

• コンテンツ・リスト

  • 追加問合せ文字列

  • 例: updatedDate gt "{{#content.date}}today - 3 days{{/content.date}}"

• タイトル/段落/テキスト

  • CKEditorを介して入力されたリッチ・テキスト

  • 例: "Content REST API format for date: {{#content.date}}now{{/content.date}}"

サポートされているコンポーネント構文

content.dateオブジェクトは、すぐに使用可能なオブジェクトとしてサポートされています。これには、todayとnowという2つのメイン・パラメータが採用されます。

today値は、現在のブラウザ時間を採用し、本日の午前零時に変換し、この値をUTC時間に変換します。

• {{#content.date}}today{{/content.date}}は、本日の午前零時のブラウザ時間に拡張され、UTC値に変換され、コンテンツREST API日付フォーマットに設定されます。例:

  2220181008065959999

• これは、次によって補強できます:

  today +/-  [day | week | month | year]

• today値はまた、加算または減算を行うと動作が変化します。減算すると、朝の時間が使用されます。加算すると、午前零時の時間が使用されます。例:

  • {{#content.date}}today - 1 day{{/content.date}}の場合、昨日の1日の始まりまで拡張されます。

  • {{#content.date}}today + 2 days{{/content.date}}の場合、明後日の午前零時まで拡張されます。

now値は、現在のブラウザ時間を採用し、調整なしでUTC時間に変換します。

• {{#content.date}}now{{/content.date}}は、UTC値に変換された現在のブラウザ時間に拡張され、コンテンツREST API日付フォーマットに設定されます。

• nowはまた、hourを使用して補強することもできます。このため、次のようになります:

  now +/-  [hour | day | week | month | year]

• 例:

  • {{#content.date}}now + 2 hours{{/content.date}} - 現在から2時間後で、UTC値に変換され、コンテンツREST API日付フォーマットに設定されます

  • {{#content.date}}now - 1 day{{/content.date}} - 昨日のこのブラウザ時間で、UTC値に変換され、コンテンツREST API日付フォーマットに設定されます

サポートされているコンポーネント構文の使用

追加問合せ文字列でマクロ拡張機能を使用するときに、過去3週間のすべてのデータを返したい場合は、次のように入力します:

updatedDate gt "{{#code.date}}today - 3 weeks{{/code.date}}"

日付のみが返されるため、コンテンツREST APIコールを操作するために、静的値を入力する場合のように問合せ文字列を構築するときに引用符を追加します。

MustacheJS

構文については、mustache.github.io/mustache.5.htmlにあるMustache JSテンプレート・ページを参照してください。

文字列の拡張時に実行されるMustacheインスタンスに1つの変更が行われています。Mustacheには、{{ }}を使用するtext拡張機能と{{{ }}}を使用するhtml拡張機能の両方が用意されています。これらの2つの違いは、テキスト格納機能では文字列に対してHTMLエンコードが行われる点です。つまり、値がa < bに拡張された場合、結果がa < bになります。これは、URLの文字列を構築する際に求めていない動作です。ユーザーにはHTML拡張機能を使用するよう伝えることはできますが、{{{ }}}を使用する必要がある理由を説明するなど、余計な作業であり、さらに多くの問題が生じます。

これを回避するために、Mustacheは、{{ }}を使用するときに値をエスケープしないよう設定されています。つまり、{{ }}と{{{ }}}は両方とも同じように動作します。これにより、任意の結果をエンコードすることが必要な場合もこの作業をユーザーのために残しておくことができます。

OOTB Mustacheモデル

Mustacheには、拡張のためにテンプレートに適用するモデルが必要です。前の例では、{{#content.date}}は、すぐに使用可能なものとしてすでに定義されています。一方、{{person}}などの新しいプロパティは開発者が追加できます。モデル内にない値をユーザーがMustacheテンプレートに入力すると、その結果は空の文字列になります。このため、Hello {{person}}の場合、開発者がpersonをモデルに追加しない限り、単にHelloに拡張されます。

使用されているモデル・オブジェクトは、SCSMacrosと呼ばれるグローバル・オブジェクトです。開発者は、このオブジェクトに別の任意のエントリを自由に追加できます。このオブジェクトは、テンプレートが評価されるときにMustacheに渡されます。

すぐに使用可能なモデル・オブジェクトは現在、content.dateオブジェクトのみをサポートしています:

{   
   content: {
     date: <lambda implementation>
   }
}

カスタムMustacheモデル

サポートされているオブジェクトは、開発者が要件に基づいて拡張できます。このため、lastTwoDaysオブジェクトを導入し、拡張を単なる{{lastTwoDays}}に簡素化できます。

前の例でHello {{person}}のようなものをサポートするためにモデルを拡張するには、personオブジェクトをSCSMacrosに追加する必要があります。これは、ページが実行される前に行う必要があります。これは、ページ・レイアウト内で先頭にスクリプト・タグを追加することによって実現できます。例:

<script type="text/javascript">
window.SCSMacros = window.SCSMacros || {};  // define/get the SCSMacros object
window.SCSMacros.person = "World";
</script>

この変更を行った後、Hello {{person}}テンプレートはHello Worldに拡張されます。

オブジェクトに値を渡したい場合(Hello {{#person}}personId{{/person}}など)、mustache lambdaを実装し、実装内の値をラップおよび拡張する必要があります。

例:

<script type="text/javascript">
window.SCSMacros = window.SCSMacros || {};  // define/get the SCSMacros object
//implement "person" as a lambda
window.SCSMacros.person = function () {
  var people = { '111': { firstName: 'Small', lastName: 'World'}, '222': { firstName: 'Big', lastName: 'Universe'} };  
  return function (text, render) {     
     var expandedText = render(text);
     var chosenPerson = people[expandedText] || people['111'];      
     return chosenPerson.firstName;
  }
};
</script>

この変更を行った後、Hello {{#person}}111{{/person}}テンプレートはHello Smallに拡張され、Hello {{#person}}222{{/person}}テンプレートはHello Bigに拡張されます。