Sobre los frameworks de Oxygen y las características específicas de ediarum

El proceso básico de configuración a través de los llamados “Frameworks” se encuentra en la documentación de Oxygen. Ediarum proporciona algunos módulos estándares para esta configuración.

Componentes de framework

En el framework, la interfaz de usuario de Oxygen para su proyecto de Oxygen está definida con su modelo de datos (estructura de documentos XML), si es necesario para diferentes tipos de documentos (por ejemplo cartas, manuscritos, cuadernos). Esta interfaz de usuario incluye los siguientes elementos:
  • Plantillas para nuevos documentos, para que los editores y editoras no tengan que construir la estructura XML “desde cero” (plantilla XML).
  • El contenido XML de la pestaña “Author” tiene un diseño fácil de leer, es decir, una interfaz de escritura del tipo “What-you-see-is-what-you-get”, para que los editores y editoras no tengan que escribir directamente en XML y puedan revisar el texto de forma clara y cercana a la publicación.
  • Botones y acciones en la barra de herramientas, para que los editores y editoras puedan insertar elementos XML y valores de atributos con un clic y en campos de entrada sin tener que conocer los elementos XML necesarios.
  • Si es necesario, escenarios de transformación (“Transformation Scenario”) que proporcionan diferentes diseños de publicación, por ejemplo para correcciones.
En su propio framework extendido puede configurar elementos personalizados para la interfaz de usuario de Oxygen.

Componentes de configuración

El framework se compone de una colección de archivos. Algunos aspectos de la configuración se realizan directamente en los archivos, para otros se utiliza el cuadro de diálogo Document type.
Tabla 1. Componentes de configuración
Componente Almacenamiento Modificación
¿Qué puede configurar? ¿Dónde almacena Oxygen XML Author sus configuraciones? ¿De qué manera se pueden cambiar las configuraciones?
Definición de esquema Documento esquema de XML (Requisitos de estructura) Archivo RNG Editar el archivo RNG
Plantilla Plantilla para nuevos documentos XML Archivo XML Editar el archivo XML
Funcionalidades de la GUI Elementos y funcionalidades de la GUI que Oxygen XML Author proporciona en el modo “Author” Archivo FRAMEWORK En la pestaña Author de la ventana Document type: Options > Preferences > Document Type Association, seleccione el framework correspondiente

Las características específicas de ediarum para la configuración a través del framework

Estructura de derivación: ediarum.BASE.edit trabaja con el modelo de datos del DTA-Basisformat (“formato básico del DTA”, un subconjunto de XML-TEI) y lo extiende en algunos puntos. Para su propio proyecto editorial extiende el modelo de datos de ediarum.BASE.edit. Por lo tanto, el modelo de datos de su proyecto editorial al final contiene diferentes partes genéricas que se derivan unas de otras: DTA-Basisformat > ediarum.BASE.edit > partes de la definición de esquema específicas del proyecto. Según esta estructura de derivación en el modelo de datos, los frameworks también se derivan uno del otro.

Nombres de archivos y estructuras de carpetas: ediarum sigue sus propias convenciones para nombrar y almacenar los archivos de configuración, entre otras cosas para permitir la entrega fácil de un framework. Es recomendable utilizar la estructura y el contenido de la carpeta ediarum.BASE.edit como guía.

Las “operaciones” de Oxygen: Las funcionalidades de la GUI esencialmente se componen de las llamadas “Operations”, es decir, módulos de comandos a partir de los cuales puede montar su propias funciones y adaptarlas a su edición mediante parámetros. Hay operaciones que son proporcionadas por Oxygen XML Author y aquellas que han sido programadas y proporcionadas especialmente para ediarum. El archivo ediarum.jar contiene las operaciones específicas de ediarum que puede utilizar.

“Editor Variables” de Oxygen: Las operaciones proporcionadas por Oxygen XML Author y por ediarum y algunos otros componentes de configuración pretenden ser simples y reutilizables de muchas maneras. Por lo tanto, siempre que se requiere información específica al contexto, se utilizan marcadores de posición (variables) en lugar de valores concretos, por ejemplo para el nombre del proyecto y la ruta del archivo, de la carpeta y de la URL. Los valores de las llamadas “Editor Variables” se definen una vez en un lugar central. Para la configuración específica de su edición, debe indicar los valores de las variables de editor específicas del proyecto y, si es necesario, crear sus propias variables de editor, por ejemplo para tipos de registro adicionales. Se recomienda continuar de forma coherente con las convenciones de denominación de las variables de editor existentes.