Help Browser Overview

About the Help Browser

The Help browser is an HTML browser integrated with the MATLAB® desktop. Use the Help browser to search and view documentation and demonstrations for MATLAB and all other installed MathWorks™ products. MATLAB automatically installs the documentation and demos for a product when you install that product.

Opening the Help Browser

To open the Help browser, click the Help button in the desktop toolbar, type helpbrowser in the Command Window, or use the Help menu in any tool. There are two panes:

Resizing the Help Browser

To adjust the relative width of the two panes, drag the separator bar between them. You can also change the font in either of the panes — see Help Fonts and Colors Preferences.

Once you find the documentation you want, you can close the Help Navigator pane so there is more screen space to view the information itself. This is shown in the following figure. To close the Help Navigator pane, click the Close box Image of Help browser display (right) pane. The Navigator (left pane) is closed, which you can do by selecting Help Navigator from the View menu. To reopen the Navigator, click the Navigator icon on the toolbar. in the pane's upper right corner. To open the Help Navigator pane from the display pane, click the Help Navigator button on the toolbar. Alternatively, use the View menu.

Types of Documentation

The Help browser and help functions provide access to the following types of information for all installed MathWorks products. The icons shown here appear in the Help browser contents listing to help you quickly identify documentation by type.

Icon

Type of Documentation

Description and When to Use

Getting Started icon

Getting Started

Review Getting Started documentation before you begin using a product or feature for the first time. Then, to learn more, go to the user guides, reference pages, demos, and examples.

Orange book icon or

Blue book icon or

Green book icon

Product

MATLAB, toolboxes, and related products use orange book icons . Simulink® software, blocksets, and related products use blue book icons . Link and Target products use green book icons .

Examples icon

Index of Examples

Accessible via the Help browser Contents listing, this is an index of the major examples included in the Help browser documentation.

User guide icon

User Guides (blue)

User guide material contains overviews as well as detailed instructions. Consult it after reviewing Getting Started material.

Reference pages icon

Reference Pages (orange)

Each function has a reference page that provides the syntax, description, examples, and other information for that function. Each reference page includes links to related functions and additional information. Reference pages are also provided for blocks and properties.

Release Notes icon

Release Notes

An overview of new products and features in a release. Release Notes also include upgrade information, links to fixed and known problems, and compatibility considerations. Review the Release Notes for all your products when you first start using a new release. Release Notes for the current version include the release notes for multiple prior versions.

PDF icon

Printable Documentation

Most products provide access to the online documentation in a printable format, PDF. Access PDF files via the Help browser and print them from your PDF reader, such as the Adobe® Acrobat® product. Most PDF files reside only on the MathWorks Web site, so you need an Internet connection to view them.

none

Demos

MathWorks products come with demonstrations that run key features of the product. Many of the demos run MATLAB code. Use the Help browser Demos pane or Search Results to access demos for the products you have installed.

none

M-File Help

Get M-file help in the Command Window to quickly access basic information for a function or model. It provides a brief description of a function and its syntax. It is called M-file help because the text of the help is a series of comments at the top of the M-file for a function.

Accessing Documentation on the Web

You can access all product documentation on the MathWorks Web site at http://www.mathworks.com/access/helpdesk/help/helpdesk.html. These are some uses for the Web site version of the documentation:

To determine the URL for a page in the Help browser, see View the Page Location

PDF documentation is available only on the Web site.

You cannot read MATLAB documentation files from the installation media for MATLAB. You also cannot use a Web browser to read the documentation files installed with MATLAB because the files are compressed JAR files.

Adding Your Own Help Files

You can add your own HTML help files so that they appear in the Help browser. For details, see Adding Your Own Toolboxes to the Development Environment in the HTML documentation (in the Help browser, or on the Web site).

Documentation in Other Languages

The MathWorks documentation is available in English. Japanese versions of MATLAB include documentation that has been translated into Japanese. For more information, go to http://www.cybernet.co.jp/matlab.

  


 © 1984-2008- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS