Контекстная справка к программе
Модератор: Модераторы
- Ichthyander
- энтузиаст
- Сообщения: 701
- Зарегистрирован: 04.04.2007 08:32:43
- Откуда: Астрахань
- Контактная информация:
Контекстная справка к программе
Как красиво и просто организовать контекстную справку к программе? По опыту знаю, что много интересных и полезных инструментов в Lazarus неочевидны и мы порой начинаем городить свой велосипед. Хочется услышать советы тех, кто это реализовал и знает где лежат грабли, на которые не стоит наступать.
Собственно, я знаю что вроде бы возможности есть и разные.
Как я понимаю используем HelpContext, HelpKeyword, HelpType... THTMLHelpDataBase... Так ведь? Я планирую онлайн справку на сайте программы, как минимум с привязкой каждого диалогового окна к своей HTML странице.
Кто какими инструментами для этого пользуются, на что обратить внимание. Какие есть интересные обзоры в интернете по контекстной справке в программах в Lazarus?
Собственно, я знаю что вроде бы возможности есть и разные.
Как я понимаю используем HelpContext, HelpKeyword, HelpType... THTMLHelpDataBase... Так ведь? Я планирую онлайн справку на сайте программы, как минимум с привязкой каждого диалогового окна к своей HTML странице.
Кто какими инструментами для этого пользуются, на что обратить внимание. Какие есть интересные обзоры в интернете по контекстной справке в программах в Lazarus?
- Лекс Айрин
- долгожитель
- Сообщения: 5723
- Зарегистрирован: 19.02.2013 16:54:51
- Откуда: Волгоград
- Контактная информация:
у компонент есть свойства Hint, HelpContent, helpWord и HelpType --- имхо, этого достаточно.
- Ichthyander
- энтузиаст
- Сообщения: 701
- Зарегистрирован: 04.04.2007 08:32:43
- Откуда: Астрахань
- Контактная информация:
Лекс Айрин писал(а):у компонент есть свойства Hint, HelpContent, helpWord и HelpType --- имхо, этого достаточно.
Достаточно для чего?
Собственно HelpContext и HelpType - это как раз свойства формы для реализации контекстной справки, разве нет? Hint... использую тоже, но развернутую справку на основе их не дашь
- Лекс Айрин
- долгожитель
- Сообщения: 5723
- Зарегистрирован: 19.02.2013 16:54:51
- Откуда: Волгоград
- Контактная информация:
Ichthyander писал(а):но развернутую справку на основе их не дашь
Вообще-то, как я понимаю, тот же HelpContent должен содержать ссылку на нужный раздел. Ну или ID раздела в справке
Вообще, в англоязычной вике есть описание по коду там советуют глянуть пример helphtml
Ichthyander
Я справки к своим программам делаю в виде HTML-страничек. По нажатию F1 в пределах формы (компонента и т.п. - структуру справки Вы должны продумать сами и очень тщательно) срабатывает код:
и Ваша справка открывается в браузере по умолчанию.
С учётом того, что Вы писали в первом посте - избежите двойной работы...
Я справки к своим программам делаю в виде HTML-страничек. По нажатию F1 в пределах формы (компонента и т.п. - структуру справки Вы должны продумать сами и очень тщательно) срабатывает код:
Код: Выделить всё
OpenDocument('Путь_И_название_файла.html')и Ваша справка открывается в браузере по умолчанию.
С учётом того, что Вы писали в первом посте - избежите двойной работы...
- Ichthyander
- энтузиаст
- Сообщения: 701
- Зарегистрирован: 04.04.2007 08:32:43
- Откуда: Астрахань
- Контактная информация:
Лекс Айрин писал(а):Ichthyander писал(а):но развернутую справку на основе их не дашь
Вообще-то, как я понимаю, тот же HelpContent должен содержать ссылку на нужный раздел. Ну или ID раздела в справке
Вообще, в англоязычной вике есть описание по коду там советуют глянуть пример helphtml
Спасибо, посмотрю
Добавлено спустя 30 минут 11 секунд:
Vadim писал(а):Ichthyander
Я справки к своим программам делаю в виде HTML-страничек. По нажатию F1 в пределах формы (компонента и т.п. - структуру справки Вы должны продумать сами и очень тщательно) срабатывает код:Код: Выделить всё
OpenDocument('Путь_И_название_файла.html')
и Ваша справка открывается в браузере по умолчанию.
С учётом того, что Вы писали в первом посте - избежите двойной работы...
Правильно ли я понял, что путь к html странице Путь_И_название_файла.html у Вас в контекстной справке формируется автоматически на основе имени формы/компонента? Вообщем, буду экспериментировать
Добавлено спустя 11 минут 10 секунд:
Вот нашел, буду пробовать http://wiki.lazarus.freepascal.org/Add_ ... pplication
Ichthyander писал(а):Правильно ли я понял, что путь к html странице Путь_И_название_файла.html у Вас в контекстной справке формируется автоматически на основе имени формы/компонента?
Ну, путь то всегда один и тот же - подкаталог help в каталоге программы, а вот названия файлам придумываются с тем расчётом, что эту справку нужно будет читать и не из программы.
Я для справки использую компоненты TIpHtmlPanel и TIpFileDataProvider.
В последней версии исправили работу с картинками (TIpFileDataProvider).
Для справки возможностей хватает.
И не люблю, когда из программы грузится браузер.
В последней версии исправили работу с картинками (TIpFileDataProvider).
Для справки возможностей хватает.
И не люблю, когда из программы грузится браузер.
- Ichthyander
- энтузиаст
- Сообщения: 701
- Зарегистрирован: 04.04.2007 08:32:43
- Откуда: Астрахань
- Контактная информация:
sign писал(а):Я для справки использую компоненты TIpHtmlPanel и TIpFileDataProvider.
В последней версии исправили работу с картинками (TIpFileDataProvider).
Для справки возможностей хватает.
И не люблю, когда из программы грузится браузер.
Есть свои минусы в этом, но очень удобно когда контекстная справка показывается одновременно и в программе и доступна с сайта и индексируется поисковиками
