Changeset 33313 for main/trunk/greenstone2/perllib/doc.pm

Timestamp:

2019-07-08T18:48:32+12:00 (5 years ago)

Author:

ak19

Message:

Minor. Changes to comment

File:

• main/trunk/greenstone2/perllib/doc.pm (modified) (2 diffs)

main/trunk/greenstone2/perllib/doc.pm

@@ -1166 +1166 @@
     elsif($field eq "GPS.mapOverlay") { # then the $value is a JSON string
 
-        # In order to allow searching map data enriched documents by map shape descriptions,
+        # In order to allow searching map-data-enriched documents by map shape descriptions,
         # and to run rawquery searches for other docs by proximity based on their map data,
         # need to store the shape descriptions and Coordinate info for shapes into the text index.
@@ -1172 +1172 @@
         # And we add Coordinate (CD) and CoordShort (CS) info for each shape in the mapoverlay in the format (Lat, Lng) as ("37S339 175E342")
         # where the digits before the N/S/E/W direction represents the whole number. And the digits after the direction are the
-        # decimal places which can range from 0 and 2-4 digits.
+        # decimal places which can vary between 0 and 2 to 4 digits.
         
-        # However, we only want to process GPS.mapOverlay only during buildcol and only in the text indexing passes (e.g. sidx and didx for lucene)
-        # and certainly never during the infodb pass of buildcol. The latter can end up duplicating Coordinate/CoordShort/GPSMapOverlayLabel for
-        # when rebuilding with the online doc editor as that runs incremental-rebuild which then calls basebuilder::reconstruct_doc_objs_metadata()
+        # However, we only want to process GPS.mapOverlay during buildcol and only in the text indexing passes (e.g. sidx and didx for lucene)
+        # and certainly never during the infodb pass of buildcol. The latter can end up duplicating Coordinate/CoordShort/GPSMapOverlayLabel
+        # when rebuilding with the online doc editor, as that runs incremental-rebuild which then calls basebuilder::reconstruct_doc_objs_metadata()
         # on all docs NOT being incrementally rebuilt. That call would get meta from the infodb and use it to reconstruct the doc objects of docs
-        # NOT being incrementally built. If the Coord and Label meta were written to the infodb, they would then be loaded back in when the collection
-        # is incrementally rebuilt for those docs that don't need incremental processing. Then this function would once again add the same meta into
-        # the infodb, thus duplicating what goes into the infodb. Hence, don't do all the following if doc::processor_mode eq "infodb".
+        # NOT being incrementally built. If the Coord and Label meta were written to the infodb, they would then be loaded back in memory when the
+        # collection is incrementally rebuilt for those docs that don't need incremental processing. Then this function would once again add the
+        # same meta into the infodb, thus duplicating what goes into the infodb. Hence, don't do all the following if doc::processor_mode =~ "infodb",
+        # or anything other than a text mode.
 
         # Note that for incremental rebuilding, the text pass can be called textreindex for instance (and infodb pass can be incinfodb).