Введение В предыдущей статье мы разобрали архитектуру в целом — теперь пройдём полный практический путь от пустой директории до готового, протестированного .qch-файла, который можно открыть в Qt Assistant.…
Введение Качество справочной системы для конечного пользователя определяется не только наличием контента, но и тем, насколько легко его найти — через дерево содержания, поиск по ключевым словам или…
Введение Скомпилированный .qch-файл сам по себе бесполезен без программного компонента, который умеет его читать и предоставлять пользователю — для этого Qt предоставляет класс QHelpEngine (и его облегчённый вариант…
Введение Контекстная справка — когда пользователь нажимает F1 на конкретном элементе интерфейса (поле формы, кнопке, диалоге) и сразу попадает на релевантную страницу справки, а не на общий стартовый…
Введение QHelpEngine сам по себе не отображает HTML — для полноценного встроенного справочного браузера нужен виджет отображения, подключённый к схеме qthelp://, по которой адресуются страницы внутри справочника. В…
Введение Помимо встраивания справки непосредственно в собственный UI приложения (предыдущая статья), .qch-файл можно открывать в Qt Assistant — отдельном, готовом приложении-справочнике, поставляемом вместе с Qt SDK. Это удобно…
Введение Поддерживать пользовательскую справку и API-документацию для разработчиков как два полностью независимых источника — затратно и чревато рассинхронизацией. Doxygen умеет генерировать не только обычный HTML, но и сразу…
Введение Приложение обновляется, и вместе с ним должна обновляться справка — но пользователь может пропустить несколько версий, обновляясь сразу с очень старой на текущую, и нужно гарантировать, что…
Введение Международное приложение должно предоставлять справку на языке пользователя, а не только на одном, изначально написанном. Qt Help Framework не имеет встроенного «автоматического перевода» контента — локализация справки…
Введение Писать справку напрямую в HTML утомительно для авторов контента, не являющихся разработчиками — теги, экранирование символов, ручная синхронизация навигации отвлекают от содержания. Markdown — гораздо более дружелюбный…