Guía de estilos

Nomenclatura de la base

Nombres de campo

En minúsculas, con guión bajo como separador de palabras.

Claves primarias

Se nombran con el prefijo id_ y se declaran como autoincrementales:

id_clave

Claves foráneas

Llevan el mismo nombre que la clave primaria a la que referencian, pero con el id al final:

clave_id

Campos comunes entre tablas

Los campos que se repiten en varias tablas —nombre, abreviacion, etc.— llevan el nombre del campo seguido del nombre de la tabla:

campo_nombretabla

Estructura del menú

Cada subsistema organiza sus ítems en cuatro subcategorías:

Subcategoría	Contenido
Ingresos de datos	Ítems que permiten al usuario ingresar datos
Informes	Reportes y consultas
Procesos	Procesos especiales del subsistema
Mantenimiento	Funciones para mantener los datos del subsistema

La estructura de directorios del módulo replica esa misma organización.

• Directoriomodulo/

  • Directorioing/

    • tabla_ing.xml
    • tabla_ins.xml
  • Directorioqry/

    • tabla_qry.xml
  • Directorioproc/

    • Directoriotabla_proc.xml -man/

      • …
    • tabla_crud.xml

Formato de los XML

Codificación

Se usa UTF-8, declarado en la primera línea del archivo:

<?xml version="1.0" encoding="UTF-8" ?>

Precaución

La declaración debe escribirse encoding="UTF-8", con guión. La variante UTF8 la aceptan libxml2 y el motor, pero rompe el tooling escrito en Python: los scripts saltean el archivo y el error que reportan apunta a la primera vocal acentuada, no a la declaración.

Ejemplo de XML básico

<?xml version="1.0" encoding="UTF-8" ?>
    <histrix tipo="consulta">
        <title>titulo</title>
        <obs></obs>
        <form>
            <table id="SISTEMA_NOMBRE_TABLA" label="etiqueta">
                 <field id="id_campo" >
                       <label>Etiqueta</label>
                       <help>Ayuda contextual</help>
                 </field>
            </table>
        </form>
    </histrix>

Tags del ejemplo

Tag	Función
<histrix>	Primer tag del contenido; su atributo tipo determina de qué clase de programa se trata
<title>	Título del programa
<obs>	Observaciones sobre el programa
<form>	Abre el bloque que define los datos a utilizar
<table>	Define la tabla base y contiene los campos de la consulta
<field>	Un campo de la consulta
<label>	Etiqueta del campo
<help>	Ayuda contextual del campo
<tipo>	Tipo de dato del campo

La referencia completa de tags y atributos está en la Referencia del schema: el índice de elementos lista los 116 tags con su jerarquía, y el índice de atributos los 444 atributos en orden alfabético.