Ajuda de funcions
La pestanya Ajuda de funcions existeix des de la versió 3.0; l'ajuda de sintaxi emergent dels editors de Ninox, des de la versió 3.1. A partir de la versió 3.2.0 (beta), el missatge emergent s'aparta davant de la llista d'autocompletació.
La pestanya Ajuda de funcions documenta el que podeu escriure a les vostres fórmules: les funcions de Ninox, les que afegeix Ninext i les funcions globals de la vostra pròpia base de dades. Als editors d'scripts de Ninox, un missatge emergent d'ajuda de sintaxi en dona l'essencial al mateix lloc on escriviu.
La pestanya està reservada als administradors. Només mostra la seva icona, un pergamí, després de la pestanya Vista de l'esquema; el nom apareix en passar-hi el ratolí per sobre. La pestanya i el missatge emergent es desactiven a la Configuració de Ninext, secció «Eines addicionals»: Ajuda interactiva.
Triar una funció
A la part superior de la pestanya, el selector té dues zones, com el de Camps i fórmules: a l'esquerra les categories, a la dreta les funcions. Escriviu unes quantes lletres a la zona de la dreta: la llista només conserva les funcions que les contenen. Cada funció va precedida de la icona del tipus de valor que retorna.
La llista reuneix tres fonts:
| Categoria | Contingut |
|---|---|
| ★ Ninext | El que Ninext afegeix al llenguatge: callNinoxFunction, Native JS (#{ … }#), Badges, els esdeveniments dels camps de vista i dels botons, onNinextLoaded, les tasques d'IA. |
| ★ Global functions | Les funcions globals de la vostra base de dades, llegides al seu codi global. |
| Categories de Ninox (Aggregation, Date, Text…) | Les funcions de Ninox, i les paraules clau del seu llenguatge (select, let, if…). |
Les dues categories marcades amb una estrella van al capdamunt, sobre fons ataronjat pàl·lid; les categories de Ninox les segueixen, per ordre alfabètic. Les funcions de Ninext es descriuen en l'idioma de Ninox (en anglès per a un idioma que Ninext no coneix); les de Ninox es descriuen en anglès.
Les entrades de les tasques d'IA (aiTaskStart, aiTaskStatus, aiTaskCancel i «AI Tasks») figuren a la llista, però encara no serveixen: depenen del servidor ninext.fr, que encara no està obert.
Què mostra una fitxa
- Com a títol, el nom de la funció i el tipus de valor que retorna i, després, la seva descripció.
- Les seves signatures («Signatures»): cada manera de cridar-la, amb els seus paràmetres i el seu tipus. Per a una paraula clau o un afegit de Ninext, és la seva sintaxi («Syntax»).
- Exemples («Example» o «Examples»), acolorits com a l'editor de Ninox.
- Per a una funció global, el seu codi complet («Script»), amb les línies numerades, amb el comentari que la precedeix.
- Un enllaç 📖 Documentation cap a la pàgina de la funció a la documentació de Ninox o a la de Ninext (no per a una funció global).
- Els enllaços «See Also» cap a les funcions properes. Després d'un salt d'aquests, el botó ←, a l'esquerra del títol, torna a la fitxa anterior.
En passar el ratolí per sobre, cada signatura, cada exemple i el codi mostren un botó de còpia. Els títols de la fitxa («Signatures», «Syntax», «Examples», «Script», «See Also») es queden en anglès, sigui quin sigui l'idioma.
L'interruptor Ajuda interactiva
Sota el selector, a la dreta, l'interruptor Ajuda interactiva activa o desactiva el missatge emergent d'ajuda de sintaxi als editors de Ninox. Està activat per defecte. El vostre navegador en recorda l'estat: val per a totes les bases de dades obertes en aquest navegador, i només allà.
No el confongueu amb el paràmetre del mateix nom de la Configuració de Ninext: desactivat, aquest paràmetre treu la pestanya i el missatge emergent per a tots els administradors de la base de dades.
L'ajuda de sintaxi emergent
En un editor d'scripts de Ninox, poseu el cursor sobre el nom d'una funció — de Ninox, de Ninext, o una funció global de la base de dades — o sobre una paraula clau: s'obre un missatge emergent sota el cursor. Hi dona la signatura, la descripció i un exemple. Es tanca quan el cursor surt del nom.
- Quan la funció té diverses signatures, les fletxes ‹ i ›, o els punts situats entre elles, passen de l'una a l'altra.
- El botó en forma de pergamí, a la part superior dreta del missatge emergent, mostra la fitxa completa de la funció a la pestanya Ajuda de funcions, i tanca el missatge emergent.
- El missatge emergent s'aparta mentre la llista d'autocompletació de Ninox està oberta, i durant una selecció de text.
A la Consola, el mateix missatge emergent s'obre quan el cursor és dins d'un nom; també informa sobre les variables locals, sobre els camps de la taula del context i sobre les paraules clau. Mentre escriviu els arguments d'una funció, a més, es mostra una guia de sintaxi per sobre del cursor, amb el paràmetre en curs ressaltat; aquesta es manté visible al costat de la llista d'autocompletació. Els missatges emergents de la Consola no depenen ni d'aquest interruptor ni del paràmetre Ajuda interactiva.