Draft

Home • How and why to Structure

Dashboard • Project • Material • Draft • Publish

---

Draft

This is where you will create and review Outlines

1. [Create Outlines](#createoutline)
2. [Collate](#collate) those outlines 
3. [Annotate](#annotate) and tag those collated outlines

---

Outline

What is an Outline

Outline is the term we use to describe a gathering of Segments as a structural annotation. An Outline is the group containing one or more Segments. By grouping Segments into Outlines you will be able to more easily manage you content for Collation and drafting for example to collate all chapter one Segments from your witness Materials you would put them together in a single Outline. By collecting Segments into an Outline you will be creating a well-structured set of Segments to facilitate collation under the draft tab.
You cannot collate any material until you have put the desired material in a segment and gathered the desired segments together to make an Outline.

---

Creating Outlines

Outlines are created under the Draft Tab.
To create Outlines go to the Drafts Tab. To create Outlines you must first create Segments under the Materials Tab.

1. Click the Create Outline button
2. Enter a title for your Outline under Label. This will be the label for this content when you are organizing your publication so a recognizable label is advisable eg. Chapter 1, siglum a,b,m,f,z for collation.
3. Click the Add Segment button.
4. The Add Segment popup allows you to select the Segment from each Material that you wish to collate or otherwise select. Remember Every segment needs to be in an Outline but only Outlines intended for collation should have contain more than one Segment.
   1. Select the first Material from the Include Segment from Material list.
   2. If selection has any existing Segment a box will appear under the Segments header listing those Segments by their Label.
5. Click the Segment desired from the Segment list to add to the Outline.
6. Repeat step 3 until you have all the Segments you want for the Outline you are making.
7. Click the Save and Close button.

Add Segment to Outline

1 . The Add Segment popup allows you to select the Segment from each Material that you wish to collate or otherwise select. Remember Every segment needs to be in an Outline but only Outlines intended for collation should have contain more than one Segment.

1. Select the first Material from the Include *Segment from Material* list. 
2. If selection has any existing Segment a box will appear under the *Segments* header listing those Segments by their Label.

1. Click the Segment desired from the Segment list to add to the Outline.
2. Repeat step 3 until you have all the Segments you want for the Outline you are making.
3. Click the Save and Close button.

A single Segment is needed for each part of a material you want to use in a publication. eg. 'Chapter 1 commentary'.
If you are creating an Outline for collation you will need to create an Segment of the desired part of each witness Material (such as Chapter 1 siglum a) To create a collatable Outline you must create and add all the outlines you wish to collate against each other. So you would create Chapter 1, siglum a,b,m,f,z for collation as an Outine and then add Chapter 1 siglum a, Chapter 1 siglum b, Chapter 1 siglum m, Chapter 1 siglum f and, Chapter 1 siglum z to it to create the collatable Outline.
Note: If there are no Outlines in the selected entry in the Include Material list, you can add Outlines by selecting the entry you want and clicking the Annotate Structure list which will bring you to the Outline popup in the Structure Tab under Materials Tab.

---

Collate, Review and Annotate Outlines

Several options become available once you have added at least one Segment to an Outline.

Outline Tools

There are a number of things you can do with your outline once you have created it.

1. Collate the segments in the Outline
2. Review the collation of a partially or completely collated Outline
3. Annotate the Collated Outline.

Collate

Once you have created a outline with more than one segments in it you will be able to collate the contents of that outline.

How To Collate

If the outline has not been collated then when a outline is selected a Collate this group button will be presented. If a collation already exists a Review Collation button will replace the Collate this group button. These buttons will only be visible if more than one segment is in the outline.

---

Start Collation

There are three options presented

      1. [Collate the contents of the outline](#collatesegment)
      2. [Request a server side collation](#serverside)
      3. [insert a URI](#inserturi) for a completed server side collation

Collate the contents of an outline

1.Click on the Collate this group button.

1. Click the Collate 'X' Segments button. (where X is the number of segments in the outline)
2. The collation window for this outline will open.

---

Request a server side Collation

Sometimes large or complex collations can take substantive periods of time to collate. If a collation appears to be taking a protracted period of time to return the collation to you. t may be that the collation you are running is just such a large or complex collation. for this purpose and to avoid the having to maintain an open browser window you can request a server side collation by clicking the Request a server side collation button.

Insert URI from completed server side collation

The notification email you receive will contain a URI to the collation. Copy and paste that URI into the text box beneath the request a server side collation but and press the enter key. This will load the collation in the collation window

---

The Collation window.

Navigating the collation window.

The Collation window is divided into 2 areas.
The Collation Decision interface and the Annotations interface

---

The Collation Interface

This where you can make the decisions between variants. A number of tools and aids are provided to facilitate this decision making. All decisions are editable at any point.
Each segment is referenced in the interface by the siglum assigned to the material the segment is a selection of. If no siglum is assigned the label for the originating Material is used.

1. Decision header
2. Read as Base Text
3. Hide Segments
4. Variants Selector
5. Previous and Next Decisions
6. View Witness
7. Add Tag
8. Saving Decision
9. Choose all single variants

####Decision Header
This is located in the center at the top of the window. It indicates which decision you are looking at as well as providing forward and back buttons either side of the header to navigate between Decisions.

Read as base text

This pull down allows you to define the base text used for the text displayed in the annotation interface. This means that the un made decisions in text presented in the annotation interface is drawn from the selected base text. This text is presented as grey text. Black text represents text where a decision has been made.
All the segments are listed in this pull down as well as a default option. This default option is an arbitrary selection of one of the segments and may change between sessions

Hide Segments

This allows you to hide and show specific segments in the collation window. The segments are labeled by the siglum applied to the material the segment is a part of. Hide sections is usually used as a thinking tool to allow you to focus on specific content from specific sigla.

Variants Selector

In the center of the window there are three columns showing the previous decision, the present decision under review (Variant selector) and the upcoming decision. The present decision under review (Variant selector) will list all the variants and will list the Siglum for that variant on the left of the variant. Variants that are the same across multiple variants will list all the relevant sigla next to the variant.

How to select a Variant/Making a decision

To select a variant from those listed click on the desire variant in the list. This will put the text of that variant in the text box directly above the list. this text can be edited as desired. If the text is edited the edited will appear as a separate variant when ever that decision is not the decision under review.

Previous and Next Decisions

In the center of the window there are three columns showing the previous decision, the present decision under review and the upcoming decision. This provides the user with some context on the content being reviewed.
Clicking on either the previous or next decision will bring that decision into the center review spot and move the corresponding previous and upcoming into their relevant places.

View Witness image

The tab beneath the present decision under review (Variant selector) will present the election of the transcribed image associated with the line of text the current decision is associated with. This is one of the advantaged of using T-Pen for your transcriptions as it allow you to review the original manuscript without having to leave the collation interface.

Add Tag

Beneath the present decision under review (Variant selector) tags can be added to the current decision in tow different ways.

1. Any tags associated with text currently under review is presented beneath the tag text box. Click the desired tag to add that tag to the decision. 
2. Type any desired tag into the *Create New Tag* text box then press return to add the tag to the decision.

Any tags that are attached are listed above the Create New Tag text box and can be deleted by clicking the 'x' on the green tag you wish to remove.

Save Decisions

To save any decisions made you MUST click the Save Decision button.

Choose all single Variants

The Choose all single Variants button will change all decisions that have only one choice to that choice. The number of such decisions made will appear above the button.

---

Review and Edit

To Review and edit any collated outline select the outline in question and click the Review Collation button that appears.
This will reopen the collation window to allow you to edit and review your collation.

---

Annotate the collated text

The bottom half of the collation screen is where you will annotate your collated text. This is where you can add, edit, view and delete annotations and tags on the collated text. Any image associated with the selected text will also be presented.

1. Select a decision to navigate the decisions
2. Select any text to annotate
3. Annotation text box
4. Change label of annotation
5. Image
6. Create/add Tag
7. Create Annotation
8. Delete Annotation

Select a Decision to navigate the decisions

Clicking any of the text will highlight the full text of the decision the text selected is part of. The collation interface will present the decision selected when you do this. Click on the Show Annotations button if the annotation tool is not visible.

Select text for annotation and tagging

Click and drag any desired selection of the text to apply an annotation to it. This means you can attach multiple annotations and tags to any part of the text contextually as desired. you can overlap annotations and tags between decisions, over multiple decisions and over parts of decisions. The highlighting of decisions when clicked serves to aid navigation to that decision point in the collation interface. You are in no way restricted to these decisions when annotating. The start and end of the selected text will appear below the annotation text box in the annotation tool

Labeling the annotation

The default label for an annotation is Annotation Detail.
To edit this label

1. Click on the label button to the right of the annotation label. 
2. Edit the label as desired
3. Click the label button to save the change

Text Box

Enter any text desired to the annotation, if any, in the text box beneath the annotation label.

Decision Image

If the decision clicked is an unedited selection of a selection from a material with an associated image that image will be presented in the annotation tool as well. Otherwise no image will appear

Create/Add Tag

Add Tag

Tags can be added to the current decision in two different ways.

1. Any tags associated with text currently under review is presented beneath the tag text box. Click the desired tag to add that tag to the decision. 
2. Type any desired tag into the *Create New Tag* text box then press return to add the tag to the decision.

Any tags that are attached are listed above the Create New Tag text box and can be deleted by clicking the 'x' on the green tag you wish to remove.

Delete

If you decide that you no longer wish to retain an annotation click the delete button. This will only appear after an annotation has been saved.

---

Home • How and why to Structure

Dashboard • Project • Material • Draft • Publish