コンフィグセット

コンフィグセット機能とは

コンフィグセット機能ができる以前は、ブログ毎にコンフィグを設定する必要がありサイト全体で共通の設定(サイト全体にベーシック認証をかけるなど)を行いたい場合でも、全ブログのコンフィグを設定を行う必要がありブログ数が多いと大変でした。

Ver. 2.10.0 で導入されたコンフィグセット機能を利用すると、コンフィグのセットを作成することができ、このセットをブログまたはカテゴリーにセットすることで、コンフィグ設定できるようになりました。これにより、同じコンフィグセットを利用しているブログやカテゴリーのコンフィグを一回の操作で変更できるようになります。

また、コンフィグセットは複数作成しておくことができるので、カテゴリー毎にコンフィグを変更するといったことも可能になりました。


コンフィグセット一覧

コンフィグセット機能を利用する

例えば、サイト全体(複数ブログ)のコンフィグを1つのコンフィグで管理し、サイト全体にBASIC認証をかけてみます。

1. サイト全体の共有のコンフィグセットを作成

管理画面 > コンフィグ よりコンフィグセットを新規作成します。


コンフィグセットの作成画面

2. 作成したコンフィグセットを編集

先ほど作成した、「サイト全体の共有のコンフィグセット」を選択して、コンフィグ一覧に移動します。


コンフィグセット一覧画面

BASIC認証をかけるため「アクセス設定」に移動して、BASIC認証を設定します。


BASIC認証設定画面

3. ルートブログにコンフィグセットを適応

「管理画面 > ブログ」に先ほど設定したコンフィグセットを割り当てます。


ブログ編集画面

この時重要なのが「子ブログにも継承する」にチェックをつけることです。ここにチェックをつけることで、チェックをしたブログまたはカテゴリーの子ブログ・子カテゴリーも同じコンフィグセットを参照するようになります。

以上で設定は完了です。これでサイト全体にBASIC認証をかけることができました。

子ブログへの継承

Ver. 3.1.0 で、コンフィグセットをブログやカテゴリーにセットした時、子ブログや子カテゴリーにも継承させることが出来るようになりました。


ブログ編集画面

「子ブログ(子カテゴリー)にも継承する」にチェックをつけた場合

「子ブログ(子カテゴリー)にも継承する」にチェックをつけた場合は、設定したブログ(カテゴリー)の子ブログ(子カテゴリー)にも同じコンフィグが設定されます。

子ブログ(子カテゴリー)は孫も含む全ての子階層のブログ(カテゴリー)が対象です。

子ブログ(子カテゴリー)でも、コンフィグセットを適応した場合、子ブログ(子カテゴリー)で設定したコンフィグセットが優先されます。よってコンフィグセットが設定されていない子ブログ(子カテゴリー)にだけコンフィグが継承されるようになります。

親ブログ(親カテゴリー)で「子ブログ(子カテゴリー)にも継承する」にチェックがついている場合かつ、子ブログ(子カテゴリー)でもチェックが付いている場合、孫ブログなどの子階層のブログ(カテゴリー)は、チェックがついている一番近い親のコンフィグセットを継承します。

「子ブログ(子カテゴリー)にも継承する」にチェックをつけなかった場合

子ブログ(子カテゴリー)にも継承する」にチェックをつけなかった場合は、そのブログ(カテゴリー)でのみ、コンフィグが適応されます。

htmx と a-blog cms で作る「もっと見る」ボタンの実装方法

まず、実践的な実装方法の一つとして、標準的なページャー UI を Ajax を使用した動的コンテンツ読み込みに置き換える方法を紹介します。これを実現するために、htmx を利用します。



head に htmx のライブラリを読み込み

<script src="https://unpkg.com/htmx.org@1.9.10"></script>
<script src="https://unpkg.com/htmx.org/dist/ext/ajax-header.js"></script>

a-blog cmshtmx のバックエンドに利用する場合、ajax-header.js の読み込みが必要ですので、ご注意ください。

リスト表示のモジュールのページャーをカスタマイズ

リスト表示用のモジュールのページャーをカスタマイズします。以下の例では、次のページへのリンクをカスタマイズしています。

<!-- BEGIN pager:veil -->
<!-- BEGIN forwardLink -->
<form hx-post="" hx-ext="ajax-header" hx-trigger="click" hx-target="this" hx-swap="outerHTML" class="acms-text-center">
 <input type="hidden" name="bid" value="1">
 <input type="hidden" name="cid" value="7">
 <input type="hidden" name="tpl" value="/include/htmx/headline.html">
 <input type="hidden" name="page" value="{forwardPage}">
 <p class="acms-text-center">
  <input type="submit" name="ACMS_POST_2GET" value="次の{forwardNum}件へ"
  class="acms-btn acms-btn-primary acms-btn-large">
 </p>
</form><!-- END forwardLink -->
<!-- END pager:veil -->

tpl を利用する際の private/cofig.system.yaml 設定

設定を全体を解除する(非推奨)

forbid_tpl_url_context: off

設定を部分的に解除する(推奨)

forbid_tpl_url_context: on
allow_tpl_path: [include/htmx/headline.html]

テンプレートファイルの html チェック

拡張子が .html のファイルが HTML フォーマットでない場合に 404 エラーを返す設定を無効にします。これは、a-blog cms が部分的な HTML を読み込めるようにするために必要です。

html_format_validate: off

続きを読み込む際の HTML で気を付けること

モジュールを <ul><li>〜</li></ul> で読み込む設定をすると、複数の <ul> タグが生成されることがあります。<li>〜</li> 部分だけを読み込み、全体として1つの <ul> タグで済むようなマークアップを心がけましょう。

_top.html

<h2 class="section-heading acms-text-center">お知らせ</h2>
<div class="module-section">
	<ul class="headline headline-1col acms-list-group clearfix" aria-labelledby="layout-top_headline">
	@include("/include/htmx/headline.html")
	</ul>
</div>

include/htmx/headline.html

<!-- BEGIN_MODULE Entry_Headline id="headline_news" -->
@include("/admin/module/setting.html")
<!-- BEGIN entry:loop -->
  <li class="headline-item {entry:loop.class}">
   <!-- BEGIN url#front --><a href="{url}" class="acms-list-group-item headline-link"><!-- END url#front -->
   <time class="headline-dat" datetime="{date#Y}-{date#m}-{date#d}">{date#Y}年{date#m}月{date#d}日( {date#week} )</time>
   <!-- BEGIN category:veil --><span class="acms-label">{categoryName}</span><!-- END category:veil -->
   <span class="headline-title">{title}</span><!-- BEGIN new --><span class="acms-label acms-label-danger">NEW</span><!-- END new -->
   <!-- BEGIN url#rear --></a><!-- END url#rear -->
  </li><!-- END entry:loop -->
  <!-- BEGIN pager:veil -->
  <li>
   <!-- BEGIN forwardLink -->
   <form hx-post="" hx-ext="ajax-header" hx-trigger="click" hx-target="this" hx-swap="outerHTML"
    class="acms-text-center">
    <input type="hidden" name="bid" value="1">
    <input type="hidden" name="cid" value="7">
    <input type="hidden" name="tpl" value="/include/htmx/headline.html">
    <input type="hidden" name="page" value="{forwardPage}">
    <p class="acms-text-center">
     <input type="submit" name="ACMS_POST_2GET" value="次の{forwardNum}件へ"
      class="acms-btn acms-btn-primary acms-btn-large">
    </p>
   </form><!-- END forwardLink -->
  </li>
  <!-- END pager:veil -->
<!-- END_MODULE Entry_Headline -->

波括弧を展開しない (@verbatim)

a-blog cms のテンプレートエンジンでは変数に波括弧を使用しているため、JavaScriptなどの波括弧とぶつかってしまい、そのままでは正常にJavaScriptが動作しません。 JavaScriptを正常に動作させるためには、波括弧をバックスラッシュでエスケープする必要があります。

<div id="app">
  \{\{ message \}\}
</div>

@verbatimブロック

テンプレートの広い箇所でJavaScript変数を表示する場合は、 HTMLを @verbatim ブロックで囲めば、波括弧を1つ1つをバックスラッシュでエスケープする必要がなくなります。

Ver. 2.10.8 で追加

@verbatim
<div id="app">
{{ message }}
</div>
@endverbatim