|
|
Line 16: |
Line 16: |
| <li>'''a set of tags for marking up entities''' such as places, names, dates, organizations, and events. These tags were available by clicking on a drop-down menu icon in version 0.14, but in 0.17 they are available as separate buttons along the top of the editor.</li> | | <li>'''a set of tags for marking up entities''' such as places, names, dates, organizations, and events. These tags were available by clicking on a drop-down menu icon in version 0.14, but in 0.17 they are available as separate buttons along the top of the editor.</li> |
| <li>'''the text box will be blank''', and you will have to paste your own text into the text box (for this you could use a document of around one page from your project to which you would like to eventually add markup).</li> | | <li>'''the text box will be blank''', and you will have to paste your own text into the text box (for this you could use a document of around one page from your project to which you would like to eventually add markup).</li> |
- | <li>'''you will not be able to load files in this version''' (this functionality will come later). In the meantime, however, we have set up authentication, and 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 while testing 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, so that each tester can have his/her own files to alter,add to, and so forth.</li> | + | <li>'''you will not be able to load files in this version''' (this functionality will come later). In the meantime, however, we have set up authentication, and 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 while testing 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, so that 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.</li> |
| <ul><li>The username for CWRC-Writer is cwrc</li> | | <ul><li>The username for CWRC-Writer is cwrc</li> |
| <li>The password is cwrcy</li></ul> | | <li>The password is cwrcy</li></ul> |
Line 69: |
Line 69: |
| </ol> | | </ol> |
| | | |
- | The first testing version (0.14) was mostly to test its look and layout, and we've added more functionalities to version 0.17, but you still cannot yet do everything in it that you will be able to do in other versions of CWRC-Writer. If there's something that you hope you'll see in later iterations, though, please let me know! I'm also adding to the documentation available at | + | The first testing version (0.14) was mostly to test its look and layout, and we've added more functionalities to version 0.17, but you still cannot yet do everything in it that you will be able to do in other versions of CWRC-Writer. If there's something that you hope you'll see in later iterations, though, please let me know! I'm also adding to the documentation available for version 0.17 at http://cwrc.cs.ualberta.ca/index.php/CWRC:XML_Editing_Tool |
- | | + | |
- | | + | |
- | == Changes to Version 0.14 for Next Iterations==
| + | |
- | | + | |
- | '''(from email July 27th, 2011)-- expanded instructions'''
| + | |
- | | + | |
- | | + | |
- | 4. Similar to the option in #3 to remove tags by right-clicking, people should be able to right click on any tagged text to delete formatting.
| + | |
- |
| + | |
- | 6. At any point, people should be able to hit return rather than clicking "ok" (i.e. not just when they are in a certain field)
| + | |
- |
| + | |
- | 7. If it will take a lot of time to allow people to view source and edit the xml directly, don't worry about that for this iteration. We discussed the possibility of allowing some people to try this, I think, but all of our current testers are fairly comfortable with xml and they should be okay with being able to access and edit the xml.
| + | |
- |
| + | |
- | 8. Diagram attached to show what the date popup would look like. People should be able to tag an entity as either a date or a date range using radio buttons.
| + | |
- |
| + | |
- | All tags should also have default values wherever possible (lang = Engl; title = monographic).
| + | |
- | | + | |
- | | + | |
- | '''(from email August 30th, 2011)-- bugs and changes'''
| + | |
- | | + | |
- | Hi James, Geoffrey, and Susan,
| + | |
- |
| + | |
- | The following is what I have noted from our Skype call today.
| + | |
- |
| + | |
- | Before the next iteration, James will fix the "ok" button issue (mentioned below) and any quick fixes by Friday, Sept. 2nd. I've attached a few screenshots, but if you'd like more, please let me know.
| + | |
- |
| + | |
- | Bugs/fixes:
| + | |
- |
| + | |
- | - add an "ok" button that people can click on after selecting to tag text/title, tag paragraph, tag quotation, and so forth, in addition to being able to hit return. Right now there is only a "cancel" button, and even though you can hit return to add the tag, it might be confusing for people not to have the "ok" button as well. Also, when I select any option other than monographic when tagging text/title, I cannot add the tag, even after I hit return (and I also had problems adding other tags by just hitting return, such as quotations, and people also may not realise that they have to hit return) [see "ok_button" screenshot]
| + | |
- |
| + | |
- | - if you select the last word at the end of a line of text that has no punctuation at the end of it, double click that word, and then click the icon at the top of the page to tag it as a citation or note, you get an error message that indicates that you are trying to add invalid markup (saying that the beginning and end have to have a common parent, and so forth). [see "common_parent_error" screenshot]
| + | |
- |
| + | |
- | - pasting a text from html keeps the html formatting, not just within the view source, but also within the text displayed on the screen (i.e. it will include bullet points). [this was deemed not to be something that needed to be changed immediately, but as something that might come back and get us down the road when applying a schema to pasted text]
| + | |
- |
| + | |
- | Changes:
| + | |
- | | + | |
- | (for this iteration, do whatever is quick: this list begins with the changes that could be for this iteration and then ends with ones that we discussed for future iterations, with some flexibility on what would be done for this iteration and the next):
| + | |
- |
| + | |
- | - the structural tags drop-down along the top menu should say "tag structure" beside the < > icon. There should also be a little arrow to indicate that it is a drop-down list. [see attached PDF "CWRC-Writer0.14_changes_sketch2"]
| + | |
- |
| + | |
- | - users should be able to right click on tagged text and, in addition to being able to add or remove tags, they should be able to also click on "edit tag" (e.g. to change the language of a quotation tag). Users should be able to do this either by right clicking or by selecting entities through the entity tab on the left side of the screen.
| + | |
- |
| + | |
- | - in the structure tab, users should be able to right click to remove paragraph tags (as with the "emphasized", "quotation", or "heading" tags), but doing so would only remove the paragraph formatting and not remove the text of the paragraph (we were going to let users be able to select a tag in the structure tab and then the "delete" key to remove that tag, but then this was deemed to be too confusing since it might make users think they are deleting the text of that tag)
| + | |
- |
| + | |
- | - eventually we'll also figure out how to deal with adding citations-- at this point, tagging for citation doesn't require any format and just adds a note. In the meantime, however, if tagging as a citation, the entity in the left-hand entity tab should say "citation" rather than "note", because this might be confusing to users (since "note" is another entity). [see attached screenshot called "citation"]
| + | |
- |
| + | |
- | - would it be possible to add icons to entities listed in the entity tab on the left side, or add under each entity icon the colour that is used for each type of tag (e.g. orange for dates), so that there is a clearer connection between the colours and icons for the different entities? This could be done perhaps by just adding a two pixel colour bar underneath each of the entity icons along the top of the screen.
| + | |
- |
| + | |
- | - users have the option to select the "unformatted" box when tagging text/title: this option should also be available for other tags such as "quotation". In other words, should we give the option to turn autoformatting off, and could people apply their own formatting? e.g. what if I cut and paste in text that already has quotation marks around quotations?
| + | |
- |
| + | |
- | - create a "new" button (with "new document" alt text) that would create a blank or fresh document. The editor should first prompt the user to ask whether s/he wants to save the existing document.
| + | |
- |
| + | |
- | - the "load", "save", and "save as" buttons should be moved to the left along the top row, before the structural tags drop-down and the entity icons. Perhaps it would also be possible to extend the top tab to put the "new", "load", "save", and "save as" buttons above the entities tab and structure tab in the top left-hand side of the screen.
| + | |
- |
| + | |
- | - there should be an overall setting to set defaults, either specific to each project once we have the ability to have each user authenticate, or by having the editor only ask once for paragraph language, and if the user selects "English", then it will not keep asking this every time the user tags a paragraph. If the user wants to change the language from the default, s/he can click on "edit tag" to do so. This could be kept track of in each session.
| + | |
- |
| + | |
- | - eventually to be able to type "q" and get to the "quotation" tag in the structural tags drop-down, and to do the same for other lists. This will be important when we get to real schema and bigger projects that might have long lists.
| + | |
- |
| + | |
- | - eventually we'll have upload/download like Google Docs or an export feature; at the moment, people can save files to a directory on the web server Kamal set up for the project. SH will tell people not to play with each other's files for the time being (or perhaps to personalize them somehow-- i.e. with their initials in the file name). Eventually we'll have separate user logins/accounts in which files would be saved.
| + | |
- |
| + | |
- | - we'll also eventually have to think of how to "chunk" texts-- i.e. how to work with bits of documents. Also, is the editor's speed with larger texts something we'll have to consider? Can people work with novels in the editor?
| + | |
- |
| + | |
- | Brainstorming about next steps:
| + | |
- |
| + | |
- | - next iteration should produce something usable by CWRC participants
| + | |
- | - validation and handling of much more complex structural markup
| + | |
- | - entity management, help text, eventually French
| + | |
- | - getting entity indexes, export, and so forth would require backend work
| + | |
- | - RDF: it shouldn't be a huge amount of work to convert to OAC/RDF. What do we intend to do with RDF?
| + | |
- | - next contract to have server-side API stuff? (to see the files they have online?). Can't do server-side stuff yet? Do a server-side project that can dovetail with this?
| + | |
- |
| + | |
- | GR and SB to work with JC on parameters of new contract. After end of Skype call, GR and SB to discuss what the next milestones would be.
| + | |
- |
| + | |
- | Other meeting notes:
| + | |
- |
| + | |
- | SH to look up TEI rules on whether heading tag has to be in a paragraph or if it can be in a block on its own.
| + | |
- |
| + | |
- | SH will make sure emails outlining changes from past versions are up on the wiki (e.g. the email about changes for v 0.17)
| + | |
- |
| + | |
- | SH to send out heads up email to editor testers on Aug. 30th [didn't have time today so will do tonight or tomorrow] and will send next iteration email on Sept. 6th
| + | |
- | - will let people know that the names in "Tag Person" are only A-H (e.g. won't get Woolf). SH will explain that the names are from CanWWR, CEWW, & Orlando and are still just for demonstration purposes. Individual projects may have their own authority lists for names and so forth.
| + | |
- | - will tell everyone that we really appreciate their feedback but that we haven't had a chance to implement everything
| + | |
- |
| + | |
- | SH to add to editor documentation on wiki before next iteration; wiki documentation should be kept up to date (i.e. 0.14 version archived and then expanded/changed to keep up to date).
| + | |
- |
| + | |
- | People at the CWRC workshops may want to be added to the testing group; for the time being, good to stick with our current group.
| + | |
- | | + | |
- | All best,
| + | |
- | | + | |
- | SH
| + | |
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. This xml editing tool is still very much in development, but as CWRC-Writer develops, we expect to be able to release an open source in-browser scholarly editing tool with the following features:
Version 0.17 is still very bare bones, but you will see that we have already made some changes based on testers' feedback on our first testing version, 0.14. Here is what you can see in Version 0.17:
The first testing version (0.14) was mostly to test its look and layout, and we've added more functionalities to version 0.17, but you still cannot yet do everything in it that you will be able to do in other versions of CWRC-Writer. If there's something that you hope you'll see in later iterations, though, please let me know! I'm also adding to the documentation available for version 0.17 at http://cwrc.cs.ualberta.ca/index.php/CWRC:XML_Editing_Tool