導入と設定の手順
このページでは、CMS版の アクセシビリティ検査 の有効化、チェックシートの表示、記録の保存先、更新確認の手順を説明します。
事前に準備するもの
- a-blog cms の管理画面にログインし、拡張アプリを有効化できるアカウント
- 配布ファイルと同梱の導入案内
- サイトの設定ファイル・テーマを編集できる担当者
更新する場合は、現在のファイルとデータベースをバックアップし、検証環境で確認してから本番環境へ反映します。
1. 拡張アプリを有効化する
- 配布ファイルを、同梱の導入案内に従って設置します。
- a-blog cms の管理画面にログインします。
- 検査全体を管理するブログで、拡張アプリ アクセシビリティ検査 を有効化します。
- 管理画面の アクセシビリティ検査 を開きます。
- 上段に並ぶ 検査・過去の記録・設定 のメニューを確認します。
検査記録簿・検査員・資料は統合アプリから起動します。それぞれを別の拡張アプリとして有効化する必要はありません。
2. チェックシートを表示する
設定 → 基本設定 → 検査記録簿チェックシート表示設定 を開き、「各ページの達成基準チェックシートを有効にする」を選んで 設定を保存 を押します。ページの編集画面で、達成基準ごとの結果・確認方法・注記を入力するための設定です。エントリーの編集画面に表示するには、サイトの設定・テーマにも次の準備が必要です。
config.server.php でフックを有効化します。
define('HOOK_ENABLE', 1);
使用テーマの admin/entry/field.html に、次の記述を追加します。
以前のエントリー用挿入モジュールの記述がある場合は、この1行に置き換えます。アプリを停止している間も、保存済みのチェック結果を保持するための記述です。
アプリを有効化したブログで、ブログ・カテゴリーにもチェック欄を置く場合は、admin/blog/field.html と admin/category/field.html に次の挿入モジュールを追加します。
<!-- BEGIN_MODULE Admin_InjectTemplate id="a11y-flow-field" --><!-- END_MODULE Admin_InjectTemplate -->
子ブログでエントリーのチェック欄・検査員を使う場合は、配布ZIPの README.md にある「子ブログのチェック欄・検査員を親で管理する」を設定します。子ブログで別途アプリを有効化する必要はありません。
設定後、対象ページのエントリー編集画面を開き直し、チェックシートが表示されることを確認します。チェックを外して保存すると非表示になりますが、保存済みの確認結果は削除されません。公開ページの検査員の表示とは別の設定です。
試験の対象レベル(A・AA・AAA)は 検査 → 試験実施:環境 で設定します。
3. 過去の記録の保存先を設定する(任意)
過去の検査や作業途中の記録を残す場合に設定します。保存先を用意しなくても、通常の検査・作業の保存・帳票作成は利用できます。
- 配布ZIPの
themes/a11y-workflow/を、CMS設置先のthemes/に配置します。 - 検査全体を管理するブログの配下に、記録保存用の子ブログを作り、非公開にします。
- 保存先の子ブログだけに
a11y-workflowテーマと付属のtemplate.yamlの指定を適用します。通常サイトのテーマは変更しません。 - 保存先のバージョン管理と承認機能を無効にします。履歴は追加するたびに別の記録として保存されます。
- 検査全体を管理するブログに戻り、設定 → 基本設定 → 過去の記録保存先設定 で子ブログを選び、設定を保存 を押します。
元のブログと保存先の設定を閲覧する権限、保存先のエントリーを編集する権限が必要です。候補が選べない場合は、子ブログの所属・非公開設定・アクセス権限を確認します。
過去の記録を追加・参照する
- 検査の各画面と、ページごとのチェックシートで入力を保存します。未保存の変更は履歴に含まれません。
- 検査 → スナップショット を開きます。最新の公開用スナップショットも残す場合は、公開用スナップショットを更新 → スナップショットを保存する の順に押します。
- 同じ画面の 保存記録のタイトル と必要に応じて 概要(任意) を入力し、保存済みの作業を履歴に追加 を押します。
- 上段の 過去の記録 を開き、一覧に追加されたタイトル・保存日時を確認します。タイトルを開くと この記録のJSONを保存 から記録を取り出せます。
通常の保存やスナップショットの保存だけでは、履歴には追加されません。保存済みの作業を履歴に追加 を押すたびに、別の記録として残ります。
記録の内容を詳しく見るときやタイトル変更・削除は、一覧の CMSでタイトル変更・削除 から行います。過去の記録を開いても、現在の検査の入力や判定は置き換わりません。
4. 検査員と資料を確認する
- 設定 → 基本設定 → 検査員設定 で、除外セレクタやパネルの初期状態を確認します。
- ログインした状態で公開ページを開き、検査パネルを確認します。管理画面には表示されません。
- 設定 → 資料・導入手順 → アクセシビリティ資料 から、マニュアル、検査項目事例集、関連リンクなどを開きます。
詳しい操作は検査記録簿の手順と検査員の手順を参照してください。
最新版と変更内容を確認する
- 設定 を開きます。
- 「バージョンとアップデート」で現在のバージョンを確認します。
- アップデートを確認する を押します。
- 表示された更新情報と変更内容を確認します。
- 必要な配布ファイルを入手し、検証環境で確認してから本番環境へ反映します。
画面が開けない・チェック欄が表示されない場合
- a-blog cms にログインできているか確認します。
- 検査全体を管理するブログで アクセシビリティ検査 が有効か確認します。
- 設定の変更や保存先ブログへのアクセスに必要な権限を確認します。
- チェックシート表示の設定、フックの有効化、テーマへの記述を確認します。
- 子ブログの場合は、管理元を参照する連携設定を確認します。