https://sourceforge.net/p/tradamus/wiki/Home/Recent changes to HomeenMon, 13 Jun 2016 14:26:59 -0000https://sourceforge.net/p/tradamus/wiki/Home/<div class="markdown_content"><pre>--- v31 +++ v32 @@ -1,6 +1,6 @@ ####[Home](Home) • [How and why to Structure](Structure) -#####[Dashboard](Dashboard) • [Edition](Edition) • [Material](Material) • [Draft](Draft) • [Publish](Publish) +#####[Dashboard](Dashboard) • [Project](Edition) • [Material](Material) • [Draft](Draft) • [Publish](Publish) --- @@ -13,17 +13,17 @@ ##The Tradamus Approach There are four core elements to building a critical edition in Tradamus. -1. Create an Editon - The edition will hold all your transcriptions, images, annotations. Think of it as a container for all of your work. -2. Import your Materials. Everything that you bring into your Edition are your materials. This could be your transcriptions, manuscript images, comentaries, bibliographies and anything else you want to include in you publviactions. -3. Organize you Materials. there are two steps to organising your materials. Firsly break your materials into manageable and logical segments. This is your oportunity to bring your Materials together and organise them to allow you to work with them. It also brings together the transcriptions in managable and coherent divisions to collate them. For example you could create an segment for each ofl the chapter ones in your witnesses. You bring those segments together into an outline which you then collate. Other content you have imported like an commentary which you can bring in as a single document also be divided int osensible and logical segments. This kinds of segments are put into outlines which are then ready to be arranged in its appropriate section when you are ready to prepare to publish. Thus you can deal with your materials in a content focused way. -4. Prepare your Outlines for publication. Once you have collated The witness Outlines, you arrange the Outlines in Sections which are then put in the desired order for publication. Thus you put your commentary outine for chapter one with the collated text of chapter one and add any desired indexs, bibliographies or other relevent content. These Sections can then be ordered as needed. This ordered set of Sections can then be published. - -This approach allows you to publish your critical edtion, not only in a variety of formats but you can also return to your materials and re-imagine your work in a different way. Your first pulbication may take a diplomatic approach, your next might be mouvaunce in its approach. +1. Create an Project - The Project will hold all your transcriptions, images, and annotations. Think of it as a container for all of your work. +2. Import your Materials. Everything that you bring into your Project are your materials. This could be your transcriptions, manuscript images, commentaries, bibliographies and anything else you want to include in you publications. +3. Organize you Materials. there are two steps to organizing your materials. Firstly break your materials into manageable and logical segments. This is your opportunity to bring your Materials together and organize them to allow you to work with them. It also brings together the transcriptions in manageable and coherent divisions to collate them. For example you could create a segment for each of the chapter ones in your witnesses. You bring those segments together into an outline, which you then collate. Other content you have imported like an commentary which you can bring in as a single document also be divided into sensible and logical segments. These kinds of segments are put into outlines, which are then ready to be arranged in its appropriate section when you are ready to prepare to publish. Thus you can deal with your materials in a content focused way. +4. Prepare your Outlines for publication. Once you have collated The witness Outlines, you arrange the Outlines in Sections which are then put in the desired order for publication. Thus you put your commentary outline for chapter one with the collated text of chapter one and add any desired indexes, bibliographies or other relevant content. These Sections can then be ordered as needed. This ordered set of Sections can then be published. + +This approach allows you to publish your critical edition, not only in a variety of formats but you can also return to your materials and re-imagine your work in a different way. Your first publication may take a diplomatic approach, your next might be mouvaunce in its approach. ##How to work in Tradamus -Create an Edition: this will contain all the materials you develop or import for your Critical Edition. +Create an Project: this will contain all the materials you develop or import for your Critical Edition. You start this in the [Dashboard](#Dashboard) @@ -41,7 +41,7 @@ --- ##Navigation 1. [Dashboard](#Dashboard) -* [Edition](#Edition) +* [Project](#Edition) * [Material](#Material) * [Draft](#Draft) * [Publish](#Publish) @@ -50,46 +50,46 @@ <a id="Dashboard"></a> ###Dashboard -This is your home screen. From here you can enter an existing Edition. Create a New Edition and edit your User information. -1. Create an Edition, Open An Existing Edition(#CreateEdition) -2. Recent Activity(#recent activity) -3. Public Edition(#publicedition) +This is your home screen. From here you can enter an existing Project. Create a New Project and edit your User information. +1. Create an Project, Open An Existing Project(#CreateEdition) +2. Recent Activity (#recent activity) +3. Public Project (#publicedition) 4. Tab Actions#(Tabaction) 5. Edit User information#(edituser) --- -## Edition -An [Edition](#Edition) is your complete project. It will contain all of the materials you import: T-Pen Transcriptions, associated images, editorial content etc. - - -## Create an Edition +## Project +A[Project](#Edition) 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. * Enter a Title. - 1. This title is editable at all times and is the human readable label used to identify the Edition in thet list of Editons. You will be able to create any number of Publications from this one Edition according to your requirements. -* Click Create New Edition - -##Open An Existing Edition -1. Click on the Edition Title in the Editions Column. This will bring you to the [Edition](#Edition)Tab for that Edition. + 1. This title is editable at all times and is the human readable label used to identify the Project in that list of Projects. You will be able to create any number of Publications from this one Project according to your requirements. +* Click Create New Project + +##Open An Existing Project +1. Click on the Project Title in the Projects Column. This will bring you to the [Project](#Edition) Tab for that Project. --- ###Recent Activity. -This displays all the recent activity on your editions where it is possible a link will be provided to allow you to go directly to the activity. - - ---- -##Public Edition -Any Edition can be published with full public access. This allows for anyone registered with tradamus.org to contribute and work on a project that you designate at public. A Project can be made public in the Edition tab by editing the permissions. +This displays all the recent activity on your Projects where it is possible a link will be provided to allow you to go directly to the activity. + + +--- +##Public Project +Any Project can be published with full public access. This allows for anyone registered with tradamus.org to contribute and work on a project that you designate at public. A Project can be made public in the Project tab by editing the permissions. --- ##Tab Actions -1. If no Edition has been opened in the current session only dashboard and the Edition Tabs will be available. -+ Selecting the Edition Tab will present a full list of the Editions belonging to or editable by you. Once an Edition is selected all the appropriate tabs become available to you. Return to the Dashboard to select an new edition. +1. If no Project has been opened in the current session only dashboard and the Project Tabs will be available. ++ 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 a new Project. @@ -101,59 +101,59 @@ --- -<a id="Edition"></a> - -##Edition -Under the Edition tab you will be able to add metadata on the Edition. You will edit your permissions settings for collaborators as well as invite new collaborators. You will also add materials to your Edition and access the Material to edit, and add metadata and tags as desired. You will also be able to delete any unwanted Materials. - ---- - -## Edition -An [Edition](Edition) is your complete project. It will contain all of the materials you import: T-Pen Transcriptions, associated images, editorial content etc. - - -## Create an Edition +<a id="Project"></a> + +##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](Edition) 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. * Enter a Title. - 1. This title is editable at all times and is the human readable label used to identify the Edition in thet list of Editons. You will be able to create any number of Publications from this one Edition according to your requirements. -* Click Create New Edition - -##Open An Existing Edition -1. Click on the Edition Title in the Editions Column. This will bring you to the [Edition](Edition)Tab for that Edition. + 1. This title is editable at all times and is the human readable label used to identify the Project in that list of Projects. You will be able to create any number of Publications from this one Project according to your requirements. +* Click Create New Project + +##Open An Existing Project +1. Click on the Project Title in the Projects Column. This will bring you to the [Project](Edition) Tab for that Project. --- ##Tab Actions -1. If no Edition has been opened in the current session only dashboard and the Edition Tabs will be available. -+ Selecting the Edition Tab will present a full list of the Editions belonging to or editable by you. Once an Edition is selected all the appropriate tabs become available to you. Return to the Dashboard to select an new edition. - - ---- - -##Edition Tab -When entering Edition tab for the first time or when you have not selected an existing edition or created a new one you will be presented with a list of the Editions available to you and the option to create an Edition. These will include Editions you created yourself or ones you have been allow to edit by other users. If you have selected an Edition selecting this tab will allow you to manage the Edition you have selected. +1. If no Project has been opened in the current session only dashboard and the Project Tabs will be available. ++ 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 Edition. It is editable at anytime and is distinct form any publication titles you may have within the Edition. +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 Edition. 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. +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 edition. +This where you manage any and all access to your Project. ####Materials] -This where you add all materials you want, to your Edition. +This where you add all materials you want, to your Project. --- ####Actions -When you have selected an Edition you will have the option to do the following under the Edition Tab. - -1. [Edit or Create Metadata](#Edit or Create Metadata) for Description of the Edition level of the project. +When you have selected an Project you will have the option to do the following under the Project Tab. + +1. [Edit or Create Metadata](#Edit or Create Metadata) for Description of the Project level of the project. * Manage User [Permissions](#Permissions). -* [Publicly Share](#Publicly Share) the Edition and set levels of sharing. +* [Publicly Share](#Publicly Share) the Project and set levels of sharing. * Import [Materials](#Materials). -* [Change Edition](#Change Edition) +* [Change Project](#Change Edition) * [Discard](#Discard) @@ -162,7 +162,7 @@ <a id="Edit or Create Metadata"></a> ###Edit or Create Metadata ####Edit Description -All meta data at this point is at the edition level, so its never a single manuscript unless your edition is only a single witness. This is where you might add data like TEI headers. +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](#Add, edit or delete key value pairs) @@ -174,7 +174,7 @@ --- <a id="Add, edit or delete key value pairs"></a> #####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. +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 @@ -189,8 +189,8 @@ These formats can be imported via -1. Edit under Description for both the Edition level or individual Materials -2. Edit under Materials for the Edition level to import materials into Tradamus. +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. @@ -222,7 +222,7 @@ 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. +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* @@ -238,7 +238,7 @@ <a id="manageuser"></a> <a id="Permissions"></a> ###Manage User Permissions -Here you can add or delete any user to your Edition. +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](#Editor),[Contributor](#Contributor),[Reviewer](#Reviewer) and [Viewer](#Viewer). #####Invite User and Set Permissions @@ -249,7 +249,7 @@ * Click the Add User Button to add user at the chosen level of Access * 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 Edition can be edited via the *Edit* button to change their permissions level or deleted via the *Delete* button +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 * The User will move to the User text box above where you can manually edit the User. @@ -262,43 +262,43 @@ * Any User deleted can be added back at any time. <a id="Users"></a> -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 [Edition] tag and editing the user and public sharing permissions there. +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. <a id="Owner"></a> #####Owner -The Owner is the creator of the Edition. The Owner/Creator of an Edition is automatically an Editor of the Edition. As Editor you, as the owner, have all levels of access to the Edition. As Editor you can edit at all levels, annotate at all levels, import [Materials](#materials), [Draft], [Section], [Publish], delete content, and perform all functions supported by Tradamus in the Edition. +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](#materials), [Draft], [Section], [Publish], delete content, and perform all functions supported by Tradamus in the Project. <a id="Editor"></a> #####Editor -The Editor has all levels of access to the Edition. As Editor you can edit at all levels, annotate at all levels, import [Materials](#materials), [Draft], [Section], [Publish], delete content, and perform all functions supported by Tradamus in the Edition. The Owner/Creator of an Edition is automatically an Editor of the Edition. +The Editor has all levels of access to the Project. As Editor you can edit at all levels, annotate at all levels, import [Materials](#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. <a id="Contributor"></a> #####Contributor -A contributor can perform all the same functions as the Editor except, import [Materials](#materials), delete materials +A contributor can: perform all the same functions as the Editor except, import [Materials](#materials), delete materials <a id="Reviewer"></a> #####Reviewer -A Reviewer can only [comment on a publication](comment publication) and cannot do any of the functions allowed in the Edition. 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 desecrate uri to access the publication and make any comments desired anonymously. +A Reviewer can only [comment on a publication](comment 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 desecrate uri to access the publication and make any comments desired anonymously. <a id="Viewer"></a> #####Viewer -A Viewer can look at all the materials as well as the [Collation]s and look through all the content of the Edition but cannot comment or make any editions of deletions. +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. <a id="None"></a> #####None -The default setting for public sharing for any Edition is 'none'. +The default setting for public sharing for any Project is 'none'. --- <a id="Publicly Share"></a> -###Publicly Share The Edition -You can share your Edition withe the Tradamus Community in general if you want to. +###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. -* On the right Side you can change via the drop down labeled Set Public Access.You can set public access to [Editor](#Editor),[Contributor](#Contributor), [Viewer](#Viewer) or the default which is [None](#None) +* On the right Side you can change via the drop down labeled Set Public Access. You can set public access to [Editor](#Editor),[Contributor](#Contributor), [Viewer](#Viewer) or the default which is [None](#None) @@ -306,11 +306,11 @@ <a id="Materials"></a> #Edit or Import Material -Material is imported under the Edtion Tab. +Material is imported under the Project Tab. There are three ways to bring in material: Link, File or Text. ####Import Material. -1.[Link](#Link), +1. [Link](#Link), 2. [File](#File) 3. [Text](#Text) @@ -318,7 +318,187 @@ <a id="Link"></a> #####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 Edition Tab +1. Go to the Project Tab +2. Click on *Edit* button next to Materials. +* Click *Link* on the top right +* 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 + + Click the *Browse T-Pen* button + + A list of projects in T-Pen will be presented to you + + Click to select the project(s) you wish to import then click + * Link Via URI + 1. Copy and past the URI you wish to resolve into the text box under Link URI + + Click Import + + + +<a id="File"></a> +#####File +1. Go to the Project Tab +2. Click on *Edit* button next to Materials. +* Click *File* on the top right +* Navigate to the file and select it +* Click *Choose* and the file is put into the list of materials on the left hand side of the Popup. + + + +<a id="Text"></a> +#####Text +1. Go to the Project Tab +2. Click on *Edit* button next to Materials. +* Click *File* on the top right +* 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](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. + +* Click on the *Expand* Button to widen the text fields for longer named materials. + +<a id="Preview2"></a> +#####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](#Preview2) +2. Edit from Materials list in Main Popup. This option brings you to the individual entry for that Material under the [Materials tab](MaterialsTab). + +<a id="Preview Changes"></a> +#####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. + + + +--- + +<a id="Change Edition"></a> +###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. + +--- + +<a id="Discard"></a> +###Discard +This allows you to discard the entire Project PERMANENTLY. You will receive a warning to be sure you are deleting the Project deliberately. + +--- +--- + + +<a id="Material"></a> +#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](#aboutMaterial) +2. [Broad Principles](#BroadPrinciples) +3. [Types of Material](#TypesofMaterial) +4. [Anatomy of a Material](#AnatomyofaMaterial) +5. [Edit or add Material](#Materials) + + +--- +<a id="aboutMaterial"></a> +##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. + +--- +<a id="TypesofMaterial"></a> +##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. + +--- +<a id="AnatomyofaMaterial"></a> +##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 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. + + +--- +<a id="Materials"></a> +#Edit or Import Material +Material is imported under the Project Tab. +There are three ways to bring in [material](Material). [Link](#Link), [File](#File) or [Text](#Text). + +####Import Material. +1.[Link](#Link), +2.[File](#File) +3.[Text](#Text) + + +<a id="Link"></a> +#####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. * Click *Link* on the top right * There are two options under link: Import from T-Pen or Link via URI @@ -335,7 +515,7 @@ <a id="File"></a> #####File -1. Go to the Edition Tab +1. Go to the Project Tab 2. Click on *Edit* button next to Materials. * Click *File* on the top right * Navigate to the file and select it @@ -345,7 +525,7 @@ <a id="Text"></a> #####Text -1. Go to the Edition Tab +1. Go to the Project Tab 2. Click on *Edit* button next to Materials. * Click *File* on the top right * There are two options under *Text* @@ -361,186 +541,6 @@ * Click on the *Expand* Button to widen the text fields for longer named materials. <a id="Preview2"></a> -#####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](#Preview2) -2. Edit from Materials list in Main Popup. This option brings you to the individual entry for that Material under the [Materials tab](MaterialsTab). - -<a id="Preview Changes"></a> -#####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. - - - ---- - -<a id="Change Edition"></a> -###Change Edition -This displays the list of Editions available to you to allow you to change to a different Edition without returning to the dashboard. Click the edition you want to select it. This will bring you to the Edition management for that selected Edition. - ---- - -<a id="Discard"></a> -###Discard -This allows you to discard the entire Edition PERMANENTLY. You will receive a warning to be sure you are deleting the Edition deliberately. - ---- ---- - - -<a id="Material"></a> -#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](#aboutMaterial) -2. [Broad Principles](#BroadPrinciples) -3. [Types of Material](#TypesofMaterial) -4. [Anatomy of a Material](#AnatomyofaMaterial) -5. [Edit or add Material](#Materials) - - ---- -<a id="aboutMaterial"></a> -##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. - ---- -<a id="TypesofMaterial"></a> -##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 Edition 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 Edition 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. - ---- -<a id="AnatomyofaMaterial"></a> -##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 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. - - ---- -<a id="Materials"></a> -#Edit or Import Material -Material is imported under the Edtion Tab. -There are three ways to bring in [material](Material). [Link](#Link), [File](#File) or [Text](#Text). - -####Import Material. -1.[Link](#Link), -2.[File](#File) -3.[Text](#Text) - - -<a id="Link"></a> -#####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 Edition Tab -2. Click on *Edit* button next to Materials. -* Click *Link* on the top right -* 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 - + Click the *Browse T-Pen* button - + A list of projects in T-Pen will be presented to you - + Click to select the project(s) you wish to import then click - * Link Via URI - 1. Copy and past the URI you wish to resolve into the text box under Link URI - + Click Import - - - -<a id="File"></a> -#####File -1. Go to the Edition Tab -2. Click on *Edit* button next to Materials. -* Click *File* on the top right -* Navigate to the file and select it -* Click *Choose* and the file is put into the list of materials on the left hand side of the Popup. - - - -<a id="Text"></a> -#####Text -1. Go to the Edition Tab -2. Click on *Edit* button next to Materials. -* Click *File* on the top right -* There are two options under *Text* - 1. Paste or type text in th text below the *text* bbutton 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](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. - -* Click on the *Expand* Button to widen the text fields for longer named materials. - -<a id="Preview2"></a> <a id="Preview Changes"></a> #####Preview Changes @@ -580,8 +580,8 @@ ##Outline <a id="outline"></a> ###What is an Outline -Outline is the term we use to describe a gathering of [Segments](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](collation) and [drafting](draft) for example to collatet 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](collation) under the [draft tab](draft). -You cannot collate any material untill you have put the desired material in a segment and gathered the desired segments together to make an Outline. +Outline is the term we use to describe a gathering of [Segments](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](collation) and [drafting](draft) 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](collation) under the [draft tab](draft). +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. ---- <a id="Create Outline"></a> @@ -591,24 +591,24 @@ 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. Rember Every segment needs to be in an Outline but only Outlines intended for collation should have contain more than one Segment. +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 appearunder the *Segments* header listing those Segments by their Label. + 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. Rember Every segment needs to be in an Outline but only Outlines intended for collation should have contain more than one Segment. +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 appearunder the *Segments* header listing those Segments by their Label. + 2. If selection has any existing Segment a box will appear under the *Segments* header listing those Segments by their Label. 4. Click the Segment desired from the Segment list to add to the Outline. 5. Repeat step 3 until you have all the Segments you want for the Outline you are making. 6. 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 Outine 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 Outine. +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. ---- @@ -630,10 +630,10 @@ <a id="collate"></a> ##Collate -Once you have created a outline with more than one segments in it you will be able to collate the contents of that oultine. +Once you have created a outline with more than one segments in it you will be able to collate the contents of that Oultine. #####How To Collate -If the outline has not been collated thn when a outline is selected a *Collate this group* button will be presented. If a collation already exists a *Reveiw Collation* button will replace the *Collate this group* button. These buttons will only be visable if more than one segment is in the outline. +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 visable if more than one segment is in the outline. --- #####Start Collation @@ -644,16 +644,16 @@ #####Collate the contents of an outline 1.Click on the *Collate this group* button. - 2. Click the *Collate 'X' Segments* button. (wher X is the number of segments in the outline) + 2. Click the *Collate 'X' Segments* button. (where X is the number of segments in the outline) 3. The [collation window](#collationwindow) for this outline will open. --- -#####Request a serverside Collation -Sometimes large or complex collations can take substative periods of time to collate. If a collation appears to be taking a protracted period of time to returh the collation to you. t may be that the collation you arerunning is just such a large or conplex collation. for this purpose and to aviod the havingto maintain an open browser window you can request a serverside collation by clicking the *Request a serverside collation* button. +#####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. <a id="uri"></a> -#####Insert URI from completed serverside collation -The notification email you recieve will contain a URI to the collation. Copy and paste that URI into the text box beneet the request a serverside collation but and press the enter key. This will load the collation in the [collation window](#collationwindow) +#####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](#collationwindow) --- ####The Collation window. @@ -665,8 +665,8 @@ --- ####The Collation Interface -This where you canmake the decisions between variants. A number of tools and aids are provided to faciltate 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 orignating Material is used. +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](#decisionheader) 2. [Read as Base Text](#basetext) @@ -681,60 +681,60 @@ <a id="decisionheader"></a> ####Decision Header -This is located in the center at the top fo the window. It indicates which decision you are looking at as well as providing forward and back buttons either side of the header to navagate between Decisions. +This is located in the center at the top fo 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. <a id="basetext"></a> #####Read as base text This pull down allows you to define the base text used for the text displayed in the [annotation interface](#anotationinterface). 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 arbitary selction of one of the segments and may change between sessions +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 <a id="hidesegment"></a> #####Hide Segments -This allows you to hide and show specific segments in the collation window. The segments are labeld 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. +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. <a id="variants"></a> #####Variants Selector -In the center of the window there are three columns showing the previious 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 theelft of the variant. Variaqnts that are the same across multiple variants will list all the relevant sigla next to the variant. +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 the 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 seperate variant when ever that decision is not the decision under review. +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. <a id="previousnext"></a> ######Previous and Next Decisions -In the center of the window there are three columns showing the previious 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 intoteh center review spot and move the corresponding previous and upcoming into their relevant places. +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. <a id="image"></a> ######View Witness image -The tab beneath the present decision under review (Variant selector) will present the election of the 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 ofr your transcriptions as it alow you to review the orginal manuscript without having to leave the collatio interface. +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. <a id="tag"></a> ######Add Tag -Beneath the present decision under review (Variant selector) tags can be added to the current decision in tow differnet ways. - 1. Any tags assciated with text currently under review is presented beneath the tag text box. Click the desired tag to add that tag to the decision. +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. <a id="saving"></a> #####Save Decisions -To save any decisions made you MUSTt click the *Save Decision* button. +To save any decisions made you MUST click the *Save Decision* button. <a id="variant"></a> ######Choose all single Variants -The *Choose all single Variants* button will change all decisons that have only one choice to that choice.The number of such decisions made will appear above the button. +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. --- <a id="reviewoutline"></a> #####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 colation window to allow you oto edit and review your collation. +This will reopen the collation window to allow you to edit and review your collation. ---- <a id="annotate"></a> -##Annotate the colllated text -The bottom half of the collation screen is whre 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. +##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](#selectdecision) 2. [Select any text to annotate](#selecttext) @@ -747,23 +747,23 @@ <a id="selectdecision"></a> ####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 annotion tool is not visable. +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. <a id="selecttext"></a> ####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 higlighting 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 +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 <a id="labelannotation"></a> ####Labeling the annotation The default label for an annotation is Annotation Detail. To edit this label - 1. click on the label button to teh right of the annoation label. - 2. Edit the labelt as desired + 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 <a id="textbox"></a> ####Text Box -Enter any text desired fo the annotation, if any, in the text box beeath the annotation label. +Enter any text desired fo the annotation, if any, in the text box beneath the annotation label. <a id="decisionimage"></a> ####Decision Image @@ -772,31 +772,31 @@ <a id="createaddtag"></a> ####Create/Add Tag ######Add Tag -Tags can be added to the current decision in two differnet ways. - 1. Any tags assciated with text currently under review is presented beneath the tag text box. Click the desired tag to add that tag to the decision. +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. <a id="clearselection"></a> ####Delete -If you decide that you no longer wish to retain an annotation clcikc hte delete button. This will only appear after an annotatation has been saved. +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. --- <a id="Publish"></a> ##Publish -This is where you will order the sections you have created. You can apply styling to your non-collated sections and decide what tags, annotations and other content will be viewable in the final edition and what level of public comments you wan to enable. +This is where you will order the sections you have created and create any number of publications as you desire from your project. You can apply styling to your non-collated sections and decide what tags, annotations and other content will be viewable in the final publication and what level of public commenting you want to enable. ---- ###Publish Tab The first time you visit this page you will be presented with a create *New Publication* button. -If you have created a publication already it will be listed on this tab with all other pulbications you have created for this Edition. -**ALL** your publications will be listed not just publications associated with the Edition you are currently working in. +If you have created a publication already it will be listed on this tab with all other publications you have created for this Project. +**ALL** your publications will be listed not just publications associated with the Project you are currently working in. ####Creating a New Publication - 1. Click on the *New Publication* button - 2. In the popup that opens type your title in the Title text box and chose your prefered output form from the pull down menu. You will be able to change the the title and output form at any point later by choosing the publication title from the list of publications under the Publish tab. See [Publication Editing](#publicationediting) for more information. + 1. Click on the *New Publication* button + 2. In the popup that opens type your title in the Title text box and chose your preferred output form from the pull down menu. You will be able to change the the title and output form at any point later by choosing the publication title from the list of publications under the Publish tab. See [Publication Editing](#publicationediting) for more information. ---- @@ -804,13 +804,13 @@ ##Publication Editing To edit a publication that you have started go to the *Publication Tab* and select the publication you wish to edit. -*Publication editing* for the the chosen publication will open. +*Publication editing* for the chosen publication will open. Here you will be able to do the following 1. Update the [Publication Title](#publicationtitle) 2. Define user and public access through [Access Control](#accesscontrol) 2. Create, Edit and, Style Publication [Sections](#section) -3. change Publication Type [Publication Type](#publicationtype) which are [Dynamic Website](#dynamicwebsite), [PDF](#pdf) and, [OAC/IIIF JSON-LD](#jsonld). +3. Change Publication Type [Publication Type](#publicationtype) which are [Dynamic Website](#dynamicwebsite), [PDF](#pdf) and, [OAC/IIIF JSON-LD](#jsonld). 4. View, set up or print or download the [Publication](#golink) 5. [Discard](#discard) the Publication 6. [Change Publication](#changepublication) @@ -819,16 +819,16 @@ <a id="publicationtitle"></a> ####Publication Title The Title for your publication is editable via the *Title* text field. -Click on the text field under the *Update Title* to edit the title. -Note: the person who lasted editied this field is listed below the this text field. +Click on the text field under the *Update Title* to edit the title. +Note: the person who lasted edited this field is listed below this text field. --- <a id="accesscontrol"></a> ####Access Control#### -The Access Control settings will default to the creator and any individuals who have exisitng permission to access the Edition that this publication is being drawn from. -Exisitng settings will be listed un the Access Control Settings +The Access Control settings will default to the creator and any individuals who have existing permission to access the Project that this publication is being drawn from. +Existing settings will be listed un the Access Control Settings To edit settings click on the edit button by the Access Control header <a id="Permissions"></a> @@ -852,10 +852,10 @@ ##### Public Sharing 1. The default state of a Publication is private -2. To change this nlick on *Edit* button next to the Access Control header. -3. Select from thedrop down under the Set Public Access header for your desired level of access. - 1. Remove Permission - This option prevents puiblic access and is the default choice. - 2. Contribute Annotation - this will allow the general public to view and add comments on any of the annotations, both yours and any other users, and let them be visable in the publication. This allows for the any area of particular scholarly interest to become a nexus of discussion and the ensuing conversation becomes one more piece of the critical edition to explore and react to. +2. To change this, click on *Edit* button next to the Access Control header. +3. Select from the drop down under the Set Public Access header for your desired level of access. + 1. Remove Permission - This option prevents public access and is the default choice. + 2. Contribute Annotation - this will allow the general public to view and add comments on any of the annotations, both yours and any other users, and let them be visible in the publication. This allows for the any area of particular scholarly interest to become a nexus of discussion and the ensuing conversation becomes one more piece of the critical edition to explore and react to. 3. View Only - this presents your publication publicly but does not allow for comments and annotations by readers. @@ -863,12 +863,12 @@ --- <a id="section"></a> ###Sections -Sections are the containers used to hold outines in groups to faciltate ordering for publication. +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 pblication 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* +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 3. To edit an existing publication click on the desired publication in the list provide on the Publish Tab. @@ -879,16 +879,16 @@ 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 rright side of the popup allows you to add, remove outline. As well as apply Layout type. +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 conent in a section or 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 ruies applied to the content of the section selected. + 7. [View](#view) any decoration or layout rules applied to the content of the section selected. <a id="newsection "></a> @@ -906,10 +906,10 @@ ---- <a id="rule"></a> -####Apply a Decoration'Style or layout rule -Style or layout rules can be applied to anything that has been taged 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 presetation of the tagged content in the final publication) Click on desired tag or tag type to open the Style and Layout popup +####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. @@ -917,7 +917,7 @@ ####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 choosen layout rule. +To remove click on default or select another button to replace any previously chosen layout rule. #####Suppress these annotations in this publication @@ -927,32 +927,32 @@ This removes any layout rule and is the default state for layout. #####Paragraph -This will cause the content of the tag to presented as a stand alone paragraph in publication. +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 presented as a stand alone line in publication. +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 commpn text styling options are available to apply. Toggle these on and off as desired. -Bold, Italic, Overline, Strickethrough, subscript, Superscript, Marked and Underline. +Eight common text styling options are available to apply. Toggle these on and off as desired. +Bold, Italic, Overline, Strikethrough, 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 Custome rules edit the text field of Custom CSS rule as desired. +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 styleing to all of the sections or none. +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. @@ -971,22 +971,22 @@ <a id="text "></a> #####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. +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. <a id=" app"></a> #####Apparatus -This layout Type will treat the content of you selected section as an apparatus. To apply this layout type Select it from the pill doen menu under the *Type* header on the upper right of the *Editing Sections* popup. +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. <a id=" list"></a> #####List -This layout Type will treat the content of you selected section as an apparatus. To apply this layout type Select it from the pill doen menu under the *Type* header on the upper right of the *Editing Sections* popup. +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. --- <a id="addoutline"></a> ####Add Outlines To Add an outline to a section. - 1. Select or create the section desired from the lsit on the upper right of the *Edit Sections* popup. - 2. Under the *Sources* header select the desired outline from the pulldown menu. - 3. Click the *+ add* button to add the outline to the section. An outline can be added to any numbero sections if desired. + 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. <a id="editoutline"></a> ####Edit Outlines @@ -997,20 +997,20 @@ --- <a id="view"></a> ####View Layout Rules and Decoration -The Decoration/styling and layout rules athat are applied to a section are listed on the bottom right of *Edit Sections* popup . +The Decoration/styling and layout rules a that are applied to a section are listed on the bottom right of *Edit Sections* popup . --- <a id="publicationtype"></a> ####Publication Type -There are three supported methods of publication from tradamus. +There are three supported methods of publication from Tradamus. 1. [Interactive Website](#interactivewebsite) 2. [Set up for Printing](#pdf) 3. [OAC/IIIF JSON-LD](#jsonld) <a id="Interactivewebsite"></a> #####Interactive Website -Click on this link to view your publication as a website. This is a dynamically built site and will be automatically updated as you make changes to the publication. This is hosted by us on Tradamus and you can direct a domain name to this url ifd you desire otherwise you can share this url as you like. -you can publish as many website publications as you like or need from your edition for free. +Click on this link to view your publication as a website. This is a dynamically built site and will be automatically updated as you make changes to the publication. This is hosted by us on Tradamus and you can direct a domain name to this url if you desire otherwise you can share this url as you like. +You can publish as many website publications as you like or need from your project for free. <a id="PDF"></a> #####Set up For Printing @@ -1024,12 +1024,12 @@ --- ####Discard -To delete or discard the pulbication click on the red Discard button in the lower left corner. THIS WILL REMOVE THE PUBLICATION, and ALL SECTIONS YOU HAVE CREATED IN THIS PUBLICATION. +To delete or discard the publication click on the red Discard button in the lower left corner. THIS WILL REMOVE THE PUBLICATION, and ALL SECTIONS YOU HAVE CREATED IN THIS PUBLICATION. ---- <a id="changepublication"></a> ####Change Publication -To change between publication click on the Change Edition button in the lower right. This will return you to the Publish Tab where you can select a different pulbication to work on or to create a new pulbication. +To change between publication click on the Change Project button in the lower right. This will return you to the Publish Tab where you can select a different publication to work on or to create a new publication. @@ -1071,7 +1071,9 @@ --- ####[Home](Home) • [How and why to Structure](Structure) -#####[Dashboard](Dashboard) • [Edition](Edition) • [Material](Material) • [Draft](Draft) • [Publish](Publish) - ---- - +#####[Dashboard](Dashboard) • [Project](Edition) • [Material](Material) • [Draft](Draft) • [Publish](Publish) + +--- + + + </pre> </div>Domhnall101Mon, 13 Jun 2016 14:26:59 -0000https://sourceforge.net16eb32135419d9086c9e5e7fee2f17e6c20399dfhttps://sourceforge.net/p/tradamus/wiki/Home/<div class="markdown_content"><pre>--- v30 +++ v31 @@ -1,6 +1,6 @@ ####[Home](Home) • [How and why to Structure](Structure) -#####[Dashboard](Dashboard) • [Edition](Edition) • [Material](Material) • [Draft](Draft) • [Publish](publish) +#####[Dashboard](Dashboard) • [Edition](Edition) • [Material](Material) • [Draft](Draft) • [Publish](Publish) --- @@ -137,11 +137,11 @@ ####Title This is where you will add the Human readable title for the whole of the Edition. It is editable at anytime and is distinct form any publication titles you may have within the Edition. -####[Description](#Description) +####Description Description contains all of the metadata, which are key value pairs, for the Edition. 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](#Permissions) +####Permissions This where you manage any and all access to your edition. -####[Materials](#Materials) +####Materials] This where you add all materials you want, to your Edition. --- @@ -161,13 +161,12 @@ --- <a id="Edit or Create Metadata"></a> ###Edit or Create Metadata -<a id="Description"></a> -####Edit <a id="Description"></a>Description +####Edit Description All meta data at this point is at the edition level, so its never a single manuscript unless your edition 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](#Add, edit or delete key value pairs) -+ [Import a JSON CSV OR XML file](#Import a JSON CSV OR XML file) via the File tab then click the *Choose File* button to browse your local hard drive. ++ [Import a JSON CSV OR XML file](#ImportJSON) via the File tab then click the *Choose File* button to browse your local hard drive. + [Copy and Paste a JSON CSV OR XML file](#Copy and Paste a JSON CSV OR XML file) into Tradamus directly. + [Import](#Import) via URI by copying and pasting the URI in to the link URI text field. + [Preview Changes](#Preview Changes). @@ -184,14 +183,14 @@ --- -<a id="Import"></a> +<a id="ImportJSON"></a> #####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](Description) for both the [Edition](Edition) level or individual [Materials](Materials Tab) -2. Edit under Materials for the [Edition](Edition) level to [import materials](importmaterial) into Tradamus. +1. Edit under Description for both the Edition level or individual Materials +2. Edit under Materials for the Edition level to import materials into Tradamus. ######Import File 1. Click the *File* button at the top left of the pop up. @@ -308,7 +307,7 @@ <a id="Materials"></a> #Edit or Import Material Material is imported under the Edtion Tab. -There are three ways to bring in [material](Material). [Link](#Link), [File](#File) or [Text](#Text). +There are three ways to bring in material: Link, File or Text. ####Import Material. 1.[Link](#Link), @@ -383,6 +382,25 @@ 1. [Edit in Preview](#Preview2) 2. Edit from Materials list in Main Popup. This option brings you to the individual entry for that Material under the [Materials tab](MaterialsTab). +<a id="Preview Changes"></a> +#####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. + + + --- <a id="Change Edition"></a> @@ -396,9 +414,10 @@ This allows you to discard the entire Edition PERMANENTLY. You will receive a warning to be sure you are deleting the Edition deliberately. --- +--- + <a id="Material"></a> - #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. @@ -559,7 +578,7 @@ ---- ##Outline - +<a id="outline"></a> ###What is an Outline Outline is the term we use to describe a gathering of [Segments](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](collation) and [drafting](draft) for example to collatet 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](collation) under the [draft tab](draft). You cannot collate any material untill you have put the desired material in a segment and gathered the desired segments together to make an Outline. @@ -608,10 +627,9 @@ 3. [Annotate](#annotate) the Collated Outline. <a id="collateoutline"></a> - - - -####Collate + + <a id="collate"></a> +##Collate Once you have created a outline with more than one segments in it you will be able to collate the contents of that oultine. #####How To Collate @@ -715,7 +733,7 @@ ---- <a id="annotate"></a> -####Annotate the colllated text +##Annotate the colllated text The bottom half of the collation screen is whre 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](#selectdecision) @@ -764,10 +782,6 @@ ####Delete If you decide that you no longer wish to retain an annotation clcikc hte delete button. This will only appear after an annotatation has been saved. - - - - --- <a id="Publish"></a> @@ -1022,11 +1036,11 @@ --- -###[APIs and Standards](APIsandStandards) +###APIs and Standards A Complete list and details of the APIs available in Tradamus. -More about[APIs and Standards](APIsandStandards) +More about [APIs and Standards](APIsandStandards) --- @@ -1057,7 +1071,7 @@ --- ####[Home](Home) • [How and why to Structure](Structure) -#####[Dashboard](Dashboard) • [Edition](Edition) • [Material](Material) • [Draft](Draft) • [Publish](publish) - ---- - +#####[Dashboard](Dashboard) • [Edition](Edition) • [Material](Material) • [Draft](Draft) • [Publish](Publish) + +--- + </pre> </div>Domhnall101Thu, 14 Apr 2016 15:04:57 -0000https://sourceforge.netcd16dccc1973cb20147d8231c2c960bd493e1bb4https://sourceforge.net/p/tradamus/wiki/Home/<div class="markdown_content"><pre>--- v29 +++ v30 @@ -39,7 +39,7 @@ Publish to a digital Critical Edition, PDF or JSON doc. [Publish](#Publish) --- -##[Navigation](Navigation) +##Navigation 1. [Dashboard](#Dashboard) * [Edition](#Edition) * [Material](#Material) @@ -48,8 +48,6 @@ --- <a id="Dashboard"></a> - - ###Dashboard This is your home screen. From here you can enter an existing Edition. Create a New Edition and edit your User information. @@ -62,7 +60,7 @@ --- ## Edition -An [Edition](Edition) is your complete project. It will contain all of the materials you import: T-Pen Transcriptions, associated images, editorial content etc. +An [Edition](#Edition) is your complete project. It will contain all of the materials you import: T-Pen Transcriptions, associated images, editorial content etc. ## Create an Edition @@ -72,7 +70,7 @@ * Click Create New Edition ##Open An Existing Edition -1. Click on the Edition Title in the Editions Column. This will bring you to the [Edition](Edition)Tab for that Edition. +1. Click on the Edition Title in the Editions Column. This will bring you to the [Edition](#Edition)Tab for that Edition. </pre> </div>Domhnall101Thu, 14 Apr 2016 14:51:21 -0000https://sourceforge.net465ef6344e6283a4c7bd6bd394a518c9a752f10ehttps://sourceforge.net/p/tradamus/wiki/Home/<div class="markdown_content"><pre>--- v28 +++ v29 @@ -1,3 +1,9 @@ +####[Home](Home) • [How and why to Structure](Structure) + +#####[Dashboard](Dashboard) • [Edition](Edition) • [Material](Material) • [Draft](Draft) • [Publish](publish) + +--- + #Tradamus Tradamus is a free digital Critical Digital Edition creation web application. Whether you have straight transcriptions of your text or full TEI encoded documents you can bring them together in Tradamus to build a Critical Edition using the methodology that you want. From the Apparatus Criticus to the final publication you decide! @@ -1050,3 +1056,10 @@ The wiki uses [Markdown](/p/tradamus/wiki/markdown_syntax/) syntax. +--- +####[Home](Home) • [How and why to Structure](Structure) + +#####[Dashboard](Dashboard) • [Edition](Edition) • [Material](Material) • [Draft](Draft) • [Publish](publish) + +--- + </pre> </div>Domhnall101Thu, 14 Apr 2016 14:48:38 -0000https://sourceforge.net763761d104d1c2ae3eb2127ec0b21be740576e5dhttps://sourceforge.net/p/tradamus/wiki/Home/<div class="markdown_content"><pre>--- v27 +++ v28 @@ -42,29 +42,979 @@ --- <a id="Dashboard"></a> -[[include ref=Dashboard]] + + + +###Dashboard +This is your home screen. From here you can enter an existing Edition. Create a New Edition and edit your User information. +1. Create an Edition, Open An Existing Edition(#CreateEdition) +2. Recent Activity(#recent activity) +3. Public Edition(#publicedition) +4. Tab Actions#(Tabaction) +5. Edit User information#(edituser) + + +--- +## Edition +An [Edition](Edition) is your complete project. It will contain all of the materials you import: T-Pen Transcriptions, associated images, editorial content etc. + + +## Create an Edition +1. Click on the + Create Button. +* Enter a Title. + 1. This title is editable at all times and is the human readable label used to identify the Edition in thet list of Editons. You will be able to create any number of Publications from this one Edition according to your requirements. +* Click Create New Edition + +##Open An Existing Edition +1. Click on the Edition Title in the Editions Column. This will bring you to the [Edition](Edition)Tab for that Edition. + + + +--- + +###Recent Activity. +This displays all the recent activity on your editions where it is possible a link will be provided to allow you to go directly to the activity. + + +--- +##Public Edition +Any Edition can be published with full public access. This allows for anyone registered with tradamus.org to contribute and work on a project that you designate at public. A Project can be made public in the Edition tab by editing the permissions. + + +--- + +##Tab Actions +1. If no Edition has been opened in the current session only dashboard and the Edition Tabs will be available. ++ Selecting the Edition Tab will present a full list of the Editions belonging to or editable by you. Once an Edition is selected all the appropriate tabs become available to you. Return to the Dashboard to select an new edition. + + + +--- +##Edit User information +1. Click on the your name on the tab in the top right corner. +* you can edit Name, Email and update your password. +* Click Save Changes + --- <a id="Edition"></a> -[[include ref=Edition]] - ---- + +##Edition +Under the Edition tab you will be able to add metadata on the Edition. You will edit your permissions settings for collaborators as well as invite new collaborators. You will also add materials to your Edition and access the Material to edit, and add metadata and tags as desired. You will also be able to delete any unwanted Materials. + +--- + +## Edition +An [Edition](Edition) is your complete project. It will contain all of the materials you import: T-Pen Transcriptions, associated images, editorial content etc. + + +## Create an Edition +1. Click on the + Create Button. +* Enter a Title. + 1. This title is editable at all times and is the human readable label used to identify the Edition in thet list of Editons. You will be able to create any number of Publications from this one Edition according to your requirements. +* Click Create New Edition + +##Open An Existing Edition +1. Click on the Edition Title in the Editions Column. This will bring you to the [Edition](Edition)Tab for that Edition. + + + +--- + +##Tab Actions +1. If no Edition has been opened in the current session only dashboard and the Edition Tabs will be available. ++ Selecting the Edition Tab will present a full list of the Editions belonging to or editable by you. Once an Edition is selected all the appropriate tabs become available to you. Return to the Dashboard to select an new edition. + + +--- + +##Edition Tab +When entering Edition tab for the first time or when you have not selected an existing edition or created a new one you will be presented with a list of the Editions available to you and the option to create an Edition. These will include Editions you created yourself or ones you have been allow to edit by other users. If you have selected an Edition selecting this tab will allow you to manage the Edition you have selected. + +####Title +This is where you will add the Human readable title for the whole of the Edition. It is editable at anytime and is distinct form any publication titles you may have within the Edition. +####[Description](#Description) +Description contains all of the metadata, which are key value pairs, for the Edition. 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](#Permissions) +This where you manage any and all access to your edition. +####[Materials](#Materials) +This where you add all materials you want, to your Edition. + +--- + +####Actions +When you have selected an Edition you will have the option to do the following under the Edition Tab. + +1. [Edit or Create Metadata](#Edit or Create Metadata) for Description of the Edition level of the project. +* Manage User [Permissions](#Permissions). +* [Publicly Share](#Publicly Share) the Edition and set levels of sharing. +* Import [Materials](#Materials). +* [Change Edition](#Change Edition) +* [Discard](#Discard) + + + +--- +<a id="Edit or Create Metadata"></a> +###Edit or Create Metadata +<a id="Description"></a> +####Edit <a id="Description"></a>Description +All meta data at this point is at the edition level, so its never a single manuscript unless your edition 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](#Add, edit or delete key value pairs) ++ [Import a JSON CSV OR XML file](#Import a JSON CSV OR XML file) via the File tab then click the *Choose File* button to browse your local hard drive. ++ [Copy and Paste a JSON CSV OR XML file](#Copy and Paste a JSON CSV OR XML file) into Tradamus directly. ++ [Import](#Import) via URI by copying and pasting the URI in to the link URI text field. ++ [Preview Changes](#Preview Changes). + +--- +<a id="Add, edit or delete key value pairs"></a> +#####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. +* Click the *+* button to add the pair to the list. + + +--- +<a id="Import"></a> +#####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](Description) for both the [Edition](Edition) level or individual [Materials](Materials Tab) +2. Edit under Materials for the [Edition](Edition) level to [import materials](importmaterial) into Tradamus. + +######Import File +1. Click the *File* button at the top left of the pop up. +* Click *Choose File* +* Navigate to the file and select it +* 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. +* Type or paste the URI of the target file into the text box labeled 'Link URI' +* Click the link button next to that text field +* The file will be imported and pasted into the text box below the *Select file* button. + + +<a id="Copy and Paste a JSON CSV OR XML file"></a> +#####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. +* Copy the content of the file you want to insert +* Paste the content into the Text Box Below the *Select File* button or the Link URI Text box. +* The Content will appear the text box below the *Select file* button. + +--- +<a id="Preview Changes"></a> +####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. + +--- +<a id="manageuser"></a> +<a id="Permissions"></a> +###Manage User Permissions +Here you can add or delete any user to your Edition. +Additionally you can set different levels of permissions to control their level of access and actions: [Editor](#Editor),[Contributor](#Contributor),[Reviewer](#Reviewer) and [Viewer](#Viewer). + +#####Invite User and Set Permissions +1. Click on *Edit* button next to Permissions. +* Type the Users Email into the User Text Box. +* Click *Check for User* button +* Set the Desired level of Access/Permissions using the pull down menu that appears below the User Text field. +* Click the Add User Button to add user at the chosen level of Access +* 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 Edition 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 +* The User will move to the User text box above where you can manually edit the User. +* 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. +* The User is Deleted Immediately. +* Any Work they have done up to that point will NOT be deleted +* Any User deleted can be added back at any time. + +<a id="Users"></a> +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 [Edition] tag and editing the user and public sharing permissions there. + + +<a id="Owner"></a> +#####Owner +The Owner is the creator of the Edition. The Owner/Creator of an Edition is automatically an Editor of the Edition. As Editor you, as the owner, have all levels of access to the Edition. As Editor you can edit at all levels, annotate at all levels, import [Materials](#materials), [Draft], [Section], [Publish], delete content, and perform all functions supported by Tradamus in the Edition. + +<a id="Editor"></a> +#####Editor +The Editor has all levels of access to the Edition. As Editor you can edit at all levels, annotate at all levels, import [Materials](#materials), [Draft], [Section], [Publish], delete content, and perform all functions supported by Tradamus in the Edition. The Owner/Creator of an Edition is automatically an Editor of the Edition. + + <a id="Contributor"></a> +#####Contributor +A contributor can perform all the same functions as the Editor except, import [Materials](#materials), delete materials + +<a id="Reviewer"></a> +#####Reviewer +A Reviewer can only [comment on a publication](comment publication) and cannot do any of the functions allowed in the Edition. 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 desecrate uri to access the publication and make any comments desired anonymously. + +<a id="Viewer"></a> +#####Viewer +A Viewer can look at all the materials as well as the [Collation]s and look through all the content of the Edition but cannot comment or make any editions of deletions. + + +<a id="None"></a> +#####None +The default setting for public sharing for any Edition is 'none'. + + +--- + +<a id="Publicly Share"></a> +###Publicly Share The Edition +You can share your Edition withe the Tradamus Community in general if you want to. + +1. Click on *Edit* button next to Permissions. +* On the right Side you can change via the drop down labeled Set Public Access.You can set public access to [Editor](#Editor),[Contributor](#Contributor), [Viewer](#Viewer) or the default which is [None](#None) + + + +--- + +<a id="Materials"></a> +#Edit or Import Material +Material is imported under the Edtion Tab. +There are three ways to bring in [material](Material). [Link](#Link), [File](#File) or [Text](#Text). + +####Import Material. +1.[Link](#Link), +2. [File](#File) +3. [Text](#Text) + + +<a id="Link"></a> +#####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 Edition Tab +2. Click on *Edit* button next to Materials. +* Click *Link* on the top right +* 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 + + Click the *Browse T-Pen* button + + A list of projects in T-Pen will be presented to you + + Click to select the project(s) you wish to import then click + * Link Via URI + 1. Copy and past the URI you wish to resolve into the text box under Link URI + + Click Import + + + +<a id="File"></a> +#####File +1. Go to the Edition Tab +2. Click on *Edit* button next to Materials. +* Click *File* on the top right +* Navigate to the file and select it +* Click *Choose* and the file is put into the list of materials on the left hand side of the Popup. + + + +<a id="Text"></a> +#####Text +1. Go to the Edition Tab +2. Click on *Edit* button next to Materials. +* Click *File* on the top right +* There are two options under *Text* + 1. Paste or type text in th text below the *text* bbutton 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](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. + +* Click on the *Expand* Button to widen the text fields for longer named materials. + +<a id="Preview2"></a> +#####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](#Preview2) +2. Edit from Materials list in Main Popup. This option brings you to the individual entry for that Material under the [Materials tab](MaterialsTab). + +--- + +<a id="Change Edition"></a> +###Change Edition +This displays the list of Editions available to you to allow you to change to a different Edition without returning to the dashboard. Click the edition you want to select it. This will bring you to the Edition management for that selected Edition. + +--- + +<a id="Discard"></a> +###Discard +This allows you to discard the entire Edition PERMANENTLY. You will receive a warning to be sure you are deleting the Edition deliberately. + +--- + <a id="Material"></a> -[[include ref=Material]] + +#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](#aboutMaterial) +2. [Broad Principles](#BroadPrinciples) +3. [Types of Material](#TypesofMaterial) +4. [Anatomy of a Material](#AnatomyofaMaterial) +5. [Edit or add Material](#Materials) + + +--- +<a id="aboutMaterial"></a> +##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. + +--- +<a id="TypesofMaterial"></a> +##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 Edition 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 Edition 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. + +--- +<a id="AnatomyofaMaterial"></a> +##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 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. + + +--- +<a id="Materials"></a> +#Edit or Import Material +Material is imported under the Edtion Tab. +There are three ways to bring in [material](Material). [Link](#Link), [File](#File) or [Text](#Text). + +####Import Material. +1.[Link](#Link), +2.[File](#File) +3.[Text](#Text) + + +<a id="Link"></a> +#####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 Edition Tab +2. Click on *Edit* button next to Materials. +* Click *Link* on the top right +* 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 + + Click the *Browse T-Pen* button + + A list of projects in T-Pen will be presented to you + + Click to select the project(s) you wish to import then click + * Link Via URI + 1. Copy and past the URI you wish to resolve into the text box under Link URI + + Click Import + + + +<a id="File"></a> +#####File +1. Go to the Edition Tab +2. Click on *Edit* button next to Materials. +* Click *File* on the top right +* Navigate to the file and select it +* Click *Choose* and the file is put into the list of materials on the left hand side of the Popup. + + + +<a id="Text"></a> +#####Text +1. Go to the Edition Tab +2. Click on *Edit* button next to Materials. +* Click *File* on the top right +* There are two options under *Text* + 1. Paste or type text in th text below the *text* bbutton 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](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. + +* Click on the *Expand* Button to widen the text fields for longer named materials. + +<a id="Preview2"></a> +<a id="Preview Changes"></a> +#####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](#Preview2) +2. Edit from Materials list in Main Popup. This option brings you to the individual entry for that Material under the [Materials tab](MaterialsTab). + + --- <a id="Draft"></a> -###[Draft](Draft) -[[include ref=Draft]] - -More about [Draft](Draft) +##Draft## +This is where you will create and review [Outlines](#outline) + 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](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](collation) and [drafting](draft) for example to collatet 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](collation) under the [draft tab](draft). +You cannot collate any material untill you have put the desired material in a segment and gathered the desired segments together to make an Outline. + +---- +<a id="Create Outline"></a> +###Creating Outlines +Outlines are created under the [Draft Tab](drafttab). +To create Outlines go to the Drafts Tab. To create Outlines you must first create [Segments](#segment) under the [Materials Tab](MaterialsTab). +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. Rember 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 appearunder 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. Rember 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 appearunder the *Segments* header listing those Segments by their Label. +4. Click the Segment desired from the Segment list to add to the Outline. +5. Repeat step 3 until you have all the Segments you want for the Outline you are making. +6. 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 Outine 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 Outine. +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. + + + + <a id="Outline Tools"></a> +####OutLine Tools + +There are a number of things you can do with your outline once you have created it. + 1. [Collate](#collateoutline) the segments in the Outline + 2. [Review](#reviewoutline) the collation of a partially or completely collated Outline + 3. [Annotate](#annotate) the Collated Outline. + +<a id="collateoutline"></a> + + + +####Collate +Once you have created a outline with more than one segments in it you will be able to collate the contents of that oultine. + +#####How To Collate +If the outline has not been collated thn when a outline is selected a *Collate this group* button will be presented. If a collation already exists a *Reveiw Collation* button will replace the *Collate this group* button. These buttons will only be visable 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. + 2. Click the *Collate 'X' Segments* button. (wher X is the number of segments in the outline) + 3. The [collation window](#collationwindow) for this outline will open. + +--- +#####Request a serverside Collation +Sometimes large or complex collations can take substative periods of time to collate. If a collation appears to be taking a protracted period of time to returh the collation to you. t may be that the collation you arerunning is just such a large or conplex collation. for this purpose and to aviod the havingto maintain an open browser window you can request a serverside collation by clicking the *Request a serverside collation* button. + + <a id="uri"></a> +#####Insert URI from completed serverside collation +The notification email you recieve will contain a URI to the collation. Copy and paste that URI into the text box beneet the request a serverside collation but and press the enter key. This will load the collation in the [collation window](#collationwindow) + +--- +####The Collation window. + +#####Navigating the collation window. +The Collation window is divided into 2 areas. +The [Collation Decision interface](#collationinterface) and the [Annotations interface](#annotationsinterface) + +--- + +####The Collation Interface +This where you canmake the decisions between variants. A number of tools and aids are provided to faciltate 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 orignating Material is used. + + 1. [Decision header](#decisionheader) + 2. [Read as Base Text](#basetext) + 3. [Hide Segments](#hidesegment) + 4. [Variants Selector](#variants) + 5. [Previous and Next Decisions](#previousnext) + 6. [View Witness](#image) + 7. [Add Tag](#Tag) + 8. [Saving Decision](#saving) + 9. [Choose all single variants](#variant) + + + <a id="decisionheader"></a> + ####Decision Header +This is located in the center at the top fo the window. It indicates which decision you are looking at as well as providing forward and back buttons either side of the header to navagate between Decisions. + +<a id="basetext"></a> +#####Read as base text +This pull down allows you to define the base text used for the text displayed in the [annotation interface](#anotationinterface). 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 arbitary selction of one of the segments and may change between sessions + +<a id="hidesegment"></a> +#####Hide Segments +This allows you to hide and show specific segments in the collation window. The segments are labeld 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. + +<a id="variants"></a> +#####Variants Selector +In the center of the window there are three columns showing the previious 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 theelft of the variant. Variaqnts 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 the 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 seperate variant when ever that decision is not the decision under review. + +<a id="previousnext"></a> +######Previous and Next Decisions +In the center of the window there are three columns showing the previious 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 intoteh center review spot and move the corresponding previous and upcoming into their relevant places. + +<a id="image"></a> +######View Witness image +The tab beneath the present decision under review (Variant selector) will present the election of the 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 ofr your transcriptions as it alow you to review the orginal manuscript without having to leave the collatio interface. + +<a id="tag"></a> +######Add Tag +Beneath the present decision under review (Variant selector) tags can be added to the current decision in tow differnet ways. + 1. Any tags assciated 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. + +<a id="saving"></a> +#####Save Decisions +To save any decisions made you MUSTt click the *Save Decision* button. + +<a id="variant"></a> +######Choose all single Variants +The *Choose all single Variants* button will change all decisons that have only one choice to that choice.The number of such decisions made will appear above the button. + + --- + <a id="reviewoutline"></a> +#####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 colation window to allow you oto edit and review your collation. + + +---- + <a id="annotate"></a> +####Annotate the colllated text +The bottom half of the collation screen is whre 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](#selectdecision) +2. [Select any text to annotate](#selecttext) +3. [Annotation text box](#textbox) +4. [change label of annotation](#labelannotation) +5. [Image ](#decisionimage) +6. [Create/add Tag](#createaddtag) +7. [Create Annotation](#createannotation) +8. [Delete Annotation](#clearselection) + +<a id="selectdecision"></a> +####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 annotion tool is not visable. + +<a id="selecttext"></a> +####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 higlighting 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 + +<a id="labelannotation"></a> +####Labeling the annotation +The default label for an annotation is Annotation Detail. +To edit this label + 1. click on the label button to teh right of the annoation label. + 2. Edit the labelt as desired + 3. Click the label button to save the change + +<a id="textbox"></a> +####Text Box +Enter any text desired fo the annotation, if any, in the text box beeath the annotation label. + +<a id="decisionimage"></a> +####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 + +<a id="createaddtag"></a> +####Create/Add Tag +######Add Tag +Tags can be added to the current decision in two differnet ways. + 1. Any tags assciated 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. + +<a id="clearselection"></a> +####Delete +If you decide that you no longer wish to retain an annotation clcikc hte delete button. This will only appear after an annotatation has been saved. + + + + --- <a id="Publish"></a> -###[Publish](Publish) -[[include ref=Publish]] -More about [Publish](Publish) + +##Publish +This is where you will order the sections you have created. You can apply styling to your non-collated sections and decide what tags, annotations and other content will be viewable in the final edition and what level of public comments you wan to enable. + +---- +###Publish Tab +The first time you visit this page you will be presented with a create *New Publication* button. +If you have created a publication already it will be listed on this tab with all other pulbications you have created for this Edition. +**ALL** your publications will be listed not just publications associated with the Edition you are currently working in. + +####Creating a New Publication + 1. Click on the *New Publication* button + 2. In the popup that opens type your title in the Title text box and chose your prefered output form from the pull down menu. You will be able to change the the title and output form at any point later by choosing the publication title from the list of publications under the Publish tab. See [Publication Editing](#publicationediting) for more information. + + +---- + +##Publication Editing +To edit a publication that you have started go to the *Publication Tab* and select the publication you wish to edit. + +*Publication editing* for the the chosen publication will open. +Here you will be able to do the following + +1. Update the [Publication Title](#publicationtitle) +2. Define user and public access through [Access Control](#accesscontrol) +2. Create, Edit and, Style Publication [Sections](#section) +3. change Publication Type [Publication Type](#publicationtype) which are [Dynamic Website](#dynamicwebsite), [PDF](#pdf) and, [OAC/IIIF JSON-LD](#jsonld). +4. View, set up or print or download the [Publication](#golink) +5. [Discard](#discard) the Publication +6. [Change Publication](#changepublication) + +--- +<a id="publicationtitle"></a> +####Publication Title +The Title for your publication is editable via the *Title* text field. +Click on the text field under the *Update Title* to edit the title. +Note: the person who lasted editied this field is listed below the this text field. + + + +--- +<a id="accesscontrol"></a> +####Access Control#### +The Access Control settings will default to the creator and any individuals who have exisitng permission to access the Edition that this publication is being drawn from. +Exisitng settings will be listed un the Access Control Settings +To edit settings click on the edit button by the Access Control header + +<a id="Permissions"></a> +####Manage User Permissions +Here you can add or delete any user to your Publication. + + +#####Invite User +1. Click on *Edit* button next to the Access Control header. +* Type the Users Email into the User Text Box. +* Click *Check for User* button. +* Click the Add User Button to add user +* 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 Publication. 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 under the Access Control header. Each entry but the owner of the Publication can be deleted via the *Edit* button deleted via the *Delete* button + +#####Delete +1. Click the *Delete* button in the entry for the User you want to delete. +* The User is Deleted Immediately. +* Any Work they have done up to that point will NOT be deleted +* Any User deleted can be added back at any time. + +##### Public Sharing +1. The default state of a Publication is private +2. To change this nlick on *Edit* button next to the Access Control header. +3. Select from thedrop down under the Set Public Access header for your desired level of access. + 1. Remove Permission - This option prevents puiblic access and is the default choice. + 2. Contribute Annotation - this will allow the general public to view and add comments on any of the annotations, both yours and any other users, and let them be visable in the publication. This allows for the any area of particular scholarly interest to become a nexus of discussion and the ensuing conversation becomes one more piece of the critical edition to explore and react to. + 3. View Only - this presents your publication publicly but does not allow for comments and annotations by readers. + + + +--- +<a id="section"></a> +###Sections +Sections are the containers used to hold outines in groups to faciltate ordering for publication. + + +####Create A Section +1. Go to the Public tab +2. If no pblication 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 +3. To edit an existing publication click on the desired publication in the list provide on the Publish Tab. +4. 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 rright 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 conent 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 ruies applied to the content of the section selected. + + + <a id="newsection "></a> +####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. + +--- +<a id="reorder"></a> +#### 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. + + +---- +<a id="rule"></a> +####Apply a Decoration'Style or layout rule +Style or layout rules can be applied to anything that has been taged 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 presetation 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 choosen 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 presented as a stand alone paragraph in publication. + +#####line +This will cause the content of the tag to presented 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 commpn 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 Custome 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 styleing 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. + + + + ---- +<a id="layouttype"></a> +####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](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](#text) + 2. [Apparatus](#app) + 3. [List](#list) + + <a id="text "></a> +#####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. + <a id=" app"></a> +#####Apparatus +This layout Type will treat the content of you selected section as an apparatus. To apply this layout type Select it from the pill doen menu under the *Type* header on the upper right of the *Editing Sections* popup. + <a id=" list"></a> +#####List +This layout Type will treat the content of you selected section as an apparatus. To apply this layout type Select it from the pill doen menu under the *Type* header on the upper right of the *Editing Sections* popup. + +--- + <a id="addoutline"></a> + +####Add Outlines +To Add an outline to a section. + 1. Select or create the section desired from the lsit on the upper right of the *Edit Sections* popup. + 2. Under the *Sources* header select the desired outline from the pulldown menu. + 3. Click the *+ add* button to add the outline to the section. An outline can be added to any numbero sections if desired. + +<a id="editoutline"></a> +####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 + + +--- +<a id="view"></a> +####View Layout Rules and Decoration +The Decoration/styling and layout rules athat are applied to a section are listed on the bottom right of *Edit Sections* popup . + +--- +<a id="publicationtype"></a> +####Publication Type +There are three supported methods of publication from tradamus. +1. [Interactive Website](#interactivewebsite) +2. [Set up for Printing](#pdf) +3. [OAC/IIIF JSON-LD](#jsonld) + +<a id="Interactivewebsite"></a> +#####Interactive Website +Click on this link to view your publication as a website. This is a dynamically built site and will be automatically updated as you make changes to the publication. This is hosted by us on Tradamus and you can direct a domain name to this url ifd you desire otherwise you can share this url as you like. +you can publish as many website publications as you like or need from your edition for free. + +<a id="PDF"></a> +#####Set up For Printing +Click on this link to view your publication as it would appear as a PDF. +If the layout is as desired Click Build PDF to generate a link to the PDF. This link can be shared and as the PDF is dynamically generated when called any updates will be built into that PDF. + +<a id="jsonld"></a> +#####OAC/IIIF JSON-LD +Click on this link to view your publication as JSON-LD document. Save the file to your hard drive or use the link as desired. + +--- + +####Discard +To delete or discard the pulbication click on the red Discard button in the lower left corner. THIS WILL REMOVE THE PUBLICATION, and ALL SECTIONS YOU HAVE CREATED IN THIS PUBLICATION. + +---- +<a id="changepublication"></a> +####Change Publication +To change between publication click on the Change Edition button in the lower right. This will return you to the Publish Tab where you can select a different pulbication to work on or to create a new pulbication. + + + --- @@ -76,13 +1026,27 @@ --- -[[include ref=AboutUs]] +#THE CENTER FOR DIGITAL HUMANITIES +The CDH at Saint Louis University is focused on creating digital tools for the digital humanities. Tradamus is the latest of a number such tools as the T-Pen transcription tool. The CDH is based in the Pius Memorial Library at Saint Louis University. + + +##THE TRADAMUS TEAM +The Tradamus suite of tools has been developed and is maintained by the Center for Digital Humanities &lt;digitalhumanities@slu.edu&gt;. The original team for the 1.0 release in July 2015 is listed here. + +<dl> +<dt>Dr. Jim Ginther, Principal Investigator</dt> +<dd>Director, Center for Digital Humanities, Saint Louis University</dd> + +<dt>Domhnall Ó h'Éigheartaigh</dt> +<dd>Project Manager, UX and UI, Center for Digital Humanities, Saint Louis University</dd> + +<dt>Patrick Cuba</dt> +<dd>Lead Developer, UX and UI, Center for Digital Humanities, Saint Louis University</dd> + +<dt>Eric Smith</dt> +<dd>Software Developer, Tarkvara Design</dd> +</dl> The wiki uses [Markdown](/p/tradamus/wiki/markdown_syntax/) syntax. - - - -[[members limit=20]] -[[download_button]] </pre> </div>Domhnall101Wed, 13 Apr 2016 19:18:26 -0000https://sourceforge.net6739d64453eecee886ad6f2990a8418438309659https://sourceforge.net/p/tradamus/wiki/Home/<div class="markdown_content"><pre>--- v26 +++ v27 @@ -9,8 +9,8 @@ There are four core elements to building a critical edition in Tradamus. 1. Create an Editon - The edition will hold all your transcriptions, images, annotations. Think of it as a container for all of your work. 2. Import your Materials. Everything that you bring into your Edition are your materials. This could be your transcriptions, manuscript images, comentaries, bibliographies and anything else you want to include in you publviactions. -3. Organize you Materials. there are two steps to organising your materials. Firsly when you are building your draft you create Outlines. This is your oportunity to bring your Materials together and organise them to allow you to work with them. It also brings together the transcriptions in managable and coherent parts to collate them. For example you could create an Outline of all the chapter ones in your witnesses to collate. You then create a witness Outline to which you add those outlines that wish to collate. Or if your comentary is a single document this will allow you to divide it up as you want within tradamus, ready to be arranged in its appropriate section when you publish. Thus you can deal with your materials in a content focused way. -4. Prepare your Outlines for publication. Once you have collated The witness Outlines, you arrange the Outlines in Sections which are then put in the desired order for publication. Thus you put your commentary otine for chapter one withe the collated text of chapter one and add any desired indexs, bibliographies or other relevent content. These Sections can then be ordered as needed. This ordered set of Sections can then be published. +3. Organize you Materials. there are two steps to organising your materials. Firsly break your materials into manageable and logical segments. This is your oportunity to bring your Materials together and organise them to allow you to work with them. It also brings together the transcriptions in managable and coherent divisions to collate them. For example you could create an segment for each ofl the chapter ones in your witnesses. You bring those segments together into an outline which you then collate. Other content you have imported like an commentary which you can bring in as a single document also be divided int osensible and logical segments. This kinds of segments are put into outlines which are then ready to be arranged in its appropriate section when you are ready to prepare to publish. Thus you can deal with your materials in a content focused way. +4. Prepare your Outlines for publication. Once you have collated The witness Outlines, you arrange the Outlines in Sections which are then put in the desired order for publication. Thus you put your commentary outine for chapter one with the collated text of chapter one and add any desired indexs, bibliographies or other relevent content. These Sections can then be ordered as needed. This ordered set of Sections can then be published. This approach allows you to publish your critical edtion, not only in a variety of formats but you can also return to your materials and re-imagine your work in a different way. Your first pulbication may take a diplomatic approach, your next might be mouvaunce in its approach. </pre> </div>Domhnall101Tue, 12 Apr 2016 20:29:11 -0000https://sourceforge.net5eb4f45724f050cfcce93e3c71a22f52e33fa982https://sourceforge.net/p/tradamus/wiki/Home/<div class="markdown_content"><pre>--- v25 +++ v26 @@ -17,12 +17,19 @@ ##How to work in Tradamus -Create an Edition: this will contain all the materials you develop or import for your Critical Edition.You start this in the [Dashboard](#Dashboard) +Create an Edition: this will contain all the materials you develop or import for your Critical Edition. + +You start this in the [Dashboard](#Dashboard) + Import your text witnesses. Import any additional content such as commentaries, editorial material, images of witnesses or other content. [Materials](#Material) + Tag and annotate your material be it witnesses or editorial content by importing [Materials](#Material) or annotating directly onto the material. [Materials](#Material) + Create outlines of your materials for ease of collation.[Draft](#Draft) + Compose your draft and collate your text. [Draft](#Draft) Style and assemble all of your content, style and assemble any desired apparatuses [Publish](#Publish) + Publish to a digital Critical Edition, PDF or JSON doc. [Publish](#Publish) --- </pre> </div>Domhnall101Mon, 28 Mar 2016 14:37:32 -0000https://sourceforge.net06bde23c4bdfe2629067ccc6649fcd41051961c8https://sourceforge.net/p/tradamus/wiki/Home/<div class="markdown_content"><pre>--- v24 +++ v25 @@ -1,5 +1,5 @@ #Tradamus -Tradamus is a free digital Critical Digital Edition creation web application. Whether you straight transcriptions of your text or full TEI encoded documents you can bring them together in Tradamus to build a Critical Edition using the methodology that you want. From the Apparatus Criticus to the final publication you decide! +Tradamus is a free digital Critical Digital Edition creation web application. Whether you have straight transcriptions of your text or full TEI encoded documents you can bring them together in Tradamus to build a Critical Edition using the methodology that you want. From the Apparatus Criticus to the final publication you decide! Annotate witnesses, Collate your witnesses by leveraging our simple sectioning approach to allow you to clearly and easily manage and work with the specific elements of your text, witness images, add commentary and editorial materials, tag, style and publish. Use the application in a way that works for you; import XML, TXT, and JSONs formats. Bring your Export your content in JSON, and JSON-LD at multiple points. Use our templates for your publication or take your publication content to deploy in whatever way you want. </pre> </div>Domhnall101Mon, 28 Mar 2016 14:36:33 -0000https://sourceforge.net903e6524897f3b9b9e3c51996c9fea2eceab88fdhttps://sourceforge.net/p/tradamus/wiki/Home/<div class="markdown_content"><pre>--- v23 +++ v24 @@ -42,7 +42,7 @@ [[include ref=Edition]] --- - +<a id="Material"></a> [[include ref=Material]] </pre> </div>Domhnall101Thu, 18 Feb 2016 17:47:56 -0000https://sourceforge.netb40e88206a9d1cc7552ce9725c48a4d328dd4d4chttps://sourceforge.net/p/tradamus/wiki/Home/<div class="markdown_content"><pre>--- v22 +++ v23 @@ -29,7 +29,7 @@ ##[Navigation](Navigation) 1. [Dashboard](#Dashboard) * [Edition](#Edition) -* [Materials](#Material) +* [Material](#Material) * [Draft](#Draft) * [Publish](#Publish) </pre> </div>Domhnall101Thu, 18 Feb 2016 17:46:53 -0000https://sourceforge.net7a1956447a15cc852d79cf9350b04743bcc2a0e4