アプリケーションのレイアウト

Aceアプリケーションを開いた最初の画面には、次の 4 つの重要な領域があります。

1. アプリケーションの上部にはメニュー バーがあり、そこからアプリケーションのすべての主要機能にアクセスできるほか、Aceに関する重要な情報や使用方法にもアクセスできます。
2. メニュー バーの下の左側には、クイック アクセス バーがあります。最初は、パッケージ化された EPUB出版物を評価するオプション[EPUB をチェック]と、Aceのデフォルト設定の一部を変更する機能[設定]のみが利用可能です。出版物が検証されると、[再実行]および[書き出す]オプションが利用可能になります。
3. クイック アクセス バーの右側には結果領域があります。ただし、アプリケーションを初めて起動したときは、ファイルとフォルダーをその領域にドラッグ アンド ドロップして検証を実行できるというメッセージのみが表示されます。
4. 最後に、アプリケーションの下部にはメッセージ コンソールがあります。Ace が評価を実行すると、実行中の操作に関するさまざまなメッセージがこの領域に出力されます。一般的に、コンソールのメッセージが重要になるのは、Aceが内部の問題に遭遇したときだけです。エラーには、何が問題だったかに関する有用な情報が含まれている場合があり、バグを報告する際に役立つことがあります。

アプリケーション言語

Aceアプリケーションを初めて実行すると、デフォルトの言語として英語が表示されます。ただし、アプリケーションはローカライズ可能なため、インターフェースとメッセージは、日本語、デンマーク語、韓国語、フランス語などの別の言語に変更できます。サポートされている言語の完全なリストについては、 epubcheck transifex ローカライズ プロジェクトを参照してください。

インターフェースを変更するには、アプリケーションの左側にあるクイックリンクの「設定」ボタンをクリックします。

アプリケーションの設定を変更するための新しいダイアログ ウィンドウが開きます。

ダイアログの下部にある[言語]セクションからアプリケーションの新しい言語を選択し、[保存] ボタンをクリックします。Aceインターフェイスは新しい言語に自動的に更新され、次にプログラムを開いたときに新しい設定が保持されます。

ファイルとフォルダのチェック

AceでEPUBファイルまたはフォルダのチェックを開始するには、次の4つの方法があります。

1. ファイルまたはフォルダを結果領域にドラッグ アンド ドロップできます。
2. 結果領域のリンクからファイルまたはフォルダを選択できます。
3. クイック アクセス バーの「EPUB をチェック」のリンクからファイルを選択できます。
4. アプリケーションの上部にある [ファイル] メニューから、ファイルまたはフォルダを選択できます。

ドラッグ アンド ドロップ機能を使用するには、出版物を含むファイルまたはフォルダがデスクトップ上にあるか、ディレクトリ ウィンドウで開かれている必要があります。出版物をクリックし、マウス ボタンを押したままにします。これで、Aceアプリケーションにドラッグできるようになります。Aceの表示は、次の画像のように、薄いグレーの点線枠がある濃いグレーの背景に変わります。

マウス ボタンを放してファイルをドロップすると、Aceはチェックを開始します。

チェックを開始するための他のすべての方法では、ファイルまたはフォルダの選択ダイアログを開きます。

出版物を含むファイルまたはフォルダを見つけて選択し、[チェック] ボタンをクリックして評価を開始します。

評価レポート

Aceが評価を完了すると、以下のタブの情報が記載されたレポートが表示されます。

• 概要— 概要タブはデフォルトで表示され、問題の種類と深刻度ごとに、個別の数と合計数が記載されます。
• 違反— 違反タブには、修正が必要な各問題が一覧表示されます。
• メタデータ- メタデータタブには、レビューできるように、出版物で見つかった関連するパッケージメタデータが一覧表示されます。
• アウトライン— アウトライン タブには、出版物の目次と見出し構造が表示されます。
• 画像— 画像タブには、出版物にある画像とその代替テキストおよび説明 (認識可能な場合) が表示されます。

次のセクションでは、これらの各タブについて詳しく説明します。

レポート概要

概要表は、最初の列 (y 軸) に違反のタイプ、最初の行 (x 軸) に違反の深刻度を一覧表示する表です。結果として、表の各値は、1 つのタイプと深刻度の問題の数を表します (たとえば、グリッドの最初の数字は、致命的な WCAG 2 レベル A 違反を表します)。

表の最後の行と列には、問題の種類と深刻度ごとの合計数が表示され、一番最後の行と列の数字は、見つかった違反の合計数を表します。

Ace は現在、WCAG 2 レベル A [wcag2a]、WCAG 2 レベル AA [wcag2aa]、および EPUB アクセシビリティ規格 [EPUB] の特定の要件に対する 3 つのタイプの違反を報告します。また、違反ではなく改善の可能性に関する推奨事項である[ベストプラクティス]も特定し、特定のカテゴリに当てはまらないメッセージには[その他]カテゴリがあります。

深刻度の分類は、違反がユーザーに与える影響を示すためのものです。ただし、分類は情報提供のみを目的としており、ユーザビリティを確保するには、記載されている深刻度に関係なく違反を修正する必要があります。

概要表は、出版物内の違反の全体像を把握する上で役立ちますが、違反の内容や修正方法に関する有用な情報は提供されません。そこで、 [違反] タブが役立ちます。

違反

Aceの[違反]タブには、出版物で見つかったすべての問題に関する詳細情報を示す表が表示されます。

表の最初の 2 つの列は、メッセージの深刻度 [影響] と問題を定義する規格 [ルールセット] を示します。

次の列 [ルール] は、ルールの短縮名と、それが Ace によって定義されているか、または基礎となる axe バリデーターによって定義されているかを示します。このフィールドは同じタイプの問題を並べ替えるのに役立ちますが、短縮名を理解する必要はありません。短縮名はプログラムが使用する内部分類システムの一部です。

[位置]列には、問題がどこにあるのかの詳細が表示されます。ファイル名と EPUB　Canonical Fragment identifierで構成されます。Canonical Fragment identifier（フラグメント識別子）の読み取りは簡単な作業ではないため、問題のあるマークアップのスニペットも含まれています。ファイルを開いてタグ付けを検索する方が、フラグメント識別子をたどるよりも通常は早いです。(フラグメント識別子は、Aceの将来のバージョンで編集をサポートするために使用される可能性があります。)

最後に、[詳細] 列には、問題の解決方法に関する情報が表示されます。問題の正確な解決策は機械では判断できない場合や、複数の解決策が考えられる場合があるため、[詳細] 列には多くの提案が含まれることがあります。

表の各列ヘッダーで違反を並べ替えることができるだけでなく、表の上部に絞り込みもできます。[絞り込み] ラベルをクリックすると、次のオプションが展開されます。

表の並べ替えと絞り込みの違いは、絞り込みをすると選択した条件に一致するメッセージのみが残ることです。たとえば、[影響]絞り込みリストから「致命的」を選択すると、致命的な違反を除くすべての違反が非表示になります。

メタデータ

メタデータタブは、アクセシビリティの問題を手動で評価するために Ace が提供する3つのレビュータブのうちの最初のタブです。このタブには、パッケージドキュメントにある出版物に関する主要なメタデータが一覧表示されます。

メタデータの表は3つの列で構成されます。最初の列はプロパティの名前を示し、2番目の列はプロパティの値を示し、3番目の列はアクセシビリティ メタデータ プロパティであるかどうかを示します。

さらに、アクセシビリティ メタデータ プロパティが含まれていない場合は、これらは表の下に一覧表示されます。

不足していると記載されているアクセシビリティ メタデータを必ず含める必要はありません。必須および推奨されるメタデータのリストについては、EPUBアクセシビリティ規格を参照してください。

メタデータ タブの下部には、アクセシビリティ メタデータを編集し、出版物を再保存するためのボタンがあります。

[編集]ボタンをクリックすると、新しいダイアログが開き、アクセシビリティ メタデータ プロパティを編集／追加するためのフィールドが表示されます。

ダイアログでメタデータを変更して保存した後、[保存する(zip / EPUB)] ボタンをクリックすると、新しくパッケージ化された EPUB ファイルを生成できます。Ace がコンテンツをパッケージ化した後、ファイルを含むフォルダーが新しいウィンドウで開きます。

アウトライン

アウトライン タブでは、目次、マークアップの見出し構造、 HTML アウトラインで表される出版物の構造を並べて比較できます。

これらのアウトラインを比較して、修正が必要な矛盾点 (HTMLタグが目次の見出しのレベルと一致していない場合や、目次に一覧表示されている項目に見出しタグが使用されていない場合など) がないか確認できます。

注記

HTMLアウトラインは、ブラウザや支援技術では実装されていません。混乱を引き起こすことがあるため、今後のリリースでAceから削除される可能性があります。

画像

画像タブには、出版物にあるすべての画像への参照が表示されます。

表の最初の列には画像が表示され、2 番目の列には代替テキストの値 ( alt属性値) が表示されます。

aria-describedby属性を使用して拡張説明が提供されている場合、参照されるコンテンツの値が3番目の列に表示されます。

画像がfigureタグ内にある場合、図表のキャプションの値は4番目の列に表示されます。

出版物内で画像が配置されている場所は5番目の列に示され、ARIAロールが画像に関連付けられている場合は最後の列に示されます。

この情報は画像を評価する上で役立ちますが、手動による検査が必要になることもよくあります。画像を適切に説明する方法は、Ace が現在表示または検出できる方法よりもたくさんあります (たとえば、画像が周囲のテキストで説明されている場合や、 aria-details属性によって関連付けられている場合もあります)。

レポートの書き出し

Aceには、クイックリンクまたはメニュー バーから検証レポートを書き出すオプションがあります。このオプションを選択すると、Ace は次のファイルとフォルダーを含む ZIP ファイルを生成します。

• report.html — レポート タブの HTML バージョン。
• report.json — レポート情報を含む JSON でエンコードされたファイル。
• data — 出版物から抽出されたデータ (画像など) を含むオプションのフォルダー。

レポートを書き出す主な理由の1つは、 SMART ツールで新しい評価を開始することです。Ace から書き出されたJSONファイルは、手動評価フォームに事前入力するために使用されます。

評価を書き出すもう1つの理由は、ブラウザで開くためです。場合によっては、アプリケーションよりもHTMLバージョンの方が使いやすいことがあります。

レポートの再実行

Ace には、クイック リンクまたはメニュー バーからレポートを再実行するオプションが用意されていますが、このオプションはプログラムが作成した一時ファイルに対してのみ実行されます。たとえば、メタデータ タブのエディターを使用してアクセシビリティ メタデータが変更された場合は、更新された出版物に対して再実行できます。

エースを呼び出す

EPUBCheck ツールと同様に、Aceもコマンド ライン インターフェイスから実行できるため、自動化されたワークフローに統合できます。グラフィカル インターフェイスを経由せずにHTML レポートを出力してブラウザーで開くことができるため、コマンド ラインを好むユーザーもいます。

コマンドラインからAceを呼び出す最も簡単な方法は、検証するファイルまたはフォルダの名前のみを指定することです。ただし、この方法で呼び出すと、プログラムのすべての出力 (処理メッセージと最終的なJSONレポート) がコマンドラインに書き戻されます。次の例は、数百行に及ぶことが多い出力の一部を示しています。

> ace accessible_epub_3.epub
info:    Processing C:\epubs\accessible_epub_3.epub
info:    Checking package...
info:    - EPUB\package.opf: No issues found
...
info:    Consolidating results...
{
  "dct:title": "Ace Report",
  "dct:description": "Report on automated accessibility checks for EPUB",
  ...
}
info:    Done.

より一般的なAceを呼び出す方法は、JSONレポートと HTMLレポートの両方が保存されるように出力ディレクトリを含めることです。--outdir引数が設定されている場合、Aceは指定された場所にレポートを出力します。たとえば、 ace_reportという新しいフォルダーにファイルを出力するには、次のようにAceを呼び出すことができます。

> ace accessible_epub_3.epub --outdir ace_report

ただし、出力ディレクトリのフルパスを指定しないと、コマンド ライン インターフェイスが現在配置されている場所を基準にしてディレクトリが作成されることに注意してください。(ディレクトリの変更方法については、EPUBCheck ページを参照してください。)

出力ディレクトリが指定されている場合、Ace は処理メッセージのみをコマンド ラインに書き込みます。最後にJSONレポートを出力する代わりに、JSONおよびHTMLレポート ファイルが正常に保存されたことが記録されます。

info:    Consolidating results...
info:    Copying data
info:    Saving JSON report
info:    Saving HTML report
info:    Done.

引数

次のリストは、Aceを呼び出すために使用される最も一般的な引数を示しています。完全なリストを表示するには、引数を指定せずにコマンド ラインからAceを実行します。

出力ディレクトリ ( --outdirまたは-o )

前のセクションで説明したように、コマンド ラインからAceを実行すると、出力ディレクトリ引数を使用してレポート ファイルを書き込む場所が示されます。

> ace accessible_epub_3.epub -o ace_report

出力を強制する ( --forceまたは-f )

force引数は、既存のレポート ファイルを上書きするために使用されます (たとえば、問題を修正した後にAceを再度実行する場合など)。

> ace accessible_epub_3.epub -o ace_report -f

すでにレポート ファイルが含まれている出力ディレクトリが指定されている場合は、誤ってデータが削除されるのを防ぐために、この引数を指定しない限り、Aceは実行されません。

詳細出力 ( --verboseまたは-V )

詳細出力引数は、Aceが実行している検証アクションに関するより詳細な情報を提供します。これは通常、プログラムの潜在的な問題をデバッグするために使用されます（たとえば、検証中にAceがクラッシュした場合、詳細出力を使用すると、どこで、なぜクラッシュしたかについて、より有用な情報を明らかにできる場合があります）。

> ace accessible_epub_3.epub --verbose

引数の省略形は大文字の「V」であることに注意してください。小文字の「v」を指定すると、Ace のバージョンが出力されます。

verbose引数は、Aceがコマンド ラインに書き込むメッセージにのみ影響します。JSONまたはHTMLレポートの情報には影響しません。

サイレント出力 ( --silentまたは-s )

サイレント出力オプションは、詳細引数の反対です。つまり、Ace が通常出力するすべての情報メッセージ (つまり、 info:プレフィックスで始まるメッセージ) を抑制します。

> ace accessible_epub_3.epub -s

このオプションは深刻なエラーを抑制しません。Aceがパブリケーションの検証中に問題に遭遇した場合、エラーはコマンド ラインに出力されます。

silent引数は、Aceがコマンド ラインに書き込むメッセージにのみ影響します。JSON またはHTMLレポートの情報には影響しません。