DocJet generates documentation from source code. It is convenient to have an overview description that summarizes the project/product/APIs you document. The top page also refers to all the generated source code documentation. Normally, the top page is located at the top of your development structure.
Figure blow shows an example of a top structure file, to be used from a web browser.
You can generate these pages using the TopJet application and templates placed in WinSDE_HOME/Forms/TopDoc directory. By using TopJet you avoid manual creation and updating of the top page.
The figure below shows the TopJet application:
Using TopJet you can:
Create the top HTML page which includes links to all HTML contents files
for each project created by DocJet. By default, the links
to Documentation\AdvantHTML\contentsf.html are created in
the DocLinks.htm file. The default top page is an HTML
frame (file DocTopFrame.htm), and the frame home page is
defined as DocHome.htm file. The output file, named DocLinks.htm, is created by default from the DoclinksTemplate.htm file.
All input files can be copied from the WinSDE structure by Import command. The top document is created in the specified root directory. All the input files and templates can be modified by any text or HTML editor.
Display the generated TopLinks file or the main HTML frame file. Use the command button Show to display the documents in the default Web browser.
Publish documents generated by DocJet and TopJet. The top and all related HTML pages from the root directory and all documents generated by DocJet are copied to a destination directory. The command button Publish starts the copying.