The Documentation Node
The main Documentation node () contains information about the formatting and defaults for a documentation. Click the Preview Selected () or Preview All () button to show a preview of the document in the Preview window. Click the Write button () in the toolbar for the Documentation Settings window to create a document. The Write option is also available by right-clicking any node in the documentation. Selecting Write from any documentation node’s context menu generates the entire document.
Format
You can select to create a document in one of the following formats, which you choose from the Output format list:
•
HTML (the default format), for creating the document as an HTML file for display in a web browser.
•
Microsoft Word, for creating the document as a Microsoft® Word .docx file.
•
Integrated help, for creating a help project folder that can become an integral part of the COMSOL documentation and help system.
Settings for Documentation in HTML Format
When generating documentation, you need to specify its name and title where to store the file. Enter the output directory for the HTML files in the HTML output directory field, or click Browse to open the Specify HTML Output Directory dialog box and browse to the desired location. Also specify the document's name a title in the Document name and Document title fields, respectively.
Settings for Documentation in Microsoft® Word Format
These settings are the same as for the HTML format, except you specify the output directory in the Word output directory field or using the Specify Word Output Directory dialog box.
Settings for Documentation as Integrated Help
When creating an integrated help project, you need to specify the following details and properties:
•
Enter the output directory for the help project in the Help output directory field, or click Browse to open the Specify Help Output Directory dialog box and browse to the desired location.
•
Enter a Namespace to use a common namespace for your help projects.
•
Enter project name and title in the Name and Title fields. The complete project name is formed from the namespace and the name. The title is the text that displays in the Contents tree on the left side of the standalone Help window or on the Contents page of the Help window for context-sensitive help integrated in the COMSOL Desktop.
•
From the Add to list, select None (the default) to not link the project to the contents of any COMSOL product, or select COMSOL Multiphysics or any of its modules to link the documentation to that of one of the products. As an advanced option, you can select Custom to link to a custom help project that you specify in the Link to help project folder field and the Link to anchor ID field. The custom help project must contain the specified anchor for your help project to link to.