diff options
author | Leena Miettinen <riitta-leena.miettinen@nokia.com> | 2010-08-31 17:01:04 +0200 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@nokia.com> | 2010-08-31 17:01:04 +0200 |
commit | 14202b39447e410645d52238ed6b484b04549cf5 (patch) | |
tree | e9fb63e68c7ba9575e01099af971dc196951370b /doc | |
parent | 7c1f9fba8b02815fb5ff2b6d75a77ea271b66ec5 (diff) | |
download | qt-creator-14202b39447e410645d52238ed6b484b04549cf5.tar.gz |
Doc - Add information about the Help mode, adding bookmarks, and detaching the help window. Add screen shots.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/images/qtcreator-help-add-bookmark-dlg.png | bin | 0 -> 23583 bytes | |||
-rw-r--r-- | doc/images/qtcreator-help-add-bookmark.png | bin | 0 -> 878 bytes | |||
-rw-r--r-- | doc/qtcreator.qdoc | 63 |
3 files changed, 63 insertions, 0 deletions
diff --git a/doc/images/qtcreator-help-add-bookmark-dlg.png b/doc/images/qtcreator-help-add-bookmark-dlg.png Binary files differnew file mode 100644 index 0000000000..8d4c6ea723 --- /dev/null +++ b/doc/images/qtcreator-help-add-bookmark-dlg.png diff --git a/doc/images/qtcreator-help-add-bookmark.png b/doc/images/qtcreator-help-add-bookmark.png Binary files differnew file mode 100644 index 0000000000..fb7429f535 --- /dev/null +++ b/doc/images/qtcreator-help-add-bookmark.png diff --git a/doc/qtcreator.qdoc b/doc/qtcreator.qdoc index 49ba3d1f96..407a283312 100644 --- a/doc/qtcreator.qdoc +++ b/doc/qtcreator.qdoc @@ -627,6 +627,54 @@ \gui Help mode, select \gui Tools > \gui Options... > \gui Help. \endlist + \section1 Finding Information in Qt Documentation + + Qt Creator, Qt SDK, Nokia Qt SDK and other Qt deliverables contain documentation + as .qch files. All the documentation is accessible in the \gui Help mode. + + To find information in the documentation, select: + + \list + + \o \gui Bookmarks to view a list of pages on which you have added bookmarks. + + \o \gui Contents to see all the documentation installed on the development + PC and to browse the documentation contents. + + \o \gui Index to find information based on a list of keywords in all the + installed documents. + + \o \gui {Open Pages} to view a list of currently open documentation pages. + + \o \gui Search to search from all the installed documents. + + \endlist + + \section2 Adding Bookmarks to Help Pages + + You can add bookmarks to useful help pages to easily find them later + in the \gui Bookmarks view. You can either use the page title as the + bookmark or change it to any text. You can organize the bookmarks in + folders in the view. + + \image qtcreator-help-add-bookmark-dlg.png "Add Bookmark dialog" + + To add a bookmark to an open help page: + + \list 1 + + \o Click the + \inlineimage qtcreator-help-add-bookmark.png + (\gui {Add Bookmark}) button on the toolbar. + + \o In the \gui {Add Bookmark} dialog, click \gui OK to save the + page title as a bookmark in the \gui Bookmarks folder. + + \endlist + + To import and export bookmarks, select \gui {Tools > Options... > Help > + General Settings > Import} or \gui Export. + \section1 Adding External Documentation You can display external documentation in the \gui Help mode. @@ -641,6 +689,21 @@ \gui Options... > \gui Help > \gui Documentation > \gui Add. \endlist + \section1 Detaching the Help Window + + By default, context-sensitive help is opened in a window next to the + code editor when you press \key F1. If there is not enough vertical + space, the help opens in the full-screen help mode. + + You can specify that the help always opens in full-screen mode or + is detached to an external window. Select \gui {Tools > Options... > Help > + General Settings} and specify settings for displaying context-sensitive help + in the \gui {On context help} field. To detach the help window, select + \gui {Always Show Help in External Window}. + + You can select the help page to open upon startup in the \gui {Home Page} + field. + \section1 Using Documentation Filters You can filter the documents displayed in the \gui Help mode to find |