ビルトインモジュールの使い方 / how-to-use-builtin-module

Slide 1

Slide 1 text

ビルトインモジュールの使い方 a-blog cms zoom up 2022/03 有限会社アップルップル森田かすみ

Slide 2

Slide 2 text

有限会社アップルップル @KasumiMorita 森田かすみ

Slide 3

Slide 3 text

& 基本的な仕組みについ & 応用した使い & 意外と知らない人が多い知識の共有などまず初めに今日話すこと

Slide 4

Slide 4 text

ビルトインモジュールとはナビゲーションモジュールエントリーリストエントリーサマリーメディアバナーエントリー本文トピックパスビルトインモジュールとは

Slide 5

Slide 5 text

基本的な仕組み

Slide 6

Slide 6 text

スニペット {url} {title}

@include("/admin/module/setting.html")

基本的な仕組み

Slide 7

Slide 7 text

モジュールIDを適用する

@include("/admin/module/setting.html")

{title}

id=”entry_list” モジュールIDとはモジュールに個別の設定を与える機能のこと。きちんと設定することで表示するデータを制御することができます。基本的な仕組み

Slide 8

Slide 8 text

管理画面＞モジュールIDで新規モジュールIDを作成 A 表示するデータの制# A 件数設% A ページャーの表2 A メインイメージの表2 A 日付の表示モジュールIDで設定できることなど基本的な仕組み

Slide 9

Slide 9 text

スニペットに  変数を追加しよう

Slide 10

Slide 10 text

変数表を確認しよう便利なクイックサーチを使おう 9 ⌘KまたはCtrl+Kで起1 9 「:」の後にモジュール名で検索スニペットに変数を追加しよう

Slide 11

Slide 11 text

変数表の読み方 loopブロックスニペットに変数を追加しよう

Slide 12

Slide 12 text

変数表の読み方変数変数が出力する値スニペットに変数を追加しよう

Slide 13

Slide 13 text

変数表の読み方〇〇ブロックスニペットに変数を追加しよう

Slide 14

Slide 14 text

変数表の読み方 veilブロックスニペットに変数を追加しよう

Slide 15

Slide 15 text

変数を適用する

@include("/admin/module/setting.html")

{title}

{oddOrEven} スニペットに変数を追加しよう

Slide 16

Slide 16 text

@include("/admin/module/setting.html")

Slide 17

Slide 17 text

IFブロックとブロックを合わせて使う

@include("/admin/module/setting.html")

{title}

1/eq/1] -->この文字はループブロックが動く時しか表示スニペットに変数を追加しよう

Slide 18

Slide 18 text

モジュールIDの引数意外としっかり知らない人が多い？

Slide 19

Slide 19 text

引数についてモジュールIDの[条件設定]タブにある引数を設定することで、そのモジュールで表示する情報を制御することができます。モジュールIDの引数

Slide 20

Slide 20 text

URLコンテキストと固定値 URLコンテキストを優先する固定値を指定する閲覧しているページのURLコンテキストがモジュールの表示内容に反映されます。そのモジュールがどのページに設置されていても同じ内容を表示します。モジュールIDの引数

Slide 21

Slide 21 text

URLコンテキストと固定値同時に指定する URLコンテキストを優先するチェックボックスと固定値を両方指定すると、閲覧ページのURLコンテキストが優先して反映されます。モジュールIDの引数

Slide 22

Slide 22 text

併用する際の優先順位 1 URLコンテキストが優先になっていて、かつ現在表示しているページでURLコンテキストが指定されている状態 2 引数が固定値で指定されている状態モジュールIDの引数 ※優先順位を理解して固定値とURLコンテキストを優先にする設定を使い分けられると、より簡単にモジュールを設定できるパターンもあります。ぜひマスターして使ってみてください。

Slide 23

Slide 23 text

グローバル変数を使う固定値にはグローバル変数が使用できます。例）イベントスケジュール 3月8日に表示した様子。本日以降に開催されるイベントが表示されている。モジュールIDの引数

Slide 24

Slide 24 text

ページャーを有効にしたい G9 [表示設定]タブの「ページャー」にチェックすD 9 [条件設定]タブの「ページ」のURLコンテキストをチェック表示設定条件設定モジュールIDの引数

Slide 25

Slide 25 text

カスタムフィールドで絞り込みたい例）ピックアップ表示例）カスタムフィールド検索チェックすることで、カスタムフィールド検索結果のURLコンテキスト通りに記事の表示を絞り込みます。モジュールIDの引数

Slide 26

Slide 26 text

初期スコープ https://developer.a-blogcms.jp/document/moduleid/entry-2730.html モジュールIDの引数

Slide 27

Slide 27 text

子階層のブログ・カテゴリー子階層のデータもモジュールの条件に含める

Slide 28

Slide 28 text

子階層のブログ・カテゴリーの設定子階層のブログ・カテゴリー

Slide 29

Slide 29 text

ctx（外部コンテキスト）テンプレートからURLコンテキストを指定する

Slide 30

Slide 30 text

ctxとは（...省略...） ctx="bid/1/cid/2" ctx（外部コンテキスト）は、モジュールの条件設定にある引数の値をテンプレート側から指定できる機能です。ビルトインモジュール、フィールドモジュールで使うことができます。 ctx（外部コンテキスト）

Slide 31

Slide 31 text

モジュールIDとctxの優先順位 1 モジュールIDの設定でURLコンテキストが優先になっていて、かつ現在表示しているページでURLコンテキストが指定されている状態 2 モジュールIDの設定で引数が固定値で指定されている状態 3 テンプレートで外部コンテキスト（ctx）を設定した状態モジュールIDと併用できるよう、優先順位が設定されています。モジュール ID が優先 ctx（外部コンテキスト）

Slide 32

Slide 32 text

ctxの特徴：モジュールIDと違って変数を使用できる（...省略...） \ \ ctx="bid/%{BID}/cid/{fieldCategoryId}

Slide 33

Slide 33 text

モジュールID名に「ctx」が含まれていると  ctx指定が読み込めなくなる https://developer.a-blogcms.jp/blog/news/entry-3305.html ctx（外部コンテキスト）

Slide 34

Slide 34 text

モジュールIDのキャッシュパフォーマンスアップ！

Slide 35

Slide 35 text

設定するモジュールID＞[条件設定]タブの「キャッシュ」項目で指定できます。分単位で指定可能です。キャッシュを設定すると、モジュールの実行回数を減らすことができ、ページ表示速度が改善されます。モジュールIDのキャッシュ

Slide 36

Slide 36 text

キャッシュをおすすめするモジュール頻繁にデータが変わらないモジュールで有効にすることをお勧めします。フッターやヘッダーで使用しているモジュールなど。 Entry_Summaryなどのよく更新があるモジュールはおすすめしません。 f ナビゲーションモジュー f リンクモジュールモジュールIDのキャッシュ

Slide 37

Slide 37 text

キャッシュの削除タイミング G 該当のモジュールIDのキャッシュ時間の設定を経過したタイミン G 該当のモジュールIDが更新されたタイミングつまり、例えばナビゲーションモジュールのデータを更新した際は、同時にキャッシュを消してくれます。モジュールIDのキャッシュ

Slide 38

Slide 38 text

よくある質問

Slide 39

Slide 39 text

親ブログの情報を  子ブログに表示したいのですがどうしたらいいでしょうか。よくある質問親ブログの情報を子ブログに表示したいのですがどうしたらいいでしょうか。

Slide 40

Slide 40 text

&$ 上階層のブログでモジュールIDを作 É$ グローバルにチェック自然とルートにモジュールIDが多くなるので命名規則に注意が必要です上階層のブログでモジュールIDを作成するよくある質問親ブログの情報を子ブログに表示したいのですがどうしたらいいでしょうか。

Slide 41

Slide 41 text

モジュールIDの命名規則 9 「_（アンダーバー）」繋2 9 モジュール名_使用場所名（コンテンツの種類）のように命名する命名規則の例） → summary_top、summary_index、summary_recruit よくある質問親ブログの情報を子ブログに表示したいのですがどうしたらいいでしょうか。

Slide 42

Slide 42 text

Entry_Photo、Entry_List、 Entry_Summary... どれを使えばいい？よくある質問 Entry_Photo、Entry_List、Entry_Summary...どれを使えばいい？

Slide 43

Slide 43 text

リリース当初は機能が別れていたのですが、バージョンアップを重ねるたび、Entry_Summaryでほとんどの機能が利用できるようになりました。 Entry_List、Entry_Headline、Entry_Photo、Entry_Summaryの4つの中で選択に迷ったらEntry_SummaryでOKです。基本的にはEntry_SummaryでOK よくある質問 Entry_Photo、Entry_List、Entry_Summary...どれを使えばいい？

Slide 44

Slide 44 text

@KasumiMorita ありがとうございました！