Руководство разработчика

Функция ПУТЕВОДИТЕЛЬ

Функция позволяет программно управлять окном путеводителя по программе.

ФУНКЦИЯ ЛОГИКА: ПУТЕВОДИТЕЛЬ(СТРОКА: файл)

Параметры

файл
Параметр может содержать:
  • пустую строку;
  • относительный путь к файлу путеводителя;
  • команду Инфо-Навигатора в формате "*команда";
  • встроенную команду по протоколу cmd в формате "cmd:команда";
  • встроенную команду по протоколу ib в формате "ib:команда".

Пустая строка приводит к переходу на стартовую страницу путеводителя.
Для протокола cmd поддерживаются следующие команды:
  • back
  • forward
  • home
  • search
  • findcont
  • content
  • index
  • new_window
  • exec
  • setvar

Для протокола ib команда может задаваться строковым кодом действия и строкой параметров. Для действий не требующих параметров строка параметров может не указываться. Допустимый вид команды по протоколу ib:
  • ib:<код действия>
  • ib:<код действия>(<строка параметров>)
Список поддерживаемых кодов действий см. в описании функции ЛКФ_ВЫПОЛНИТЬ_ДЕЙСТВИЕ. Для параметрических действий строка параметров аналогична задаваемой в редакторе меню. Например, открытие журнала "ЖурХозОпер": "ib:_JOURNAL_EDITOR_(ЖурХозОпер)".

Для упрощенного запуска ibx файлов из тела html документа используется специальная команда exec. Например, запуск файла guide.ibx со строковым параметром qwerty:
ib:exec(guide,qwerty).

Возвращаемое значение

ДА – в случае успешного выполнения команды, НЕТ – в противном случае.

Пример

Пример иллюстрирует использование функции ПУТЕВОДИТЕЛЬ в совокупности со специально созданными html файлами.

В файле example.html:

<a href="ib:exec(guide,hello)">Пример запуска ibx</a>

В файле guide.ipp:

ВЫЧИСЛИТЬ(СТРОКА: парам)
  СООБЩЕНИЕ(парам)
КОНЕЦ

Открытие файла example.html функцией ПУТЕВОДИТЕЛЬ:

ПУТЕВОДИТЕЛЬ("example.html")

При нажатии на ссылку в окне путеводителя будет запущена программа guide.ibx и выведено окно сообщения с текстом hello.


См. также: