Введение

Лицензия
Учебник
Справочник
-  Интерфейс
-  Справка
-  Документы
-  Предпочтения
-  Создание
-  Организация
-  Редактирование
-  Предпросмотр
-  Поиск
-  Библиография
-  Структуры
-  Стили
Каскадирование таблиц стилей (CSS)
Часто задаваемые вопросы (ЧЗВ)

Таблица
Индекс


Предыдущая страница
5.2.1.2. Использование сценариев на других языках   1  2  3  4  Следующая страница
5.2.1.4. Виртуальная мащина Java в Windows XP К началу
5.2.1. Общие
Таблица содержания  | Библиография  | Глоссарий  | Индекс
Руководство пользователя
      5. Приложения
          5.2. ЧЗВ, Советы и подсказки
              5.2.1. Общие
  • Руководство пользователя
  • Введение
  • Лицензионное соглашение
  • Учебник
  • Справочное руководство
  • Приложения
WIT - Основные свойства WIT - философия WIT - принципы использования Метод применения
Регистрированная версия Персональная лицензия / Профессиональная лицензия Оговорка по гарантиям Оценка и регистрация Преимущества регистрации
Создание и установка документа Организация идей Импорт идей Добавление рисунков Добавление библиографии Выбор структуры и стиля сайта Web Создание и тестирование сайта Web Выгрузка сайта Web на сервер Интернет
Инсталляция и конфигурирование Графический интерфейс пользователя Справка Управление документами Предпочтения Создание идеи Организация идей Редактирование содержания идеи Предпросмотр идеи Многие критерии поиска идей Управление ссылками на публикации Модели структур Модели стилей
Краткий справочник по CSS1 ЧЗВ, Советы и подсказки Известные проблемы и их решения
 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) 

{
// извлечение ключа реестра (например : MyHelpValues), где
// были сохранены такие значения, как "CMyDialog"="text/my-dialog".
//.
CString regKey = ... ; //Извлечение значения, связанного с именем значения "helpid".
CString helpFile = ...; // Извлечение пути к корневому каталогу сайта web Справки
CString helpPath = "C:\MyInstallDir\Help"; // к примеру, или используйте реестр
if (helpFile == _T(""))
{
CString msg;
msg.Format("Soon help on \"%s\", file %s ...", helpId, helpFile);
AfxMessageBox(msg);
} else {
// Создание пути к файлу Справки
CString helpFile = helpPath + "\\" + helpFile + ".html";
// Подключение броузера к файлу Справки (например, MSIE)
CString iePath = "C:\Program Files\Internet Explorer\iexplore.exe"; // (или запрос пути к MSIE в реестре)
_spawnlp(_P_NOWAIT , iePath, "ie", helpFile, NULL );
}
}

 В методе CMyDialog::OnHelpInfo() вызовите метод показа справки, передавая имя класса в качестве параметра (контекст):

BOOL DDispBookPage::OnHelpInfo(HELPINFO* pHelpInfo) 

{
theApp.ShowHelp("CMyDialog");
return TRUE;
}

 Откомпилируйте и запустите программу xxxx. Высветите диалог, обрабатываемый посредством CMyDialog, и нажмите клавишу F1: запускается навигатор сети web и показывает правильную страницу (в нашем случае "C:\MyInstallDir\Help\my-dialog.html").

 Затем вы можете изменять руководство пользователя, и снова автоматически создавать его в том же месте: здесь не нужно перекомпилировать само программное обеспечение.

Ключевые слова : Создание контекстной справки ; Справка

Предыдущая страница
5.2.1.2. Использование сценариев на других языках   1  2  3  4  Следующая страница
5.2.1.4. Виртуальная мащина Java в Windows XP К началу
5.2.1. Общие
Таблица содержания  | Библиография  | Глоссарий  | Индекс

Руководство пользователя к Web Idea Tree 2.50 - 307 / 357
© 2001-2003 Christophe Guibert. Все права сохраняются.
Спроектировано и создано в WebIdeaTree