Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions

[Prev: Customizing Qt Assistant with Profiles] [Home]

Adding Documentation to a Profile

In order to add new documentation to a profile you must specify a new documentation content file.

Click Edit|Settings to invoke the Settings dialog. Click the Profiles tab. Now select or create a new profile and click Add or Modify to invoke the Edit Profile dialog. Then go to the Documentation list and click Add to invoke the Add Documentation dialog. Select a new documentation content file; the file must be an XML file in Qt Assistant's documentation content file format. Qt Assistant will read the file, and if the file is valid it is added to the profile.

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

Documentation Content File Format

The Documentation Content file must contain the documentation's table of contents and all important keywords for the index. In addition, it may inherit an icon for the documentation which will be used in the Qt Assistant toolbar. You can also specify an extra directory path for additional images used in the documentation.

An example of a content file that uses all the available tags and attributes is shown below:

demodoc.dcf

<!DOCTYPE DCF>
<DCF ref="demo.html" icon="handbook.png" imagedir="../img/"
     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>

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

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

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