Ayuda de funciones
La pestaña Ayuda de funciones existe desde la versión 3.0; la descripción emergente de sintaxis de los editores de Ninox, desde la versión 3.1. A partir de la versión 3.2.0 (beta), la descripción emergente se retira ante la lista de autocompletado.
La pestaña Ayuda de funciones documenta lo que puede escribir en sus fórmulas: las funciones de Ninox, las que añade Ninext y las funciones globales de su propia base de datos. En los editores de script de Ninox, una descripción emergente de sintaxis ofrece lo esencial en el mismo lugar donde escribe.
La pestaña está reservada a los administradores. Solo muestra su icono, un pergamino, después de la pestaña Vista del esquema; su nombre aparece al pasar el ratón. La pestaña y la descripción emergente se desactivan en la Configuración de Ninext, sección «Herramientas adicionales»: Ayuda interactiva.
Elegir una función
En la parte superior de la pestaña, el selector tiene dos zonas, como el de Campos y fórmulas: a la izquierda las categorías, a la derecha las funciones. Escriba unas letras en la zona de la derecha: la lista solo conserva las funciones que las contienen. Cada función va precedida del icono del tipo de valor que devuelve.
La lista reúne tres fuentes:
| Categoría | Contenido |
|---|---|
| ★ Ninext | Lo que Ninext añade al lenguaje: callNinoxFunction, JavaScript nativo (#{ … }#), Badges, los eventos de los campos de vista y de los botones, onNinextLoaded, las tareas de IA. |
| ★ Global functions | Las funciones globales de su base de datos, leídas en su código global. |
| Categorías de Ninox (Aggregation, Date, Text…) | Las funciones de Ninox, y las palabras clave de su lenguaje (select, let, if…). |
Las dos categorías marcadas con una estrella van primero, sobre fondo anaranjado pálido; las categorías de Ninox las siguen, por orden alfabético. Las funciones de Ninext se describen en el idioma de Ninox (en inglés para un idioma que Ninext no conoce); las de Ninox se describen en inglés.
Las entradas de las tareas de IA (aiTaskStart, aiTaskStatus, aiTaskCancel y «AI Tasks») figuran en la lista, pero todavía no sirven: se apoyan en el servidor ninext.fr, que aún no está abierto.
Lo que muestra una ficha
- Como título, el nombre de la función y el tipo de valor que devuelve y, después, su descripción.
- Sus firmas («Signatures»): cada forma de llamarla, con sus parámetros y su tipo. Para una palabra clave o un añadido de Ninext, es su sintaxis («Syntax»).
- Ejemplos («Example» o «Examples»), coloreados como en el editor de Ninox.
- Para una función global, su código completo («Script»), con las líneas numeradas y el comentario que la precede.
- Un enlace 📖 Documentation a la página de la función en la documentación de Ninox o en la de Ninext (no para una función global).
- Los enlaces «See Also» a las funciones relacionadas. Después de un salto así, el botón ←, a la izquierda del título, vuelve a la ficha anterior.
Al pasar el ratón, cada firma, cada ejemplo y el código muestran un botón para copiar. Los títulos de la ficha («Signatures», «Syntax», «Examples», «Script», «See Also») permanecen en inglés, sea cual sea el idioma.
El interruptor Ayuda interactiva
Debajo del selector, a la derecha, el interruptor Ayuda interactiva activa o desactiva la descripción emergente de sintaxis en los editores de Ninox. Está activado por defecto. Su estado lo recuerda su navegador: vale para todas las bases de datos abiertas en ese navegador, y solo allí.
No lo confunda con el ajuste del mismo nombre de la Configuración de Ninext: desactivado, ese ajuste retira la pestaña y la descripción emergente para todos los administradores de la base de datos.
La descripción emergente de sintaxis
En un editor de script de Ninox, coloque el cursor sobre el nombre de una función —de Ninox, de Ninext, o una función global de la base de datos— o sobre una palabra clave: se abre una descripción emergente debajo del cursor. Indica la firma, la descripción y un ejemplo. Se cierra cuando el cursor sale del nombre.
- Cuando la función tiene varias firmas, las flechas ‹ y ›, o los puntos situados entre ellas, pasan de una a otra.
- El botón con forma de pergamino, arriba a la derecha de la descripción emergente, muestra la ficha completa de la función en la pestaña Ayuda de funciones, y cierra la descripción emergente.
- La descripción emergente se retira mientras la lista de autocompletado de Ninox está abierta, y durante una selección de texto.
En la Consola, la misma descripción emergente se abre cuando el cursor está dentro de un nombre; también informa sobre las variables locales, los campos de la tabla del contexto y las palabras clave. Mientras escribe los argumentos de una función, se muestra además una guía de sintaxis encima del cursor, con el parámetro en curso resaltado; esta permanece visible junto a la lista de autocompletado. Las descripciones emergentes de la Consola no dependen ni de este interruptor ni del ajuste Ayuda interactiva.