Using the Graphical User Interface

Launch the GUI with outline-extractor.sh.

The main window

One source panel (pick an extractor from the dropdown, then configure its properties in the table below it) and one target panel (same idea, for the writer), plus an Extract button. Picking a different extractor or writer replaces its property table with that provider’s own properties - nothing carries over between unrelated providers.

Three menus - File, View, and Help (mnemonics Alt+F, Alt+V, Alt+H respectively, where the platform supports them):

Item Shortcut Does

File > Load Configuration…​

Cmd+O

Opens a saved JSON configuration file (Configuration files)

File > Open Recent

A submenu of recently loaded configuration files

File > Save Configuration…​

Cmd+S

Writes the current extractor/writer selection and properties to a JSON file

File > Import JDBC Driver…​

Copies a JDBC driver jar into place (Importing a JDBC driver)

File > Exit

Quits the application (Windows only - macOS provides Quit in its own system menu instead)

View > Show Raw Property Names

Cmd+R

Toggles the property table’s left column between display name and raw config-file property name (The property table)

View > Show Descriptions

Cmd+D

Toggles an extra description column on the property table, resizing the window to make room

View > Show Extracted Outline Window

Cmd+T

Whether the next extraction’s progress dialog also shows the extracted outline as a tree (Running an extraction) - on by default, and not persisted between sessions

Help > User Guide

Opens this document (Getting help)

Help > About

Version and license information (Windows only - macOS provides About in its own system menu instead)

On macOS, Cmd is the shortcut modifier shown above; on Windows and Linux, the same shortcuts use Ctrl instead.

The property table

Each property appears as a row: its name/description in the left column, its value in the right. Boolean properties render as a checkbox rather than typed true/false text; password fields are masked as you type, both while typing and once entered.

Running an extraction

Clicking Extract opens a progress dialog with three areas: overall progress, what the extractor is doing, and what the writer is doing. It stays open after the run finishes (success or failure) rather than disappearing immediately, so you can read what happened - each provider can report a one-line summary of what it actually did (e.g. how many files were written, or where a database ended up), not just a generic "done." With View > Show Extracted Outline Window on (the default), the same dialog also shows the extracted Common Outline Format outline itself as a tree - every dimension and member, exactly as the writer received it - a quick way to sanity-check the extraction side independently of whatever the writer produced.

Configuration files

File > Load Configuration…​ and File > Save Configuration…​ read/write the same JSON format the CLI uses (Configuration files on the CLI page), so a configuration built by hand or by the GUI works in either place. File > Open Recent keeps a shortlist of recently loaded configurations.

Importing a JDBC driver

File > Import JDBC Driver…​ opens a file chooser - pick one or more .jar files and they’re copied into ~/.ngoe/drivers (Bringing Your Own JDBC Driver) for you. If a same-named driver is already there, it asks for confirmation before replacing it, and warns that replacing an already-registered driver only takes effect after restarting.

Getting help

Help > User Guide opens this document in a lightweight built-in viewer - the same content as the PDF manual, with its own navigable outline sidebar down the left side, generated directly from this page’s own headings.