Public:CWRC-Writer Documentation
From CWRC
| Line 17: | Line 17: | ||
== Testing Instructions for v0.18 == | == Testing Instructions for v0.18 == | ||
| + | |||
| + | |||
| + | 1) Log in to Version 0.18 of CWRC-Writer at http://apps.testing.cwrc.ca/editor/devbuild/ | ||
| + | |||
| + | The username is cwrc and the password is cwrcy. | ||
| + | |||
| + | 2) You cannot load files from your own computer for this iteration, but you can begin by pasting your text in the text box (e.g. a file from your project, or even just any text) or loading a saved file. To load a saved file, click on the "Load" icon beside the "Save As" icon at the top of the page. | ||
| + | |||
| + | 3) As with the last version (0.17), when clicking on the "Save" or "Save As" buttons you can save your file on our server as a temporary test file to work with in this iteration, and you can use the "Load" button to bring up that file. However, because at the moment we do not have authentication set up for each individual user, it's best if you do not play with each other's files: this way each tester can have his/her own files to alter, add to, and so forth. Perhaps personalizing your files by adding initals to the beginning (e.g. SAH) would be a good way to indicate to others that it is a file created by one of the other CWRC-Writer testers. | ||
| + | |||
| + | 4) As with version 0.17, the entities, such as for "Place", "Event", and "Organization", are still just random placeholders at the moment. We added some entries from a sample authority list for the "Person" entity, although these names only go up to H so far, so if you try to tag "Woolf", for example, you will not be able to find Virginia Woolf in this list. | ||
| + | |||
| + | In version 0.18, however, we've added a "Create New" button that you can click on after selecting text to mark up as an entity, such as "Place", as this will be connected to the entity management system in future iterations and will allow you to add new entities. At the moment, however, it is just for demo purposes, and saves of new entities are not permanent. | ||
| + | |||
| + | 5) We now have help text displayed for some tags, such as Div 1. Right click on a section of text, then select "Structural Tags" and then "Div 1", click on the "Help" button, and you will see the help text for Div 1. Some tags still don't have help text, but we're hoping that this can serve as a demo of what it would look like. | ||
| + | |||
| + | 6) Validation of the whole text is coming. At the moment, the editor is using the Orlando events schema, and so it is limited, and the editor will only give you the tags that are valid at the point that you are inserting them. | ||
| + | |||
| + | 7) Some changes in the layout/interface: | ||
| + | - we now have the path of the tag displayed below the icons on the top of the CWRC-Writer page | ||
| + | - you can cut and paste text, but moving large sections will cause the text to lose its tags and/or entities | ||
| + | - the source view has changed a bit, but as with previous versions, it's best not to play around too much in "edit source" at this point | ||
| + | |||
| + | 8) Have a look at this version of CWRC-Writer, play around a bit, and let me know what you think. | ||
| + | |||
| + | 9) Did you find a bug or error? If you find any bugs or issues, please let me know (s.hesemeier@ualberta.ca) using the basic bug-reporting info below: | ||
| + | |||
| + | What browser were you using? On what operating system? | ||
| + | What version of the editor? | ||
| + | When did it occur? (date/time) | ||
| + | Short description of error. | ||
| + | Steps that led to the error. | ||
| + | Text of document that was tested. | ||
| + | You could add a screenshot as illustration if this is easy for you to do; otherwise, don't worry about screenshots. | ||
| + | |||
| + | Also, if you are unsure about how something works, please feel free to email me with your questions! As mentioned above, knowing what you have questions about will also help us with fleshing out the documentation for future iterations. | ||
Revision as of 16:26, 23 January 2012
About
CWRC-Writer is an in-browser text markup editor being developed by the Canadian Writing Research Collaboratory (CWRC) for use by collaborative scholarly editing projects. As CWRC-Writer develops, we expect to be able to release an open source in-browser scholarly editing tool with the following features:
- Close-to-WYSIWYG editing and enrichment of scholarly texts with meaningful visual representations
- Ability to add Named Entity Annotations
- Ability to combine TEI markup for the text and stand-off RDF annotations
- Ability to export using “weavers” that recombine the plain text, the TEI, and the RDF into different forms (including a TEI-like embedded XML)
- Documented code for editorial projects to be able to incorporate CWRC-Writer into their projects
- And more!
Getting Started
1) Open CWRC-Writer in a Web browser, such as Firefox or Chrome (Internet Explorer is not supported). The latest version (0.18) is available at http://apps.testing.cwrc.ca/editor/devbuild/
2) You will be prompted to enter the username (cwrc) and password (cwrcy).
Testing Instructions for v0.18
1) Log in to Version 0.18 of CWRC-Writer at http://apps.testing.cwrc.ca/editor/devbuild/
The username is cwrc and the password is cwrcy.
2) You cannot load files from your own computer for this iteration, but you can begin by pasting your text in the text box (e.g. a file from your project, or even just any text) or loading a saved file. To load a saved file, click on the "Load" icon beside the "Save As" icon at the top of the page.
3) As with the last version (0.17), when clicking on the "Save" or "Save As" buttons you can save your file on our server as a temporary test file to work with in this iteration, and you can use the "Load" button to bring up that file. However, because at the moment we do not have authentication set up for each individual user, it's best if you do not play with each other's files: this way each tester can have his/her own files to alter, add to, and so forth. Perhaps personalizing your files by adding initals to the beginning (e.g. SAH) would be a good way to indicate to others that it is a file created by one of the other CWRC-Writer testers.
4) As with version 0.17, the entities, such as for "Place", "Event", and "Organization", are still just random placeholders at the moment. We added some entries from a sample authority list for the "Person" entity, although these names only go up to H so far, so if you try to tag "Woolf", for example, you will not be able to find Virginia Woolf in this list.
In version 0.18, however, we've added a "Create New" button that you can click on after selecting text to mark up as an entity, such as "Place", as this will be connected to the entity management system in future iterations and will allow you to add new entities. At the moment, however, it is just for demo purposes, and saves of new entities are not permanent.
5) We now have help text displayed for some tags, such as Div 1. Right click on a section of text, then select "Structural Tags" and then "Div 1", click on the "Help" button, and you will see the help text for Div 1. Some tags still don't have help text, but we're hoping that this can serve as a demo of what it would look like.
6) Validation of the whole text is coming. At the moment, the editor is using the Orlando events schema, and so it is limited, and the editor will only give you the tags that are valid at the point that you are inserting them.
7) Some changes in the layout/interface: - we now have the path of the tag displayed below the icons on the top of the CWRC-Writer page - you can cut and paste text, but moving large sections will cause the text to lose its tags and/or entities - the source view has changed a bit, but as with previous versions, it's best not to play around too much in "edit source" at this point
8) Have a look at this version of CWRC-Writer, play around a bit, and let me know what you think.
9) Did you find a bug or error? If you find any bugs or issues, please let me know (s.hesemeier@ualberta.ca) using the basic bug-reporting info below:
What browser were you using? On what operating system? What version of the editor? When did it occur? (date/time) Short description of error. Steps that led to the error. Text of document that was tested. You could add a screenshot as illustration if this is easy for you to do; otherwise, don't worry about screenshots.
Also, if you are unsure about how something works, please feel free to email me with your questions! As mentioned above, knowing what you have questions about will also help us with fleshing out the documentation for future iterations.
