Руководство пользователя разработчика информационных систем

1 Введение 12

1.1 Структура применения 12

1.2 Область применения 13

1.3 Краткое описание возможностей 13

1.4 Минимальные требования к уровню подготовки программиста 14

2 Назначение и условия применения 15

2.1 Виды деятельности, функции, для автоматизации которых предназначены виджеты WWII 15

2.2 Условия применения 16

2.3 Комплект и лицензии 16

2.4 Интеграция и совместимость 17

3 Архитектура Web Widget Interactive Interface ITCOD 18

4 Архитектура программной составляющей виджета WWII 19

4.1 Упрощенное описание виджета WWII 19

4.2 Концепция виджета WWII 19

4.3 Структура виджета 21

4.3.1 Сруктура файловой части виджета 21

4.3.2 Шаблон программной части виджета 23

4.3.3 Пример шаблона программной части виджета 25

4.3.4 Описание примера шаблона программной части виджета 26

5 Взаимодействие с WWII 27

5.1 Элементы взаимодействия 27

5.1.1 Источники данных 27

5.1.2 Обработчики данных 28

5.1.3 Получатели данных 28

5.2 Схемы взаимодействия 29

5.3 Пользовательский интерфейс 30

5.4 Методы выполнения виджетов WWII 30

5.4.1 Цикличное исполнение дерева виджетов 31

5.4.2 Выборочное исполнение виджетов 32

5.4.3 Активные и пассивные виджеты 32

5.4.4 Срок жизни виджета 32

5.4.5 Типы виджетов по назначению 33

5.5 Взаимодействие с сетевыми сервисами 33

5.6 Методы управления WWII 34

5.6.1 Пользователь 34

5.6.2 Виджет 34

5.6.3 Внешний сервис 35

5.7 Прямое управление элементами DOM 35

6 Программное ядро WWII 36

6.1 Структура файлового хранилища в БД ITCOD 36

6.2 Структура и функции ядра WWII 36

6.3 Процедуры ядра WWII 36

6.4 Деревья подчинённости виджетов WWII 37

6.5 URI запросы к ядру WWII 38

6.5.1 Структура URI запросов к ядру WWII 38

6.5.1.1 Формат URI 38

6.5.1.2 Формат фрагментной части URI 39

6.5.1.3 Ключи фагментной части URI 39

6.5.1.3.1 dir — код электронного каталога 39

6.5.1.3.2 rnd — идентификатор предыдущего цикла 40

6.5.1.3.3 window.close – закрыть окно 41

6.5.1.3.4 window.open — открыть окно 41

6.5.1.3.5 widget_[кодВиджета] — запустить виджет 41

6.5.1.3.6 Устаревающие ключи 42

6.6 Переменные ядра WWII 42

6.6.1 Информационные переменные 42

6.6.1.1 tmname — торговая марка ПО 43

6.6.1.2 program — наименование ПО 43

6.6.1.3 $title — кодовое имя ПО 43

6.6.1.4 TITLE — Название каталога и раздела 43

6.6.1.5 version — версия ПО 43

6.6.1.6 license — перечень лицензий ПО 44

6.6.1.7 copyright — копирайт ПО 44

6.6.1.8 Author — автор ПО 44

6.6.1.9 AuthorMail — e-mail автора ПО 44

6.6.2 Переменные пользовательского интерфейса 45

6.6.2.1 PageLoaded — статус загрузки html-шаблона интерфейса (DOM) 45

6.6.2.2 $set2Dom – флаг загрузки интерфейса WWII в DOM 45

6.6.2.3 LANG - текущий язык web-интерфейса 45

6.6.2.4 $SKIN — код каталога шаблона интерфейса WWII 46

6.6.2.5 WINDOW — текушее состояние пользовательского интерфейса 46

6.6.2.6 path - путь без ключей 46

6.6.2.7 url - текущая информация в url-строке браузера 46

6.6.2.8 NEWURL — текущие данные в строке url браузера 46

6.6.2.9 OLDURL – предыдущие данные в строке url браузера 46

6.6.2.10 NEWCLICK — флаг последнего нажатия на кнопку мышки 46

6.6.2.11 OLDCLICK — флаг предыдущего нажатия на кнопку мышки 47

6.6.2.12 $position — авто-определяемый вид пользовательского экрана 47

6.6.2.13 $Width — ширина пользовательского экрана 47

6.6.2.14 $Height — высота пользовательского экрана 47

6.6.2.15 $oldWidth — предыдущяя ширина пользовательского экрана 47

6.6.2.16 $oldHeight — предыдущяя высота пользовательского экрана 47

6.6.2.17 $NGINXRESIZE — включение режима авто-ресайза изображений 47

6.6.2.18 prefixImage — префикс авто-масштабируемых изображений 48

6.6.2.19 stepDPI — шаг изменения размеров авто-масштабируемых изображений 48

6.6.2.20 stDPI — минимальная ширина авто-масштабируемых изображений 48

6.6.2.21 YstDPI - минимальный высота авто-масштабируемых изображений 48

6.6.2.22 FONT — первичный размер масштабируемых фонтов 48

6.6.2.23 Комплект масштабируемых фонтов WWII 49

6.6.2.24 FONTLINE - базовый размер фонта для описаний ярлыков 49

6.6.2.25 fontline - текущий размер фонта для описаний ярлыков 49

6.6.2.26 FONTOBJ 49

6.6.2.27 wproc - коэффициент изменения ширины реального экрана от идеального 50

6.6.2.28 hproc - коэффициент изменения высоты реального экрана от идеального 50

6.6.2.29 kproc — коэффициент изменения масштаба реального экрана от идеального 50

6.6.2.30 minScale — минимальное количество ярлыков сущностей по горизонтали 50

6.6.2.31 maxScale - максимальное количество ярлыков сущностей по горизонтали 50

6.6.2.32 scalvar — среднее значение количество ярлыков сущностей по горизонтали 50

6.6.2.33 normScale — текущее количество ярлыков сущностей по горизонтали 51

6.6.3 Переменные статуса работы ядра WWII 52

6.6.3.1 $DebugInf - последнее лог. Сообщение 52

6.6.3.2 $DebugLog - лог работы ПО 52

6.6.3.3 START - флаг статуса выполнения ядра WWII 52

6.6.3.4 animationStatus — флаг поддержки функций css animation браузером 52

6.6.3.5 $RND – уникальный идентификатор цикла обработки ядра WWII 53

6.6.3.6 $time — время начала исполнения последнего цикла обработки WWII 53

6.6.3.7 sTop и sOld - окно текущего и предыдущего запроса 53

6.6.3.8 fileAPISupport — поддержка работы с файлами 53

6.6.4 Переменные управления электронным каталогом (БД) 54

6.6.4.1 startCat — начальный электронный каталог при старте ядра WWII 54

6.6.4.2 topCat - домашний электронный каталог 54

6.6.4.3 VisibleTree — Значение по умолчанию типа открытия дерева каталога 54

6.6.4.4 VisibleObjectStart — Значение по умолчанию типа загружаемой инф. сущности 54

6.6.4.5 VisibleObject - Значение по умолчанию типа загруженной инф. сущности 54

6.6.4.6 startObj — порядковый номер ярлыка первой выводимой сущности при открытии раздела каталога 54

6.6.4.7 endObj — порядковый номер ярлыка последней отображаемой сущности при открытии раздела каталога 55

6.6.4.8 lastObj — последний просмотренный объект в разделе каталога 55

6.6.4.9 $OBJECT — Номер активной сущности в отображаемом разделе 55

6.6.4.10 $ATRIB — код активной сущности 55

6.6.4.11 $OLDATRIB — код предыдущей активной сущности 55

6.6.4.12 $CAT — Код текущего электронного каталога 55

6.6.4.13 CATALOG - Код текущего электронного каталога 55

6.6.4.14 pathCatalog - путь к электронному каталогу 55

6.6.5 Неописанные переменные 55

6.7 Информационные массивы 58

6.7.1 Списки и стэки (номерные массивы Array) 59

6.7.1.1 Массивы визуализации интерфейса 59

6.7.1.1.1 mouseXY — координаты курсора мышки на экране 59

6.7.1.1.2 $lang — список языков интерфейса 59

6.7.1.1.3 $BANER — список Y-областей виджета 59

6.7.1.1.4 $LCR — список X-областей виджета 59

6.7.1.1.5 $XYZ — список геометрических параметров XY-областей 59

6.7.1.1.6 $POINT — список координат XY-области виджета на экране 60

6.7.1.2 Массивы визуализации каталога (БД) 60

6.7.1.2.1 dirTree[CATALOG] – массив строк ствола каталога генерируемый ядром 60

6.7.1.2.2 dirTreeWhite[CATALOG] - массив строк ствола каталогов генерируемый виджетами 60

6.7.1.2.3 indexTree[CATALOG] — форматированные индексы вложенности разделов каталога 60

6.7.1.2.4 topTree[CATALOG] - не форматированные индексы вложенности разделов каталога 61

6.7.1.2.5 MENU — список индексов(строк) текущего раздела каталога 61

6.7.1.2.6 itcod — массив пути к ядру WWII 61

6.7.1.2.7 INFO — информация о владельце открываемой БД 61

6.7.1.3 Устаревшие Array массивы 61

6.7.2 Ассоциативные массивы (информационные хэши Object) 62

6.7.2.1 Хэш массивы настроек ядра WWII 62

6.7.2.1.1 сompanyini - параметры из файла company.ini 62

6.7.2.1.2 languageini - параметры из файла language.ini 62

6.7.2.1.3 typesini - параметры из файла types.ini 62

6.7.2.1.4 itcodini – параметры из файла itcod.ini 62

6.7.2.1.5 skinini - параметры из файла skin.ini 62

6.7.2.2 Хэш массивы интерфейса WWII 63

6.7.2.2.1 $CSS — массив css блоков 63

6.7.2.2.2 MSG – массив сообщений 63

6.7.2.2.3 widget — пользовательский интерфейс WWII 63

6.7.2.2.4 widgetStat – статусы этапов обработки ячеек массива widget 63

6.7.2.2.5 $RESIZE - массив статуса ресайза виджетов 63

6.7.2.2.6 $SET2DOM – статусы установки параметров виджетов в DOM 64

6.7.2.2.7 $INITI – статус инициализации интерфейса по виджетам 64

6.7.2.2.8 Устаревшие массивы (удаляемые) 64

6.7.2.3 Хэш массивы БД ITCOD 64

6.7.2.3.1 Catalog - хэш информации о каталоге 64

6.7.2.3.2 infoTree – информация о разделпх каталога 64

6.7.2.3.3 dirTree – массив стволов каталогов генерируемый ядром 65

6.7.2.3.4 DirTreeWhite - массив стволов каталогов генерируемый виджетами 65

6.7.2.3.5 IndexTree — массив списков индексов вложенности разделов каталогов 65

6.7.2.3.6 topTree — массив списков не форматированных индексов вложенности разделов каталогов 66

6.7.2.3.7 UROVEN — массив уровней разделов каталогов 66

6.7.2.3.8 Устаревшие массивы 66

6.7.2.4 Хэш массивы управления виджетами WWII 66

6.7.2.4.1 WidGet — массив url-источников виджетов 66

6.7.2.4.2 WidGetInfo — информация о виджетах 66

6.7.2.4.3 WidGetStat — статусы первичной активации виджетов 67

6.7.2.4.4 WidGetActiv — статусы загрузки виджетов (устаревающий) 67

6.7.2.4.5 WidGetP — массив дерева подчинённости (в разработке) 67

6.7.2.4.6 WidGetURI – массив путей к файлам виджетов 67

6.7.2.4.7 WidGetID — массив callback-кодов загрузки виджетов 67

6.7.2.4.8 WidGetIZO — массив информации о изображениях областей виджетов 68

6.7.2.4.9 WidGetIface — статусы рассчета идеального интерфейса для DOM-областей виджетов 68

6.7.2.4.10 $WIDGETCLIPBOARD — буфер обмена для виджетов 68

6.7.2.4.11 $WIDGETCB – дополнительный буфер обмена виджетов (память) 68

6.7.2.4.12 $BABYSTART — массив статусов работы функции BabyStart 69

6.7.2.4.13 SidGetStat — статусы загрузки внешних приложений для виджетов 69

6.7.2.4.14 SidGetURI — пути загрузки внешних приложений для виджетов 69

6.7.2.4.15 SidGetID — callback коды загрузки внешних приложениц для виджетов 69

6.7.2.4.16 Устаревшие массивы 69

6.7.2.5 Хэш массивы загрузки файлов 69

6.7.2.5.1 rFile — массив содержимого загружаемых файлов loadF() 69

6.7.2.5.2 wFile — массив содержимого загружаемых виджетов 69

6.7.2.5.3 $APPS — статусы готовности внешних сетевых приложений (web API) 69

6.7.2.6 Неописанные массивы 70

6.8 DOM HTML 71

6.8.1 HEAD 71

6.8.1.1 itcod-ver — версия шаблона интерфейса WWII 71

6.8.1.2 itcod-catalog — код первичного электронного каталога 71

6.8.1.3 Itcod-template — режим работы интерфейса WWII 72

6.8.1.4 itcod-nginxResize — Метод Auto Resize Images for httpd Nginx 72

6.8.1.5 itcod-cdn – перечень CDN источников 72

6.8.1.6 itcod-css – параметр загрузки CSS-файла интерфейса 73

6.8.1.7 itcod — список подключаемых виджетов 73

6.8.1.8 itcod-skin – код скина (код БД ITCOD) 74

6.8.1.9 itcod-font – базовый размер фонта 74

6.8.1.10 itcod-fontline – размер фонта описания ярлыков инф. сущностей 74

6.8.1.11 Устаревающие параметры 74

6.8.1.11.1 itcod-VisibleObject — тип инф. Сущности 74

6.8.1.11.2 itcod-oblojka — отображение обложки раздела 75

6.8.1.11.3 itcod-oblojka.start — отображение обложки каталога 75

6.8.1.11.4 itcod-scale — количество ярлыков 75

6.8.1.11.5 itcod-screen — состояние окна блокировки 75

6.8.1.12 Устаревшие параметры 76

6.8.2 DIV ID & CLASS 76

6.8.2.1 program — наименование ПО 77

6.8.2.2 version — версия ПО 77

6.8.2.3 copyright — копирайт ПО 77

6.8.2.4 license — лицензии ПО 77

6.8.2.5 information — блоки информации о ПО 77

6.8.2.6 DebugInf — Текущяя обработка WWII 77

6.8.2.7 DebugLog — Лог-лист WWII 77

6.8.2.8 AJAX — элемент ajax 77

6.8.2.9 LOADING – блок индикации исполнения функций WWII 78

6.8.2.10 SITE — элемент описания сайта 78

6.8.2.11 INFO — блок сообщения 78

6.8.2.12 pageDialog — блок сообщения 79

6.8.2.13 OBLOJKA — блок обложки каталога 79

6.8.2.14 Устаревшие области 79

6.9 Функции ядра WWII ITCOD 80

6.9.1 Функции ядра WWII 80

6.9.1.1 autoSTART ($DEBUG) — старт WWII 81

6.9.1.2 randomNumber (m,n) – случайное число 81

6.9.1.3 curDate ($COMM) — дата время 81

6.9.1.4 alertMsg(msg, ok, no, close) — вывода сообщения пользователю 81

6.9.1.5 DebugInfo ($MSG, $COMM) — помещение сообщения в лог 81

6.9.1.6 DialogMsg(message, ok, no, close) — вывод диалога 81

6.9.1.7 checkhash(start, status) – контролёр активности интерфейса 82

6.9.2 Функции интерфейса WWII 82

6.9.2.1 listbuild() - первичная функция генерации интерфейса WWII 82

6.9.2.2 list($LIST, $PARENT, $CONTR, $DEBUG) — исполнение виджетов 82

6.9.2.3 listSlave($LIST, $PARENT, $CONTR, $DEBUG)— исполнение виджетов 82

6.9.2.4 procSize($DEBUG) — обработка коэффициентов масштабирования интерфейса 82

6.9.2.5 calculateProc ($SKIN, $LIST) - рассчет коэффициентов масштабирования интерфейса 82

6.9.2.6 homesize() - определение размеров экрана 82

6.9.2.7 block() - включить блокирование экрана 83

6.9.2.8 unblock() - выключить блокирование экрана 83

6.9.2.9 mousePage() - определение координат курсора мыши 83

6.9.2.10 testClick() - определение нажатия кнопки мыши 83

6.9.2.11 loading($COMM, $DEBUG) — включение/выключение индикатора LOADER 83

6.9.2.12 ajaxcss (Color, bgColor) — установка css для индикатора LOADER 83

6.9.2.13 ajaxloader(Color, bgColor) – генерация индикатора LOADER 83

6.9.2.14 FontCalculate() - пересчёт размера блока фонтов 83

6.9.2.15 Bksp($array) – удаление символов «возврат каретки» и «перевод строки» 83

6.9.2.16 browser() - определение браузера 83

6.9.2.17 getStyleSheet(index) — чтение файла css из html-шаблона 83

6.9.2.18 addStyleSheet(url) — помещение файла css в html-шаблон 83

6.9.2.19 StyleSheet_makeCompatible(style) — обработка css 84

6.9.2.20 addCss($NAME, $VAR) — добавление css-ноды в DOM 84

6.9.2.21 delCss($NAME) - удаление css-ноды из DOM 84

6.9.2.22 initIZO($LIST) — инициализация массива WidGetIZO 84

6.9.2.23 loadIZO(widget) — загрузка изображений из WidGetIZO 84

6.9.2.24 Устаревшие функции 84

6.9.3 Функции генерации пользовательского интерфейса WWII 84

6.9.3.1 Функции получения данных 84

6.9.3.1.1 getClassXYZ ($wid) — получение данных о области class из DOM 84

6.9.3.1.2 getIdXYZ ($wid) – получение данных о области id из DOM 84

6.9.3.2 Функции генерации интерфейса 85

6.9.4 Функции управления каталогами 86

6.9.4.1 loadVasStart(vas) — загрузка файла ствола каталога 87

6.9.4.2 viewTREE(index) — чтение массива строк раздела каталога 87

6.9.4.3 readTREE(index, debug) — загрузка раздела каталога 87

6.9.4.4 loadVASIMG($VAR) — получение изображения обложки раздела 87

6.9.4.5 loadVAS(data, command, treeVAS, debug) — загрузка файла раздела 87

6.9.4.6 initAtrib($CATALOG) — загрузка настроечной инф.сущности интерфейса 87

6.9.4.7 loadObject(...) — загрузка информационной сущности 87

6.9.4.8 loadFile(filePath, $CATALOG) — загрузка файла 87

6.9.4.9 hashINI ($obj, $dat, $ps, $url, $scrip) - 87

6.9.4.10 objINI ($type, $obj, $dat, $ps) - 87

6.9.4.11 SearchMENUOBJ (ATRIB) – поиск позиции инф. сущности в разделе 87

6.9.5 Функции управления виджетами 87

6.9.5.1 f($FUNC, $PARAM, $COMM) — контролируемый запуск функций 88

6.9.5.2 go(...) — ассинхронная загрузка виджета 88

6.9.5.3 WidGetContr (…) - контроль загрузки виджета 88

6.9.5.4 loadScript(...) - тех. функция контроля загрузки виджета 88

6.9.5.5 loaded(...) - тех. функция контроля загрузки виджета 88

6.9.5.6 failed(...) - тех. функция контроля загрузки виджета 88

6.9.5.7 autoGo (…) - функция разрешения загрузки виджета 88

6.9.5.8 WinContr($i) — parent-контроль запуска виджетов 88

6.9.5.9 preloadWidget(...) — предзагрузка виджета 88

6.9.5.10 AutoStartWidGet (...) — функция разрешения старта виджета 88

6.9.5.11 BabyStart(...) — старт baby-виджетов 88

6.9.5.12 BabyStartSlave(...) - эхо-старт виджетов baby/baby/... 88

6.9.5.13 autoRunWidGet (…) - функция разрешения выполнения виджета 89

6.9.5.14 loadWidGet ($WID, $DEBUG) — загрузка/запуск виджета 89

6.9.5.15 listWidGetBaby (…) - формирование списка бэби виджетов из 'ibaby' 89

// на входе имя формата widget_HOME, на выходе номерной массив данных
89

6.9.5.16 listWidGetBabyStr ($WID, $DEBUG) - тех. функция для listWidGetBaby (…) 89

6.9.5.17 listWidGetEchoBaby (…) - формирование эхо-списка бэби виджетов из 'ibaby' 89

6.9.5.18 listWidGetEchoBabyStr (…) - - тех. функция для listWidGetEchoBaby (…) 89

6.9.6 Функции загрузки файлов 89

6.9.6.1 getXmlHttp() - функция xml-запроса к ресурсу 89

6.9.6.2 startINI(catalog) — инициализация загрузки файлов настроек каталога 89

6.9.6.3 writeini(...) - загрузка файлов настроек каталога и помещение в массивы 89

6.9.6.4 loadF(...) - инициализация ассинхронного запроса получения файла 89

6.9.6.5 loadINI(filePath, $hash) — загрузка файлов настроек каталога 90

6.9.6.6 loadDirHtml(filePath) — загрузка списка файлов внешнего ресурса 90

6.9.6.7 loadScr($NAME, $SID) — ассинхронная загрузка внешнего скрипта 90

6.9.6.8 goScr(url, callback, errback, SID) — ассинхронная загрузка внешнего скрипта 90

6.9.6.9 SidGetContr (data, $SID) – контроль загрузки внешнего скрипта 90

6.9.6.10 loadedScr(data, SID) - тех. функция контроля загрузки скрипта 90

6.9.6.11 failedScr(data, SID) - тех. функция контроля загрузки скрипта 90

6.9.6.12 js2head($VAR) — добавление link-js в секцию head html-шаблона 90

6.9.6.13 js2body($VAR)— добавление link-js в секцию body html-шаблона 90

6.9.6.14 img2html(...) - добавление link-img в секцию body html-шаблона 90

6.9.6.15 Scripts ($VAR, $TXT) – загрузка внешних скриптов (не виджетов) 90

6.9.6.16 preloadIMG(images) — предзагрузка изображений 90

6.9.7 Неописанные функции 91

6.9.7.1 line2html(...) - корректировка содержимого id-области DOM 91

7 Поддержка разработчика WWII ITCOD 92

8 Виджеты разработчиков 92

9 Партнёрство и сотрудничество 93

10 Рекомендации по освоению 93

11 Автор и разработчик WWII ITCOD 93

Список используемых сокращений и терминов

Сокращение, термин	Полное наименование, определение
ИС	Информационная система. Система обеспечивающая автоматизацию бизнес-процессов отдельного подразделения/департамента организации.
КИС	Комплексная информационная система. Объединение различных ИС в единую систему автоматизации всех бизнес-процессов предприятия.
ПП	Программная платформа. Комплект программ для автоматизации общих бизнес-процессов любой ИС в среде единой КИС. Создания специализированных ИС на основе базовых функций ПП. Объединения множеств ИС в КИС.
ITCOD	Наименование формата объектных баз данных и ПП. Зарегистрированная торговая марка разработчика..
WWII	Web Widget Interactive Interface ITCOD. Интерактивный полиморфный web-интерфейс ITCOD. Автор: Вдовытченко Ю.Н. 2012-2015гг.
WW	Web-виджет'ы
БД	Объектная База данных формата ITCOD.
ПО	Программное обеспечение