Guia de estilos

Nomenclatura utilizada

Las tablas de histrix deberan ajustarse a los siguientes estándares:

Nombre de los campos

Los nombres de los campos estarán en minúsculas utilizando guión bajo _ como separador de palabras.

Campos clave (Primary Key)

Se deberá poner como nombre manteniendo la siguiente estructura:

id_clave // Así como también se deberá colocar como atributo auto incremental.

Claves foráneas (FK)

se deberá poner las claves foráneas con el mismo nombre que se utiliza en la tabla que es primary key pero cambiando el orden al final de id. Por ejemplo: fk_id.

Campos comunes: se deberá colocar a los campos comunes entre tablas como por ejemplo nombre, abreviación, etc. El nombre del campo y a continuación el nombre de tabla larga quedando de la siguiente forma:

campo_nombretabla

Estructura de menu a utilizar

Los menús del sistema deberán seguir el siguiente formato:

• Nombre del Subsistema

• Ingresos de datos:

sub categoría se encontraran todos aquellos ítems que permitan el ingreso de datos por parte del usuario.

• Informes:

aquí se encontraran aquellos ítems del sistema que incluyan la generación de reportes y consultas del mismo.

• Procesos:

en esta sub-categoría se encontraran aquellos  procesos especiales del subsistema en si.

• Mantenimiento:

aquí se incluirán aquellas funcionalidades del subsistema que se utilicen para mantener datos del subsistema.

Internamente se debe conservar la misma estructura para ordenar los archivos en directorios.

• Directorymodulo/

  • Directorying/

    • tabla_ing.xml
    • tabla_ins.xml
  • Directoryqry/

    • tabla_qry.xml
  • Directoryproc/

    • Directorytabla_proc.xml -man/

      • …
    • tabla_crud.xml

Formato de los xml

Los módulos de Histrix se implementan a partir de archivos xml. Este manual intenta describir y explicar el funcionamiento y significado de sus etiquetas y propiedades.

Codificacion

Se utilizará UTF-8 como formato de codificación para garantizar la correcta utilización de cualquier caracter en cualquier idioma.

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

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 Utilizados

- <histrix> Debe ser la primera etiqueta o tag que marca el comienzo del contenido que histrix interpretará y determinará el tipo de xml de que se trata.
    - <title> Contiene el título de del programa.
    - <obs> Contiene observaciones acerca del programa.
    - <form> Comienza el bloque que define los datos a utilizar.
        - <table> Contiene los campos involucrados en la consulta y define la tabla base a utilizar.
            - <field> Especifica el campo a utilizar en la consulta.
                - <label> Especifica la etiqueta del campo.
                - <help> Especifica la ayuda contextual del campo.
                - <tipo> Determina de que tipo es el campo.