Document Actions
Documentation Tools
Most applications need online documentation or a help file. Qt Assistant is a configurable and redistributable documentation reader, which can be easily customized and redistributed with your Qt application.
HTML Documentation Reader
Qt Assistant works in a similar way to a web browser, presenting documentation as a collection of hyperlinked pages. Qt Assistant allows pages to be bookmarked, and provides the standard previous and next toolbar buttons for navigation between visited pages. Qt Assistant uses Qt's support for rich text and HTML to display pages. This means that technical writers can use existing tools to produce documentation for use with Qt Assistant.
 |
Qt Assistant on Windows |
Fast Keyword Lookup and Full Text Search
Qt Assistant also provides a fast keyword lookup facility for function and classes, and a full text search facility for the documentation. Documents found during a full text search are presented in order of relevance, and every occurrence of the keyword within the documentation is highlighted.
Recent Improvements
Qt Assistant has been redesigned to use a self-contained help format for documentation packages that makes it easier to maintain collections of documents. The indexing facilities provided by Qt Assistant have been improved to allow multiple co-existing collections of documents to be searched, and results from advanced searches are presented in a familiar webpage-style result page.