Введение
|
5.2.1.3. Создание системы контекстуальной Справки
Для программистов программа WIT поможет легко создавать системы контекстуальной Справки к программному обеспечению в фазе его разработки: здесь даны основные этапы (с их иллюстрированием на Microsoft Visual C++, а для других языков программирования необходимо сделать некоторые незначительные изменения). В программе WIT активизируйте экспертный режим и выберите имена создаваемых страниц HTML (меню "Файл/Предпочтения"). Создайте структуру руководства пользователя к вашему программному обеспечению. Эта структура должна соответствовать основным функциям вашей программы для их документирования, а также для документирования основных диалоговых рамок. Давайте понятные имена файлам, связанным с каждой идеей. Напишите руководство пользователя, используя для этого WIT (опишите ключевые слова, выберите модели структуры и стиля; проверьте, чтобы модель структуры создавала идеи на отдельных страницах (структура: одна идея - одна страница, смотреть вкладку "Страница" диалога модели структуры). Опишите, где надо создавать сайт web, например, "c:\MyInstallDir\Help", и создайте здесь сайт. В Visual C++, подгрузите метод OnHelpInfo() во все ваши классы диалогов (диалоговые рамки (создаваемые из CDialog), виды (создаваемые из CView), вкладки (создаваемые из CPropertyPage) листов свойств (CPropertySheet)). В реестре (к примеру) создайте ключ (например MyHelpValues), в котором вы будете сохранять значения (цепочки) типа следующей: "valueName" = "helpPagePath". Например, для диалоговой рамки CMyDialog, для которой была создана идея "My dialog" с именем связанного файла "my-dialog", создайте ключ: "CMyDialog" = "text/my-dialog" Конкретные страницы Справки создаются в подкаталоге "text" корневого каталога сайта: "c:\MyInstallDir\Help" (не нужно добавлять суффикс к именам страниц). В классе CxxxxApp (где xxxx есть имя документируемого вами программного обеспечения), создайте метод типа этого : void CxxxxApp::ShowHelp(CString helpId) В методе CMyDialog::OnHelpInfo() вызовите метод показа справки, передавая имя класса в качестве параметра (контекст): BOOL DDispBookPage::OnHelpInfo(HELPINFO* pHelpInfo) Откомпилируйте и запустите программу xxxx. Высветите диалог, обрабатываемый посредством CMyDialog, и нажмите клавишу F1: запускается навигатор сети web и показывает правильную страницу (в нашем случае "C:\MyInstallDir\Help\my-dialog.html"). Затем вы можете изменять руководство пользователя, и снова автоматически создавать его в том же месте: здесь не нужно перекомпилировать само программное обеспечение.
Ключевые слова : Создание контекстной справки ; Справка
|