¡Pautas en XML! ✍️ Nomenclatura de Nombres de Archivos XML para vistas Odoo | Odoo guidelines

Consideraciones para Crear Archivos XML en Odoo

Reglas Básicas para Nombres de Archivos XML

• Al crear archivos XML para vistas en Odoo, el nombre del archivo debe estar en minúsculas sin excepción.

• No se deben incluir acentos en el nombre del archivo. Por ejemplo, "purchase order views" está correctamente escrito en minúsculas y sin acentos.

• El nombre del archivo debe comenzar con el nombre del modelo, sustituyendo los puntos por guiones bajos. Ejemplo: "purchase_order".

• El archivo debe terminar con "views". Así, un archivo correcto sería "purchase_order_views.xml".

Importancia de Nombrar Correctamente los Archivos

• Nombrar los archivos XML según el modelo facilita la localización y modificación de estos cuando sea necesario.

• Si se necesita ajustar una vista específica (como "rest_user"), es más sencillo encontrar el archivo correspondiente si sigue la convención de nombres adecuada.

• Un mal nombramiento puede complicar la búsqueda; por ejemplo, si no se inicia con el nombre del modelo, podría ser difícil identificar qué archivo modificar.

Organización de Vistas dentro de un Archivo XML

• Un modelo puede tener múltiples vistas (formulario, lista, etc.) que pueden coexistir en un solo archivo XML sin generar errores.

• Sin embargo, es recomendable mantener las vistas relacionadas al mismo modelo juntas para evitar confusiones sobre su ubicación.

Buenas Prácticas al Declarar Vistas y Menús

• Se recomienda declarar todas las vistas primero, seguidas por acciones y menús relacionados al mismo modelo. Este orden ayuda a mantener claridad y organización.

• En un ejemplo típico: primero las vistas (formulario, lista), luego las acciones y finalmente los menús correspondientes.

Manejo de Menús en Archivos Opcionales

• Los menús principales no vinculados a acciones específicas pueden extraerse a un archivo opcional llamado "<nombre_del_módulo>_menús".

• Esto permite una mejor organización; todos los menús relacionados a un módulo específico deberían declararse dentro de este nuevo archivo.

Ejemplo Práctico desde Odoo

Menús en el Módulo

Estructura de Menús

• Se presenta la estructura del menú correspondiente a un módulo específico, donde se pueden encontrar todos los menús necesarios para su funcionamiento.

• El archivo abierto revela un menú principal que organiza las opciones disponibles dentro del módulo.

• Se identifican menús de primer nivel, cada uno con sus respectivos submenús, lo que permite una navegación clara y estructurada.

• La posibilidad de crear múltiples menús para el módulo o aplicación se destaca como una funcionalidad clave.