UI settings

The MAT UI has a number of available settings which you can use.

The Tabs menu

The Tabs menu looks like this:

This menu is initially blank. It lists all tabs which have been opened and not closed. If you select a tab in this menu, the UI will display the tab (if it's hidden), and make it the active tab (if it isn't). You can hide tabs by pressing the "-" button at the right end of the tab, and make them visible again using this menu.

The View menu

The View menu looks something like this:

[view menu]

The settings in this menu vary according to the type of tab that's active. The settings you see here are:

The settings listed in the View menu are only some of the available features. In order to see all the settings, select "All settings..." from the View menu. This will bring up a modal dialog which permits you to change the settings of all the available settings, including those for other types of tabs and those advanced settings which are never available in the View menu directly. This dialog looks something like this (the available settings, again, may change):

[settings dialog]

You can find a full description of all available UI settings here.

In the remainder of this section, we illustrate two of the most common UI settings, and we'll conclude with more about how to manage your UI settings.

Show character offsets

If you enable this setting, you'll get the following behavior:

[hover with indices]

You can see that in the tagging info line, the start and end offsets of the annotation are now displayed.

Show annotation tables

If you enable this setting, your UI will now look like this:

[annotation tables]

The lower pane gives you access to a table for each annotation label. For more complex tasks, this table will be very useful. It can be sorted by most of the columns. The menu immediately above the table allows you to select which label you wish to display in the table.

The annotation tables will always show all content annotations for the document, whether or not they have styles associated with them in the legend.

Settings management

In addition to the "All settings..." item, the View menu has a number of other items which help you manage your UI settings.

"Save settings in browser": if you select this item, your current UI settings will be stored in your browser cookies. Whenever you load the MAT UI within the same browser, these settings will be reload from your browser cookies when the UI loads. Note that this does not enable dynamic saving; if you change the settings, and you want those changed settings saved, you'll need to select "Save settings in browser" again.

"Clear saved browser settings": if you select this item, any UI settings stored in your browser cookies will be cleared. This does not affect your current MAT UI session; it means that whenever you load the MAT UI in the future, there will be no saved settings in your browser cookies available for loading.

"Export settings as XML": if you select this item, the browser will save the current UI settings as an XML file (named "ui_settings.xml" by default). If you've configured your browser to prompt you for where to save files, you'll have the opportunity to change the file name and save it where you want. The format of this XML file is described here.

"Import settings from XML": if you select this item, the browser will prompt you to select a UI settings file in the appropriate format for loading. The current UI settings will be modified as a result of the successful load. The UI will show you a status popup reporting that the load is complete.

"Reset settings to defaults": if you select this item, the current UI settings will be changed to the default settings provided by the MAT Web server.

The default UI settings are described here. If you start up MATWeb normally, MATWeb will provide those settings as the defaults. However, you can modify the default UI settings provided by the server by passing an XML file to the --ui_settings option of MATWeb. The XML file produced by the "Export settings as XML" item has the proper format for the --ui_settings option to MATWeb; in other words, you can start the server, customize your settings, save an XML file from the UI, and then use that XML file as the server defaults in the future.

The Help menu

The Help menu looks like this:

[help menu]

The "Documentation" item will open a new tab or window containing this documentation; the "About MAT" item will show a small popup window which shows the MAT version number.

The logging button

As you can see from the images above, the menubar contains an item labeled "Logging is off (press to start)". If you press that button, your UI will look like this:

At this point, the logger is enabled. This log captures a wide range of timestamped UI gestures. If you press the button again, the browser stops logging, and downloads a CSV log of your interaction, whose format is described here.