The Help Window and Topic-Based Help
The Help window is useful as it is connected to many of the features in the COMSOL Desktop. This concept is called topic-based help or context help. You can also search and access all the HTML documentation content from this window.
The Help system automatically starts a web server using port 8090 on the computer where COMSOL Multiphysics is installed. Depending on the security settings, you might get a question to allow that port to be used the first time the help system is started.
The operating system might also issue a firewall security warning. To use Help, allow COMSOL Multiphysics access through the firewall.
To learn more about a node in the Model Builder, or a window on the Desktop, click to highlight a node or window, then press F1. The Help window opens and displays the topic information about the selected feature.
Opening the Help Window and the Topic-Based Help
There are several ways to open the Help window:
•
Press F1.
•
In the main toolbar, click Help ().
•
In the upper-right corner of the COMSOL Desktop, click the () button.
•
From the main menu, select File>Help (Windows) Help>Help (Linux and macOS).
•
Right-click any node in the Model Builder and select Help.
About Using the F1 key to access Context Help
To display topic-based (context) information in the Help window, on the COMSOL Desktop:
•
Click to highlight a node in the Model Builder tree. For example, the Component or Geometry node.
•
Click a window tab, for example, Model Builder, Add Study, or Messages.
•
For Windows users, hover over ribbon buttons or menu items to display a tooltip. While the tooltip is showing, you can press F1 to display more detail.
At the top of the Help window you find the tools and search functionality listed in the table below. Also, above the help text, a clickable breadcrumb trail shows the location of the displayed contents in the COMSOL documentation set. Click any part of the trail to move to that level in the COMSOL documentation.
In some cases you need to refocus the context help on its target before pressing F1. Try clicking to highlight a node, a window, or the button or click to focus on the Help window, hover over a toolbar button (Windows only) and press F1.
Table 1-1: The Help and Documentation Toolbars
Button
Name
Description
Click the Home button or select the COMSOL Documentation top node in the table of contents tree to return to the COMSOL Documentation window home page. Not available when showing context help in the Help window.
Show Table of Contents/Show Topic
When a help topic page is shown in the Help window, click Show Table of Contents to open a tree-based menu of the COMSOL documentation. When you select a node in the table of contents tree the corresponding topic is shown on the topic page. Alternatively, click again (Show Topic) to return to the topic page.
Search
On the Help window, click to open the search engine to look for contents in the COMSOL documentation. Search results are shown sorted by product.
On the Documentation window, enter search terms in the field and choose the Search scope — All documents, Selected only, or Application libraries.
See Searching Help and Documentation Content for more information about search terms you can use.
/
Back
Navigates backward to the previous page in the Help or Documentation window’s browser history.
/
Forward
Navigates forward in the browser history, but only to the end of the current list.
Sticky Help
On the Help window, click the Sticky Help button to lock the current help window (the icon is highlighted ), which can be useful to keep some help topic or model instruction active, or to release the window and view topic-based (context) help when a node or window is clicked.
Show in External Browser
On the Help window, click the Show in External Browser button to show the current help topic in an external web browser.
Navigates backward to the previous section in the documentation.
Navigates forward to the next section in the documentation.
Changing the Default Documentation and Help Settings
To edit the following settings, open The Preferences Dialog Box and click Help.
Locate the Target area and choose Documentation window (the default) from the Show documentation in list to show the help contents in the Documentation window that is included in the COMSOL Desktop environment (default), or select External browser to display the help contents in a separate web browser. For further details on how to access and use the documentation, see the section The Documentation Window below. Similarly, using the Show help in list, you can choose between Help window (default) and External browser to show topic-based help in the Help window inside the COMSOL Desktop or in an external web browser, respectively. When showing topic-based help in an external browser, you need to press F1, choose Help>Help, or select the Help context menu item (when applicable) to trigger an update of the browser’s contents. The PDF-file target setting controls what happens when you click a PDF link on the COMSOL Documentation entry page. Choose In place to display PDF documents using the native browser’s PDF display settings, or choose New window to launch them in the default system application for PDF-files. On Windows, the native browser is always Microsoft Edge or Internet Explorer.
In the Source area, set the Location to Local to display help using locally installed help files or to Online to access help from the COMSOL website. For the Local option, edit the Documentation root directory file path as required. The default file paths are based on the platform:
•
On Windows C:\Program Files\COMSOL\COMSOL55\Multiphysics\doc, or generically COMSOL55\doc.
•
For macOS and Linux, under the main COMSOL installation directory: COMSOL55/Multiphysics/doc.
Proxy Server Settings
If you connect to the internet through a web proxy, you can use the controls in the Proxy server settings area to specify the proxy server settings to use when communicating with the COMSOL website for displaying online help in integrated mode as well as for performing updates of the COMSOL Application Library and the COMSOL Part Library (see The Application Library Update Window and The Part Library Update Window for further details about these services).
The Configuration list has the following options:
•
 No proxy server: Connect to the update server directly, bypassing any proxies. This is the default setting.
•
 Use system settings: Use the system-wide proxy server settings defined on your computer.
•
 Manual: Choose this alternative if you want to specify a proxy server by entering the name (or IP address) and port number in the Server and Port number fields. The default port number is 443, which is the default for HTTP secure (HTTPS). If the proxy server requires authentication, you are asked to provide username and password the first time in each COMSOL session you access documentation or update the COMSOL Application Library or Part Library.
Selecting a Web Browser
In the General section of the Preferences dialog, under Web browser (Windows and Linux only), you can choose which browser the COMSOL Multiphysics software should use to show pages on the COMSOL website and documentation when using the web browser mode. The following settings are available:
•
On Windows: Choose the Program setting System default to use the default system web browser. Alternatively, choose Custom and then give the path to an Executable location for a different browser installed on your computer.
•
On Linux: Type the path to the web browser directly in the Executable field, or click the Browse button and then point to the executable file on the file system.
On macOS, this setting is not available, and COMSOL Multiphysics always uses the system’s default web browser.