[lmi-commits] [lmi] master d8cea05 4/5: Rework and rename a column-definition footnote

[Greg Chicares]

branch: master
commit d8cea05e8e8a4c67efe8e996e218f2e5c84f8369
Author: Gregory W. Chicares <address@hidden>
Commit: Gregory W. Chicares <address@hidden>

    Rework and rename a column-definition footnote
    
    Thanks to pilcrows and guillemets, both the name of the defined term
    and its definition can easily be customized for any product. Holding
    both in a single variable eliminates the chore of keeping multiple
    variables synchronized.
---
 ill_reg_column_headings.mst | 5 +----
 ledger_invariant.cpp        | 2 +-
 ledger_invariant.hpp        | 2 +-
 ledger_invariant_init.cpp   | 2 +-
 product_data.cpp            | 7 ++++++-
 product_data.hpp            | 2 +-
 6 files changed, 11 insertions(+), 9 deletions(-)

diff --git a/ill_reg_column_headings.mst b/ill_reg_column_headings.mst
index 42e0107..2ec29f2 100644
--- a/ill_reg_column_headings.mst
+++ b/ill_reg_column_headings.mst
@@ -103,10 +103,7 @@ less any monthly charges deducted.
   {{FlexiblePremiumFootnote}}
 {{/SinglePremium}}
 
-<p>
-<b>Guaranteed Crediting Rate:</b>
-{{GuaranteedCreditRateFootnote}}
-</p>
+{{DefnGuarGenAcctRate}}
 
 <p>
 <b>Guaranteed Values:</b>
diff --git a/ledger_invariant.cpp b/ledger_invariant.cpp
index f9c001b..cbf3d58 100644
--- a/ledger_invariant.cpp
+++ b/ledger_invariant.cpp
@@ -304,7 +304,7 @@ void LedgerInvariant::Alloc(int len)
     Strings["FlexiblePremiumFootnote"       ] = &FlexiblePremiumFootnote       
;
     Strings["GuaranteedValuesFootnote"      ] = &GuaranteedValuesFootnote      
;
     Strings["CreditingRateFootnote"         ] = &CreditingRateFootnote         
;
-    Strings["GuaranteedCreditRateFootnote"  ] = &GuaranteedCreditRateFootnote  
;
+    Strings["DefnGuarGenAcctRate"           ] = &DefnGuarGenAcctRate           
;
     Strings["GrossRateFootnote"             ] = &GrossRateFootnote             
;
     Strings["NetRateFootnote"               ] = &NetRateFootnote               
;
     Strings["MecFootnote"                   ] = &MecFootnote                   
;
diff --git a/ledger_invariant.hpp b/ledger_invariant.hpp
index 4fedb3d..7b8c2b7 100644
--- a/ledger_invariant.hpp
+++ b/ledger_invariant.hpp
@@ -314,7 +314,7 @@ class LMI_SO LedgerInvariant final
     std::string FlexiblePremiumFootnote;
     std::string GuaranteedValuesFootnote;
     std::string CreditingRateFootnote;
-    std::string GuaranteedCreditRateFootnote;
+    std::string DefnGuarGenAcctRate;
     std::string GrossRateFootnote;
     std::string NetRateFootnote;
     std::string MecFootnote;
diff --git a/ledger_invariant_init.cpp b/ledger_invariant_init.cpp
index a2e2939..c8afb2b 100644
--- a/ledger_invariant_init.cpp
+++ b/ledger_invariant_init.cpp
@@ -441,7 +441,7 @@ void LedgerInvariant::Init(BasicValues const* b)
         FlexiblePremiumFootnote       = p.datum("FlexiblePremiumFootnote"      
  );
         GuaranteedValuesFootnote      = p.datum("GuaranteedValuesFootnote"     
  );
         CreditingRateFootnote         = p.datum("CreditingRateFootnote"        
  );
-        GuaranteedCreditRateFootnote  = p.datum("GuaranteedCreditRateFootnote" 
  );
+        DefnGuarGenAcctRate           = p.datum("DefnGuarGenAcctRate"          
  );
         GrossRateFootnote             = p.datum("GrossRateFootnote"            
  );
         NetRateFootnote               = p.datum("NetRateFootnote"              
  );
         MecFootnote                   = p.datum("MecFootnote"                  
  );
diff --git a/product_data.cpp b/product_data.cpp
index 34a6987..6c46528 100644
--- a/product_data.cpp
+++ b/product_data.cpp
@@ -307,7 +307,7 @@ void product_data::ascribe_members()
     ascribe("FlexiblePremiumFootnote"       , 
&product_data::FlexiblePremiumFootnote       );
     ascribe("GuaranteedValuesFootnote"      , 
&product_data::GuaranteedValuesFootnote      );
     ascribe("CreditingRateFootnote"         , 
&product_data::CreditingRateFootnote         );
-    ascribe("GuaranteedCreditRateFootnote"  , 
&product_data::GuaranteedCreditRateFootnote  );
+    ascribe("DefnGuarGenAcctRate"           , 
&product_data::DefnGuarGenAcctRate           );
     ascribe("GrossRateFootnote"             , &product_data::GrossRateFootnote 
            );
     ascribe("NetRateFootnote"               , &product_data::NetRateFootnote   
            );
     ascribe("MecFootnote"                   , &product_data::MecFootnote       
            );
@@ -564,6 +564,10 @@ static std::string const S_FnOmnibusDisclaimer =
   " subject to change. Actual results may be more or less favorable.";
 static std::string const S_FnInitialDbo =
   "The initial death benefit option is {{InitDBOpt}}.";
+static std::string const S_DefnGuarGenAcctRate =
+  "¶¶«Guaranteed Crediting Rate:»"
+  " The minimum annual interest rate credited on unloaned funds."
+  ;
 static std::string const S_DefnAV =
   "Account value is the accumulation of payments less charges and 
disbursements.";
 static std::string const S_DefnCSV =
@@ -690,6 +694,7 @@ sample::sample()
     item("FnGuaranteedPremium")        = S_FnGuaranteedPremium;
     item("FnOmnibusDisclaimer")        = S_FnOmnibusDisclaimer;
     item("FnInitialDbo")               = S_FnInitialDbo;
+    item("DefnGuarGenAcctRate")        = S_DefnGuarGenAcctRate;
     item("DefnAV")                     = S_DefnAV;
     item("DefnCSV")                    = S_DefnCSV;
     item("DefnMec")                    = S_DefnMec;
diff --git a/product_data.hpp b/product_data.hpp
index 9e04041..bf6702c 100644
--- a/product_data.hpp
+++ b/product_data.hpp
@@ -297,7 +297,7 @@ class LMI_SO product_data
     glossed_string FlexiblePremiumFootnote;
     glossed_string GuaranteedValuesFootnote;
     glossed_string CreditingRateFootnote;
-    glossed_string GuaranteedCreditRateFootnote;
+    glossed_string DefnGuarGenAcctRate;
     glossed_string GrossRateFootnote;
     glossed_string NetRateFootnote;
     glossed_string MecFootnote;