Menu

Material

Domhnall101

HomeHow and why to Structure

DashboardProjectMaterialDraftPublish

Material

Under this tab you manage Materials - your content. These materials can include transcriptions, commentaries, forewords, images etc. You can edit and annotate all your materials under this tab as well as add metadata. This is where you can divide up your materials into sections to facilitate collation as well as linking to Draft where you can section content to facilitate collation or to facilitate arrangement in Publish.

  1. About Material
  2. Broad Principles
  3. Types of Material
  4. Anatomy of a Material
  5. Edit or add Material

About Material

This information is not specifically about how to use this web application, but more about understanding the data model and the technical decisions made in its creation. Comprehending all this will help you work more effectively but is not required for basic use.

Broad Principles

Each critical edition is an arrangement of editorial materials and the assertions made about them. The most common materials are those that represent various witnesses to the edited text, but there may be supporting texts, images, digital or real objects, and original material generated by the editor without which the edition could not be considered complete.


Types of Material

Witness

These are copies of a given text from different sources that may or may not vary from other witnesses of the same text. These can be imported From T-PEN, XML or JSON documents, or be manually created.

Image

Tradamus supports images and while preferably sc:Canvas, any resolvable image is made annotatable. Images connected to an Project via a T-Pen project allows the relevant area of an image to be viewable with the text.

Editorial Content

Chapter headings, introductions, commentaries, analyses or any additional material you wish to add to your Project so as to be able to introduce them into the publication in the order or manner of your choosing.

Dataset

Encoded data to generate charts, tables, or publication aids

Placeholder

Any digital pointer to a non-digital or unavailable resource that needs a hook provided to allow for annotation. If for instance you have access to collation tables for a witness but not the witness and you only wish to capture the variants we generate a placeholder sc:canvas for that so as to allow you to annotate that specific material if you desire to.


Anatomy of a Material

The creation of a new material relies on a link/import/upload or a manual process. All a material requires to exist is a title. Tradamus will immediately create a full digital document representing this material and update it with any additional data. This document is available at its URI. When a material is imported from a location that provides a URI, which resolves to a SharedCanvas Manifest, that URI will be retained. Otherwise, Tradamus will mint and maintain a new URI.
The interface is designed to facilitate adding, annotating or editing the following elements to the material:

Title
A label that provides only a human-readable string. For a manuscript witness, this is often similar to the shelfmark or identifier, though significantly distinct. This is defined by the user and can be edited at any time.

Siglum
This is a letter (especially an initial) or other symbol used to refer to a particular witness of a text. It acts as human readable abbreviated label to aid identification of a witness. This is defined by the user and can be edited at any time.

Metadata
Annotations that specifically target the base material for the purpose of description. This is defined by the user and can be edited at any time.

Transcription
Annotations that attach textual data to the material.

Manifest
Sequence of sc:Canvas objects that represent the annotated images and other data of a material.

Annotations
List of all other annotations that target the material, but which may not be otherwise classifiable, including those imported from XML or JSON files.


Edit or Import Material

Material is imported under the Project Tab.
There are three ways to bring in material]: Link, File or Text.

Import Material.

1.Link,
2.File
3.Text

One of the options that you have is to link to remote URI, or import a file. A file can be a JSCON, CSV, or XML. What importing or linking does is resolves the link of file and is put into the list of materials on the left hand side of the Popup.

  1. Go to the Project Tab
  2. Click on Edit button next to Materials.
  3. Click Link on the top right
  4. There are two options under link: Import from T-Pen or Link via URI
    1. T-Pen Import
      1. To import from T-Pen make sure you are signed into T-Pen in another browser window
      2. Click the Browse T-Pen button
      3. A list of projects in T-Pen will be presented to you
      4. Click to select the project(s) you wish to import then click
    2. Link Via URI
      1. Copy and past the URI you wish to resolve into the text box under Link URI
      2. Click Import

File
  1. Go to the Project Tab
  2. Click on Edit button next to Materials.
  3. Click File on the top right
  4. Navigate to the file and select it
  5. Click Choose and the file is put into the list of materials on the left hand side of the Popup.

Text
  1. Go to the Project Tab
  2. Click on Edit button next to Materials.
  3. Click File on the top right
  4. There are two options under Text
    1. Paste or type text in th text below the text button to manually create a document from an XML or JSON formatted text
    or
    2. Use the this form button to create a completely new document.
    1. Click the this form button
    + Enter Title, Siglum and click the
    add text button to get he text field for adding text.
    + Create and line breaking string or Page Breaking string via the text fields provided.
    + Click the
    Create button to add the material to the Material list.
    + Further edits are done via the Materials tab.or the
    Edit* button in the entry for the relevant material in the list on the left had side of the main popup after you have created the material entry.

  5. Click on the Expand Button to widen the text fields for longer named materials.


Preview Changes

Preview changes brings up a popup which allows you to browse the contents of the imported or pasted in document so that you quickly edit the content if needed. You may wish to add edit of delete a TEI header for example. You can scroll through all the content included in your imported file and edit is desired.

Click on the Expand Button to widen the text fields for longer key value pairs entries.

There are two buttons in the 'Preview Changes' popup: Edit These and Add These

  1. Edit as JSON
    This button will add all the content to the text box on the right in the Main popup.
    The text can be deleted or edited in that text box.

  2. Import JSON
    This button will add the content as an entry per project to the list in the Main popup.


Edit options under Import

  1. Edit in Preview
  2. Edit from Materials list in Main Popup. This option brings you to the individual entry for that Material under the Materials tab.

HomeHow and why to Structure

DashboardProjectMaterialDraftPublish

Related

Wiki: Dashboard
Wiki: Draft
Wiki: Edition
Wiki: Home
Wiki: Material
Wiki: MaterialsTab
Wiki: Metadata
Wiki: Navigation
Wiki: Publish
Wiki: Structure
Wiki: header
Wiki: ignore help index
Wiki: importmaterial

MongoDB Logo MongoDB