Compatibilidad con archivos de Schematron

"Schematron" hace referencia a un lenguaje de validación basado en reglas que se utiliza para definir pruebas para un archivo XML. El editor admite archivos de Schematron. Puede importar los archivos de Schematron y también editarlos en el Editor. Con un fichero de Schematron se pueden definir determinadas reglas y, a continuación, validarlas para un tema DITA o un mapa.

Importación de archivos de Schematron

Siga estos pasos para importar los archivos de Schematron:

Validación de un tema o asignación DITA con Schematron

Después de importar los archivos de Schematron, puede editarlos en el Editor. Puede utilizar los ficheros de Schematron para validar los temas o un mapa DITA. Por ejemplo, se pueden crear las reglas siguientes para un tema o mapa DITA:

Cuando se abre un tema en el Editor, aparece un panel de validación de Schematron a la derecha. Realice los siguientes pasos para agregar y validar un tema o asignación con un archivo de Schematron:

{width="350"}

La compatibilidad con Schematron en el Editor le ayuda a validar los archivos con un conjunto de reglas y a mantener la coherencia y la corrección en todos los temas.

Comprender los resultados de validación y los niveles de gravedad

Los resultados de validación se muestran según el atributo de función definido en el archivo Schematron. Los problemas se clasifican en Fatal, Error, Warn o Info, con un recuento visible para cada categoría en el panel Validación.

{width="350"}

Para determinar la gravedad de un problema, se evalúa el valor que distingue entre mayúsculas y minúsculas del atributo role definido en el archivo Schematron correspondiente.

El siguiente fragmento muestra los valores de atributos de función admitidos definidos en una regla de Schematron:

Si no se especifica el atributo de rol o si se usa un valor no admitido, el problema se clasifica como Error en el panel Validación. Este comportamiento también se aplica a los archivos de Schematron existentes que no definen un atributo de función; en estos casos, todos los problemas se agrupan en Error.

Escenarios de guardado de archivos

Guardar un archivo depende de la comprobación de validación antes de guardar el archivo en configuración de Workspace:

Usar instrucciones de aserción e informe para comprobar las reglas schematron-assert-report

Experience Manager Guides también admite las instrucciones de aserción e informe de Schematron. Estas instrucciones le ayudan a validar los temas DITA.

Instrucción Assert

Una instrucción assert genera un mensaje cuando una instrucción de prueba se evalúa como false. Por ejemplo, si desea que el título aparezca en negrita, puede definir una instrucción assert para él.

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

Cuando se validan los temas DITA con Schematron, aparece un mensaje para los temas en los que el título no aparece en negrita.

Declaración de informe

Una instrucción de informe genera un mensaje cuando una instrucción de prueba se evalúa como verdadera. Por ejemplo, si desea que la descripción breve tenga menos de 150 caracteres o menos, puede definir una instrucción de informe para comprobar los temas en los que la descripción breve tenga más de 150 caracteres.
Al validar los temas DITA con Schematron, se obtiene un informe completo de las reglas en las que la sentencia de informe se evalúa como true. Por lo tanto, recibe un mensaje para los temas en los que la descripción breve tiene más de 150 caracteres.

<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>

Uso de expresiones Regex schematron-regex-espressions

También puede utilizar expresiones Regex para definir una regla con la función matches() y luego realizar la validación mediante el archivo Schematron.

Por ejemplo, puede utilizarlo para mostrar un mensaje si el título contiene solo una palabra.

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

Definir patrones abstractos schematron-abstract-patterns

Experience Manager Guides también admite patrones abstractos en Schematron. Puede definir patrones abstractos genéricos y reutilizarlos. Puede crear parámetros de marcador de posición que especifiquen el patrón real.

El uso de patrones abstractos puede simplificar el esquema de Schematron al reducir la duplicación de reglas y facilitar la administración y actualización de la lógica de validación. También puede facilitar la comprensión del esquema, ya que puede definir una lógica de validación compleja en un único patrón abstracto que se puede reutilizar en todo el esquema.

Por ejemplo, el siguiente código XML crea un patrón abstracto y, a continuación, el patrón real hace referencia a él mediante el identificador.

<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>