Edition

Home • How and why to Structure

Dashboard • Project • Material • Draft • Publish

---

Project

Under the Project tab you will be able to add metadata on the Project. You will edit your permissions settings for collaborators as well as invite new collaborators. You will also add materials to your Project and access the Material to edit, and add metadata and tags as desired. You will also be able to delete any unwanted Materials.

---

Project

An Project is your complete project. It will contain all of the materials you import: T-Pen Transcriptions, associated images, editorial content etc.

Create an Project

1. Click on the + Create Button.
2. Enter a Title. This title is editable at all times and is the human readable label used to identify the Project in the list of Projects. You will be able to create any number of Publications from this one Project according to your requirements.
3. Click Create New Project

Open An Existing Project

Click on the Project Title in the Projects Column. This will bring you to the Project Tab for that Project.

---

Tab Actions

1. If no Project has been opened in the current session only dashboard and the Project Tabs will be available.
2. Selecting the Project Tab will present a full list of the Projects belonging to or editable by you. Once an Project is selected all the appropriate tabs become available to you. Return to the Dashboard to select an new Project.

---

Project Tab

When entering Project tab for the first time or when you have not selected an existing Project or created a new one you will be presented with a list of the Projects available to you and the option to create an Project. These will include Projects you created yourself or ones you have been allow to edit by other users. If you have selected an Project selecting this tab will allow you to manage the Project you have selected.

Title

This is where you will add the Human readable title for the whole of the Project. It is editable at anytime and is distinct form any publication titles you may have within the Project.

Description

Description contains all of the metadata, which are key value pairs, for the Project. Metadata is technically important, but it is the kind of thing that you is going to have very specific needs for what you want to do with it. Adding metadata like that contained in a TEI header would be the most obvious choice to add here(repository, shelf marks etc.) but you are free to add what every fits your needs.

Permissions

This where you manage any and all access to your Project.

Materials

This where you add all materials you want, to your Project.

---

Actions

When you have selected a Project you will have the option to do the following under the Project Tab.

1. Edit or Create Metadata for Description of the Project level of the project.
2. Manage User Permissions.
3. Publicly Share the Project and set levels of sharing.
4. Import Materials.
5. Change Project
6. Discard

---

Edit or Create Metadata

Edit Description

All meta data at this point is at the Project level, so its never a single manuscript unless your Project is only a single witness. This is where you might add data like TEI headers.

Selecting the Edit button next to Description which will bring up a pop up that will allow you to

1. Add, edit or delete key value pairs
2. Import a JSON CSV OR XML file via the File tab then click the Choose File button to browse your local hard drive.
3. Copy and Paste a JSON CSV OR XML file into Tradamus directly.
4. Import via URI by copying and pasting the URI in to the link URI text field.
5. Preview Changes.

---

Add, edit or delete key value pairs

You can edit each pair individually. If you click on them, they will pop up to the top where you can edit and save. You can also delete them from here. We require a two click confirmation, so you don’t accidentally get rid of something. And you can also add new ones at the top as well. So all of that works very easily for brief manual additions.

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

Add

1. Enter your key value pair in the two text boxes on the top right.
2. Click the + button to add the pair to the list.

---

Import a JSON CSV OR XML file

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 puts the text within the editable text box below the choose file button where you can edit it directly as needed.

These formats can be imported via

1. Edit under Description for both the Project level or individual Materials
2. Edit under Materials for the Project level to import materials into Tradamus.

Import File

1. Click the File button at the top left of the pop up.
2. Click Choose File
3. Navigate to the file and select it
4. Click Choose and the file will be imported and pasted into the text box below the Select file button.

Import Via Link

1. Click the Link button at the top left of the pop up.
2. Type or paste the URI of the target file into the text box labeled 'Link URI'
3. Click the link button next to that text field
4. The file will be imported and pasted into the text box below the Select file button.

Copy and Paste a JSON CSV OR XML file

Copy and Paste File

1. Click the * button at the top left of the pop up.
2. Copy the content of the file you want to insert
3. Paste the content into the Text Box Below the Select File button or the Link URI Text box.
4. The Content will appear the text box below the Select file button.

---

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 delete any un-needed metadata. You can scroll through all the metadata included in your imported file and delete any unwanted items.

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

you can edit them individually. If you click on them, they will pop up to the top where you can edit and save. I can also delete them from here. We require a two click confirmation, so you don’t accidentally get rid of something. And you can also add new ones at the top as well.

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

1. Edit These
   This button will add all the metadata to the text box in the Main Edit Metadata pop under the select File Button where you can edit the metadata directly.
   Each entry can be deleted individually by Clicking on the Delete Button for that Entry. THERE IS NO WARNING WITH THIS DELETION-THE ENTRY IS DELETED IMMEDIATELY.

2. Add These
   This button will add the metadata to the list in the 'Preview Changes' popup.

Editing the meet data list in the 'Preview Changes' popup is done by clicking on the edit icon for the entry you wish to edit which will bring the data entry to the top of the list. The metadata entry can then be edited directly there.

---

Manage User Permissions

Here you can add or delete any user to your Project.
Additionally you can set different levels of permissions to control their level of access and actions: Editor,Contributor,Reviewer and Viewer.

Invite User and Set Permissions

1. Click on Edit button next to Permissions.
2. Type the Users Email into the User Text Box.
3. Click Check for User button
4. Set the Desired level of Access/Permissions using the pull down menu that appears below the User Text field.
5. Click the Add User Button to add user at the chosen level of Access
6. If the User is not a registered User an email will beset to the email address provided inviting the User to Join and be a user on The Project. You cannot add a user until they have registered. Once they have noted you of their registration you can return to this popup to add them.

Each User added will appear in the list on the lower left. Each entry but the owner of the Project can be edited via the Edit button to change their permissions level or deleted via the Delete button

Edit

1. Click the Edit button in the entry for the User you want to edit
2. The User will move to the User text box above where you can manually edit the User.
3. If you change the users email you will be force d to add the new email as a new user. You cannot change the email for the invited user.

Delete

1. Click the Delete button in the entry for the User you want to delete.
2. The User is Deleted Immediately.
3. Any Work they have done up to that point will NOT be deleted
4. Any User deleted can be added back at any time.

there are a number of levels of Users supported in Tradamus, each with it s own level of permissions dictating the level of access that user can have. Permissions can be change at any time by going to the [Project] tag and editing the user and public sharing permissions there.

Owner

The Owner is the creator of the Project. The Owner/Creator of an Project is automatically an Editor of the Project. As Editor you, as the owner, have all levels of access to the Project. As Editor you can edit at all levels, annotate at all levels, import Materials, [Draft], [Section], [Publish], delete content, and perform all functions supported by Tradamus in the Project.

Editor

The Editor has all levels of access to the Project. As Editor you can edit at all levels, annotate at all levels, import Materials, [Draft], [Section], [Publish], delete content, and perform all functions supported by Tradamus in the Project. The Owner/Creator of an Project is automatically an Editor of the Project.

Contributor

A contributor can perform all the same functions as the Editor except, import Materials, and delete materials.

Reviewer

A Reviewer can only comment on a publication and cannot do any of the functions allowed in the Project. The Reviewers identity is hidden from the Editor and the Editors is hidden from the Reviewer. The Reviewer can only be appointed in the Publication stage of the process when a Reviewer is sent a discrete uri to access the publication and make any comments desired anonymously.

Viewer

A Viewer can look at all the materials as well as the [Collation]s and look through all the content of the Project but cannot comment or make any Projects of deletions.

None

The default setting for public sharing for any Project is 'none'.

---

Publicly Share The Project

You can share your Project withe the Tradamus Community in general if you want to.

1. Click on Edit button next to Permissions.
2. On the right Side you can change via the drop down labeled Set Public Access. You can set public access to Editor ,Contributor , Viewer or the default which is None.

---

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,

1. File
2. Text

Link

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 the 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.

---

Change Project

This displays the list of Projects available to you to allow you to change to a different Project without returning to the dashboard. Click the Project you want to select it. This will bring you to the Project management for that selected Project.

---

Discard

This allows you to discard the entire Project PERMANENTLY. You will receive a warning to be sure you are deleting the Project deliberately.

---

Home • How and why to Structure

Dashboard • Project • Material • Draft • Publish