関連エントリー機能

任意の記事に関連した情報のエントリーを表示する機能として、登録されているタグの一致数に応じて関連記事を表示するタグリレーショナル（Entry_TagRelational）というモジュールがあります。
a-blog cms Ver.2.6.0からは（Admin_Entry_Autocomplete）モジュールが追加されています。エントリーの登録・編集時に、関連するエントリーを検索し、紐付け登録をします。より柔軟な関連記事登録が可能になります。

関連エントリーのUIです。”段落”と入力すると、"段落"というキーワードで絞りんだエントリーが選択できます。

登録されたエントリーは、ハンドルを掴んでドラッグアンドドロップすることで表示順を変更することも可能です。また、右の確認ボタンを押すことで、実際にそのエントリーのページに移動して内容を確認することもできます。

関連エントリー登録後は、登録されたエントリーが検索フォームの下に一覧で表示されています。

紐づけられたエントリーはテンプレートをカスタマイズすることで下の図のように表示することが可能です

関連エントリー機能の有効化・設定

この機能を使用するためにはテンプレート側のカスタマイズおよび管理画面の設定が必要になってきます。

関連エントリー機能を有効にする

関連エントリー機能を使用可能にするために、 管理画面 > 編集画面 > 編集設定 より下の図のように 関連エントリー のチェックボックスにチェックを入れます。

関連記事グループの設定

「関連記事グループ」の機能では、関連エントリーをグルーピングすることが可能です。 この機能を使えば、1つの記事に対して複数の関連エントリーのグループを表示できます。 初期状態では、サイト全体から記事を選択することになり、1つの記事に対して1つのグループしか設定できません。

関連記事グループ設定

関連記事グループの設定項目

  • タイプ: グループを識別する値（英数字で入力）
  • ラベル: 編集画面でグループに表示される値
  • モジュールID: 関連記事選択UIでの選択肢を表示するためのモジュール「Admin_Entry_Autocomplete」のモジュールID名を指定します。
  • URLコンテキスト（ctx）: ここで設定されたURLコンテキストで関連記事選択UIの選択肢を絞り込みます
  • 登録制限: ここで設定された数だけ関連記事を選定できます
タイプ グループを識別する値（英数字で入力）
ラベル  編集画面でグループに表示される値
モジュールID 関連記事選択UIでの選択肢を表示するためのモジュール「Admin_Entry_Autocomplete」のモジュールID名を指定します。
URLコンテキスト（ctx） 設定されたURLコンテキストで関連記事選択UIの選択肢を絞り込みます
登録制限 設定された数だけ関連記事を選定できます
上記の設定をした場合の編集画面例
編集画面例

設定された関連記事を表示する

エントリーに登録した関連記事を表示する方法を解説します。表示する方法は大きくわけて2つあります。

Entry_Body, Entry_Summaryの変数で出力する

1つ目の方法は、Entry_BodyやEntry_Summaryの entry:loop 内で、対応する関連記事を出力する方法です。一覧ページなどでエントリーに合わせて関連記事も表示する時に有効です。

変数の有効化

Entry_Bodyまたは、Entry_SummaryのモジュールIDの「表示設定」で「関連エントリーを表示する」にチェックをつけます。

関連記事を表示する設定

変数表

Entry_Bodyまたは、Entry_Summaryの変数表を見ると、関連記事の出力変数がありますので、変数表をみてテンプレートに変数を記入します。

Entry_Bodyの変数表

https://developer.a-blogcms.jp/document/acms-code/vars/Entry_Body.html?cache=off

Entry_Summaryの変数表

https://developer.a-blogcms.jp/document/acms-code/vars/Entry_Summary.html

関連記事の変数表

「default」タイプの関連記事の場合の例

<!-- BEGIN relatedEntry -->
  <!-- BEGIN relatedEntry.default -->
  <ul>
    <!-- BEGIN relatedEntry.default:loop -->
    <li><a href="{url}">{categoryName}: {title}</a></li>
    <!-- END relatedEntry.default:loop -->
  </ul>
  <!-- END relatedEntry.default -->
<!-- END relatedEntry -->

Entry_Summary 自体の出力内容を関連エントリーにする

2つめの方法は、Entry_Summaryモジュールの表示内容を、関連記事の内容にしてしまう方法です。詳細ページなどで、エントリーに付随する関連記事一覧を表示するのに便利です。

設定方法

まず、引数のエントリーIDにチェックをつけてEntry_SummaryのモジュールIDを作成します。

引数のエントリーIDにチェックをつける

次に「表示設定」で、「関連エントリーのサマリーを表示する」にチェックをつけて、表示する関連記事グループを選択します。

表示設定で関連記事を表示する設定にする

モジュールIDを作成したら、Entry_Summaryのスニペットをテンプレートに記述し、作成したモジュールIDを適用します。そのエントリーで設定した関連記事を表示します。

オートコンプリートのモジュールIDを作成

オートコンプリート(Admin_Entry_Autocomplete)モジュールは下の図のようにキーワードを入力し、そのキーワードを含むエントリーを絞り込み登録するためのモジュールです。

オートコンプリート(Admin_Entry_Autocomplete)モジュールはデフォルトでブログに登録された記事全体を検索できるようになっています。検索する記事をカテゴリーやカスタムフィールドなどで絞り込みたい場合はモジュールIDの作成が必要になってきます。

モジュールID作成時の注意事項

モジュールID化した場合は、URLコンテキストのキーワードにチェックをつけてください。チェックがない場合は絞り込まれません。デフォルトではキーワードにチェックがつかないため、/js/config.js を以下のように設定が必要です。

// 860行目付近
'Admin_Entry_Autocomplete' : ['bid', 'uid', 'cid', 'keyword', 'tag', 'field_', 'start', 'end'],

しかしながら、/js/config.js を直接編集するとアップデート時に設定が消してしまうおそれがあるため、お使いのテーマファイルの /themes/お使いのテーマ/admin/module/field.html にファイルを設置して以下のように記述します。組み込みJSについて詳しくは、 読み込みが必要なJavascriptファイル をご覧ください。

<script type="text/javascript">
    ACMS.Ready(function(){
    	ACMS.Config.Admin.argGuidance.Admin_Entry_Autocomplete = ['bid', 'uid', 'cid', 'keyword', 'tag', 'field_', 'start', 'end'];
    })
</script>

モジュールIDを作成する場合にはモジュールから下の図のようにオートコンプリート(Admin_Entry_Autocomplete)を選択します。また引数を指定することでエントリーを絞り込む範囲を制限することができます。例えばカテゴリーの引数に1を指定するとカテゴリーが1のエントリーの中から記事を検索し登録することができます。

テンプレートの記述

/system/ajax/edit/autocomplete.jsonを使用中のテーマの同一の階層にコピーします。その後、下のソースのように作成したモジュールIDをテンプレートに新たに追記してください。

<!-- BEGIN_MODULE Admin_Entry_Autocomplete id="設定したモジュールID" -->[<!-- BEGIN entry:loop -->
    \{
    	"label": "<!-- BEGIN categoryField -->（{fieldCategoryName}）<!-- END categoryField -->{title}",
    	"value": "<!-- BEGIN categoryField -->（{fieldCategoryName}）<!-- END categoryField -->{title}",
    	"title": "{title}",
    	"id": {eid},
    	"url": "{url}",
    	"datetime": "{date#Y}/{date#m}/{date#d} {date#H}:{date#i}",
    	"categoryName": "<!-- BEGIN categoryField -->{fieldCategoryName}<!-- END categoryField -->"
    \}<!-- BEGIN glue -->, <!-- END glue --><!-- END entry:loop -->
]<!-- END_MODULE Admin_Entry_Autocomplete -->