related_blog_posts HubLタグを使用して関連するブログ記事のリストを作成する
related_blog_posts HubLタグを使用すると、さまざまなパラメーターに基づいて関連するブログ記事の動的なリストを作成できます。執筆者、記事パス、および公開日による絞り込み機能を使用して、複数のブログにまたがる記事のリストを生成できます。開発者は、マクロを使用してモジュールのHTML出力を指定することもできます。このHubLタグはブログ記事とページの両方で使用できます。このチュートリアルでは、related_blog_posts HubLタグのパラメーターと使用方法について説明します。
related_blog_posts
HubLタグは、記事/ページ側で編集可能なモジュールを生成せず、HubLで完全に設定されることに注意してください。
記事のリストは、以下のパラメーターに一致する記事(このHubLタグが表示された記事に関連する記事)と設定されたパラメーター値を比較して得られた関連性スコアから生成されます。必須のパラメーターはありませんが、パラメーターを指定することで、返される記事を細かく制御できます。カンマ区切りパラメーターの場合は、設定する値が多いほど返されるリストの範囲が広がります。post_formatter
パラメーターを使用すると、モジュールのHTML出力を生成するマクロを指定できます。パラメーターの完全なリストと既定のHTML出力の例については、related_blog_postsの仕様を参照してください。
Parameter | Type | Description | Default |
---|---|---|---|
limit
| number | リストするブログ記事の最大数。 |
3
|
blog_ids
| 'default' or blog id | リストする記事を含むブログのID。 |
none
|
tags
| String | 記事に関連性があるかどうかを判定するために使用するタグ(カンマ区切り)。ブログ記事にこれらのタグのいずれかまたは類似のタグがある場合、記事の関連性が高くなり、リストでのランキングが向上します。 |
none
|
blog_authors
| String | リストする記事の執筆者の名前(カンマ区切り) |
none
|
blog_post_ids
| String | リストする関連ブログ記事の検索に使用するブログ記事ID(カンマ区切り)。このパラメーターは、ウィジェットをページに表示する場合にのみ使用してください。ブログ記事の場合は既定で、ウィジェットが表示される記事になります。 |
none
|
post_formatter
| String | 返されるブログ記事を表示するためのカスタムマクロの名前。このマクロには、フォーマットする記事オブジェクト、ブログ記事の反復数、および結果に含まれるブログ記事の合計数という3つのパラメーターが渡されます。指定されていないか、「default」に設定された場合は、組み込みのフォーマッターを使用して各記事がフォーマットされます。 |
none
|
callback
| String | 返されるブログ記事をレンダリングするためのJavaScript関数の名前。関数に、形式を設定するブログ記事オブジェクトの配列が渡されます。callbackパラメーターとpost_formatterパラメーターのどちらも指定されていない場合、タグは既定の形式のHTMLを生成します。 |
none
|
path_prefixes
| String | リストする記事のURLパスまたはサブディレクトリー(カンマ区切り)。ブログ記事のパスに類似するプレフィックスがある場合は、記事の関連性が高くなり、リストでのランキングが向上します。 |
none
|
start_date
| date/time | ある日時より後に公開された記事に絞り込むことができます。 |
none
|
end_date
| Date/Time | ある日時より前に公開された記事に絞り込むことができます。 |
False
|
blog_post_override
| String | 他のパラメーター値やフィルターに関係なく、返されたリストに常に表示されるブログ記事のID(カンマ区切り)。 |
none
|
ページの読み込みを高速化するために、post_formatter
パラメーターではなくcallback
パラメーターを使用することを強くお勧めします。
1つの記事にrelated_blog_posts
HubLタグを使用する場合は、blog_post_ids
パラメーターを指定しないでください。ブログ記事の場合は既定で、ウィジェットが表示される記事になります。
このタグを使用してウェブサイトを強化する方法の例を以下に示します。
この例では、2つの異なるブログから、指定された3人のblog_authors
(ブログ執筆者)によって書かれた記事のリストを生成します。
この例では、特定のブログ記事に関連し、「sales enablement」タグを含む10件の記事のリストを、公開日の期間を限定して作成します。この例では、blog_post_ids
パラメーターをページで使用するために指定します。
この例では、callback
パラメーターを使用して記事リストのHTML出力を制御することにより、5件の記事のリストを生成します。(マクロを使用したpost_formatter
パラメーターを使用しない方法。)
貴重なご意見をありがとうございました。