WordCheck PM Interface Enhancements
WordCheck PM Interface Enhancements
Status
- Current status: Prototyping & implementing
- Driving developers: cpeel
- Informed developers: jmdyck
- Informed non-developers: DESiegel60, garweyne, kraester
- Other interested parties: crb11, dkretz,
- Discussion threads: WordCheck development: PM Interface discussion
Introduction
The PM interface of WordCheck could use some improvements. After the inital version was released much discussion took place on ways to make it both more user friendly and more powerful. Several new tools are being developed to help address this. This page is designed to be a overview and status page to track the development and provide a central location for things brought up in a forum thread.
Please feel free to contribute to this document.
Feature status legend
indicates the feature has been pushed down to the production server
indicates the feature has been checked into CVS and likely available on the main test site or will be shortly
indicates the feature is coded in someone's sandbox (see list of sandboxes below)
indicates that some developer has vouched for the feature and is willing to code it or is in the process of doing so
Distilled features
These are some features/changes that were distilled from the discussion forum (with an attempt to attribute the thought to the poster with a link to the post where applicable). Feel free to add to these lists but don't modify the status unless you're the developer.
General
forumpost:294629 dkretz: Manage the word lists outside of the Edit Project page - see also forumpost:299391 (cpeel: split the Edit Word Lists to their own page)
forumpost:294791 garweyne: The 'click-through' page for downloading a suggestion list is worthless, get rid of it (cpeel: made the download link download the file directly)
forumpost:295341 garweyne: Create a page for suggesting bad words (stealth scannos) by comparing the text between rounds, finding words that were changed in a previous round that aspell wouldn't catch
forumpost:299822 garweyne: Create a way to see how many flagged words WordCheck will find per page, useful for seeing how 'flag-heavy' pages are to prevent flag overload
forumpost:299822 DESiegel: Have a graph showing how many flagged words there are per-page
forumpost:313135 cpeel: Have the 'Quit without Saving' button return to the page you entered from instead of always returning you to the Project Search page
forumpost:297507 cpeel & forumpost:297524 crb11: If words are added to a word list from outside the Edit Word Lists page, and the list is changed in the Edit Word List page, alert the user to prevent data from being lost.
forumpost:313026 kraester: Add projectID and PP name to the Edit Project Word List page as well as link back to the Edit Project page.
forumpost:289905 kraester: Remove the good_word_suggestions.txt file from the Word Lists box to help avoid confusion about what this is.
forumpost:334913 dkretz: Make the 'suggestions have been made' notification icon a link to the Suggestions from Proofer page.
garweyne: Use good_word_suggestions.txt to track all WordCheck usage instead of just usage that generates suggestions (cpeel: implemented by moving to a database instead of a flat-file -- also tracks word corrections done in WordCheck).
- forumpost:316496 kraester: Enhance the Edit Project Word List page to help prevent data loss [developer notes: suggest adding a JS confirmation pop-up upon exit if one of the textareas has been changed -- should probably also be done on Edit Project Info so the pages behave the same]
Suggestion pages
forumpost:294462 crb11: Allow the words to be selected from the suggesion pages by some other means than copy/paste (cpeel: implemented as checkboxes although copy/paste will still function)
forumpost:297341 crb11: Suggestion from Proofer page: Be able to see which proofer suggested a word and on what page
forumpost:297505 garweyne: Be able to see the word in context (ie: with the image and some reference text)
forumpost:294819 crb11: Suggestion from Proofer page: Manage the Suggestions from Proofers without having to access every project page, edit the project, run the Suggestions from Proofer page, and (optionally) edit the Good Words list
Suggestion from Proofer page: Allow editing of the good_word_suggestions.txt file so that if a PM elects not to add a word to the Good or Bad Word lists it doesn't have to be looked at again (cpeel: implemented by flagging on timestamps rather than editing the source file)
forumpost:298595 garweyne: Suggestion from Proofer page: Don't list suggestions that are already on the project's Bad or Good words list
forumpost:304640 DESiegel: Suggestion from WordCheck page: Show if the word is being flagged because it is on the Site or Project Bad Word List
forumpost:328668 garweyne: Be able to look up the frequency and context information for words other than those provided in the suggestion pages.
forumpost:344613 garweyne: Suggestions from diff analysis: Create a better ranking for the scannos to give the PM better information on which ones are worth including as Bad Words.
(various posts) Reduce the verbosity of the Suggestion tools. forumpost:345817 kraester: Move the tool details to the WordCheck FAQ and link to that tool's description in the FAQ from the tool.
- forumpost:290492 garweyne: Show number of words that are contained in each cutoff
- forumpost:314856 De2164: Provide a way for PMs to suggest words to the Site Good and Bad Word Lists.
- forumpost:315995 kraester: allow for full alpha sorting at a give cutoff, for instance - if the user is at cutoff level 5, only display items with a frequency of 5 or more but sort the entire list by word alphabetically [developer notes: probably needs to be done server-side by caching the results and just doing the sorting/cutoff stuff; will necessitate some 'reload' button to refresh the cache upon demand].
- forumpost:321087 kraester, forumpost:328368 lvl & forumpost:347615 crb11: Suggestion pages (including Manage All Proofer Suggestions) should remember the selected cutoff values after adding words to a Word List.
- forumpost:328523 garweyne: Change the order of the columns on the Manage All Proofer Suggestions page to prevent really long words from hiding context links for shorter words in the same table.
- forumpost:337228 kraester: Allow preference or some other 'sticky' setting that causes the Suggestion from Proofers page to pull all suggestions by default, not just those since the last saving of the GWL.
- forumpost:335876 garweyne: Provide a link to the Project and/or Word Lists from the Suggestion from Proofers page and Manage All Proofer Suggestions page since those can be accessed outside of the Word Lists page.
- forumpost:342473 punicafides: Suggestion from Proofer page: Provide some way (another checkbox?) to allow words to be added to the Bad Words List in addition to the Good Words List.
- forumpost:344504 big_bill: Suggestion from diff analysis page: Add an 'Most often changed to' column since words can be changed to more than one value.
(via pgdptest) grythumn: Usage: table background colors are hard to distinguish apart, need to make them more obvious.
(via pgdptest) grythumn: Usage: don't flag pages that are from before WC rollout.
(via pgdptest) McKeown: Context pages: switching from the Proofer Suggestion Details page when in vertical view to the Full Context pages changes you back to a horizontal view.
Context pages
forumpost:312707 garweyne: Retain image size across image views (cpeel: displayimage.php now retains last image size for a session)
- forumpost:313597 garweyne: Allow words to be added to the word list directly from the context page
- forumpost:312707 garweyne: Have the frames retain their places after they are moved instead of resetting for each new context opened
Testing sandboxes
Development is currently taking place in the following user's sandboxes: cpeel's sandbox