Documentación

• Idioma (campo LAN)

Este campo hace referencia a la tabla de idiomas y define el idioma en el que está escrita la documentación.

• Tipo de doc. (campo TYP)

Este campo define el tipo de documentación. Cada tipo está asociado a un tipo de elementos documentados (documentación funcional que describe una ficha del diccionario, o valores de parametrización varios que describen la estructura del diccionario).

Cuando un tipo de documentación corresponde a un código de objeto, se crea automáticamente una entrada de Documentaciónen la barra de menú del objeto correspondiente. En ese momento, se pueden documentar las fichas introducidas en el objeto correspondiente. Por este motivo, el código de la ayuda funcional es AFC (código del objeto Funciones), el código de la ayuda de los parámetros generales es ADP (código del objeto Parámetros), etc.

Las reglas para nombrar las documentaciones se encuentran en una documentación anexa.

• Código (campo COD)

Este campo define el código de la documentación. Por norma general, corresponde al código de la ficha (función, parámetro, etc.) que está documentando. Las reglas para nombrar las documentaciones se encuentran en una documentación anexa.

• Nivel (campo LEV)

Este nivel establece una jerarquía en los párrafos. El primer párrafo de un nivel se encuentra en el índice principal (salvo si es de tipo MIN).

• Subnivel (campo SUBLEV)

Este subnivel establece una subjerarquía en los párrafos. Cuando hay más de un subnivel por nivel de documentación, se establece un índice secundario en el primer subpárrafo de un nivel para mostrar los vínculos a los siguientes subpárrafos (salvo si el subpárrafo es de tipo MIN).

• Párrafo (campo PAR)

El código de párrafo determina cómo se genera el párrafo en el documento final. Puede ser una simple copia del texto o una generación más sofisticada en función del diccionario. Una documentación anexa detalla los códigos de párrafo que se pueden utilizar en función del tipo de documentación.

• Pantalla (campo MSK)

Cuando se introduce un código de pantalla en este campo, un icono que aparece en la descripción del párrafo de la documentación generada permite desplegar una sección con la lista de campos de la pantalla y la ayuda en campo asociada. Se recomienda utilizar un estilo de párrafo igual a 4 (encabezado en color en el que se muestra el icono para desplegar el campo).

• Descripción (campo TIT)

Este campo es la descripción del párrafo. Si está en blanco, se asigna una descripción por defecto en función del tipo de párrafo (tanto en creación como en modificación).

Si en los párrafos varios que no aparecen en el índice (de tipo MIN) se introduce una descripción con el carácter "!", se desactiva la inserción de la descripción.

• Código actividad (campo CODACT)

Un código de actividad, heredado del diccionario en el momento de la regeneración, que permite sobre todo distinguir entre las fichas estándar y específicas, pero también crear documentaciones adaptadas a dosieres dados generando únicamente los párrafos y la documentación correspondiente a los códigos de actividad activadas en el dossier. El código de actividad FAL (siempre falso) siempre se reconoce de forma particular: un párrafo marcado con este código nunca es tenido en cuenta por el tratamiento de generación, incluso si se solicita una generación completa. Esto permite desactivar los párrafos generados que no se desea encontrar en una documentación.

• Módulo (campo MODULE)

Módulo del párrafo de la documentación.

• Estilo (campo STY)

El estilo hace referencia a un valor numérico que corresponde a una etiqueta "H1","H2,"H3", etc., según el número elegido. Si este campo está en blanco, su valor por defecto es 3. En los subpárrafos, se recomienda utilizar 4, 5 o 6, según el nivel. El 4 se muestra en un encabezado: aparece un icono que proporciona acceso a las ayudas en campo cuando el párrafo tiene una pantalla asociada.

• Prioridad traducción (campo PRIO)

• Grupo propietario (campo CREGRP)

Este campo permite mostrar el grupo que ha creado la documentación correspondiente.

Solo está disponible en los entornos en los que se ha implementado esta noción. Corresponde a los entornos que contienen el parámetro de usuario GRPDEV.

Nota: Si el grupo del usuario es distinto al grupo propietario de la tabla AOBJGRPDEV, el grupo aparece en rojo.

• Validación (campo VLDDAT)

Es la fecha en la que la ficha se ha considerado como válida.

• campo VLDFLG

Este indicador significa que la ficha se ha considerado como válida.

• campo TEXTE

Este campo permite introducir el texto del párrafo tal y como se va a mostrar en la documentación final. Hay algunos casos particulares:

• Algunos párrafos no se muestran por completo. Suele ser el caso de los párrafos de descripción, que contienen una lista de palabras clave insertadas en el código HTML de la documentación (campo Keywords).
• Algunos párrafos se generan a partir del diccionario. El texto introducido es complementario (antes o después del texto generado, según el caso) y no suele ser obligatorio.
• En las documentaciones de tipo APM (índice de documentaciones relativo a niveles de menú), el texto introducido se interpreta como una lista de vínculos adicionales a las documentaciones correspondientes (se generan los vínculos automáticos).