Pomoc funkcji

Karta Pomoc funkcji istnieje od wersji 3.0; dymek pomocy składni w edytorach Ninox — od wersji 3.1. Od wersji 3.2.0 (beta) dymek ustępuje miejsca liście autouzupełniania.

Karta Pomoc funkcji dokumentuje to, co można zapisać w formułach: funkcje Ninox, funkcje dodane przez Ninext oraz funkcje globalne Państwa bazy. W edytorach skryptów Ninox dymek pomocy składni podaje najważniejsze informacje w tym samym miejscu, w którym Państwo piszą.

Karta jest zarezerwowana dla administratorów. Wyświetla wyłącznie swoją ikonę, zwój, po karcie Przegląd schematu; jej nazwa pojawia się po najechaniu kursorem. Kartę i dymek wyłącza się w panelu Ustawienia Ninext, w sekcji „Dodatkowe narzędzia”: Interaktywna pomoc.

Wybór funkcji

U góry karty selektor ma dwa obszary, tak jak selektor w karcie Pola i formuły: po lewej kategorie, po prawej funkcje. Wpisanie kilku liter w obszarze po prawej zawęża listę do funkcji, które je zawierają. Każda funkcja jest poprzedzona ikoną typu zwracanej przez nią wartości.

Lista łączy trzy źródła:

Dwie kategorie oznaczone gwiazdką znajdują się na początku, na jasnopomarańczowym tle; kategorie Ninox następują po nich w kolejności alfabetycznej. Funkcje Ninext są opisane w języku Ninox (po angielsku w przypadku języka, którego Ninext nie zna); funkcje Ninox są opisane po angielsku.

Pozycje zadań AI (aiTaskStart, aiTaskStatus, aiTaskCancel i „AI Tasks”) figurują na liście, ale jeszcze nie działają: opierają się na serwerze ninext.fr, który nie jest jeszcze otwarty.

Co pokazuje opis funkcji

• W tytule nazwa funkcji i typ zwracanej przez nią wartości, a następnie jej opis.
• Jej sygnatury („Signatures”): każdy sposób jej wywołania, z parametrami i ich typem. W przypadku słowa kluczowego lub dodatku Ninext — jego składnia („Syntax”).
• Przykłady („Example” lub „Examples”), pokolorowane tak jak w edytorze Ninox.
• W przypadku funkcji globalnej — jej pełny kod („Script”), z numerowanymi wierszami i poprzedzającym ją komentarzem.
• Link 📖 Documentation do strony funkcji w dokumentacji Ninox lub w dokumentacji Ninext (nie dla funkcji globalnej).
• Linki „See Also” do pokrewnych funkcji. Po takim przejściu przycisk ←, po lewej stronie tytułu, prowadzi z powrotem do poprzedniego opisu.

Po najechaniu kursorem każda sygnatura, każdy przykład i kod pokazują przycisk kopiowania. Nagłówki opisu („Signatures”, „Syntax”, „Examples”, „Script”, „See Also”) pozostają po angielsku, niezależnie od języka.

Przełącznik Interaktywna pomoc

Pod selektorem, po prawej stronie, przełącznik Interaktywna pomoc włącza lub wyłącza dymek pomocy składni w edytorach Ninox. Jest domyślnie włączony. Jego stan jest zapamiętywany przez przeglądarkę: obowiązuje dla wszystkich baz otwieranych w tej przeglądarce i tylko tam.

Nie należy go mylić z ustawieniem o tej samej nazwie w panelu Ustawienia Ninext: wyłączone ustawienie usuwa kartę i dymek dla wszystkich administratorów bazy.

Dymek pomocy składni

W edytorze skryptów Ninox proszę ustawić kursor na nazwie funkcji — Ninox, Ninext lub funkcji globalnej bazy — albo na słowie kluczowym: pod kursorem otwiera się dymek. Podaje on sygnaturę, opis i przykład. Zamyka się, gdy kursor opuści nazwę.

• Gdy funkcja ma kilka sygnatur, strzałki ‹ i › lub umieszczone między nimi kropki pozwalają przechodzić od jednej do drugiej.
• Przycisk w kształcie zwoju, w prawym górnym rogu dymka, wyświetla pełny opis funkcji w karcie Pomoc funkcji i zamyka dymek.
• Dymek znika, dopóki otwarta jest lista autouzupełniania Ninox, oraz podczas zaznaczania tekstu.

W Konsoli ten sam dymek otwiera się, gdy kursor znajduje się wewnątrz nazwy; informuje też o zmiennych lokalnych, o polach tabeli kontekstu i o słowach kluczowych. Podczas wpisywania argumentów funkcji nad kursorem wyświetla się ponadto przewodnik składni, z wyróżnionym bieżącym parametrem; ten pozostaje widoczny obok listy autouzupełniania. Dymki Konsoli nie zależą ani od tego przełącznika, ani od ustawienia Interaktywna pomoc.