1.3. The ToolRunner GUI

1.3. The ToolRunner GUI
	Chapter 1. Introduction to ToolRunner

Figure 1.1. ToolRunner Main Window

The main menu offers general file handling, preferences, display options, and extras. See Main menu.

1.3.1. FileList Area

The FileList area is dedicated to file handling:

Button menu for file list: Shortcut buttons for some typical functions; also a filter option for filtering the displayed files.
File list: Lists files for the process. Can be saved as .mlfilelist file. For each file, the name, package, path, and extension are displayed.

It is possible to select several or all files in the file list and start the according processes.

To add files to the file list,

select File → Add Files from Directory or File → Add Files from Packages.
or directly drag files from a file browser into the file list.

If more files than necessary are in the list, you can

delete files from the list by selecting them and pressing DEL.
click Clear to remove them all.
select the wanted files and click Hide Deselected to hide the others.
enter a filter term to narrow the list.

1.3.1.1. File List Button Menu

Figure 1.2. File List Button Menu

Select All: Selects all files in the file list.

Show All: Displays all files. Same effect as Show → Show All.

Hide Deselected: Hides all files in the file list that are currently not selected. This function works repeatedly so that you can hide more and more files in the process. Same effect as Show → Hide Deselected.

Clear: Clears the currently displayed list of files (will not delete saved .mlfilelist files). Same effect as File → Clear FileList.

Filter: In the filter field, you can enter terms to filter the list. The filter will be applied immediately.

Figure 1.3. Filter

Options:

Match Case: Check to take the lower/upper case of the entered filter term into account.
Substring: Check to use the filter term like in a wildcard search.

1.3.2. Execution Area

The Execution area is dedicated to the execution of build processes.

Button menu for starting the process(es): Starts, skips, and cancels the default processes for the selected files (e.g., Run on Selection will generate, e.g., HTML and PDF files from .mldoc (documentation) files); also contains options for log file creation and verbose mode.
Output area for files: Displays the results of the process and the link to the report. The output file names are links; double-click them to open the files.
Output area for process information: Displays information for each process in order of processing. If several processes are running at the same time, the information will get mixed up.

You can edit the file list while a process is still running. We recommend that you check the create log files option in this case, which will result in one log file per processed file and facilitates later analysis of failed processes.

1.3.2.1. Run Button Menu

Figure 1.4. Run Button Menu

Run on Selection: Starts the process based on the currently selected files.

Skip: Skips the currently processed file and proceeds with the next file.

Cancel: Cancels the whole process.

Options:

Create log files: Check to create log files (.log) for each processed file. The log files will be stored in same directory as the output.
Verbose mode: Check to set the verbose mode. Every processing step will be listed explicitly.