readerannotation: add comments to the annotation structure

frontend/apps/reader/modules/readerannotation.lua

@@ -12,6 +12,7 @@ function ReaderAnnotation:buildAnnotation(bm, highlights, update_pageno)
         hl = {}
         if bm.highlighted then -- orphaned bookmark
             hl.drawer = self.view.highlight.saved_drawer
+            hl.color = self.view.highlight.saved_color
             if self.ui.paging then
                 if bm.pos0.page == bm.pos1.page then
                     hl.pboxes = self.document:getPageBoxesFromPositions(bm.page, bm.pos0, bm.pos1)
@@ -22,19 +23,20 @@ function ReaderAnnotation:buildAnnotation(bm, highlights, update_pageno)
         end
     end
 
-    return { -- annotation structure
+    return { -- annotation
-        datetime    = bm.datetime,
+        datetime    = bm.datetime, -- creation time, not changeable
-        drawer      = hl.drawer,
+        drawer      = hl.drawer,   -- highlight drawer
-        text        = bm.notes,
+        color       = hl.color,    -- highlight color
-        text_edited = hl.edited,
+        text        = bm.notes,    -- highlighted text, editable
-        note        = bm.text,
+        text_edited = hl.edited,   -- true if highlighted text has been edited
-        chapter     = bm.chapter,
+        note        = bm.text,     -- user's note, editable
-        page        = bm.page,
+        chapter     = bm.chapter,  -- book chapter title
-        pageno      = pageno,
+        pageno      = pageno,      -- book page number
-        pos0        = bm.pos0,
+        page        = bm.page,     -- highlight location, xPointer or number (pdf)
-        pos1        = bm.pos1,
+        pos0        = bm.pos0,     -- highlight start position, xPointer or table (pdf)
-        pboxes      = hl.pboxes,
+        pos1        = bm.pos1,     -- highlight end position, xPointer or table (pdf)
-        ext         = hl.ext,
+        pboxes      = hl.pboxes,   -- pdf pboxes, used only and changeable by addMarkupAnnotation
+        ext         = hl.ext,      -- pdf multi-page highlight
     }
 end
 
@@ -55,6 +57,7 @@ function ReaderAnnotation.buildHighlight(an)
     return {
         datetime    = an.datetime,
         drawer      = an.drawer,
+        color       = an.color,
         text        = an.text,
         edited      = an.text_edited,
         chapter     = an.chapter,