ATHEN_core.md

First time Use

If you start ATHEN for the first time you should be able to find a screen like the following:

The image shows the way ATHEN is built: The left big panel is the project explorer, where all your files are displayed. In the big middle section your documents and their markup will be displayed and it is therefore referenced as the editor. Then there are 2 more panels, one is directly below the editor. The views in this part are referred to as "analyzer". An analyzer (depending on which one is selected) always resembles the current selection of the editor and therefore acts as a live inspection module. The part on the right side contains a multitude of so called "views". Depending on which view is selected, the behaviour of the editor changes. The constellation of all visible parts is called a perspective, and will be exchangeable in the future.

Use the Main menu the change global settings or to get access to utility options. The toolbar, which is located above the project explorer currently has 3 buttons available, the leftmost allows you to create a new project, the middle one opens a dialog to switch the workspace and the rightmost button switches the active perspective. In the top toolbar you should now assign a workspace to ATHEN, a workspace is nothing but a folder on your local filesystem (or one that synchronizes to a web hoster if wished). Once completed you can create a new project with the leftmost button in the toolbar.

The project explorer should now display your fresh created project, ad also created 3 folder: "descriptor", "input", "output" The intention behind those folder is that you should place your typesystems in the descriptor folder and all data which is about the be worked on in the input folder. Finished document should be moved to the output folder (e.g. by drag and drop).

Now it is time to import data into ATHEN. For this you can either copy data into the new created input folder of your project (on your filesystem, ATHEN watches the assigned workspace and updates the project explorer on the fly note: this might not always work on the first startup). Alternatively you can copy+ paste from your filesystem into one of the folder of ATHEN.

Once you succeeded importing data into ATHEN, you can proceed to open it and view it. A simple Doubleclick (left mouse button) will open the selected document in the editor and display its text content without any special markup. Note: if you are asked to assign a typesystem, there is no need to assign one, you can just cancel this dialogue If you try to open a .txt file ATHEN first asks you if it may convert it into the UIMA .xmi format. Afterwards you can open your documents.

Working with ATHEN

ATHEN has a built-in typesystem that allows you to edit and change a multitude of types already. If you want to change your own types you need to define a valid UIMA Typesystem and assign it to the application via Preferences->Editor Settings in the Main menu.

Tutorial: Add and edit your first Annotation with ATHEN

We assume you managed to succeed to import data as described above. For this tutorial we create a .txt data with the content. ATHEN helps me, Markus Krug to quickly annotate my documents.

Open it (after conversion, which is usually done automatically for you) and you should be able to see the following screen:

The annotation browser should be opened in the "view stack" and it should not display anything but a simple documentAnnotation, which is a standard type in UIMA to store Meta information about the document. The editor should display the assigned text.

Let us try to mark every noun for this tutorial. Rightclick the editor, a context menu should appear, select configurate styles A new dialog should appear, in the textfield, type: POS ATHEN should filter all other types, but one, double click the "false" in the visible column to make the annotations of this type visible. Close the dialog.

Now, as soon as you mark some text in the editor and press "Enter" you should create a new annotation. Since we want to mark every noun we can now create an annotation for "ATHEN", "Markus" , "Krug" and "documents". The result should look as follows:

Now it is time to tell ATHEN that our annotations should represent nouns, for this you can move the text cursor into one of your annotations and WITHOUT any text selection click Enter. You should see a new dialog popping up, assign your POS-Tag into the POSTag textfield and click ok.

Verify your action in the Annotation Browser, you should see 4 created Annotations of the type POS. Expand the tree in the annotationbriwser until you can see your edited changes.

If you want to remove an annotation just place your text cursor within the span of an annotation and press DEL, the annotation should dissappear.