Go to: Synopsis. Return value. Keywords.
Related. Flags.
Python examples.
showHelp([string], [absolute=boolean], [docs=boolean], [helpTable=boolean])
Note: Strings representing object names and
arguments must be separated by commas. This is not depicted in the
synopsis.
showHelp is NOT undoable, queryable, and NOT
editable.
Invokes a web browser to open the on-line documentation and help
files. It will open the help page for a given topic, or open a
browser to a specific URL.
None
In query mode, return type is based on queried flag.
browse, documentation, web, page, help
help
absolute, docs,
helpTable
| Long name (short name) |
Argument types |
Properties |
docs(d) |
boolean |
  |
|
Use this flag to directly specify a help file relative to the
on-line documentation root. |
|
absolute(a) |
boolean |
|
|
The specified "URL" is an absolute URL that should be passed
directly to the web browser. |
|
helpTable(ht) |
boolean |
|
|
Use this flag to specify which file will be used to search for
help topics when the -d/docs and -a/absolute flags are not used. If
only a file name is specified and not a path, then the file is
assumed to be in the maya application directory.
If this flag does not accept an argument if it is queried.
The default value is "helpTable". |
|
| Flag can appear in Create mode of
command |
 Flag can appear in Edit mode of command |
| Flag can appear in Query mode of command |
 Flag can have multiple arguments, passed
either as a tuple or a list. |
import maya.cmds as cmds
# View the documentation for the launchBrowser command
#
cmds.showHelp( 'Commands/showHelp.html', docs=True )
# View the Autodesk home page
#
cmds.showHelp( 'http://www.autodesk.com/', absolute=True )
# Query for the full path to the help page on the Align Tool
#
cmds.showHelp( 'AlignTool', q=True )
# Set the help lookup-table to $MAYA_APP_DIR/customHelpTable
#
cmds.showHelp( 'customHelpTable', helpTable=True )
# View the help topic "Particle" found in customHelpTable.dat
#
cmds.showHelp( 'Particle' )