Control de la calidad del contenido en el editor web
Este artículo ofrece una descripción general de las posibilidades de validación dentro del editor web de AEM Guides.
Al diseñar, el editor web aprovecha la configuración de esquema DITA en el sistema para obligar a los usuarios a crear contenido compatible con DITA. Con esto, todo el contenido almacenado en el sistema es contenido DITA estructurado, reutilizable y válido.
Más allá de la compatibilidad con las reglas DITA, el editor web también admite la validación de contenido basado en reglas de "Schematron".
"Schematron" hace referencia a un lenguaje de validación basado en reglas que se usa para definir pruebas para un archivo XML. Puede importar los archivos de Schematron y también editarlos en el Editor Web. Con un fichero "Schematron" se pueden definir determinadas reglas y, a continuación, validarlas para un tema DITA o un mapa. Las reglas de Schematron pueden garantizar la coherencia de la estructura XML mediante la imposición de restricciones definidas como reglas. Estas restricciones están impulsadas por PYME que son propietarias de la calidad y coherencia del contenido.
NOTA: el editor web admite el Esquemas ISO.
Saber cómo funciona "Schematron" en el editor web
Configuración de reglas de Schematron
Consulte la sección "Compatibilidad con archivos de Schematron" en la Guía del usuario
Aplicar reglas de validación al guardar el archivo
La configuración de Editor web permite a los usuarios avanzados configurar las reglas o archivos de Schematron que se ejecutarán cada vez que un usuario actualice el contenido. Para obtener más información, consulte la sección "Validación" en Guía del usuario
¿Puede ejecutar la validación manualmente?
Sí, como autor/usuario mientras crea contenido, puede utilizar el panel Schematron en el editor web para cargar un archivo schematron y ejecutar validaciones en el archivo abierto en el editor.
Para que esto funcione, el administrador de perfiles de carpeta debe permitir que todos los usuarios agreguen archivos Schemtron en el panel Validación. Consulte la configuración del editor (captura de pantalla anterior)
Reglas compatibles
La versión actual de AEM Guides admite la validación mediante reglas basadas en la "Afirmación" únicamente. (ver recurso vs. informe)
Aún no se admite ninguna regla basada en "Informes".
Ejemplos y más ayuda sobre las reglas de Schematron
Ejemplos de uso
-
Compruebe si un vínculo es externo y si tiene un ámbito "externo"
code language-none <sch:pattern> <sch:rule context="xref[contains(@href, 'http') or contains(@href, 'https')]"> <sch:assert test="@scope = 'external' and @format = 'html'"> All external xref links must be with scope='external' and format='html' </sch:assert> </sch:rule> </sch:pattern> -
Compruebe si hay al menos una "referencia de tema" en un mapa o al menos una "li" debajo de una "ul"
code language-none <sch:pattern> <sch:rule context="map"> <sch:assert test="count(topicref) > 0"> There should be atleast one topicref in map </sch:assert> </sch:rule> <sch:rule context="ul"> <sch:assert test="count(li) > 1" > A list must have more than one item. </sch:assert> </sch:rule> </sch:pattern> -
El elemento "indexterm" siempre debe estar presente en un "prólogo"
code language-none <sch:pattern> <sch:rule context="*[contains(@class, ' topic/indexterm ')]"> <sch:assert test="ancestor::node()/local-name() = 'prolog'"> The indexterm element should be in a prolog. </sch:assert> </sch:rule> </sch:pattern>
Recursos
- Explicación de conceptos básicos de Schematron
- Más información sobre Reglas de afirmación en Schematron
- Archivo de Schematron de muestra