Archivo de configuración del módulo

El archivo config.xml es el archivo que define un módulo. Es utilizado por NexoPOS para identificar un módulo y distinguirlo de otros módulos. Esto te explicará todo lo que necesitas saber sobre el archivo config.xml.

Estructura del archivo config.xml

Ese archivo está ubicado en la raíz de cada módulo. Un módulo que no tenga ese archivo no es un módulo válido y, incluso, podría no aparecer como módulo en el panel. Ese archivo debe tener una estructura específica como esta:

<?xml version="1.0" ?>
<module>
    <namespace>NsStockTransfers</namespace>
    <version>4.5.1</version>
    <author>Blair Jersyer</author>
    <name>Stock Transfers Module</name>
    <description>module description</description>
</module>

La etiqueta «module» es un parámetro obligatorio. Como elemento secundario, tiene las siguientes etiquetas

• namespace (required): a unique identifier of the module. Should not have any space or special character.
• version (required): the actual version of the module.
• author (required): The name of the author.
• name (required): A human name for the module. This will be displayed on the module list.
• description (required): a brief description of the module. This will also be displayed on the modules list.

Definición de dependencia

Si desea exigir ciertos módulos antes de que se pueda activar un módulo, debe definir una etiqueta «requires» que acepte como subetiquetas los módulos que desea requerir.

<requires>
        <dependency namespace="NsMultiStore" min-version="6.1.0">Nexo Multi Store Module</dependency>
</requires>

En el ejemplo anterior, configuramos como dependencia «NsMultiStore», que debe estar al menos en la versión «6.1.0».

También podemos definir una «versión máxima» para establecer la versión máxima permitida.

Forzar versión del núcleo

Si desea que el módulo sea compatible con una versión específica de NexoPOS, puede definir la versión del núcleo usando la etiqueta «core» de la siguiente manera.

<core min-version="6.1.0" max-version="6.1.9"/>

En el ejemplo anterior, estamos solicitando la versión «6.1.0» de NexoPOS y establecemos la versión máxima en «6.1.9».

Localización

A partir de NexoPOS 6.x, hemos introducido la localización en la descripción del módulo. La idea es hacer que la descripción sea ampliamente comprensible para audiencias que no hablan inglés (que era el valor predeterminado). Esto requiere agregar un hijo de la etiqueta de descripción, la etiqueta «locale», de la siguiente manera:

...
<description>
    <locale lang="en">Here is an english description</locale>
    <locale lang="fr">Voici une description en français</locale>
</description>
...