Schematron ファイルのサポート

「Schematron」は、XML ファイルのテストを定義するルールベースの検証言語を指します。 Web エディタは、Schematron ファイルをサポートします。 Schematron ファイルをインポートし、Web エディタで編集することもできます。 Schematron ファイルを使用すると、特定のルールを定義し、DITA トピックまたはマップ用に検証できます。

Schematron ファイルのインポート

Schematron ファイルをインポートするには、次の手順を実行します。

{width="300"}

Schematron を使用した DITA トピックまたはマップの検証

Schematron ファイルをインポートした後、Web エディタで編集できます。 Schematron ファイルを使用して、トピックまたは DITA マップを検証できます。 例えば、DITA マップまたはトピックに対して次のルールを作成できます。

Web エディタでトピックを開くと、右側に「スキーマの検証」パネルが表示されます。 Schematron ファイルを使用してトピックまたはマップを追加および検証するには、次の手順を実行します。
{width="300"}

Web エディタでの Schematron のサポートにより、一連のルールに対してファイルを検証し、トピック全体で一貫性と正確性を維持できます。

assert ステートメントと report ステートメントを使用して、ルールを確認する schematron-assert-report

AEMガイドでは、Schematron の assert 文と report 文もサポートしています。 これらの文は、DITA トピックを検証するのに役立ちます。

Assert 文

assert 文は、test 文が false と評価されると、メッセージを生成します。 例えば、タイトルを太字にしたい場合は、タイトルに assert 文を定義できます。

<sch:rule context="title">
    <sch:assert test = "b"> Title should be bold </sch:assert>
  </sch:rule>

Schematron を使用して DITA トピックを検証すると、タイトルが太字でないトピックに関するメッセージが表示されます。

レポート明細書

テストステートメントが true と評価されると、レポートステートメントはメッセージを生成します。 例えば、短い説明を 150 文字以下にしたい場合、レポート文を定義して、短い説明が 150 文字を超えるトピックを確認できます。
スキーマトロンを使用して DITA トピックを検証すると、レポート文が true と評価されるルールの完全なレポートが取得されます。 短い説明が 150 文字を超えるトピックに関するメッセージが表示されます。

<sch:rule context="shortdesc">
        <sch:let name="characters" value="string-length(.)"/>
        <sch:report test="$characters &gt; 150">
        The short description has <sch:value-of select="$characters"/> characters. It should contain more than 150 characters.
        </sch:report>
    </sch:rule>

正規表現の使用 schematron-regex-espressions

正規表現式を使用して matches() 関数でルールを定義し、Schematron ファイルを使用して検証を実行することもできます。

例えば、タイトルに単語が 1 つしか含まれていない場合は、このフィールドを使用してメッセージを表示できます。

<assert test="not(matches(.,'^\w+$'))">
No one word titles.
</assert>

抽象パターンの定義 schematron-abstract-patterns

AEMガイドは、Schematron の抽象パターンもサポートしています。 汎用の抽象パターンを定義して、これらの抽象パターンを再利用できます。 実際のパターンを指定するプレースホルダパラメータを作成できます。

抽象パターンを使用すると、ルールの重複を減らし、検証ロジックの管理と更新を容易にすることで、Schematron スキーマを簡略化できます。 また、複雑な検証ロジックを単一の抽象パターンで定義し、スキーマ全体で再利用できるので、スキーマを理解しやすくすることもできます。

例えば、次の XML コードは抽象パターンを作成し、実際のパターンは ID を使用して参照します。

<sch:pattern abstract="true" id="LimitNoOfWords">

<sch:rule context="$parentElement">

<sch:let name="words" value="string-length(.)"/>

<sch:assert test="$words &lt; $maxWords">

You have <sch:value-of select="$words"/> letters. This should be lesser than <sch:value-of select="$maxWords"/>.

</sch:assert>

<sch:assert test="$words &gt; $minWords">

You have <sch:value-of select="$words"/> letters. This should be greater than <sch:value-of select="$minWords"/>.

</sch:assert>

</sch:rule>

</sch:pattern>

<sch:pattern is-a="LimitNoOfWords" id="extend-LimitNoOfWords">

<sch:param name="parentElement" value="title"/>

<param name="minWords" value="1"/>

<param name="maxWords" value="8"/>

</sch:pattern>