Diff for /annozilla/www/ToDo.html between versions 1.15 and 1.21

version 1.15, 2008/07/12 13:57:53 version 1.21, 2008/10/23 17:18:52
Line 1 Line 1
 <h1>Annozilla 'to do' list</h1>  <h1>Annozilla 'to do' list</h1>
<h2>Short term</h2><h2>Preferences</h2>
 <ul>  <ul>
<li>Don't write to window.status?<li>Preference wizard for easy first-time setup. (Now pretty much working I think, except, if Annozilla sidebar is open, the server settings don't seem to be used until after a restart - seems a bit of an edge case). Update: don't auto-open window, as it's an annoyance after installing multiple extensions. See <a href="http://blog.fligtar.com/2008/10/16/responsible-first-run-usage/">http://blog.fligtar.com/2008/10/16/responsible-first-run-usage/</a>.
<li>Preference wizard for easy first-time setup. (Now pretty much working I think, except, if Annozilla sidebar is open, the server settings don't seem to be used until after a restart - seems a bit of an edge case). 
<li>iconClick-&gt;openEditorWindow-&gt;doesn't get fragment to add temporary icon 
Error: [Exception... "'openEditorWindow requires either a fragment or an existing annotation' when calling method: [nsIDOMEventListener::handleEvent]"  nsresult: "0x8057001e (NS_ERROR_XPC_JS_THREW_STRING)"  location: "&lt;unknown&gt;  data: no]. 
(Does it need it? The condition in the code doesn't seem to match the error message.) 
Updated code, some errors now reported to console. 
<li>IconManager trouble getting body from server? 
due to asynchronous body load: see loadBodyOnSuccess  
<li>Don't want to load annotation bodies during annotation loading 
(in general case - OK for local server) 
 <li>Remove server as default post server if that server is deleted from the list  <li>Remove server as default post server if that server is deleted from the list
 <li>"Basic" server prefs - is there any way we can set the data up only on "OK"?  <li>"Basic" server prefs - is there any way we can set the data up only on "OK"?
<li><strike>Annotation passed to postAnnotationOnSuccess from remote server<li>In the Server Options panel, display "Local Server" not "urn:localserver"
  doesn't have proper annotation type; need to reload to get it</ul>
  and sometimes author is something like "rdf#mjAmH".
  (We send RDF to the server and get back an annotation to indicate success;<h2>Loading</h2>
  however the annotation data is incomplete and so we try to supplement it<ul>
  with the data we originally passed. The test on 'creator' goes wrong,<li>Get the 'finished' notification too soon (after receiving all responses but before
  because we pass it as a literal and get it back as a resource.resolving the individual annotations).
  We fail to overwrite the more "specific" type of "Comment" because the<li>I think the 'Stop Loading' menu item is removed slightly too late
  "Annotation" type is already present.)</strike> Mostly fixed, but can</ul>
  still be a problem with loading a newly-created annotation in a pop-up window.
<li>After creating a reply - or presumably after all other post/updates -<h2>UI</h2>
all open windows get their status updated to say "SUCCESS". Partial fix.<ul>
<li>nsIAnnotationMetadata doesn't deal with multiple values, eg multiple types<li>Don't write to window.status?
 <li>Make replies visible in annotation window (for users not using the sidebar)
 <li><strike>Use XBL language binding everywhere</strike> Now expecting to
 remove the language options from the UI
 <li>Use nsIPromptService, not window.alert (looks more professional)
 <li>Accessibility
 <li>Add top-level menu. (Menu is present; only "load annotations is present", "stop loading" and "options" are present)
 <li>User isn't informed of errors from servers (eg 'check replies'). (This might
 be hard to implement if there are multiple servers.)
 </ul>
 
 <h2>Errors</h2>
 <ul>
 <li>Annozilla fails with "error loading annotations" during loading of   <li>Annozilla fails with "error loading annotations" during loading of 
 annotations if there is an annotation that has no context property.   annotations if there is an annotation that has no context property. 
 (This property is not a requirement for annotations, I think.)  (This property is not a requirement for annotations, I think.)
<li>Also, it would be better if annozilla tried to continue the loading of <li>iconClick-&gt;openEditorWindow-&gt;doesn't get fragment to add temporary icon
annotations if one annotation is "malformed".Error: [Exception... "'openEditorWindow requires either a fragment or an existing annotation' when calling method: [nsIDOMEventListener::handleEvent]"  nsresult: "0x8057001e (NS_ERROR_XPC_JS_THREW_STRING)"  location: "&lt;unknown&gt;  data: no].
 (Does it need it? The condition in the code doesn't seem to match the error message.)
 Updated code, some errors now reported to console.
 <li>When creating an annotation, an icon is supposed to be inserted into the  <li>When creating an annotation, an icon is supposed to be inserted into the
 document, but this fails.  document, but this fails.
 <li>Invoke "load annotation" twice - get annotations appearing twice in sidebar  <li>Invoke "load annotation" twice - get annotations appearing twice in sidebar
 <li><strike>"When listing the replies in the sidebar, the annotated region is determined  
 based on the wrong document (the main browser page instead of the annotation).</strike>   
 Update: you basically can't tell this now that we show the annotation title instead  
 <li>Since setting up my own server I get an authentication prompt from Firefox - why?  
 Should Annozilla just use FF authentication anyway?  
 <li>No reason for there to be (internally) two buttons for Save on the editor window.  
 </ul>  </ul>
   
<h2>Medium term</h2><h2>Others</h2>
 <ul>  <ul>
<li>Frameset support? Probably not.<li>Implement Reply/Check for Replies for LocalServer. (Harder than it looks!)
<li>Convert "annotationLookups" into some kind of RDF thing which users could<li>No reason for there to be (internally) two buttons for Save on the editor window.
install more types to. Maybe the icon lookup too? Update: started work, adding 
annotationTypes.rdf and hooking this up to editor.xul. 
<li><strike>Implement Reply/Check for Replies.</strike> 
<li>Make all sidebar options available via menu (not just context menu) 
<li>In the Server Options panel, display "Local Server" not "urn:localserver" 
(if possible) 
<li>Rework classes using model/view/controller terminology. (Underway as part of the 
tabbed browsing support.) 
<li><strike>On sidebar load with no servers, make it easier to load the Server options 
panel</strike> There's an "Options" menu item now. 
<li>Move multiple server support into an 'Advanced' panel. Underway. 
<li><strike>Use XBL language binding everywhere</strike> Now expecting to 
remove the language options from the UI 
</ul> 
 
<h2>Long term</h2> 
<ul> 
<li><strike>XBL for annotation icons and/or highlights</strike> Doesn't seem to be possible because we can't bind to arbitrary text nodes 
<li>The 'fastback' feature would presumably leave annotation icons/highlights in the document but not held by Annozilla. Could the annotation data be held in the document, with DOM UserData? (speculation, I don't know whether this is possible.) 
 <li>Test cases  <li>Test cases
 <li>Unit tests  <li>Unit tests
 </ul>  </ul>
Line 119  the document has finished loading. Prett Line 99  the document has finished loading. Prett
 new annotation, then "Save" should effectively be an update, not a new Post</strike>  new annotation, then "Save" should effectively be an update, not a new Post</strike>
 <li><strike>After saving an annotation, "delete" should be available. (But after "delete",  <li><strike>After saving an annotation, "delete" should be available. (But after "delete",
 you shouldn't be able to save).</strike>  you shouldn't be able to save).</strike>
   <li><strike>nsIAnnotationMetadata doesn't deal with multiple values, eg multiple types</strike> Fixed for types only.
   <li><strike>"When listing the replies in the sidebar, the annotated region is determined
   based on the wrong document (the main browser page instead of the annotation).</strike> 
   <li><strike>On sidebar load with no servers, make it easier to load the Server options
   panel</strike> There's an "Options" menu item now.
   <li><strike>XBL for annotation icons and/or highlights</strike> Doesn't seem to be possible because we can't bind to arbitrary text nodes
   <li><strike>Warn if deleting an unsaved annotation</strike>
   <li><strike>Remove username/password handling from Annozilla</strike>
   <li><strike>Move multiple server support into an 'Advanced' panel.</strike>
   <li><strike>Annotation passed to postAnnotationOnSuccess from remote server
     doesn't have proper annotation type; need to reload to get it
     and sometimes author is something like "rdf#mjAmH".
     (We send RDF to the server and get back an annotation to indicate success;
     however the annotation data is incomplete and so we try to supplement it
     with the data we originally passed. The test on 'creator' goes wrong,
     because we pass it as a literal and get it back as a resource.
     We fail to overwrite the more "specific" type of "Comment" because the
     "Annotation" type is already present.)</strike>
   <li><strike>It would be better if annozilla tried to continue the loading of 
   annotations if one annotation is "malformed".</strike>
   
   <h2>Fixed since 0.4.0.a.5/0.7.0.a.6 release</h2>
   <ul>
   <li><strike>Changing the annotation title when updating an annotation has no effect</strike>
   <li><strike>Make all sidebar options available via menu (not just context menu)</strike>
   <li><strike>Doing "CheckForReplies" seems to check for all servers - shouldn't it only check
   the server on which the reply is saved? Also, the count of servers which we're waiting to hear
   from isn't decremented if a server returns failure when getting replies.</strike>
   <li><strike>After creating a reply - or presumably after all other post/updates -
   all open windows get their status updated to say "SUCCESS".</strike>
   <li><strike>Reinstate "Stop" (and add to top-level menu)</strike>
   <li><strike>Rework classes using model/view/controller terminology. (Underway as part of the
   tabbed browsing support. All annotations are stored in a 'model' class; the sidebar
   and icon manager have been modified to act as a view.)</strike>
   <li><strike>(Editor) Don't enable Save until "type" is populated</strike> Now a very short time delay
   <li><strike>Convert "annotationLookups" into some kind of RDF thing which users could
   install more types to</strike>
   <li><strike>IconManager trouble getting body from server?
   due to asynchronous body load: see loadBodyOnSuccess </strike> Can't see problem any more
   <li><strike>Don't want to load annotation bodies during annotation loading</strike>
   Can't see problem any more
   (in general case - OK for local server)
   </ul>

Removed from v.1.15  
changed lines
  Added in v.1.21


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>