Customizing the UI

There are a wide range of UI settings which you can change which will allow you to customize the MAT UI.

Available settings

General UI settings

Annotation palette settings

Annotation popup menu settings

Annotation editor settings

Reconciliation settings

Annotation operation settings

How to change the settings

There are three ways to change your settings in the MAT UI.

Via XML

You can change the default UI settings by creating an XML file and passing it to the --ui_settings option of MATWeb when you start it up, or you can load the settings into the UI directly via "View -> Import settings from XML". You can also save your current settings to XML via "View -> Export settings to XML".

Let's say that you want to change the default way the UI prepares the annotation hover. By default, the text doesn't show the annotation offsets; but you want them to be shown. Your XML file would look like this:

<ui_settings>
<showCharOffsets default="yes"/>
</ui_settings>

Each setting is the name of an element within the <ui_settings> element, and each element accepts the new default value as the value of its "default" attribute.

In the MAT UI

In the MAT UI, the "View" menu will allow you to change the settings. The more common settings are available directly in the "View" menu, and you can review and change all the settings via "View -> All settings...".

Via browser cookies

In the MAT UI, you can also save your current browser settings as cookies via "View -> Save settings in browser", and the settings will be applied when you visit the MAT URL in the same browser. You can also clear the saved browser settings.

In the standalone UI

In the standalone UI, you can modify the defaults by passing in new values via the uiSettings parameter. Not all the settings are available in the standalone UI.

List of settings

Here are all the known settings. The order of the settings is the order in which they were introduced into MAT. This is also the order in which they appear in the UI settings editor.

name of setting
description
available values
system default value
Javascript values in standalone UI
showCharOffsets
whether the description of the annotation created when you over over the annotation contains the annotation start and end offsets or not
yes, no
no
true, false (default)
showSegments
whether the document pane shows the segments in the document or not (you should never need this one)
yes, no
no
true, false (default)
editAnnotationsIn
where the annotation editor should be presented, by default ("neither" means no default is set)
tab, popup, neither
neither
N/A
terseAnnotationEditor
whether or not the level of detail in the annotation editor should be reduced
yes, no
no
true, false (default)
centerAnnotationEditorPopup
whether the annotation editor popup should be placed in the middle of the workbench, instead of in the upper right corner
yes, no
no
true, false (default)
autotagIsCaseSensitive
whether the UI, when asked to tag all identical untagged text sequences elsewhere in the document with the current tag and attributes, takes case into account when determining string identity
yes, no
yes
true (default), false
showAnnotationTables
whether the UI will show annotation tables for document windows in situations where they're not required by default
yes, no
no
N/A
reconciliationAutoAdvance
whether the UI, during reconciliation, will offer to advance to the next stratum when a stratum is completed
yes, no
no
N/A
reconciliationExportToFile
whether the UI, during reconciliation, will export reconciled documents to files ("yes") or to other UI tabs ("no")
yes, no
no
N/A
deleteAnnotationAccelerator
the key that the annotation menu popups recognize as a request to delete an annotation
a single character
"-"
a single character
repeatAnnotationAccelerator
the key that the annotation menu popups recognize as a request to repeat the last annotation label
a single character
"="
a single character
highlightLinksDuringHover
whether to highlight the links between an annotation and other annotations when the mouse hovers over it yes, no
yes
true (default), false
annotationEditorWidth
initial width of each annotation editor popup
a CSS width or raw number (interpreted as pixels)
determined by editor content
a string representing a CSS width or raw number
annotationEditorFontSizePercentage
the percentage of the default font size that the body of the annotation editor is rendered with
a CSS percentage or raw number (interpreted as a percent)
inherited from parent (i.e., 100%)
a string representing a CSS percentage or raw number
annotationTableFontSizePercentage
the percentage of the default font size that the body of the annotation tables are rendered with
a CSS percentage or raw number (interpreted as a percent) inherited from parent (i.e., 100%) N/A
layoutRightPanelWidth
the width, in pixels, of the right-hand pane in the MAT desktop (not available from the "View" menu because the value is processed before the menu is available)
a number
300
N/A
layoutBottomPanelHeight
the height, in pixels, of the bottom details pane in the MAT desktop (not available from the "View" menu because the value is processed before the menu is available) a number
200
N/A
extraLineSpacing
the height, in ems, of the extra spacing between each line in the text panes in the UI
a float
no value
a string representing a float
suppressMenuActionsDuringAnnotationEdit
whether to suppress the usual menu actions (e.g., create/replace/delete annotations) while annotation editors are open
yes, no
no
true, false (default)
showAnnotationIDForDebugging
whether to show the annotation ID, in various display locations, for the purposes of debugging serialization/deserialization problems with annotation-valued attributes.
yes, no
no
true, false (default)
invokeChooseModeFromPopupMenu
whether to show actions in the annotation popup menu which allow the user to invoke choose mode to link annotations together, when such actions are possible and not otherwise suppressed (see suppressMenuActionsDuringAnnotationEdit above)
yes, no
yes
true (default), false
editSpanlessAnnotationsImmediately
whether to open an annotation editor immediately when a spanless annotation is created
yes, no
yes
true (default), false
xmlInputAnnotationConversion what to do with unknown annotations when reading XML input
discard, convert, signal
discard
discard (default), convert, signal
addNumberedLinkAcceleratorsDuringAnnotationEdit
whether to add numeric keyboard accelerators (1 through 9) to items in the annotation menu which provide annotation values to attributes in an open annotation editor
yes, no
no
false (default), true
enterGuidedNavigationModeInAnnotationEditors
whether to enter guided navigation mode in the annotation editors
never, on request, always
never
never (default), on request, always
alwaysShowStackedAnnotations
whether to show stacked rather than overlapping annotations for non-comparison and non-reconciliation documents when hand annotation isn't available
yes, no
yes
true (default), false