UMR Writer 3.0 Detailed Guide

Basic Workflow

1. Create an account and log in.
2. Open your Account page to see your projects and document history.
3. Enter a project and use Checkout for Annotation on a document.
4. Annotate sentence-level UMR first.
5. Open document-level annotation when sentence-level work is ready.
6. Save, export, and optionally submit checked-out work for quality control.

Top Navigation

Control	What it does
Register	Creates a new user account.
Login	Signs in and unlocks annotation pages.
Account	Opens your dashboard with projects, documents, and profile settings.

Video Tutorial

For Annotators

1. Open Account and click your project.
2. Go to Documents and click Checkout for Annotation.
3. Open the checked-out file from My Checked Out Documents.
4. Annotate sentence-level UMR, save, and manage alignments.
5. Open Document-Level Annotation from the sentence page when ready.
6. Export if needed, then use Submit for QC.

For Project Admins

1. Use Upload Document to add new files.
2. Manage project-specific schema extensions in Temporary Rolesets and Temporary Relations.
3. Adjust available lattice values in the lattice sections.
4. Manage users from Members, including promoting other members to admin or demoting admins back to annotators (a project must always have at least one admin).
5. Review QC submissions and run adjudication from Quality Control.

The account page is split into a left content area and a right profile panel.

Projects Card

Control	Meaning
Project name link	Opens that project page.
Permission badge	Shows your role for the project, such as admin or annotator-level access.
Red delete-project button	Visible to admins only. Deletes the whole project after confirmation. This is irreversible.

All Documents Card

Control	Meaning
Document row link	Opens the combined sentence/annotation viewer for that document.
Project badge next to a document	Shows which project that document belongs to.

Profile Panel

Field or button	Meaning
Profile image	Displays your current avatar.
Username field	Read-only display of your username.
Email field	Read-only display of your email.
Picture upload input	Selects a new profile picture file.
Submit button	Uploads the selected new profile picture.

The project page uses a left sidebar for navigation and a large right content area. Which actions you can use depends on your project permission.

Sidebar Navigation

Sidebar item	What opens
Documents	Main project document list.
My Checked Out Documents	Your active annotation assignments.
Quality Control	QC document list and adjudication tools.
Temporary Rolesets	Project-specific roleset definitions.
Temporary Relations	Project-specific relation definitions.
Lexicon	Opens the project lexicon page, where annotators can add project-specific frame entries, search existing entries, and download the current project lexicon as JSON.
Statistics	Opens project statistics.
Members	Member list and membership management.
Settings	Project-level editable settings.
Lattice sections	Admin-only configuration pages for discourse, aspect, person, number, modal strength, and modification value availability.

Documents Section

Control	What it does
Upload Document	Admin-only button. Opens the upload page for source documents.
View Sentences and Annotations	Opens a read-oriented combined view for the selected document.
Checkout for Annotation	Creates or opens your annotator copy so you can work on the document.
Checked out by text	Shows who currently has annotator copies checked out.
Delete document button	Admin-only. Deletes the whole document after confirmation.

My Checked Out Documents Section

Control	What it does
Document name link	Opens sentence-level annotation at sentence 1.
Submit for QC	Marks your checked-out document ready for quality control after confirmation.
Override	Opens the override page so you can replace the checked-out annotation with an uploaded file.
Delete button	Deletes your checked-out annotation copy after confirmation.

Quality Control Section

Control	What it does
QC document link	Opens the QC document at sentence-level annotation.
Remove QC button	Admin-only. Removes a document from the QC list.
Adjudication checkboxes	Select exactly two documents to compare.
Sentence-level comparison radio	Compares sentence-level annotations.
Document-level comparison radio	Compares document-level annotations.
Compare Documents	Submits the selected pair for adjudication when exactly two documents are selected.

Members Section

Control	What it does
Member rows	List all users currently assigned to the project. Each row shows a small badge with that member's role (admin or annotate).
Promote button	Admin-only. Promotes a regular member to admin. A project can have multiple admins at the same time; promoting someone does not remove your own admin status.
Demote button	Admin-only. Demotes another admin back to a regular annotator. You can also demote yourself, as long as at least one other admin remains. The button is hidden when only one admin is left, so a project always has at least one admin.
Remove-member button	Admin-only. Removes that user from the project.
New member username field	Enter the username of the person you want to add.
Add Member	Admin-only. Adds the entered username to the project. New members are added with annotate permission; promote them afterwards if they should also be an admin.

Settings Section

Control	What it does
Project Name field	Edits the displayed project name.
Save Changes	Saves project setting edits.

Temporary Rolesets

These are project-specific rolesets added to supplement the built-in annotation inventory.

Control	What it does
Add New Roleset	Shows the roleset creation form.
Roleset Name	Name of the temporary roleset.
Type dropdown	Assigns the roleset category.
Sub-roles mode dropdown	Controls how the sub-role list is defined.
Sub-roles text field	Comma-separated sub-role list when fixed sub-roles are used.
Allow Repeat checkbox	Marks the roleset as repeatable.
Save Roleset	Saves the new temporary roleset.
Cancel	Closes the creation form without saving.
Delete button in the table	Removes an existing temporary roleset.

Temporary Relations

These are project-specific relation labels that become available in annotation menus.

Control	What it does
Add New Relation	Shows the relation creation form.
Relation Name	Enter the custom relation name without the leading colon. The form displays the colon separately.
Type dropdown	Available values are participant, modifier, and attribute.
Allow Repeat checkbox	Marks the relation as repeatable.
Save Relation	Saves the new temporary relation.
Cancel	Closes the form without saving.
Delete button in the table	Removes an existing temporary relation.

Annotation Lattice Sections

Admin users also see configuration pages for Discourse Relations, Aspect, Person, Number, Modal Strength, and Modification. These pages expose toggle-style controls that determine which values are available in annotation dropdowns.

The sentence-level page is split into a left annotation workspace and a right utility panel.

Left Panel: Navigation Card

Control	What it does
Left arrow ←	Opens the previous sentence.
Right arrow →	Opens the next sentence.
Sentence counter	Shows the current sentence number and total sentence count.
Sentence list	Each row is a link to that exact sentence.
Active sentence highlight	Marks which sentence you are currently annotating.

Left Panel: Current Sentence Card

Control	What it does
Edit	Toggles sentence segmentation editing. In edit state the button changes to Save and writes the updated sentence text to the server.
Sentence display	Shows the tokenized sentence used by annotation and alignment tools. Hovering a token highlights any graph variables aligned to it (in green), and hovering a variable in the graph highlights its aligned tokens here (in yellow). See Alignments Panel below for details.
Hidden sentence editor textarea	Appears only when sentence editing is enabled.
Translation badges EN and ES	Show available glosses for the current sentence.
Notes box	Displays sentence notes when notes exist.

Left Panel: Annotation Preview Toolbar

Button or control	Behavior
In-place Edit Mode toggle	Switches between Branch Mode and Edit Mode. In Edit Mode you click relations and values to change them with dropdowns. In Branch Mode right-click branch operations are enabled.
Text Editor / Graph	Switches between the interactive graph view and a plain-text editor view of the same annotation.
Save	Saves the current sentence-level annotation and also saves current alignments.
Validate	Runs graph validation and displays errors and warnings in the validation results panel below the graph.
Delete	Deletes the entire sentence annotation and clears all alignments for that sentence after confirmation.
Copy	Copies the full current annotation text to the clipboard.
Parens	Opens the parenthesis checker overlay. Clicking a parenthesis highlights its matching pair.
Diff	Opens a before/after comparison modal. Added, deleted, and moved lines are highlighted.
Add Top	Visible only when the sentence has no usable graph yet. Opens the top-node creation dialog.

Graph View and Text View

Element	What it does
Line-number column	Shows live line numbers for the current graph text.
Graph preview area	Shows the current UMR as interactive text.
Text editor textarea	Shows the same graph as editable plain text. Pressing Tab inserts four spaces for indentation.
Validation results box	Displays validation errors and warnings after running Validate.

Mode-Specific Behavior

Mode	What is enabled
Branch Mode	Right-click menus for Add Branch, Delete Branch, Move Branch, and Store Temporarily.
In-place Edit Mode	Clickable relation and value dropdown editing. Right-click branch operations are disabled.
Text Editor Mode	Plain-text editing; graph-only controls such as branch operations and undo/redo are hidden.

Right Panel

Panel	What it contains
Document Info	Collapsible table with annotator, file name, language, project name, and project creator (the user who originally set up the project; the project may have additional admins beyond this person).
Quick Actions	Links to Document-Level Annotation, Export Annotation, and Back to Project.
Temporary Branch Storage	Collapsible area that lists branches you stored temporarily for reuse in this document.
Alignments	Manual alignment editor plus auto-generation tools.

Alignments Panel

Hover cross-highlighting. Once alignments exist for a sentence, hovering over a variable span in the UMR graph (e.g. s1x) highlights its aligned tokens in the source sentence in yellow, and any other instances of the same variable in the graph (reentrancy / coreference) in green. Hovering over a token in the source sentence does the reverse — every variable aligned to that token lights up. Multi-token alignments such as 2-3 and discontiguous alignments such as 2-3, 5-5 highlight all included tokens together. The unaligned sentinel 0-0 produces no highlight.

Control	What it does
Generate Alignments	Runs automatic alignment generation from the current sentence tokens and graph. Confident matches are applied automatically; ambiguous matches open a disambiguation dialog.
Variable field	Enter the graph variable you want to align manually.
Alignment field	Enter the token span, typically in range form such as 3-3 or 4-6.
Add Alignment	Adds the manual alignment row to the current sentence.
Existing alignment badges	Show saved alignment values for each variable. Clicking a badge makes it editable. The adjacent red × button removes that alignment value.

Add Top Dialog

This dialog appears when you click Add Top on an empty sentence.

Field or control	Meaning
Concept Type dropdown	Available values are Sentence Token, Discourse Concept, Abstract Concept, Named Entity, Reification Roleset, and Custom Concept.
Token search field	Filters sentence tokens when Sentence Token is selected.
Token grid	Lets you select one or more tokens for the top concept. Selected tokens are automatically used for alignment.
Frame lookup area	For a single selected token, shows lemma lookup and candidate frames. It also includes a Use token as is button.
Discourse concept search/select	Used when Discourse Concept is selected.
Abstract concept search/select	Used when Abstract Concept is selected.
Named entity type search/select	Used when Named Entity is selected.
Name-token selector	Appears for named entities so you can choose which tokens populate the :name content.
Non-event roleset search/select	Used when Reification Roleset is selected.
Custom Concept field	Manual free-text concept entry.
Variable field	Lets you specify the top node variable explicitly.
Generate Variable	Fills the variable field automatically.
Cancel	Closes the dialog without creating a node.
Confirm	Creates the top node and associated initial alignment data.

Branch Mode Right-Click Menus

Right-click target	Menu options
Variable node	Add Branch
Relation span or branch	Delete Branch, Move Branch, Store Temporarily

Add Branch Dialog

Field or control	Meaning
Relation search field	Filters available relations.
Relation list	Selects the relation to attach under the chosen parent node.
Relation description box	Shows schema help for the currently selected relation when available.
Child-node controls	These change depending on the selected relation. The dialog can request a token-based concept, discourse concept, abstract concept, named entity, reification roleset, string value, number value, or an existing reentrant variable.
Search inputs inside child-node sections	Filter the relevant token, concept, value, or variable list.
Sense lookup area for token-based predicates	When a single sentence token is selected, the dialog lemmatizes the token and looks up candidate senses from the base frame files plus the project lexicon.
Retry with a lemma	Appears when automatic lemmatization may have failed. Annotators can type the corrected lemma and retrieve frame candidates again.
Open Lexicon For "lemma"	Appears when no matching frame is found, and also remains available when matches are found but none of them is correct. Use it to add or update a project-specific frame entry for the current lemma.
Manual sense field	Use this only when you already know the exact roleset name. If that sense is used to add the branch, it is saved into the project lexicon so it can be retrieved in future annotation.
Add Branch	Inserts the new branch into the graph and updates alignments when the chosen child originates from sentence tokens.

Lexicon Workflow For Missing or Incorrect Frames

1. Select the token in Add Branch and inspect the returned sense list.
2. If the lemma looks wrong, use Retry with a lemma first.
3. If the lemma is correct but the needed frame is missing, or the existing matches are not the right sense, click Open Lexicon For "lemma".
4. Add the project lexicon entry on the lexicon page. The lemma field is filled automatically.
5. Use the lexicon search panel on the left to confirm the entry was added successfully.
6. Click Back to Annotation to return to the sentence page. The same Add Branch dialog reopens automatically for the same parent node.
7. Run the lookup again and choose the new project lexicon sense.

Delete, Move, and Temporary Storage

Action	Meaning
Delete Branch	Removes the selected branch from the graph.
Move Branch	Reattaches an existing branch elsewhere in the graph.
Store Temporarily	Copies the selected branch into the temporary branch storage panel so you can reuse it later, including across different sentences in the same document.

Diff and Parenthesis Utilities

Utility	Meaning
Parenthesis checker modal	Shows the graph in a separate overlay. Clicking any ( or ) highlights its matching pair and scrolls to it if necessary.
Diff modal	Shows a two-column comparison between an earlier graph state and the current graph. The modal also includes Mark as Saved, which resets the comparison baseline.

The document-level page has three columns: all sentence-level annotations on the left, the current document-level annotation in the middle, and triple-entry plus export tools on the right.

Left Column: All Sentence-Level Annotations

Element	Meaning
Sentence badge	Identifies each sentence number.
Sentence text	Shows the original sentence content.
Sentence-level annotation preview	Shows the sentence-level graph for reference.
No annotation available notice	Appears if that sentence has no sentence-level annotation.

Middle Column: Current Document-Level Annotation

Control	What it does
Left arrow ←	Moves to the previous sentence and asks whether you want to save current changes first.
Right arrow →	Moves to the next sentence and asks whether you want to save current changes first.
Sentence label	Shows which sentence the current document-level annotation is anchored to.
Structured annotation display	Shows the current :temporal, :modal, and :coref branches in a readable grouped format.
Jump to sentence dropdown	Lets you move directly to any sentence. The page prompts you to save before navigating away.

Right Column: Document Info

The collapsible Document Info card shows annotator, file, language, and project.

Right Column: Add Document-Level Triples

This card uses three tabs. Each tab has a source field, a relation dropdown, a target field, and an add button.

Tab	Controls and values
Temporal	Reference Node and Current Node fields use datalist suggestions. Predefined temporal node suggestions are document-creation-time, past-reference, present-reference, and future-reference. The Relation Type dropdown contains :contained, :before, :after, :overlap, and :depends-on. The action button is Add Temporal Triple.
Modal	Source Node and Target Node fields use datalist suggestions. Predefined modal node suggestions are root, author, and null-conceiver. The Relation Type dropdown contains :modal, :full-affirmative, :partial-affirmative, :strong-partial-affirmative, :weak-partial-affirmative, :neutral-affirmative, :strong-neutral-affirmative, :weak-neutral-affirmative, :full-negative, :partial-negative, :strong-partial-negative, :weak-partial-negative, :neutral-negative, :strong-neutral-negative, :weak-neutral-negative, and :unspecified. The action button is Add Modal Triple.
Coreference	Source Node and Target Node are free text fields with datalist support. The Relation Type dropdown contains :same-entity, :same-event, and :subset-of. The action button is Add Coreference Triple.

Right Column: Actions Card

Control	What it does
Save Document Annotation	Saves the current document-level triple set to the server.
Modal Export Mode dropdown	Controls export behavior for modal information. Available values are Modal on both levels and Modal on document level only.
Export Annotation	Exports the full document annotation as a downloadable file. The export respects the selected modal export mode.
Back to Sentence Level	Returns to sentence-level annotation for the current sentence.

Deleting Triples

Existing triples shown in the middle column can be removed with a right-click context menu. The document-level UI also marks unsaved changes and reminds you to click Save Document Annotation.

UMR Writer includes dedicated search pages outside the sentence/document annotation screens. In general, search is used to locate documents, annotation patterns, concepts, or relations across project data.

If you are documenting a local deployment for annotators, this section should be paired with screenshots from the actual search page because search controls are not embedded in the main annotation templates.

UMR Writer supports the UMR 2.0 data release format for both upload and export.

In practice this means exported files are expected to round-trip back into the tool without format conversion, assuming the project language and document structure remain compatible.