Merge branch 'dd_msg_reader_speed_improvements_and_newscan_and_indexed_mode_updates' into 'master'

DDMsgReader: Speed improvements and updates for newscans, and updates for the indexed newscan menu mode.

See merge request !363

xtrn/DDMsgReader/DDMsgReader.cfg

@@ -52,10 +52,6 @@ convertYStyleMCIAttrsToSync=true
 ; Whether or not to prepend the subject for forwarded messages with "Fwd: "
 prependFowardMsgSubject=true
 
-; For indexed reader mode, whether or not to enable caching the message
-; header lists for performance
-enableIndexedModeMsgListCache=true
-
 ; An index of a quick-validation set from SCFG > System > Security Options > Quick-Validation Values
 ; to be used by the sysop to quick-validate a local user who has posted a message while reading the
 ; message.  This index is 0-based, as they appear in SCFG. Normally there are 10 quick-validation
@@ -74,5 +70,18 @@ saveAllHdrsWhenSavingMsgToBBSPC=false
 ; user setting; users can toggle this for themselves as they like.
 useIndexedModeForNewscan=false
 
+; For indexed reader mode, whether or not to enable caching the message
+; header lists for performance
+enableIndexedModeMsgListCache=true
+
+; Default for a user setting: During a newscan, whether or not to only show new
+; messages. Users can then toggle this as they like.
+newscanOnlyShowNewMsgs=true
+
+; Default for a user setting: For the indexed newscan sub-board list, whether or not
+; to "snap" the lightbar selected item to the next sub-board with new messages upon
+; displaying or returning to the indexed newscan menu
+indexedModeMenuSnapToFirstWithNew=false
+
 ; The theme file name (for colors, strings, etc.)
 themeFilename=DefaultTheme.cfg

xtrn/DDMsgReader/ddmr_cfg.js

@@ -57,15 +57,15 @@ while (continueOn)
 			if (userChoice)
 			{
 				var saveRetObj = saveDDMsgReaderCfgFile();
-				if (saveRetObj.saveSucceeded)
+				// Show an error if failed to save the settings.  If succeeded, only show
+				// a message if settings were saved to the mods directory.
+				if (!saveRetObj.saveSucceeded)
+					uifc.msg("Failed to save settings!");
+				else
 				{
-					var msg = "Changes were successfully saved"; 
 					if (saveRetObj.savedToModsDir)
-						msg += " (saved to the mods dir)";
-					uifc.msg(msg);
+						uifc.msg("Changes were successfully saved (to the mods dir)");
 				}
-				else
-					uifc.msg("Failed to save settings!");
 			}
 			continueOn = false;
 		}
@@ -111,6 +111,8 @@ function doMainMenu()
 		"quickUserValSetIndex", // Number (can be -1)
 		"saveAllHdrsWhenSavingMsgToBBSPC", // Boolean
 		"useIndexedModeForNewscan", // Boolean
+		"indexedModeMenuSnapToFirstWithNew", // Boolean
+		"newscanOnlyShowNewMsgs", // Boolean
 		"themeFilename" // String
 	];
 	// Strings for the options to display on the menu
@@ -139,6 +141,8 @@ function doMainMenu()
 		"Quick User Val Set Index",
 		"Save All Headers When Saving Message To BBS PC",
 		"Use Indexed Mode For Newscan",
+		"Index menu: Snap to sub-boards w/ new messages",
+		"During a newscan, only show new messages",
 		"Theme Filename"
 	];
 	// Build an array of formatted string to be displayed on the menu
@@ -533,6 +537,16 @@ function getOptionHelpText()
 	optionHelpText["useIndexedModeForNewscan"] += "a menu showing each sub-board and the number of new messages and total messages in each. When disabled, ";
 	optionHelpText["useIndexedModeForNewscan"] += "the reader will do a traditional newscan where it will scan through the sub-boards and go into reader ";
 	optionHelpText["useIndexedModeForNewscan"] += "mode when there are new messages in a sub-board.";
+	
+	optionHelpText["indexedModeMenuSnapToFirstWithNew"] = "Index menu: Snap to sub-boards w/ new messages: For the indexed newscan sub-board ";
+	optionHelpText["indexedModeMenuSnapToFirstWithNew"] += "menu in lightbar mode, whether or not to 'snap' the selected item to the next ";
+	optionHelpText["indexedModeMenuSnapToFirstWithNew"] += "sub-board with new messages upon displaying or returning to the indexed newscan ";
+	optionHelpText["indexedModeMenuSnapToFirstWithNew"] += "sub-board menu. This is a default for a user setting that users can toggle ";
+	optionHelpText["indexedModeMenuSnapToFirstWithNew"] += "for themselves".
+	
+	optionHelpText["newscanOnlyShowNewMsgs"] = "During a newscan, only show new messages (default for a user setting): Whether or not ";
+	optionHelpText["newscanOnlyShowNewMsgs"] += "to only show new messages when the user is doing a newscan. Users can toggle this as ";
+	optionHelpText["newscanOnlyShowNewMsgs"] += "they like.";
 
 	optionHelpText["themeFilename"] = "Theme filename: The name of a file for a color theme to use";
 
@@ -556,7 +570,8 @@ function getMainHelp(pOptionHelpText, pCfgOptProps)
 	for (var i = 0; i < pCfgOptProps.length; ++i)
 	{
 		var optName = pCfgOptProps[i];
-		helpText += pOptionHelpText[optName] + "\r\n\r\n";
+		//helpText += pOptionHelpText[optName] + "\r\n\r\n";
+		helpText += pOptionHelpText[optName] + "\r\n";
 	}
 	return word_wrap(helpText, gHelpWrapWidth);
 }

xtrn/DDMsgReader/revision_history.txt

@@ -5,6 +5,26 @@ Revision History (change log)
 =============================
 Version  Date         Description
 -------  ----         -----------
+1.87     2023-11-18   Possible speed improvement when loading messages.
+                      New: User setting to only show new messages in a newscan
+                      (defaults to true/enabled)
+                      In the message list, there is now an additional space
+                      before the 'from' name, in case one of the status
+                      characters is a letter (this should look better).
+                      New: In lightbar mode, the indexed newscan menu can
+                      optionally 'snap' to the next sub-board with new messages
+                      when showing/returning to the menu
+                      Fix: When listing personal email, messages to the user
+                      were written with the to-user color wuen unread. Now the
+                      regular colors are always used (since all of a user's
+                      personal emails are 'to' them).
+                      Fix: For indexed newscan, if there are no sub-boards
+                      selected for scan in the user's newscan configuration,
+                      then output a message and exit. Otherwise, it would end
+                      up in an infinite loop.
+                      Updated how user settings are loaded, to ensure that
+                      default user settings from DDMsgReader.cfg actually get
+                      set properly in the user settings.
 1.86     2023-11-09   New feature: For indexed mode, when choosing a sub-board,
                       the R key can be used to mark all messages as read in the
                       sub-board.