assistant.leaf

Linux下的基于X11的图形开发环境。

\i \Menu{View|Zoom in} increases the font size.
\i \Menu{View|Zoom out} decreases the font size.
\i \Menu{View|Views|Sidebar} toggles the display of the Sidebar.
\i \Menu{View|Views|Toolbar} toggles the display of the Toolbar.
\i \Menu{View|Views|Line up} lines up the toolbar buttons in the
Toolbar.
\endlist

\section2 The Go Menu

\list
\i \Menu{Go|Previous} display the previous page.
\i \Menu{Go|Next} display the next page.
\i \Menu{Go|home} go to the home page.
\endlist
This menu also has additional items; these are pre-defined bookmarks
that vary depending on your configuration.

\section2 The Bookmarks Menu

\list
\i \Menu{Bookmarks|Add} add the current page to the list of bookmarks.
\endlist
This menu may have additional items, i.e. any bookmarks that you have
already made. If you want to delete a bookmark go to the Bookmarks tab
on the Sidebar.

\section1 The Dialogs

\section2 The Print Dialog

This dialog is platform-specific. It gives access to various printer
options and can be used to print the current page.

\section2 The Find Text Dialog

This dialog is used to find text in the current page. Enter the text
you want to find in the Find line edit. If you check the 'Whole words
only' checkbox, the search will only consider whole words, i.e. if you
search for 'spin' with this checkbox checked it will not match
'spinbox', but will match 'spin'. If you check the 'Case sensitive'
check box then, for example, 'spin' will match 'spin' but not 'Spin'.
You can search Forward or Backward from your current position in the
page by clicking one of the Direction radio buttons. Click the \Button
Find button to search (or search again), and click the \Button Close
button to finish.

\section2 The Settings Dialog

This dialog is used to set your preferences for \QA. In order to 
confirm your changes click \Button OK; or click \Button Cancel
to keep the previous settings. \QA will remember your 
settings between sessions, including window sizes and positions, 
and which pages you have open. The Settings dialog contains the
following tabs:

\list
\i General Settings

To change the base font used throughout \QA, select a 
font type from the Font combobox. To choose a new fixed-width 
font, to show code snippets for example, choose a font type from 
the 'Fixed font' combobox. To change the color of hypertext 
links, click the 'Link color' color button. Uncheck the 
'Underline links' checkbox if you don't want underlined links. 

\i Web Settings 

Some pages contain links to external web pages. In order to display
these links, you must specify a web browser. Click \Button Browse to
invoke the \Widget Assistant dialog and navigate until you find the
web browser you wish to use. Click \OK to accept the
selection. Alternatively, type in the name of your browser's
executable in the line edit.

\i Documentations 

To add your own documentation to \QA, click \Button Add to invoke the
\Widget Assistant dialog. Navigate through the files until you find
the documentation you want to add and then click \OK. Click \Button
Delete to remove obsolete documentation from the Documentations
list box. Read more about adding your own documentation in the next
chapter, \l {Adding Documentation to Qt Assistant}. 

\i Categories

All documentation is categorized, for example,
development, office, multimedia, etc. To create a new category, type
its name in the Category Name line edit and click \Button Add. The
new category appears in the Categories list box with a checkbox to its
left. Leave the box checked to display all of the category's
available documentation. To remove a category, select it from the list
box and click \Button Delete. For further information about
categories read the next chapter, \l {Adding Documentation to Qt Assistant}.
\endlist

\chapter Full Text Searching

From Qt 3.1, \QA offers a powerfull full text search engine. In order
to search for certain words or text, go to the 'Search' tab in the
sidebar. Then enter the text you are looking for and press \Key Enter
or click \Button Search. The search is always case insensitive, so
Foo, fOo and FOO are all treated as the same. The following search
patterns can be used:

\list
\i \c deep -- lists all the documents that contain the word 'deep'

\i \c{deep*} -- lists all the documents that contain a word beginning
with 'deep'

\i \c{deep copy} -- lists all documents that contain both 'deep' \e
and 'copy'

\i \c{"deep copy"} -- list all documents that contain the phrase 'deep copy'
\endlist

The wildcard (*) character cannot be used within quotes. 

The list of documents is ordered according to the number of
occurrences of the search text they contain, with those with the
highest number of occurrences appearing first. Simply click any
document in the list to have it display in the document pane.

If the documentation is changed, e.g. if new documents are added or
old ones removed, \QA will reindex. At present this only works for
latin1 encoded documents, i.e. Unicode is not yet supported.

\chapter Adding Documentation to Qt Assistant

Adding new documentation to \QA is straight-forward. You simply
specify a new documentation content file for \QA to use.

Click \Menu Edit|Settings to invoke the \Widget Settings dialog. Click
the \Menu{Documentations} tab. Now click \Button Add to invoke a
file open dialog. Select the new documentation's content file. (This
file must be an XML file in \QA's documentation content file format.)

Another way to add your own documentation is, to start \QA with the
commandline option '-addContentFile' followed by the documentation
content file.
Example: assistant -addContentFile /mycompany/myapp/help.xml

\QA will parse this file, add it and quit, i.e. no mainwindow will
be shown. This way can be used when adding documentation during an
installation process. 

If the new documentation belongs to a category which does not
currently appear in the Categories list box, you can add the category
using the \Widget Settings dialog. It is not normally necessary to do
this manually since \QA detects new categories and adds them
automatically. 

The format of the documentation content file is described in the
following section.


\section1 Documentation Content File format

The file must contain the documentation's table of contents and all
important keywords for the index. Furthermore, it should inherit a
category specification.

An example of a content file with all available tags is shown below:

\c demodoc.xml

\code
<!DOCTYPE DCF>
<DCF ref="demo.html" category="qt/development" title="Development Demo Handbook">
<section ref="./chap1/chap1.html" title="Chapter1">
    <section ref="./chap1/section1.html" title="Section1">
	<keyword ref="./chap1/section1.html#foo">foo</keyword>
	<keyword ref="./chap1/section1.html#bla">bla</keyword>
	<section ref="./chap1/section1.html#subsection1" title="Subsection 1"/>
	<section ref="./chap1/section1.html#subsection2" title="Subsection 2"/>
	<section ref="./chap1/section1.html#subsection3" title="Subsection 3"/>
    </section>
    <section ref="./chap1/section2" title="Section2">
	<section ref="./chap1/section2.html#subsection1" title="Subsection 1"/>
	<section ref="./chap1/section2.html#subsection2" title="Subsection 2"/>
	<section ref="./chap1/section2.html#subsection3" title="Subsection 3"/>
    </section>
</section>
<section ref="./chap2/chap2.html" title="Chapter2">
    <keyword ref="./chap2/chap2.html#foo">foo</keyword>
    <section ref="./chap2/section1.html" title="Section1"/>
</section>
</DCF>
\endcode

Sections may be nested as deeply as necessary. All references should
be related. 

Note that any \c keyword tags for a given section must appear \e
before any sections nested within the given section.

The paths in the \c refs attribute are always written Unix-style
(forward slashes) and are relative to the location of the
documentation content file itself.