4. Тема 4 (2 часа). Разработка системы помощи и документации. Зачет по системе

В настоящее время существует и применяется широкий набор инструментов для создания систем помощи и документации.

1. Классификация систем помощи

Системы помощи могут классифицироваться:

• по функциональности:

  • пользовательская документация;

  • документация для разработчиков;

• способу хранения информации:

  • HLP-файлы;

  • CHM-файлы;

  • PDF-файлы;

• интерактивности:

  • «горячая» справка (вызов контекстной помощи из программы);

  • документация;

На сегодняшний день формат AdobePDFсчитается одним из самых защищенных форматов для хранения электронной документации.

Для создания же систем «горячей» справки самым распространенным и удобным считается формат CHM, родственный гипертекстовым форматам.

2. Классификация инструментов по созданию систем помощи

Существует четыре основных типа программ, предназначенных для составления справочных систем:

• интегрированные в среду разработки (для продуктов Borland– это Эксперты, расширяющие возможностиIDE);

• взаимодействующие со средой разработки (взаимодействуют с IDE, но являются самостоятельными приложениями);

• самостоятельные программы по созданию помощи по компонентам (работают с исходным кодом, но не взаимодействуют со средой разработки);

• инструменты создания систем помощи (не поддерживают языки программирования; вся информация о разработке заполняется вручную).

Основным преимуществом интегрированных или взаимодействующих инструментов (первые 3 типа) является то, что они избавляют разработчика от рутинных действий по переносу структуры компонента в структуру справочной системы (со всеми объектами, связями и событиями).

Система помощи по разрабатываемому компоненту должна создаваться с помощью одного из инструментов по созданию таких систем.

3. Использование инструментов по созданию систем помощи

При создании систем помощи используются различные инструменты, облегчающие человеческий труд. Одной из таких систем является HelpScribble. Основное окно этого инструмента показано на рис.3.

Рис. 2. Основное окно программы HelpScribble

Интерфейс этого инструмента интуитивно понятен и, самое главное, понятной и стандартизованной в итоге получается сама справка.

В результате совместной работы программиста и инструмента HelpScribbleполучается законченная система помощи по разработанному компоненту.

Пример того, как может выглядеть справка по одному из рассматриваемых здесь компонентов (TMyRadioButton) приведен на рис.4 и рис.5.

Рис. 3. Справка по компоненту TMyRadioButton

Рис. 4. Примерный вид описания компонента

3. Отчет

Отчет по лабораторному практикуму должен включать:

• текст задания на разработку;

• описание постановки задачи;

• описание этапов проектирования интерфейса;

• описание технологии, порядка и результатов тестирования;

• документацию по системе.

4. Варианты заданий

Ниже приведены примерные варианты заданий.

• Разработать визуальные компоненты Delphi, реализующие элементы управленияCheckBoxиRadioButtonи позволяющие изменять свой внешний вид путем задания их цвета или вида элементов из файла форматаBMP. Компоненты должен поддерживать темы ОСWindowsXP.

• Разработать визуальный компонент Delphi, реализующий элемент «Подпись» (потомокTLabel). Компонент должен обладать возможностью включения и отключения выделения, т.е. при наведении на него мышкой, компонент или должен выделяться простым подсвечиванием, выбранным цветом, или должен быть обведен рамкой с выбираемыми параметрами (толщина обводки, цвет рамки, цвет внутренней заливки, прозрачность заливки), или выделен путем небольшого смещения и отбрасывания тени. Предусмотреть возможность применения нескольких видов выделения одновременно.

• Разработать визуальный компонент Delphi, реализующий элемент управления «Список» с возможностью многоэлементного выбора (потомокTCheckListBox). Компонент должен поддерживать возможность изменения своего внешнего вида путем задания цвета его элементов (полосы прокрутки, фон, элемент, подтверждающий выбор строки) палитройRGBили файлом форматаBMP.

• Разработать визуальный компонент Delphi, реализующий функции полос прокрутки экрана (вертикальных и горизонтальных), с возможностью изменения их внешнего вида. Внешний вид полос задается изображением, сохраненным в файлеBMP.

• Разработать визуальный компонент Delphi, реализующий элемент управления «Выпадающий список» (потомокTComboBox). Компонент должен поддерживать возможность изменения своего внешнего вида путем задания цвета его элементов (поле ввода, внешний вид выпадающего меню, кнопки вызова выпадающего меню, полосы прокрутки) палитройRGBили файлом форматаBMP. Компонент должен поддерживать темы ОСWindowsXP.

• Разработать визуальный компонент Delphi, который представляет собой кнопку. Компонент предоставляет возможность изменения своего внешнего вида путем задания фона кнопки или цветовой гаммойRGB(цветовая заливка), или рисунком, представленным в форматеBMP. Кроме того, необходимо предусмотреть возможность задания вида кнопки 3Dилиflat, в обоих режимах должен поддерживаться “горячий след”, т.е. при наведении мышкой на подпись кнопки, последняя должна или подсвечиваться выбранным цветом, или весь компонент должен выделяться на фоне путем небольшого смещения и отбрасывания тени. Предусмотреть возможность применения нескольких видов выделения одновременно. Компонент должен поддерживать темы ОСWindowsXP.

• Разработать невизуальный компонент Delphi, помещение которого на экземпляр классаTFormприводит к заполнению рабочей области экземпляра выбранным фоном. Фон может задаваться или цветовой гаммойRGB(цветовая заливка), или рисунком, представленным в форматеBMP. Кроме того, необходимо учесть возможность изменения коэффициента прозрачности формы.

• Разработать визуальный компонент Delphi, представляющий собой главное меню приложения, управляемое компонентомDelphi-ActionManager. Компонент должен корректно работать с приложениямиSDIиMDI, а также реализовывать интерфейс ОСWindowsXP.

• Разработать визуальный компонент Delphi, реализующий элемент управления “ползунок”. Компонент должен позволять изменять свой внешний вид путем задания цвета для каждого элемента компонента (шкала, насечки на шкале, подписи к насечкам, собственно ползунок) или путем задания внешнего вида каждого элемента компонента из файлаBMP. Продумать возможность градиентной заливки области перемещения ползунка от начальной отметки до текущего положения (начальный и конечный цвета задаются).

• Разработать визуальный компонент Delphi, реализующий элемент “строковая сетка” (потомокTStringGrid). Компонент должен позволять изменять свой внешний вид или путем изменения цвета элементов компонента (фиксированные заголовки строк, столбцов и пересечений), представленного палитройRGB, или путем задания их внешнего вида файлом в форматеBMP. Элемент также должен позволять изменять внешний вид полос прокрутки.

Все разработанные компоненты должны корректно поддерживать стандартные события операционной системы Windows, а именно: перемещение, изменение размеров, перерисовка, и т.д.

Задания повышенной сложности:

• Разработать визуальный компонент Delphi, реализующий функции закладок (потомок TTabControl), поддерживающий возможность изменения внешнего вида элемента путем задания фона или цветовой гаммой RGB (цветовая заливка), или рисунком, представленным в формате BMP, раздельно для каждого элемента компонента (собственно закладка и подпись на ней). Компонент должен поддерживать возможность включения и отключения “горячего следа”, т.е. при наведении мышкой на подпись, последняя должна или подсвечиваться выбранным цветом, или выделяться на фоне закладки путем небольшого смещения и отбрасывания тени. Предусмотреть возможность применения нескольких видов выделения одновременно и возможность задания иконки (свойство Icons: TiconList в пределах всего компонента), которая должна отображаться и выделяться совместно с подписью.

• Разработать визуальный компонент Delphi, реализующий функции элемента контроля страниц (потомок TPageControl), поддерживающий возможность изменения внешнего вида элемента путем задания фона или цветовой гаммой RGB (цветовая заливка), или рисунком, представленным в формате BMP, раздельно для каждого элемента компонента (собственно закладка и подпись на ней). Компонент должен поддерживать возможность включения и отключения “горячего следа”, т.е. при наведении мышкой на подпись, последняя должна или подсвечиваться выбранным цветом, или выделяться на фоне элемента путем небольшого смещения и отбрасывания тени. Предусмотреть возможность применения нескольких видов выделения одновременно и возможность задания иконки (свойство Icons: TiconList в пределах всего компонента), которая должна отображаться и выделяться совместно с подписью.

• Разработать визуальный элемент Delphi, предоставляющий возможность отображения на экране монитора вложенных структур с уровнем вложенности два. Первый уровень отображается набором кнопок с подписями и иконками. Второй уровень также представляется набором кнопок с подписями и иконками; располагаются эти кнопки между кнопками первого уровня. При нажатии на соответствующую кнопку первого уровня происходит раскрытие кнопок второго уровня и соответствующее смещение кнопок первого уровня. Предусмотреть возможность изменения вида кнопок обоих уровней (3D, flat, заливка цветом, заливка рисунком из файла BMP), изменения заливки фона компонента (заливка цветом, заливка рисунком из файла BMP), перемещения кнопок первого уровня по кнопкам раскрытого второго уровня.

• Разработать визуальный компонент Delphi, реализующий элемент управления «Регулятор». Компонент должен позволять изменять свой внешний вид (стандартный плоский регулятор, круглый регулятор, ручка-регулятор). Стандартный плоский регулятор представляет собой стандартный ползунок Windows. Круглый регулятор представляет собой обыкновенную круглую ручку регулирования. Вид каждой составляющей круглого регулятора задается файлом BMP. Ручка-регулятор – 3D-регулятор, ручка которого перемещается в двух плоскостях: плоскости монитора и воображаемой плоскости, перпендикулярной к плоскости монитора. При перемещении ручки регулятора в воображаемой плоскости происходит масштабирование ручки, т.е. происходит 3D-эмуляция перемещения ручки в пространстве на экране монитора. Элементы ручки задаются файлом формата BMP.

• Разработать компонент Delphi, реализующий синтаксическую подсветку вводимого текста. Компонент должен поддерживать все возможности стандартного интерфейсного компонента Delphi – RichEdit. Необходимо предусмотреть возможность изменения словаря компонента и задания цвета выделения для каждой группы элементов словаря.