СБИС++ ГЕНЕРАТОР ШАБЛОНОВ ДОКУМЕНТОВ ДЛЯ MICROSOFT WORD

СБиС++ Генератор шаблонов документов для
                 Microsoft Word
               Руководство системного программиста

                                                     2011-05-12

                            Содержание

Общие сведения о программе        ………...…………………………………2
Структура программы               ………...…………………………………3
Структура установщика программы   ………...…………………………………5
Настройка программы               ………...…………………………………6
Проверка программы                ………...…………………………………7
Дополнительные возможности        ………...…………………………………8

Общие сведения о программе

Программа СБиС++ Генератор шаблонов документов для MS Word
предназначена для создания шаблонов документов формата Microsoft Word
на основе определенных в системе СБИС полей.

Программа поддерживает работу в следующих операционных системах:
  1 Microsoft Windows 2000;
  2 Microsoft Windows XP;
  3 Microsoft Windows 7.

Программа совместима со следующими версиями программы Microsoft
Word:
  1 Microsoft Word 2000;
  2 Microsoft Word 2003;
  3 Microsoft Word 2007;
  4 Microsoft Word 2010.

                                                                    2

Структура программы

В логической структуре программы можно выделить следующие модули:
1 Модуль Declarations содержит глобальные объявления констант и
  структуры данных для хранения списка полей.
2 Модуль KeyCodeConstants содержит определение функции KeyCodes,
  возвращающей массив символьных обозначений клавиш (используется
  для настройки горячих клавиш).
3 Модуль Main содержит определение функций, ответственных за
  инициализацию программы.
   SBISTemplateConstructorShow          Инициализация,         получение
                                        списка опредленных в СБИС
                                        полей (через вывоз функции
                                        GetKeyMap модуля KeyMap2000)
                                        и      отображение        формы
                                        конструктора
   SBISTemplateConstructorOpenHelp,     Отображение окна справки, окна
   SBISTemplateConstructorOpenSettings, настроек, окна «About»
   SBISTemplateConstructorOpenAbout
   Document_Open, AutoNew               Обработчики событий «Открытие
                                        документа», «Открытия файла с
                                        шаблоном»
   SBISTemplateConstructorMainTimer     Запуск     основного     таймера
                                        приложения
4 Модуль Utils содержит определения вспомогательных функций.
   GetRegistry                         Получить значение из реестра по
                                       ключу.
   GetBoolRegistry                     Получить значение булевского
                                       типа из реестра по ключу.
   SetRegistry                         Установить значение в реестре по
                                       ключу.
   setupHotKeys                        Установить горячие клавиши.
   SetupParameters                     Установить текущие параметры
                                       горячих клавиш.
   OpenHelp                            Показать справку.
5 Модуль MainForm содержит реализацию основной функциональности
  программы в виде набора определений функций.
   InitItems                                   Инициализировать
                                               компонент отображения

                                                                       3

списка полей
   getFieldCode                                 Получить код поля
   updateInsertedList                           Обновить          список
                                                вставленных полей
   UpdateUI                                     Обновить        элементы
                                                пользовательского
                                                интерфейса (компоненты
                                                форм)
   detailListBox_DblClick,                      Обработчики
                                helpButton_Click,
   InsertedListBox_DblClick,                    соответствующих
   masterListBox_DblClick, modifyButton_Click,  событий      компонентов
   openButton_Click,        previewButton_Click,пользовательского
   refreshButton_Click,                         интерфейса
                                saveButton_Click,
   settingsButton_Click,       showButton_Click,
   deleteButton_Click,          findButton_Click,
   insertButton_Click,     InsertedListBox_Click,
   masterListBox_Click,      detailListBox_Click,
   UserForm_Activate
   updateFields                                   Обновить значения полей
   insertSelectedField                            Вставить выделенное в
                                                  данный момент поле
   OnTimer                                        Обработчик       таймера
                                                  обновления интерфейса
6 Модуль SettingsForm содержит определения функций обработки ввода
  данных в компоненты формы настроек приложения.
7 Модуль KeyMap2000 содержит определение функции GetKeyMap,
  реализующей передачу в конструктор списка определенных в СБИС
  полей.

На физическом уровне программа состоит из следующих модулей.
1 Файл Template Constructor.dot – файл шаблона, в котором представлена
  реализация макроса на VBA (Visual Basic for Applications). Данный модуль
  включает в себя реализацию пользовательского интерфейса конструктора,
  связь с динамически подгружаемым модулем KeyMap2000.dll, реализацию
  функций работы с документом формата Word.
2 Файл KeyMap2000.dll - динамически подгружаемый модуль, реализующий
  интерфейс передачи конструктору списка полей, определенных в системе
  СБИС.
3 Файл TemplateConstructor.chm, в котором содержится пользовательская
  справочная документация.

                                                                         4

Структура установщика программы

Установщик программы разработан с использованием инструмента InnoSetup
и включает в себя следующие файлы:
1 файл install.iss – исходные коды установщика;
2 файлы KeyMap2000.dll, Template Constructor.dot, TemplateConstructor.chm
   относящиеся к дистрибутиву программы;
3 файл psvince.dll – служебная динамическая библиотека, позволяющая
   установщику определить запущен ли тот или иной процесс или нет и
   использующаяся для предотвращения установки программу одновременно
   с запущенным приложением Microsoft Word.

                                                                        5

Настройка программы

Основную настройку программы и её окружения осуществляет установщик
программы, а именно:
1 с помощью модуля psvince.dll проверяет не запущено ли на момент
  запуска установщика приложение Microsoft Word. Если Microsoft Word
  запущен, то для продолжения установки установщик требует завершить
  работу Microsoft Word;
2 анализируя ключи реестра, проверяет какие из версий Microsoft Word
  установлены на ПК пользователя и сохраняет пути до установленных
  версией Microsoft Word;
3 копирует файлы программы в директорию «STARTUP\», которая
  располагается в директории выбранной версии Microsoft Word;
4 сохраняет в реестре путь до установленного приложения.

Кроме того, настройка уже установленной программы может быть
осуществлена с помощью окна «Настройки…».

                                                                   6

Проверка программы

Тестирование программы осуществляется согласно следующему плану
тестирования.

1 Тестирование выполняется на заранее определенном списке поле.
2 Проверка установки конструктора шаблонов на операционных системах
  версий: Microsoft Windows 2000, Microsoft Windows XP, Microsoft
  Windows 7.
3 Проверка установки конструктора шаблонов на Microsoft Word: Microsoft
  Word 2000, Microsoft Word 2003, Microsoft Windows 2007.
4 Проверка операции вставки выбранного поля в документ – результат: поле
  вставлено в документ, поле появилось в окне конструктора в списке
  вставленных полей.
5 Проверки операции поиска поля – результат: поле найдено в документе.
6 Проверка операции удаления поля, выбранного в списке вставленных
  полей - результат: поле удалено из списка вставленных полей и из
  документа.

                                                                       7

Дополнительные возможности

Одной из точек расширения программы является замена реализации модуля
KeyMap2000.dll на другую реализацию, включающую в себя дополнительные
возможности (например, загрузки списка полей из внешнего хранилища), при
условии сохранения интерфейса модуля.

                                                                       8