Creating annotations with Pundit

= Introduction =

This tutorial proposes three examples of annotation assignments, with two objectives:


 * to let users experiment with the different ways of annotating a document in Pundit;
 * to help users to create a critical mass of annotations so that they can begin experimenting with Ask, the next Pundit component that will be introduced in Tutorial 2.

The annotation tutorials have been developed in collaboration with the Wittgenstein Archive Bergen (WAB) research group.

= Audience =

The tutorial is addressed to potential users as well as to developers interested in understanding how the process of annotation works in practice.

= Objective =

The aim of this tutorial is to show how to create annotations with Pundit. The activity of annotating aims at solving specific research questions such as the evolution of an author’s idea on a specific question or the reconstruction of the author’s thought. Pundit allows you to answer these questions through the different functionalities it offers. These functionalities will be described in the assignments that follow. In particular we will show how to create annotations using the triple composer:

= Description =
 * Connecting different text fragments through appropriate properties in the same page and in different pages;
 * Connecting a text fragment to an entity (ex. “grammar”);
 * Adding free comments to text.

A few words on how to get ready for the assignments. Before creating annotations and experimenting with the proposed topics, first create a new notebook. This will make it easier to later analyse the results of the exercises.

To create a new notebook in Pundit and to give it a meaningful name:


 * Go to Pundit (e.g. click on the following link:
 * In the Pundit top bar, click on “Your name” and then on “Manage Notebooks”
 * In the “Create a new notebook” field, type the name of your new notebook.
 * Set the new notebook as the “current notebook”, click on the gear button next to it and choose “Set as Current Notebook”, where the annotations you create from now on will be saved.

Assignments are then structured with a goal (which includes both a research objective and the description of what to obtain through Pundit) and a hands on (in which are described all the steps required to reach the goal).

Goal
Annotate some Ts-310 (Brown book) passages which are relevant for the discussion of what grammar is.

To do so, you are going to establish a link between a portion of text and a concept taken from a controlled vocabulary. The final shape of the annotation will be:


 * “Portion of text” : discusses : grammar

Hands on

 * Go to http://wittgensteinsource.org and browse Ts-310 to find a relevant text section.
 * Once you have found the transcription you want to annotate, click the “Annotate” button (as shown in the figure below).




 * Feed, the annotation environment, will open in a new tab.
 * Use the mouse to select the text that you want to annotate, then click “Annotate text fragment” from the contextual menu (as shown in the figure below).




 * The text fragment will be set as subject of your “triple” in the “triple composer” in the top-right part of the Pundit bar.
 * Choose the “discusses” relation to use as predicate of your triple: click on the “predicate” yellow box, find it and click on the “+” button next to it (as shown in the figure below).




 * Choose an object: click on the “object” red box and search for “grammar”. Results will be returned from a variety of sources, find the one from the WAB:Subjects vocabulary and click on the “+” button next to it (as shown in the figure below).




 * An annotation can contain multiple triples. To add another, click on “Add new triple” and repeat the steps.
 * You can remove items from the subject, predicate and object boxes by clicking on the little wheel button at the left of each item, and then choosing “remove item” from the contextual menu.
 * When satisfied click the “Save” button: the annotation should load in a few seconds and be displayed in the page (as shown in the figure below).



Goal
There are a great number of “hasOtherVersion” Bemerkungen pairs for Ms-115 and Ts-310. Investigate such Bemerkungen pairs, finding pieces of revised text. Connect them and explain the meaning of the link with a free comment.

To do so, you are going to establish one link between two portions of text and another link between one of these two texts and a free comment. The final annotation will include two triples, of the following shape:


 * “Portion of text” : has revision : “Another portion of text”
 * “Portion of text” : has comment : “Originally it said … and got changed because ...”

Hands on

 * Click one of the following links, which will open the two versions of a bemerkung side by side:


 * http://po.st/2DVICE
 * http://po.st/pXyTGT
 * http://po.st/ziUeKR
 * http://po.st/0d6Ama
 * http://po.st/pyaONS
 * http://po.st/Srrc7x
 * http://po.st/cpappu
 * http://po.st/ySWQKQ
 * http://po.st/cmgnhk
 * http://po.st/5AeQjz
 * http://po.st/FWtuo9
 * http://po.st/H4NlZ5
 * http://po.st/osqJLk
 * http://po.st/uqDgXD
 * http://po.st/VnX4PR
 * http://po.st/L5X8nF
 * http://po.st/tg8vQJ
 * http://po.st/S3pGji
 * http://po.st/fl6TtO
 * http://po.st/ZlGpqb
 * http://po.st/y2rvAF
 * http://po.st/yRmnbV
 * http://po.st/kcfR3z
 * http://po.st/rI9s6P
 * http://po.st/PRZPNQ


 * Once you have chosen text in the first version, select it and click “Connect this text to…” (as shown in the figure below).




 * The “Connect text” window can be safely closed clicking the “x” icon on the top right, without losing the first bit of selected text.
 * To change the first bit of text, click the “cancel” button, and start over.
 * Once you have chosen text in the second version, select it and click “Connect to previously selected text” (as shown in the figure below).




 * If not satisfied with the selected texts, click the “cancel” button, and start over.
 * Click the “Go to save” button. The triple composer will show the two text in the “subject” and “object” boxes, asking for a predicate to connect them (as shown in the figure below).




 * Find the “has revision” predicate, and click the “+” button next to it or its label to add it to the predicate box.
 * Add a new triple by clicking on the “Add a new triple” button.
 * Drag one of the two texts from the lower triple to the upper “subject” box. This will copy the text into the new triple (as shown in the figure below).




 * Click on the upper “predicate” box, and add the “comment (text)” relation by clicking on the “+” icon next to it or on its label.
 * Click on the upper “object” box. Insert the comment in the text area that pops up (as shown in the figure below).




 * Click on “done”. The comment will be inserted as “object” for the upper triple.
 * Click the “Save” button: the annotation should load in a few seconds and get displayed in the page (as shown in the figure below).



Goal
In Ts-310 (the Brown Book), connect one language game to another Bemerkung’s language game, which is a further development of the first one.

To do so, you are going to establish two links between two portions of text coming from different pages and the concept “Language game” taken from a controlled vocabulary. This will state that the identified portions are both language games. A third link will then connect the two texts together. The final annotation will include three triples, of the following shape:


 * “Portion of text” : discusses : Language game
 * “Another portion of text” : discusses : Language game
 * “Portion of text” : refers to : “Another portion of text”

Hands on

 * Go to http://wittgensteinsource.org and browse Ts-310 to find a relevant text section.
 * Once you have found the text you want to annotate, click the “annotate” button (as shown in the figure below).




 * Feed, the annotation environment, will open.
 * Use the mouse to select the text that you want to annotate, then click “add to my items” from the contextual menu (as shown in the figure below).




 * The text fragment will be saved into your items, which you can see by clicking the “my items” shortcut button in the Pundit top bar. Moreover, a star icon will be added to the page, next to the selected text fragment (as shown in the figure below).




 * Go back to http://wittgensteinsource.org and browse Ts-310 to find an evolution of the saved language game.
 * Once located, click the “annotate” button to open the Feed annotation environment on the new source.
 * Select the text that you want to link to the previous language game and click “annotate text fragment”.
 * The text fragment will be set as subject of your “triple” in the “triple composer” in the top-right part of the Pundit bar.
 * Choose the “discusses” relation to use as predicate of your triple.
 * Click on the “object” box and search for “language game” from the WAB:Subjects vocabulary, and add it to the “object” box
 * Add a new triple clicking on the “Add a new triple” button
 * Drag the previously saved text fragment from my items to the new “subject” box (as shown in the figure below).




 * Add the “discusses” relation in the upper triple “predicate” box
 * Click on the “object”, search for “language game” and add it as object, or, as a shortcut, you can drag it from the lower triple’s “object” box to the upper one
 * The annotation should now look like the figure below




 * Add a new triple (the third) clicking on the “Add a new triple” button
 * Drag the first triple’s subject into the third triple’s “subject” box and the second triple’s subject into the third triple’s “object” box. The annotation should now look as the figure below
 * Click on the third triple’s “predicate” box and add the “refers to” predicate
 * Click the “Save” button: the annotation should load in a few seconds and get displayed in the page (as shown in the figure below).