matlab\helptools – Команды помощи

Accessing on-line HTML help

<helpbrowser> - Bring up the help browser.

HELPBROWSER Help Browser

HELPBROWSER Brings up the Help Browser.

Reference page in Help browser

doc helpbrowser

<helpdesk> - Comprehensive hypertext documentation and troubleshooting.

HELPDESK Comprehensive hypertext documentation and troubleshooting.

HELPDESK displays the start page for the online documentation

In the matlab Help browser.

Reference page in Help browser

doc helpdesk

<helpview> - Display HTML file in help viewer.

HELPVIEW Displays an HTML file in the Help browser or

"What's This Help" window.

SYNTAX:

helpview (topic_path)

helpview (topic_path, win_type)

helpview (topic_path, win_type, ...)

helpview (topic_path, win_type, parent)

helpview (topic_path, win_type, parent, ...)

helpview (map_path, topic_id)

helpview (map_path, topic_id, win_type)

helpview (map_path, topic_id, win_type, ...)

helpview (map_path, topic_id, win_type, parent)

helpview (map_path, topic_id, win_type, parent, ...)

ARGUMENTS:

topic_path

Path of an html file. The path must end in .htm(l) or

.htm(l) and an HTML anchor reference, for example,

/v5/help/helpview.html#topicpath

d:/v5/help/helpview.html#topicpath

map_path

Path of a map file (see below) that maps

topic ids to the paths of topic files. The path must

end in the extension .map, for example,

d:/v5/help/ml_graph.map

The map path may be of the form mapkey:KEY where KEY

identifies a map file specified in a topic map locator file

in a product's help tree.

topic_id

An arbitrary string that identifies a topic. HELPVIEW uses

the map file specified by path to map topic_id to

the path of the HTML file that documents the topic.

win_type

Type of window in which to display the help content.

Specify "CSHelpWindow" to use the context-sensitive help viewer.

Otherwise, the main "Help" window is used.

parent

Handle to a figure window. Used by the "CSHelpWindow" win_type

to determine the parent of the help dialog. This argument is ignored

if the win_type is not CSHelpWindow.

'position'

Position property (similar to figure property). This property

specifies the size and location on the screen of the help dialog.

This argument is ignored if the win_type is not CSHelpWindow.

csh_position

Position of the help dialog. Used by the "CSHelpWindow" win_type

to determine the size and location of the help dialog. This argument

is ignored if the win_type is not CSHelpWindow.

'size'

Size property. This argument is ignored if the win_type is not

CSHelpWindow.

csh_size

Size of the help dialog. Used by the "CSHelpWindow" win_type

to determine the size of the help dialog. This argument is ignored

if the win_type is not CSHelpWindow.

'location'

Location property. This argument is ignored if the win_type is

not CSHelpWindow.

csh_location

Location of the help dialog. Used by the "CSHelpWindow" win_type

to determine the location of the help dialog. This argument is

ignored if the win_type is not CSHelpWindow.

TOPIC MAP FILE

The map file is an ascii text file that is

essentially a two-column list. Each line is

of the form:

TOPIC_ID PATHNAME

The TOPIC_ID is an arbitrary string identifying

a "chunk" of online help contained in an HTML

file. Typically, the technical writer and the

developer will agree what these identifiers should be,

and the developer will use them in calls to helpview.

PATHNAME is a topic_path relative to

the directory containing the map file.

For example, suppose the following map file

% creating_plots.map

zoom ../creating_plots/data_ex8.html#zoom

panning ../creating_plots/data_ex9.html#panning

is in the directory DOCROOT/techdoc/creating_plots, where DOCROOT

is the root directory of the MATLAB help system. Then,

the following call

helpview([docroot '/techdoc/creating_plots/creating_plots.map'], 'zoom');

is equivalent to

helpview([docroot '/techdoc/creating_plots/data_ex8.html#zoom']);

Examples:

map_path = [docroot '/techdoc/matlab_prog/matlab_prog.map'];

helpview(map_path,'matlab_data_types','CSHelpWindow');

helpview(map_path,'matlab_data_types','CSHelpWindow','size',[500 400]);

helpview(map_path,'matlab_data_types','CSHelpWindow', 'location', ...

[100 100]);

helpview(map_path,'matlab_data_types','CSHelpWindow', 'position',...

[50 50 100 100]);

Overloaded methods:

uiservices.helpview

rptparent/helpview

<doc> - Display HTML documentation in the Help browser.

DOC Reference page in Help browser.

DOC opens the Help browser, if it is not already running, and

otherwise brings the Help browser to the top.

DOC FUNCTIONNAME displays the reference page for FUNCTIONNAME in the Help browser. FUNCTIONNAME can be a function or block in an