Professional Documents
Culture Documents
Home
Glossary
Index
Forms
About Forms
A Form provides a mechanism for viewing, querying and setting Minescape data
for a specific operation or task. In previous versions of Minescape, a form was
referred to as a screen. A form consists of panels each with an appropriate title
and containing various labels and fields.
Forms are used for a diverse range of tasks including:
viewing and selecting various Minescape data types
tracking and manipulating CAD coordinate geometry
obtaining measurements and information from the CAD window
viewing and setting display definitions for CAD graphics
setting input requirements and executing user-commands
setting an input Spec for a module and submitting it for execution.
An example of a form appears below.
Forms
Form features and their usage
Contents
Home
Glossary
Index
Form intrinsics
Standard behaviour
Minescape embraces Motif standardsstandard techniques for navigation and
usage therefore apply across all forms.
Form categories
Every form is categorised according to the type of functionality it provides. This
categorisation provides a convenient mechanism for storing and locating form
definition files and associated data such as related actions and Specs. Typical
examples of form categorisations include:
tables
designs
grids
cad
Forms
Form features and their usage
Contents
Home
Glossary
Index
Controls
Menu Bar
Some fields permit
you to select from
a pull-down
selection
list
Some fields
permit you
to enter
data
Default
Button
Fields
A number of different field types are used by Minescape forms. Each field type
has a specific appearance and associated usage characteristics. Some field
types permit you to enter dataMinescape data type fields go on to validate this
data. Some field types only permit you to select data from an available list of
options.
See also: Minescape data types in the Minescape Customisation Guide.
Menus
Most forms feature a standard Menu Bar which gives you access to generic
form-related operations. Menu options are sensitised and desensitised
according to the field currently selected.
Buttons
Standard (text label) form buttons are placed horizontally across the bottom of a
form. Some forms also feature icon buttons. A number of buttons are defined for
Minescape forms. Usually one button has a visible indent around itthis denotes
that the button is the default action button and that it can be selected at any time
by pressing Enter.
Forms
Form features and their usage
Contents
Home
Glossary
Index
Form decks
In a form-deck, tab-dividers appear horizontally across the top of the form. The
information in each individual tab-divider in the form-deck is referred to a form.
Tab-dividers
A tab-divider is a mechanism for identifying and selecting a layer from the form.
Tab-dividers are positioned horizontally across the top of a form (as part of a
form deck) and/or vertically down the right-hand side.
Help
All forms feature comprehensive on-line help facilities. At the click of a button you
can get:
help about a field
help about the form.
Form basics
Navigation
Navigating a form
Using the mouse
Menu items, fields, tab-dividers and buttons on a form are selected by leftclicking (pressing the left mouse button).
Using the keyboard
You can use Tabto move around the form. Selectable fields and the OK and
Apply buttons are sequentially ordered in a form. Use the following key
sequences for moving about a form using the keyboard:
Tab to move in a forward direction
Shift - Tab to move in a reverse direction.
Forms
Form features and their usage
Contents
Home
Glossary
Index
Forms
Form features and their usage
Contents
Home
Glossary
Index
Menus
The menus contained in any form are found in the Menu Bar of the respective
form.
The Pointer Menu is also accessible from any input field contained in the form.
Specs menu
The Specs menu can be found in any forms Menu Bar. To display the menu, leftclick on Specs.
The menu displayed on the left opens. Specs menu options are listed in the table
below.
Option
Action
Restore ...
Save
Save As ...
Clear
Initialise
Stow
Quit
Forms
Form features and their usage
Contents
Home
Glossary
Index
Fields menu
The Fields menu can be found in any forms Menu Bar. To display the menu, leftclick on Fields.
The number of options displayed on this menu depends on the field type
selected. The example below shows a Fields menu when a Design File field is
selected.
Fields Menu Options
Option
Submenu
Option
Select Item...
Row
Action
If more items exist that can be displayed in the fields
selection list, they can be displayed using the Select
an item option.
This option is only activated when the current field is a cell in a table. The
Row menu appears with the following options:
Fill Down
Delete
Insert Before
Insert After
Clear
Projects...
Browse...
Forms
Form features and their usage
Contents
Home
Glossary
Index
Option
Submenu
Option
Action
Create...
Copy...
Delete...
Edit...
Pick
Rename
View ...
Forms
Form features and their usage
Contents
Home
Glossary
Index
Help menu
The Help menu can be found in any forms Menu Bar. To display the menu, leftclick on Help.
The menu displayed on the left opens. Help menu options are listed in the table
below.
Option
Action
On Context ...
Invoke context sensitive help for the form. You can left-click the question
mark in a field to display field help or on the form to display form help.
Once you left-click, your help viewer starts up and the applicable help
topic displayed. On Context invokes the same action as the Help button
at the bottom of the form.
Manuals ...
Activates your help viewer which displays a catalogue of Minescape online manuals.
Trace ...
See also:
Forms
Form features and their usage
Contents
Home
Glossary
Index
Buttons
Depending on the function, different forms can contain a variety of buttons.
OK button
The OK button invokes the form apply action and dismisses the form using the
form terminating action (i.e. OK = Apply + Cancel).
Apply button
The Apply button invokes the form apply action but does not dismiss the form.
Cancel button
The Cancel button dismisses the form by invoking the terminating action. This
action does not pass any form data to the Minescape environment and has
the same effect as selecting Quit from the Specs menu or Close from the
window menu button.
Close button
In forms that contain a Cancel button, when the Apply button is activated, the
Cancel button changes to Close. After Applying the action, this button closes
the form.
Help button
The Help button invokes form help for the form.
Forms
Form features and their usage
Contents
Home
Glossary
Index
When the CAD Apply button is selected, the form is hidden from view and
stowed in the Docking Area thus enabling unobstructed access to the CAD
window.
Form is stowed
in the
Docking Area
When input in the CAD window has been completed, the form reappears. Select
Close to close the form.
If OK is selected, the form is stowed in the Docking Area but is closed after
completion of CAD input.
Forms
Form features and their usage
Contents
Home
Glossary
Index
Fields
Non-selectable fields
Non-selectable fields (also known as protected fields) display data but cannot be
selected or have their data changed.
Selectable fields
Selectable fields (also known as unprotected fields) display data and allow
interaction. A selectable field may be either:
Non-editable A non-editable field can be selected but its data cannot be
altered. Boolean (toggle) fields and Option fields are examples
of non-editable fields.
Editable
An editable field allows you to enter, change and delete data.
Data fields and Table fields are typical examples of editable
fields. When you select an editable field, the form Edit menu is
enabled.
Field input errors
Most editable fields are Minescape data type fields because they have an
Minescape data type parent which ensures the integrity and validity of any
entered data. For example, if a field requires the name of a design file as input,
you can only enter the name of a existing design file or create a new design file
and enter its name. If you enter invalid data to an Minescape data type field, an
error pop-up prompts you to make an alternative entry or selection.
See also: Minescape data types in the Minescape Customisation Guide.
Types of fields
A form can display the following types of fields:
Data fields
Boolean (toggle) fields
Option fields
Table fields
Forms
Form features and their usage
Contents
Home
Glossary
Index
Field focus
You can only enter data into a field when it is in focus. To do this you need to leftclick in the field. When a field is in focus it is bordered by a visible indent.
Modes
Forms are always registered against their parent.
Read mode
A form displayed in read mode cannot have its data edited or changed.
Read/write mode
A form displayed in read/write mode can have its data changed and updated.
When you select either the Apply or OK button, the forms data is submitted to
the Minescape environment for use by a Minescape process such as a module.
Display properties
Transient
A transient form takes the command focus from its calling parent thereby
restricting access to other current Minescape windows. Therefore you must
close the form before you can undertake further work in other parts of the
Minescape interface. A transient form is identified by an OK, Cancel and Help
button.
Non-transient
You can leave a non-transient form open for the duration of a Minescape session
without taking command focus from elsewhere in Minescape. A non-transitory
form always includes an Apply button.
Persistent
A persistent form is a form that when reopened, maintains the state in which it
was last closed.
Forms
Form features and their usage
Contents
Home
Glossary
Index
Using Specs
The data present in a form is collectively known as a Spec. A Spec is a list of
name:value pairings which Minescape uses to refer to data used in a project. All
Specs are namedMinescape uses its own naming schema to refer to Specs.
Typically, Specs are held in memory, however Minescape permits you to save
from data to disk as a named Spec. By doing this, you can refer to the Spec at
any time.
For UNIX
Form Specs are saved to the project ./formspec directory according to the
following convention:
Note: Do not add your own extensions to Spec namesthis is done by Minescape.
For NT
Form Specs are saved to the project .\formspec directory according to the
following convention:
Forms
Form features and their usage
Contents
Home
Glossary
Index
Note: Do not add your own extensions to Spec namesthis is done by Minescape.
Loading a Spec
Existing form Specs can be loaded/restored using this option. The values in the
form are replaced with those from a saved Spec.
To load a saved Spec to a form:
Select SpecsRestore from the form Menu Barthe following form appears.
Select the Load Spec tab-divider.
Enter the Category and the Name of the Spec you wish to load.
Select OK.
The fields on the current form are loaded with the values in the Spec that match
the variable names.
Forms
Form features and their usage
Contents
Home
Glossary
Index
Restoring a Spec
This options enables an existing form Spec to be restored i.e. the values in the
form are replaced with those from a saved form.
The form must have been saved using the Save As option.
To load the values from a Spec saved for another form, change the Form field
(and/or the Subcategory field). The required name can then be selected from
the pull-down selection list
. When the Form field is modified, the first name
of any Spec saved for that form is loaded into the Name field.
To restore the default of another form into the current one, change the Form to
formall defaults in the current sub-category are then listed.
To restore a saved Spec to a form:
Select SpecsRestore from the form Menu Barthe following form appears.
Select the Form Restore tab-divider.
Subcategorythe default for the current form
e.g. minescape/tables.
./formspec[<category><formname>.form.
For NT
.\formspec[<category><formname>.form.
Select OK.
The Spec is loaded to the form.
Forms
Form features and their usage
Contents
Home
Glossary
Index
Updating a Spec
To update a Spec:
The Spec is saved to the same name and updated with the changes.
Saving a named Spec
To save a Spec as a named Spec:
./formspec/<category>/<userid>.<formname>
e.g. ./formspec/minescape/tables/fred.mns_tabpost
according to the forms category.
For NT
.\formspec\<category>\<userid>.<formname>
e.g. .\formspec\minescape\tables\fred.mns_tabpost
according to the forms category.
Forms
Form features and their usage
Contents
Home
Glossary
Index
Select OK.
./formspec/[<category>]/<name entered>.<formname>
e.g. ./formspec/minescape/tables/fred.mns_tabpost
according to the forms category.
For NT
./formspec/[<category>]/<name entered>.<formname>
e.g. ./formspec/minescape/tables/fred.mns_tabpost
according to the forms category.
Forms
Form features and their usage
Contents
Home
Glossary
Index
Clearing a Spec
To clear all data fields in a form, select SpecsClear from the form Menu Bar.
Initialising a Spec
To restore the form to the field values displayed when it was first opened, select
SpecsInitialise from the form Menu Bar.
Forms
Form features and their usage
Contents
Home
Glossary
Index
Forms
Form features and their usage
Contents
Home
Glossary
Index
More Items
Select the field in the form for which you want to list
the items.
Enter an expression
Select the item
Forms
Form features and their usage
Contents
Home
Glossary
Index
Select FieldsCreate from the form Menu Bar or select Create from the
Pointer Menuthe form used to create a new instance of the data type
appears.
Select the
field in which
to create the
new date
Using this form,
Select
FieldsCreate
The Create
Design File
form appears
Forms
Form features and their usage
Contents
Home
Glossary
Index
Select the field containing the data whose attributes you want displayed.
Select FieldsView from the form Menu Bar or select View from the Pointer
Menuthe attributes are displayed in a separate window.
When you are finished checking the data attributes, select Cancel to dismiss
the form.
Forms
Form features and their usage
Contents
Home
Glossary
Index
Pick the required element from the CAD window by double left-clicking.
The appropriate details from the selected element appear in the
corresponding input field in the form.
Forms
Form features and their usage
Contents
Home
Glossary
Index
or
The Column Filldown Selection form opens (see above) with all of the items
highlightedthese selections can be cleared by selecting the Clear button or
selected/deselected using the F12 left click or Ctrl left-click.
Forms
Form features and their usage
Contents
Home
Glossary
Index
The list may be sorted and displayed using the Sort and display list in reverse
order
button. If this button is depressed, the list is sorted in ascending
order, or descending order if it is not depressed.
To filldown a table in a specific order, items can be raised to the top by selecting
one or more items and selecting the Raise Items
button or by double leftclicking an item in the list.
Items in the Item Selection panel can be selected/deselected using one of the
following methods:
1. Select/deselect multiple items and select OK.
2. Enter a wildcard in the template field (in the accompanying example, A* is
used).
select OKthe table cells in the selected field in the form are filled with all
items commencing with A.
Note: Fill
down does not ask for a template if there are less than 250 items on the list.
First clear (deselect) the highlighted items by selecting the Clear button.
Now, for example, enter A* and select the Filter button; then enter F* and
select the Filter buttonall items starting with A and F are highlighted.
Select OK. The selected items are placed in the current row and
subsequent rows of the table column.
If the field is an extended data type field (e.g. BLOCKS) a list of possible values
is displayed. To generate the values, select the Generate button. The following
form opensthis form allows a naming convention to be defined in order to
generate names to fill down a list.
Forms
Form features and their usage
Contents
Home
Glossary
Index
Note: The default base source value is displayed in the Base value field and is the first
name found in the selected items. If the existing value in the field is to be used for
the source, the Base value field should be cleared.
Note: A Step Size may be set for Counter parts. Scroll to the right to set this advance
option. It may be positive or negative in value. Missing or zero values are treated as
a step of one.
Forms
Form features and their usage
Contents
Home
Glossary
Index
Deleting a row
To delete a row:
To insert a blank row above the current row, select Insert Before or use
CtrlF5. To insert a blank row below the current row, select Insert After,
or use F5
Forms
Form features and their usage
Contents
Home
Glossary
Index
Getting help
Form help
Form help provides information on form usage and output. Form help can be
accessed by:
See also:
Field help
Field help provides information on the data required for a field. Field help can be
accessed by:
left-clicking on the field for which help is required and selecting F1.
selecting HelpOn Context from the Page Menu Bar and left-clicking on the
field for which help is required.
See also:
Exiting a form
You can exit a form by:
selecting the OK button to dismiss the form and execute its apply action
selecting the Cancel button to dismiss the form without executing its apply
action
if Apply has been selected and the Cancel button has changed to Close,
select Close to exit the form.
selecting SpecsQuit from the form Menu Barthe form is dismissed
without executing its apply action
selecting Close from the form window menu button
.
double-clicking on the form window menu button.
Forms
Form features and their usage
Contents
Home
Glossary
Index
Contour
Bubble help that provides the function of the stowed form can be
displayed by placing the cursor over the icon.
To access the stowed forms, simply left-click on the icon.
Accessing Data
The Minescape Explorer
The Minescape Explorer is a special Minescape form which provides access to
all data used in the current Minescape project. It provides a focal point for all
Minescape data-related actions, allowing you to perform a variety of generic
operations including create, copy, delete, import, export, edit, graphics and
process operations.
Data types are logically categorised into folders in the Minescape Explorer.
Related data is displayed hierarchically in child folders beneath each parent
folder. For example, the Design file hierarchy
folder contains Layer
folders for the design files that currently exist in the project.
The Minescape Explorer is the only default form that does not use the standard
Minescape forms Menu Bar, but instead uses its own special menu that provides
access to the forms generic operations.
The Minescape Explorer is a persistent formits current state is maintained
between closing and opening.
Forms
Form features and their usage
Contents
Home
Glossary
Index
or
File menu
(different to
standard
form menu)
Create
Delete
Export
View
Edit
Process
Graphics
Rename
Stow the Minescape
Explorer
Icon buttons
for standard
data operations
Hierarchy
Indicator
Data types
by category
See:
Data items
are selected
in this panel
Forms
Form features and their usage
Contents
Home
Glossary
Index
Highlight (Shift-left-click) the last item in the list (all items between the two
selected items are highlighted).
or
Forms
Form features and their usage
Contents
Home
Glossary
Index
Generic actions
Once a data item is selected, you can perform an action. The generic operations
available using the Minescape Explorer may be accessed by using the buttons
that appear horizontally across the top of the form, via the form File menu or by
dragging-and-dropping an item onto the button. The following generic actions
are available:
Button
Name
Action
Create
Import
Import data into the selected data item, offering all registered methods for
importing to the selected data type.
Export
Export data from the selected data item, offering all registered methods for
exporting from the selected data type.
Delete
Edit
Edit the selected data item by invoking the editor registered for data of that
type.
View
Rename
Copy
Copy the selected data item by generating a new instance of the same type.
Info
Graphics
Process
Process the selected data item, offering all registered processing option for
data of that type.
Reverse sort
Refresh
Forms
Form features and their usage
Contents
Home
Glossary
Index
Forms
Form features and their usage
Contents
Home
Glossary
Index
Note: The list of files presented for selection in the File Browser form (see below) will be of the
same data type. This field is automatically updated on completion of the following form.
IMPORTANT
Select FieldsProjects from the Menu Bar or select Projects from the fields
Pointer Menuthe following form opens:
Select the Project containing the file to be accessed from the pull-down
selection list.
Forms
Form features and their usage
Contents
Home
Glossary
Index
Select the File name whose data you wish to access from the pull-down
selection list
Select OKthe file name is written to the selected field.
Note: The list of files presented for selection in the File Browser form (see below) will be of the
same data type. This field is automatically updated on completion of the following form.
IMPORTANT
Select FieldsBrowse from the Menu Bar or select Browse from the fields
Pointer Menuthe following form opens:
On an NT platform, / in the pathname below would be substituted with \
Forms
Form features and their usage
Contents
Home
Glossary
Index
Double clicking a directory name will add that name to the Directory field and
display all files contained in that directory in the panel below the field.
Double clicking a file name in the panel below the Directory field selects the
file and closes the form. The selected file name is added to the field in the
form e.g. in the example above, the Design File field.
Select OKthe file name is written to the selected field (e.g. the Design File
field in the above examples).
Customising forms
i
See: