|
Mira Documentation and Help System
Mira includes extensive documentation and several
help systems. These are described below.
User's Guides and other Documents
|
Windows Help (local)
|
The Windows format Mira Help document ("User's
Guide") opens from the Help > Help
Topics menu command at the top of the Mira screen.
|
|
User's Guide (online)
|
Open the HTML format
Mira Pro x64 User's Guide from the Help menu at
the top of the Mira screen.
If the Internet is not available on this computer,
the User's Guide is available on your local computer by checking in
the
General Properties.
|
|
Script User's Guide (online)
|
Open the HTML format
Mira Pro x64 Script User's Guide for
complete documentation on the scripting language and more than 1000
functions, classes, and methods.
|
|
Tutorial
|
See the online
Getting Started Tutorial on the Mirametrics
website.
|
|
Topic Tutorials
|
See the list of
tutorials embedded in this User's Guide.
|
|
Script code samples
|
See the
Mira Pro x64 Script User's Guide.
Nearly every topic for a function or method includes a simple
example with source code.
|
Topic Help
Use "Topic Help" to learn about specific window or
command features. This help is accessed in different ways from
different types of windows:
|
Dialog Windows
|
Use the [Help] button
on the dialog. This button is usually at the lower left corner
(e.g.,
Rotate Image) or lower right corner
(e.g.,
Plot Properties) of the dialog. Some
image calibration dialogs (e.g.,
Create Master Flat) display the button
on the middle right side.
|
|
View Windows
|
Use the [?] button on
the
main toolbar. Click this button to
open Help for the top-most view window, including
Image,
Plot,
Chart,
3-D Plot,
Report ,
Script , and
Text Editor windows.
|
|
Docking Panes:
|
Use the drop menu button
from the button row at the right end of the pane's title bar. If
the docking pane has a pop-up menu, choose the Help Topics command from the menu. If the pane does
not have a menu, the Topic Help is immediately launched.
|
|
Docking Pane Toolbars in View Windows
|
Right-click the arrow button at the bottom of the
Toolbar. Note that left-clicking the same button disables the
command mode.
|
|
Keystroke Help Panes
|
Use the drop menu button
from the button row at the right end of the pane's title bar. These
panes are the
Image Keys Pane and
Plot Keys Pane.
|
|
Toolbar
button
|
This button, located at the bottom of a toolbar
(e.g.,
Point Measurements) is a dual-purpose
button when left-clicked or right-clicked. Like all of Mira's dual
purpose buttons, it shows a small red triangle on its lower right
corner:
|
Topic Help can use the Mira
Pro x64 User's Guide source from either the Internet or the
computer. The online version is periodically updated whereas the
computer version is updated when the Mira installation is updated.
The source is selected using the Use Internet Topic Help option in the
General Properties dialog. When Mira is first
installed, this option is set to false, meaning that Topic Help is
opened from the Mira installation on your computer. The installed
version should be selected when an Internet connection is
unavailable.
Warning about Cached Online Pages
After installing a new version of Mira, your web
browser may display cached pages from an obsolete version of an
online User's Guide. This can create issues with missing
topics or lost graphics. To refresh the cache, use Shift+F5 or Shift+Reload the first time you open the User's
Guide of a new Mira version. Some browsers do not respond to this
procedure and you may need to open Settings to clear the
cache.
Related Topics
Contents
New Features
Mira Support
Mira Pro x64 8.83 User's Guide, Copyright Ⓒ 2026 Mirametrics, Inc.
All Rights Reserved.
|