Documentación para desarrolladores

El archivo facturascripts.ini

Este archivo es imprescindible en cada plugin y contiene los siguientes campos:

  • name, para el nombre del plugin. Debe ser el mismo nombre que el directorio del plugin.
  • description, para la descripción del plugin.
  • version, para la versión del plugin. Debe ser un número entero o decimal.
    • 1.0 -> Bien
    • 1.0.1 -> Mal
    • 1.0-beta -> Mal
  • min_version, para indicar la versión mínima de FacturaScripts necesaria.
  • require, para indicar la lista de plugins (separadas por coma) de los que depende este plugin.
    • require = 'POS' -> Bien
    • require = 'POS, Servicios' -> Mal. Hay un espacio.
    • require = 'POS,Servicios' -> Bien

name

Indica el nombre del plugin y debe coincidir con el nombre de la carpeta. Este campo se añadío en FacturaScripts 2018 para resolver los problemas con los plugins cuyo zip contiene los archivos dentro de una carpeta que no se corresponde con la que debe tener el plugin. Ahora se utiliza este name para renombrar la carpeta.

Ejemplo de facturascripts.ini

description = 'My fantastic new plugin for FacturaScritps'
min_version = 2020.80
name = 'MyNewPlugin'
version = 1

Esto indica que es el plugin MyNewPlugin, en su versión 1, que requiere para su funcionamiente FacturaScripts 2020.81

Problema más frecuente

El problema más frecuente es poner un name distinto al nombre de la carpeta del plugin:

  • Carpeta Miplugin, name = 'Miplugin' -> Bien
  • Carpeta Mi plugin, name = 'Miplugin' -> Mal. No uses espacios.
  • Carpeta Miplugin, name = 'MiPlugin' -> Mal. La p está en minúscula en la carpeta, pero en mayúsculas en el name.
Buscar

Necesita identificarse para continuar con esta acción. Haga clic en iniciar sesión o cree una cuenta.

Iniciar sesión
neorazorx_1
neorazorx_1
1304 Puntos 8 años
Fecha de creación 27-04-2018 00:00:00
Última actualización 30-12-2020
Contador de visitas 1614

Copyright (c) 2013-2021 FacturaScripts