# Overview

## Definition

A macro is a high-level command, added to the Flux application, which regroups several commands in a given order. It receives (upon entry) one or more parameters and executes (upon exit) a series of predefined actions.

A macro file (*.py) is a text file, which defines the macro-function in the PyFlux language.

## Use

A macro improves the quality and efficiency of the user-software interaction due to:

• the regrouping of the repetitive commands
• its dialog box especially designed for the entrance of the parameters

## General operation

The operation mode of the most general type is presented in the table below.

Stage Description Context
1 Creation of the macro definition file Text editor
Creation of the image-formatted file for the associated icon (optional) Image editor
3 Execution of the macro Flux

## Some rules

Within the storage on the disk, a macro corresponds to a directory which includes:

• a file of the macro
• a file of the associated icon (optional)

The directory, the file of macro and the icon must be named after the macro-function.

Example:

• Name of the function: Polypoint3D
• Name of the directory of macro: Polypoint3D.PFM
• Name of the file of macro: Polypoint3D.py
• Name of the file of the associated icon: Polypoint3D.gif

## Location

The macros can be stored in any directory chosen by the user. The macros provided by Flux are stored within the specific directory extensions.