Menu ▾ ▴

Structure

Domhnall101

Home • How and why to Structure

Dashboard • Project • Material • Draft • Publish

Structures at the Heart Of Tradamus.

Understanding how to use the structuring in Tradamus is key to using the application.
The principle is straight forward. Your publication is built with three levels of structure.

Firstly you divide your Material into Segments(#segments).
Then you Group your segments into Outlines and finally you group your Outlines into Sections which you can then order for publication.

  1. Segments. This is how you describe and identify the required parts of your content.
  2. Outlines. This is how you gather your described content and prepare your content for collation.
  3. Sections. This is how you order your content for publication.

Segments

What are and why use Segments?

Creating Segments is simple way to select structural parts of your witness texts or other content. The advantage to doing this is it allows you to deal with one piece of your content at a time in a manageable way while creating a useable structure for that content as you go. This has a number of immediate benefits. If you are bringing your content in from T-Pen and you have the first chapter transcribed for all your witnesses this will allow to start collation without needing your entire text transcribed. It also facilitates feeling with transposed or absent parts in the witnesses easily. Once you have your Segments made you will collect them in Outlines which you can then collate. Attempting Collation of entire texts without creating manageable Outlines first is possible but it can take several days or more for CollateX to complete. We allow for this longer collation with an option to receive notification when the collation has been run.

Segmenting allows for much greater control on your Material. For example you could create segments for each chapter from a multi-chapter witness or your commentaries for each chapter from a single Material that contains all the chapter commentaries. This means you can segment you materials for easier use with Tradamus without having to prestructure you materials as multiple documents. You can create this structure within Tradamus with out having to rework your content to be structurally consistent before bring it into Tradamus. it also allows you to segment the same Material in as many ways as you like without having to alter or rework the original source. This makes collation much more flexible and makes experimentation and multiple approaches to the content viable from the same set of original Material without having to rework that original Material.

Tradamus allows your Project to be built of multiple, well-structured and well-annotated segments made from your Material. In order to support this we have built a tool Create Segments.The Create Segments button allows you to break your content into manageable pieces to allow you to have greater control in collating different elements of you witnesses as well as reordering them to facilitate this without the need to physically reorder the contents of the witness so your content remains true to its source while being usable especially when you need to reorder the content or need granularity in the collation of you witnesses. When you do this you are creating structural annotations of the Material.
After importing you Material into Tradamus you need to segment the Material. You do this under the Material Tab.

Create Segment

On the Material Tab select the material you wish to edit from the list presented. If you are already in a material you can change the Material you are working on via the change Material icon on the top right (book Icon).
In the witness you wish to section click on Create Segment under the Segment heading. this will open the Material in the Create Segment window.

You have a number of options

  1. Select the desired page of text from the Page Selection pull down on the top left
  2. Show structural annotations on the left below the page selection pull down.
  3. Select how you wish the text to break from the Break On pull down on the top right.
  4. Change the witness you wish to section via the small tab on the right side of the witness name at the top of the page.
  5. Select text directly to create Segments, Label, tag, and save.
  6. View All Annotations

Structural Annotations

Clicking on the Show Structure/Show All button displays all the structural annotations associated with the witness material being segmented in a list beneath the Show Structure/Show All button.

These annotations can in turn be clicked to hide or show their associated content in a list below the list of structural annotations. By clicking on these individual entries of content the main text field containing the transcription will be highlighted to indicate where the selected content is in the transcription.

The 'Break On' Pull Down

This pull down allows you to change how the text being sectioned will display. Not all structural tags will be of use but we display them all in case you have specific needs or are using the structural tags in a specific way that is of use in this sectioning

Change Witness

In the title bar on the right of the witness title there is a pull down that displays all the material that is part of the Project that is being worked on.


###Create Segment
On the Material Tab select the material you wish to edit from the list presented. If you are already in a material you can change the Material you are working on via the change Material icon on the top right (book Icon).
In the witness you wish to section click on Create Segment under the Segment heading. this will open the Material in the Create Segment window.

You have a number of options

  1. Select the desired page of text from the Page Selection pull down on the top left.
  2. Show structural annotations on the left below the page selection pull down.
  3. Select how you wish the text to break from the Break On pull down on the top right.
  4. Change the witness you wish to section via the small tab on the right side of the witness name at the top of the page.
  5. Select text directly to create Segments, Label, tag, and save.
  6. View All Annotations

Creating Segments

  1. On the Material Tab for the witness you wish to create a Segment, click on Create Segments button; this will open the text for the selected Material.
  2. Select the desired page that you wish to start on from the page selection pull down on the top left.
  3. Hide or show any structural annotations already in the witness via the Show Structure button.
  4. Select the structural annotation to break on.

  5. To select a part of our text to Section complete the following steps

    1. Choose the starting point of your Segment in by Highlight some text at the desired starting point for the Segment. This can be any length but must be at least 1 character.
    2. In the Segment Label box click the Set Start button to make the highlighted text the start of your Segment.
    3. Select the end of the Segment by highlighting in the same manner as the 2. above and clicking the Set End button.
      1. If the end point is on a later page of the witness change the page selected to the desired page via the Page Selection pull down or by clicking the forward and back buttons either side of the Page Selection pull down.
    4. Create a label for the section in the Section Label text box.
    5. Add any tags desired to this Segment by entering the desired tag in the Create new tag text box
    6. Click Create Segment
    7. Click the Clear button to change the start or end point for the Segment.

Add Tag

tags can be added to the current decision in tow different ways.

  1. Any tags associated with text currently selected and 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.

View all Annotations

  1. Click on the View All Annotations under the Structures option
    1. The number in the button is the number of annotations associated withe material selected.
  2. The View Annotations popup allows tags to view by view Types and View Tags*
  3. Each button provides the relevant list of tag types that can be view. Click on the Tag Type to view the tags present.
  4. ESC or clicking the red close button will close the popup.

Creating Segments

  1. On the Material Tab for the witness you wish to create a Segment, click on Create Segments button; this will open the text for the selected Material.
  2. Select the desired page that you wish to start on from the page selection pull down on the top left.
  3. Hide or show any structural annotations already in the witness via the Show Structure button.
  4. Select the structural annotation to break on.

  5. To select a part of our text to Section complete the following steps

    1. Choose the starting point of your Segment in by Highlight some text at the desired starting point for the Segment. This can be any length but must be at least 1 character.
    2. In the Segment Label box click the Set Start button to make the highlighted text the start of your Segment.
    3. Select the end of the Segment by highlighting in the same manner as the 2. above and clicking the Set End button.
      1. If the end point is on a later page of the witness change the page selected to the desired page via the Page Selection pull down or by clicking the forward and back buttons either side of the Page Selection pull down.
    4. Create a label for the section in the Section Label text box.
    5. Add any tags desired to this Segment by entering the desired tag in the Create new tag text box
    6. Click Create Segment
    7. Click the Clear button to change the start or end point for the Segment.

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.

Sections

Sections are the containers used to hold outlines in groups to facilitate ordering for publication.

Create A Section

  1. Go to the Public tab
  2. If no publication one does not exist create a New Publication by clicking the New Publication button, assign a title to it in the popup and click Create New Publication

Edit a Section

  1. To edit an existing publication click on the desired publication in the list provide on the Publish Tab.
  2. Select the
Publication Section

This is a list of Sections already assigned to the chosen Publication if any exist.
Click the Edit button next to the Publication Sections title.
This will open the Edit Sections popup
The left side of the popup allows you to edit, reorder, decorate and set the layout options for a selected section
The right side of the popup allows you to add, remove outline. As well as apply Layout type.

The Edit Sections popup that this presents allows you to

1. [Create a new Section](#newsection)
2. [Re-order](#reorder) the Sections
3. Add a [style or layout rules](#rule) to tagged content in a section or sections
4. Apply [different layout types](#layouttypes) (apparatus, text and list) to the section.
5. [Select and add outlines](#addoutline) to any section
6. [Edit](#editoutline) which outlines are in any section
7. [View](#view) any decoration or layout rules applied to the content of the section selected.

Create a new Section

To Create a new section enter the title in the text box under the section list under the Sections Header on the upper right of the pop over.

Click the +New Section button to add the new section to the section list.

Reorder

Under the Section Header on the upper left side of the Edit Sections popup there is a list of current Sections
These can be clicked and dragged into any desired order. This is the order in which the outlines in the section will be presented when published.

Apply a Decoration'Style or layout rule

Style or layout rules can be applied to anything that has been tagged in the outlines within the sections.
A list of all Tags and tag types are listed on the lower left of the Edit Sections popup .
To apply a rule to that tag (and thereby to the presentation of the tagged content in the final publication) Click on desired tag or tag type to open the Style and Layout popup

Layout and Style

This popup allows you to apply textual and layout styling to the content of your tags. A generic sample of text is provided in the Sample box and displays the changes as they are applied to the tag or tag type.
These rules can be applied to the tags as it is within one section or as many sections as desired

Layout

There are five options that can be applied to layout. Only one can be applied at a time
To remove click on default or select another button to replace any previously chosen layout rule.

Suppress these annotations in this publication

This prevents any annotation associated with this tag being presented in the publication. This is ideal for removing any tags used for internal reference or as notes to other collaborators without having to go back and edit out everyone of them.

Default

This removes any layout rule and is the default state for layout.

Paragraph

This will cause the content of the tag to present as a stand alone paragraph in publication.

line

This will cause the content of the tag to present as a stand alone line in publication.

Remove

This will remove the tag and ALL the contents and ALL annotations of the tag or tag type from the publication.

Style

Eight common text styling options are available to apply. Toggle these on and off as desired.
Bold, Italic, Overline, Strickethrough, subscript, Superscript, Marked and Underline.

Status and Custom CSS Rule

Status rules are provided as built in examples of sample CSS rules that can be applied.
Only one Status Rule can be applied at one time.
There is no restriction on the number of Custom Rules that can be applied.
Default removes any layout rule and is the default state for layout.
To delete Custom rules edit the text field of Custom CSS rule as desired.

Apply

All Sections within the Publication will be listed under the Apply To header.
Click any entry in the list to turn on those rules and styling to all instances of the tag or tag type in that section or sections.
Click on the button above the list to toggle the application of the rules and styling to all of the sections or none.

Reset

To remove all styles and rules from the selected tag or tag type click on the reset button in the top right of the popup.

Layout Type

What is Layout Type

Layout type is a method to create different elements of your final publication from the sections you have created. This is how you control and create the text areas, as well as any apparatus' and list you wish to be made available in your publication. This means that when you create and annotate outlines you do not then have to recreate the apparatus and lists. You reuse the same outline to generate each type of content as desired.
When making a PDF you can form your content in three ways with the Layout Type.

  1. Text
  2. Apparatus
  3. List

Text

This layout Type will treat the content of you selected section as text blocks. most of your content will be of this type. To apply this layout type Select it from the pull down menu under the Type header on the upper right of the Editing Sections popup.

Apparatus

This layout Type will treat the content of you selected section as an apparatus. To apply this layout type Select it from the pull down menu under the Type header on the upper right of the Editing Sections popup.

List

This layout Type will treat the content of you selected section as an apparatus. To apply this layout type Select it from the pull down menu under the Type header on the upper right of the Editing Sections popup.

Add Outlines

To Add an outline to a section. 

1. Select or create the section desired from the list on the upper right of the *Edit Sections* popup.
2. Under the *Sources* header select the desired outline from the pull down menu. 
3. Click the  *+ add* button to add the outline to the section. An outline can be added to any number of sections if desired.

Edit Outlines

Click and drag to reorder the outlines in the section as desired.
Click on the trash can icon to remove the outline from the section

View Layout Rules and Decoration

The Decoration/styling and layout rules that are applied to a section are listed on the bottom right of Edit Sections popup .

Home • How and why to Structure

Dashboard • Project • Material • Draft • Publish

Related

Wiki: Collation
Wiki: Dashboard
Wiki: Draft
Wiki: Edition
Wiki: Home
Wiki: How To Use
Wiki: Material
Wiki: MaterialsTab
Wiki: Publish
Wiki: Structure
Wiki: Users
Wiki: drafttab
Wiki: header
Wiki: segments

MongoDB Logo MongoDB