C2024-017 Removed old (not implemented) format variables and settings from the format files and removed incomplete references to them in the C# code. Also added descriptions of the used format variables in the C# code that hooks the XML format files to the PROMS C# logic.

PROMS/VEPROMS.CSLA.Library/Format/ENums.cs

@@ -127,10 +127,6 @@ namespace VEPROMS.CSLA.Library
 	[Flags]
 	public enum E_DocStructStyle : ulong
 	{
-		//USEONALLPAGES = 0,			// Default
-		//USEONFIRSTPAGE = 1,			// Use only on the first page
-		//USEONALLBUTFIRSTPAGE = 2,			// Use on all but the first page
-		//USEONLASTPAGE = 4,			// NO LOGIC exists for this selection. Use only on the last page
 		None = 0,
 		UseSectionFoldout = 8,			// Attach section foldouts (only active if using SectionLevelFoldouts_ON
 		DontCountFoldoutPgs = 16,			// Used with the USESECTIONFOLDOUT flag. Keeps foldout pages from 
@@ -138,7 +134,7 @@ namespace VEPROMS.CSLA.Library
 		TableOfContents = 32,
 		DontCountInTabOfCont = 64,
 		Placekeeper = 128,
-		Align1StLevSubWHLS = 0x00000100,	// guess?
+		Align1StLevSubWHLS = 0x00000100,	// the first level sub-step will start at the same column as the high level step
 		DoubleBoxHLS = 0x00000200,
 		UseAltCntrline = 0x00000400,
 		DontNumberInTOC = 0x00000800,	// Don't include page number for this section in the Table of Contents

PROMS/VEPROMS.CSLA.Library/Format/PageStyles.cs

@@ -21,6 +21,7 @@ namespace VEPROMS.CSLA.Library
 		public PageStyle() : base() { }
 		#endregion
 		#region Business Methods
+		// description to associate with a DocStyle
 		private LazyLoad<string> _Name;
 		[DisplayName("Name")]
 		[Description("Page Style Name")]
@@ -31,6 +32,8 @@ namespace VEPROMS.CSLA.Library
 				return LazyLoad(ref _Name, "@Name");
 			}
 		}
+
+		// a unuque number that is referenced from the DocStyles
 		private LazyLoad<int?> _Index;
 		[DisplayName("Index")]
 		[Description("Page Style Index")]
@@ -41,6 +44,7 @@ namespace VEPROMS.CSLA.Library
 				return LazyLoad(ref _Index, "@Index");
 			}
 		}
+
 		private PageItems _PageItems;
 		public PageItems PageItems
 		{
@@ -66,6 +70,7 @@ namespace VEPROMS.CSLA.Library
 	}
 	#endregion
 	#region PageItem
+	// this links up the <Item> group in <PageStyle>
 	public class PageItem : vlnFormatItem
 	{
 		#region Constructor
@@ -92,6 +97,8 @@ namespace VEPROMS.CSLA.Library
 				return (_RelatedItem == null) ? _RelatedItem = new RelatedItem(SelectSingleNode("RelatedItem")) : _RelatedItem;
 			}
 		}
+
+		// this can be an actual token, in curly braces, that dynamically gets replaced with information, or just plain text
 		private LazyLoad<string> _Token;
 		[Category("Content")]
 		[DisplayName("Content")]
@@ -103,6 +110,8 @@ namespace VEPROMS.CSLA.Library
 				return LazyLoad(ref _Token, "@Token");
 			}
 		}
+
+		// the row on the page to place the Item
 		private LazyLoad<float?> _Row;
 		[Category("Location")]
 		[DisplayName("Vertical Position")]
@@ -114,6 +123,8 @@ namespace VEPROMS.CSLA.Library
 				return LazyLoad(ref _Row, "@Row");
 			}
 		}
+
+		// the column on the page to place the Item
 		private LazyLoad<float?> _Col;
 		[Category("Location")]
 		[DisplayName("Horizontal Position")]
@@ -125,6 +136,8 @@ namespace VEPROMS.CSLA.Library
 				return LazyLoad(ref _Col, "@Col");
 			}
 		}
+
+		// the justification at the Col position in which to print the Token information
 		private LazyLoad<E_Justify?> _Justify;
 		public E_Justify? Justify
 		{ 
@@ -133,6 +146,8 @@ namespace VEPROMS.CSLA.Library
 				return LazyLoad<E_Justify>(ref _Justify, "@Justify");
 			} 
 		}
+
+		//run the PROMS Replace Words logic on the resulting text of Token
 		private LazyLoad<bool> _RepWords;       // F2021-053: Do replace words in page list
 		public bool RepWords
 		{
@@ -141,6 +156,8 @@ namespace VEPROMS.CSLA.Library
 				return LazyLoad(ref _RepWords, "@RepWords");
 			}
 		}
+
+		//Flag to tell PROMS to get the alarm value information based on the specified Child applicability
 		private LazyLoad<bool> _ROLkUpMatch;       // C2021-065 (BNPP Alarms format)
 		public bool ROLkUpMatch
 		{
@@ -149,6 +166,10 @@ namespace VEPROMS.CSLA.Library
 				return LazyLoad(ref _ROLkUpMatch, "@ROLkUpMatch");
 			}
 		}
+
+		// Flag to specify if that PageStyle Item should be used in creating alarm point information
+		// for viewing in the PROMS step editor
+		// this information is displayed in a Note that it build on the fly when first opening an Alarm Point page
 		private LazyLoad<bool> _ROLkUpInEditor;       // C2021-018 (BNPP Alarms format)
 		public bool ROLkUpInEditor
 		{
@@ -157,6 +178,9 @@ namespace VEPROMS.CSLA.Library
 				return LazyLoad(ref _ROLkUpInEditor, "@ROLkUpInEditor");
 			}
 		}
+
+		// defines a maxium width before the resolved PSI token (procedure specific information) text is wrapped
+		// on to the next line
 		private LazyLoad<int?> _MaxWidth;
 		public int? MaxWidth
 		{
@@ -165,6 +189,7 @@ namespace VEPROMS.CSLA.Library
 				return (LazyLoad(ref _MaxWidth, "@MaxWidth"));
 			}
 		}
+
 		// MaxWidth, above, flagged that, if there was more than 1 line, the topmargin would be adjusted by however
 		// many lines the PSI item contained (for wst alarms).   The MaxWidthCurPage is used when that adjustment
 		// should not be made, the length of the PSI item is only relevant for the current page.  
@@ -177,6 +202,8 @@ namespace VEPROMS.CSLA.Library
 				return (LazyLoad(ref _MaxWidthCurPage, "@MaxWidthCurPage"));
 			}
 		}
+
+		// the resolved pagestype item font size will be reduce in order to fit within the defined width
 		private LazyLoad<int?> _FontShrinkAftLen;		// F2021-066 & 070 (text len before shrinking font)
 		public int? FontShrinkAftLen
 		{
@@ -185,6 +212,8 @@ namespace VEPROMS.CSLA.Library
 				return (LazyLoad(ref _FontShrinkAftLen, "@FontShrinkAftLen"));
 			}
 		}
+
+		// used in Alarm Point Table page style values with FontShrinkAftLen set, will display this message if the text cannot be shrunk enough (and be readable) to fit within the defined width
 		private LazyLoad<string> _FontTooSmallMsg;		// F2021-066 message if can't shrink enough
 		public string FontTooSmallMsg
 		{
@@ -193,7 +222,9 @@ namespace VEPROMS.CSLA.Library
 				return LazyLoad(ref _FontTooSmallMsg, "@FontTooSmallMsg");
 			}
 		}
+
 		// F2023-039 allow to select text color of a pagelist line
+		// sets a text color for the page style Item
 		private LazyLoad<string> _TextColor;
 		public string TextColor
 		{
@@ -202,6 +233,8 @@ namespace VEPROMS.CSLA.Library
 				return LazyLoad(ref _TextColor, "@TextColor");
 			}
 		}
+
+		// set to a string, will remove the matching string from the end
 		// F2023-112 Vogtle Units 3 & Backgrounds - trim the ending "-B" from the procedure number (used in title box of page header)
 		private LazyLoad<string> _TrimEnding;
 		public string TrimEnding
@@ -235,6 +268,8 @@ namespace VEPROMS.CSLA.Library
 		public RelatedItem() : base() { }
 		#endregion
 		#region Business Methods
+
+		// the name of the PSI logical token to check
 		private LazyLoad<string> _Token;
 		[Category("RelatedContent")]
 		[DisplayName("RelatedContent")]
@@ -246,6 +281,8 @@ namespace VEPROMS.CSLA.Library
 				return LazyLoad(ref _Token, "@Token");
 			}
 		}
+
+		// new Row value to use for PageStyle Item
 		private LazyLoad<float?> _Row;
 		[Category("Location")]
 		[DisplayName("Vertical Position")]
@@ -257,6 +294,8 @@ namespace VEPROMS.CSLA.Library
 				return LazyLoad(ref _Row, "@Row");
 			}
 		}
+
+		// new Col value to use for PageStyle Item
 		private LazyLoad<float?> _Col;
 		[Category("Location")]
 		[DisplayName("Horizontal Position")]
@@ -268,6 +307,8 @@ namespace VEPROMS.CSLA.Library
 				return LazyLoad(ref _Col, "@Col");
 			}
 		}
+
+		// new Justify value to use for PageStyle Item
 		private LazyLoad<E_Justify?> _Justify;
 		public E_Justify? Justify
 		{