[lmi-commits] [lmi] master 2fd6a11 147/156: Use shorter and more consistent names for external templates

[Greg Chicares]

branch: master
commit 2fd6a11c17c8ea70d55f6c671ba159dd0e283549
Author: Vadim Zeitlin <address@hidden>
Commit: Vadim Zeitlin <address@hidden>

    Use shorter and more consistent names for external templates
    
    Avoid file names longer than 31 character cut off by abbreviating longer
    strings in the standard way for all illustrations (e.g. always use
    "supp" instead of "supplemental" even for short file names because it
    needs to be abbreviated in this way for longer ones) and also use
    shorter "reg_d_indiv" prefix for the individual private placement type.
    
    And use "reg_" prefix for the templates and classes used for the regular
    illustrations generation for consistency with the other types.
---
 ledger_pdf_generator_wx.cpp                        | 80 ++++++++++++----------
 nasd_supplemental.mst => nasd_supp.mst             |  0
 ...supplemental_report.mst => nasd_supp_report.mst |  0
 column_headings.mst => reg_column_headings.mst     |  0
 ...ive_summary.mst => reg_d_group_narr_summary.mst |  0
 ...e_summary2.mst => reg_d_group_narr_summary2.mst |  0
 ...ental_report.mst => reg_d_group_supp_report.mst |  0
 ...al_cover_page.mst => reg_d_indiv_cover_page.mst |  0
 reg_d_individual_curr.mst => reg_d_indiv_curr.mst  |  2 +-
 ...vidual_curr_irr.mst => reg_d_indiv_curr_irr.mst |  2 +-
 ...ooter_lower.mst => reg_d_indiv_footer_lower.mst |  0
 ...ooter_upper.mst => reg_d_indiv_footer_upper.mst |  0
 ...vidual_guar_irr.mst => reg_d_indiv_guar_irr.mst |  2 +-
 ...individual_header.mst => reg_d_indiv_header.mst |  0
 ...individual_notes1.mst => reg_d_indiv_notes1.mst |  0
 ...individual_notes2.mst => reg_d_indiv_notes2.mst |  0
 ...individual_notes3.mst => reg_d_indiv_notes3.mst |  0
 ...ental_report.mst => reg_d_indiv_supp_report.mst |  2 +-
 footer.mst => reg_footer.mst                       |  0
 footer_disclaimer.mst => reg_footer_disclaimer.mst |  0
 header.mst => reg_header.mst                       |  0
 narrative_summary.mst => reg_narr_summary.mst      |  2 +-
 ...ative_summary_cont.mst => reg_narr_summary2.mst |  0
 numeric_summary.mst => reg_numeric_summary.mst     |  2 +-
 supplemental_report.mst => reg_supp_report.mst     |  2 +-
 tabular_details.mst => reg_tabular_details.mst     |  2 +-
 tabular_details2.mst => reg_tabular_details2.mst   |  2 +-
 27 files changed, 52 insertions(+), 46 deletions(-)

diff --git a/ledger_pdf_generator_wx.cpp b/ledger_pdf_generator_wx.cpp
index 1aad825..e0c13d8 100644
--- a/ledger_pdf_generator_wx.cpp
+++ b/ledger_pdf_generator_wx.cpp
@@ -1525,7 +1525,7 @@ using numbered_or_attachment_base = typename 
std::conditional
     >::type;
 
 template<bool is_attachment>
-class numeric_summary_or_attachment_page
+class reg_numeric_summary_or_attachment_page
     : public numbered_or_attachment_base<is_attachment>
 {
   public:
@@ -1541,7 +1541,11 @@ class numeric_summary_or_attachment_page
             ,interpolate_html
             );
 
-        this->render_page_template("numeric_summary", writer, 
interpolate_html);
+        this->render_page_template
+            ("reg_numeric_summary"
+            ,writer
+            ,interpolate_html
+            );
     }
 };
 
@@ -1728,7 +1732,7 @@ class page_with_tabular_report
     }
 };
 
-class tabular_detail_page : public page_with_tabular_report
+class reg_tabular_detail_page : public page_with_tabular_report
 {
   private:
     enum
@@ -1747,12 +1751,12 @@ class tabular_detail_page : public 
page_with_tabular_report
 
     std::string get_fixed_page_contents_template_name() const override
     {
-        return "tabular_details";
+        return "reg_tabular_details";
     }
 
     std::string get_upper_footer_template_name() const override
     {
-        return "footer_disclaimer";
+        return "reg_footer_disclaimer";
     }
 
     void render_or_measure_extra_headers
@@ -1822,7 +1826,7 @@ class tabular_detail_page : public 
page_with_tabular_report
     }
 };
 
-class tabular_detail2_page : public page_with_tabular_report
+class reg_tabular_detail2_page : public page_with_tabular_report
 {
   private:
     enum
@@ -1835,12 +1839,12 @@ class tabular_detail2_page : public 
page_with_tabular_report
 
     std::string get_fixed_page_contents_template_name() const override
     {
-        return "tabular_details2";
+        return "reg_tabular_details2";
     }
 
     std::string get_upper_footer_template_name() const override
     {
-        return "footer_disclaimer";
+        return "reg_footer_disclaimer";
     }
 
     illustration_table_columns const& get_table_columns() const override
@@ -1919,18 +1923,18 @@ class standard_supplemental_report : public 
page_with_tabular_report
     std::string                const page_template_;
 };
 
-class supplemental_report : public standard_supplemental_report
+class reg_supplemental_report : public standard_supplemental_report
 {
   public:
-    explicit supplemental_report(html_interpolator const& interpolate_html)
-        :standard_supplemental_report(interpolate_html, "supplemental_report")
+    explicit reg_supplemental_report(html_interpolator const& interpolate_html)
+        :standard_supplemental_report(interpolate_html, "reg_supp_report")
     {
     }
 
   private:
     std::string get_upper_footer_template_name() const override
     {
-        return "footer_disclaimer";
+        return "reg_footer_disclaimer";
     }
 };
 
@@ -2064,27 +2068,29 @@ class pdf_illustration_regular : public pdf_illustration
         // Add all the pages.
         add<cover_page>();
         numbered_page::start_numbering();
-        add<standard_page>("narrative_summary");
-        add<standard_page>("narrative_summary_cont");
-        add<standard_page>("column_headings");
+        add<standard_page>("reg_narr_summary");
+        add<standard_page>("reg_narr_summary2");
+        add<standard_page>("reg_column_headings");
         if(!invar.IsInforce)
             {
-            add<numeric_summary_or_attachment_page<false>>();
+            add<reg_numeric_summary_or_attachment_page<false>>();
             }
-        add<tabular_detail_page>();
-        add<tabular_detail2_page>();
+        add<reg_tabular_detail_page>();
+        add<reg_tabular_detail2_page>();
         if(invar.SupplementalReport)
             {
-            add<supplemental_report>(get_interpolator());
+            add<reg_supplemental_report>(get_interpolator());
             }
         if(!invar.IsInforce)
             {
-            add<numeric_summary_or_attachment_page<true>>();
+            add<reg_numeric_summary_or_attachment_page<true>>();
             }
     }
 
-    std::string get_upper_footer_template_name() const override { return {}; }
-    std::string get_lower_footer_template_name() const override { return 
"footer"; }
+    std::string get_upper_footer_template_name() const override
+        { return {}; }
+    std::string get_lower_footer_template_name() const override
+        { return "reg_footer"; }
 };
 
 // Common base class for basic illustration pages using the same columns in
@@ -2316,7 +2322,7 @@ class nasd_supplemental : public page_with_tabular_report
 
     std::string get_fixed_page_contents_template_name() const override
     {
-        return "nasd_supplemental";
+        return "nasd_supp";
     }
 
     illustration_table_columns const& get_table_columns() const override
@@ -2482,7 +2488,7 @@ class pdf_illustration_nasd : public pdf_illustration
             {
             add<standard_supplemental_report>
                 (get_interpolator()
-                ,"nasd_supplemental_report"
+                ,"nasd_supp_report"
                 );
             }
     }
@@ -2551,13 +2557,13 @@ class pdf_illustration_reg_d_group : public 
pdf_illustration
         numbered_page::start_numbering();
         add<reg_d_group_basic>();
         add<standard_page>("reg_d_group_column_headings");
-        add<standard_page>("reg_d_group_narrative_summary");
-        add<standard_page>("reg_d_group_narrative_summary2");
+        add<standard_page>("reg_d_group_narr_summary");
+        add<standard_page>("reg_d_group_narr_summary2");
         if(invar.SupplementalReport)
             {
             add<standard_supplemental_report>
                 (get_interpolator()
-                ,"reg_d_group_supplemental_report"
+                ,"reg_d_group_supp_report"
                 );
             }
     }
@@ -2673,7 +2679,7 @@ class reg_d_individual_guar_irr : public 
reg_d_individual_irr_base
 
     std::string get_fixed_page_contents_template_name() const override
     {
-        return "reg_d_individual_guar_irr";
+        return "reg_d_indiv_guar_irr";
     }
 
     illustration_table_columns const& get_table_columns() const override
@@ -2707,7 +2713,7 @@ class reg_d_individual_curr_irr : public 
reg_d_individual_irr_base
 
     std::string get_fixed_page_contents_template_name() const override
     {
-        return "reg_d_individual_curr_irr";
+        return "reg_d_indiv_curr_irr";
     }
 
     illustration_table_columns const& get_table_columns() const override
@@ -2751,7 +2757,7 @@ class reg_d_individual_curr : public 
page_with_tabular_report
 
     std::string get_fixed_page_contents_template_name() const override
     {
-        return "reg_d_individual_curr";
+        return "reg_d_indiv_curr";
     }
 
     illustration_table_columns const& get_table_columns() const override
@@ -2824,30 +2830,30 @@ class pdf_illustration_reg_d_individual : public 
pdf_illustration
 
         // Add all the pages.
         numbered_page::start_numbering();
-        add<standard_page>("reg_d_individual_cover_page");
+        add<standard_page>("reg_d_indiv_cover_page");
         add<reg_d_individual_guar_irr>();
         add<reg_d_individual_curr_irr>();
         add<reg_d_individual_curr>();
-        add<standard_page>("reg_d_individual_notes1");
-        add<standard_page>("reg_d_individual_notes2");
-        add<standard_page>("reg_d_individual_notes3");
+        add<standard_page>("reg_d_indiv_notes1");
+        add<standard_page>("reg_d_indiv_notes2");
+        add<standard_page>("reg_d_indiv_notes3");
         if(invar.SupplementalReport)
             {
             add<standard_supplemental_report>
                 (get_interpolator()
-                ,"reg_d_individual_supplemental_report"
+                ,"reg_d_indiv_supp_report"
                 );
             }
     }
 
     std::string get_upper_footer_template_name() const override
     {
-        return "reg_d_individual_footer_upper";
+        return "reg_d_indiv_footer_upper";
     }
 
     std::string get_lower_footer_template_name() const override
     {
-        return "reg_d_individual_footer_lower";
+        return "reg_d_indiv_footer_lower";
     }
 };
 
diff --git a/nasd_supplemental.mst b/nasd_supp.mst
similarity index 100%
rename from nasd_supplemental.mst
rename to nasd_supp.mst
diff --git a/nasd_supplemental_report.mst b/nasd_supp_report.mst
similarity index 100%
rename from nasd_supplemental_report.mst
rename to nasd_supp_report.mst
diff --git a/column_headings.mst b/reg_column_headings.mst
similarity index 100%
rename from column_headings.mst
rename to reg_column_headings.mst
diff --git a/reg_d_group_narrative_summary.mst b/reg_d_group_narr_summary.mst
similarity index 100%
rename from reg_d_group_narrative_summary.mst
rename to reg_d_group_narr_summary.mst
diff --git a/reg_d_group_narrative_summary2.mst b/reg_d_group_narr_summary2.mst
similarity index 100%
rename from reg_d_group_narrative_summary2.mst
rename to reg_d_group_narr_summary2.mst
diff --git a/reg_d_group_supplemental_report.mst b/reg_d_group_supp_report.mst
similarity index 100%
rename from reg_d_group_supplemental_report.mst
rename to reg_d_group_supp_report.mst
diff --git a/reg_d_individual_cover_page.mst b/reg_d_indiv_cover_page.mst
similarity index 100%
rename from reg_d_individual_cover_page.mst
rename to reg_d_indiv_cover_page.mst
diff --git a/reg_d_individual_curr.mst b/reg_d_indiv_curr.mst
similarity index 97%
rename from reg_d_individual_curr.mst
rename to reg_d_indiv_curr.mst
index ee29d52..299de2a 100644
--- a/reg_d_individual_curr.mst
+++ b/reg_d_indiv_curr.mst
@@ -18,7 +18,7 @@
     email: <address@hidden>
     snail: Chicares, 186 Belle Woods Drive, Glastonbury CT 06033, USA
 }}
-{{>reg_d_individual_header}}
+{{>reg_d_indiv_header}}
 
 <font size="-1">
 
diff --git a/reg_d_individual_curr_irr.mst b/reg_d_indiv_curr_irr.mst
similarity index 97%
rename from reg_d_individual_curr_irr.mst
rename to reg_d_indiv_curr_irr.mst
index 65819b2..687dc68 100644
--- a/reg_d_individual_curr_irr.mst
+++ b/reg_d_indiv_curr_irr.mst
@@ -18,7 +18,7 @@
     email: <address@hidden>
     snail: Chicares, 186 Belle Woods Drive, Glastonbury CT 06033, USA
 }}
-{{>reg_d_individual_header}}
+{{>reg_d_indiv_header}}
 
 <font size="-1">
 
diff --git a/reg_d_individual_footer_lower.mst b/reg_d_indiv_footer_lower.mst
similarity index 100%
rename from reg_d_individual_footer_lower.mst
rename to reg_d_indiv_footer_lower.mst
diff --git a/reg_d_individual_footer_upper.mst b/reg_d_indiv_footer_upper.mst
similarity index 100%
rename from reg_d_individual_footer_upper.mst
rename to reg_d_indiv_footer_upper.mst
diff --git a/reg_d_individual_guar_irr.mst b/reg_d_indiv_guar_irr.mst
similarity index 97%
rename from reg_d_individual_guar_irr.mst
rename to reg_d_indiv_guar_irr.mst
index d4e0714..ed5bee6 100644
--- a/reg_d_individual_guar_irr.mst
+++ b/reg_d_indiv_guar_irr.mst
@@ -18,7 +18,7 @@
     email: <address@hidden>
     snail: Chicares, 186 Belle Woods Drive, Glastonbury CT 06033, USA
 }}
-{{>reg_d_individual_header}}
+{{>reg_d_indiv_header}}
 
 <font size="-1">
 
diff --git a/reg_d_individual_header.mst b/reg_d_indiv_header.mst
similarity index 100%
rename from reg_d_individual_header.mst
rename to reg_d_indiv_header.mst
diff --git a/reg_d_individual_notes1.mst b/reg_d_indiv_notes1.mst
similarity index 100%
rename from reg_d_individual_notes1.mst
rename to reg_d_indiv_notes1.mst
diff --git a/reg_d_individual_notes2.mst b/reg_d_indiv_notes2.mst
similarity index 100%
rename from reg_d_individual_notes2.mst
rename to reg_d_indiv_notes2.mst
diff --git a/reg_d_individual_notes3.mst b/reg_d_indiv_notes3.mst
similarity index 100%
rename from reg_d_individual_notes3.mst
rename to reg_d_indiv_notes3.mst
diff --git a/reg_d_individual_supplemental_report.mst 
b/reg_d_indiv_supp_report.mst
similarity index 97%
rename from reg_d_individual_supplemental_report.mst
rename to reg_d_indiv_supp_report.mst
index 33702aa..327ad38 100644
--- a/reg_d_individual_supplemental_report.mst
+++ b/reg_d_indiv_supp_report.mst
@@ -18,7 +18,7 @@
     email: <address@hidden>
     snail: Chicares, 186 Belle Woods Drive, Glastonbury CT 06033, USA
 }}
-{{>reg_d_individual_header}}
+{{>reg_d_indiv_header}}
 
 <font size="-1">
 
diff --git a/footer.mst b/reg_footer.mst
similarity index 100%
rename from footer.mst
rename to reg_footer.mst
diff --git a/footer_disclaimer.mst b/reg_footer_disclaimer.mst
similarity index 100%
rename from footer_disclaimer.mst
rename to reg_footer_disclaimer.mst
diff --git a/header.mst b/reg_header.mst
similarity index 100%
rename from header.mst
rename to reg_header.mst
diff --git a/narrative_summary.mst b/reg_narr_summary.mst
similarity index 99%
rename from narrative_summary.mst
rename to reg_narr_summary.mst
index d4583ca..19ff3d3 100644
--- a/narrative_summary.mst
+++ b/reg_narr_summary.mst
@@ -18,7 +18,7 @@
     email: <address@hidden>
     snail: Chicares, 186 Belle Woods Drive, Glastonbury CT 06033, USA
 }}
-{{>header}}
+{{>reg_header}}
 
 <p align="center">NARRATIVE SUMMARY</p>
 
diff --git a/narrative_summary_cont.mst b/reg_narr_summary2.mst
similarity index 100%
rename from narrative_summary_cont.mst
rename to reg_narr_summary2.mst
diff --git a/numeric_summary.mst b/reg_numeric_summary.mst
similarity index 99%
rename from numeric_summary.mst
rename to reg_numeric_summary.mst
index ec41bec..bb23afe 100644
--- a/numeric_summary.mst
+++ b/reg_numeric_summary.mst
@@ -18,7 +18,7 @@
     email: <address@hidden>
     snail: Chicares, 186 Belle Woods Drive, Glastonbury CT 06033, USA
 }}
-{{>header}}
+{{>reg_header}}
 
 <p align="center">Numeric Summary</p>
 
diff --git a/supplemental_report.mst b/reg_supp_report.mst
similarity index 98%
rename from supplemental_report.mst
rename to reg_supp_report.mst
index aff2154..d738f60 100644
--- a/supplemental_report.mst
+++ b/reg_supp_report.mst
@@ -18,7 +18,7 @@
     email: <address@hidden>
     snail: Chicares, 186 Belle Woods Drive, Glastonbury CT 06033, USA
 }}
-{{>header}}
+{{>reg_header}}
 
 <p align="center">{{SupplementalReportTitle}}</p>
 
diff --git a/tabular_details.mst b/reg_tabular_details.mst
similarity index 98%
rename from tabular_details.mst
rename to reg_tabular_details.mst
index 89a3570..cc752d5 100644
--- a/tabular_details.mst
+++ b/reg_tabular_details.mst
@@ -18,7 +18,7 @@
     email: <address@hidden>
     snail: Chicares, 186 Belle Woods Drive, Glastonbury CT 06033, USA
 }}
-{{>header}}
+{{>reg_header}}
 
 <p align="center">Tabular Detail</p>
 
diff --git a/tabular_details2.mst b/reg_tabular_details2.mst
similarity index 98%
rename from tabular_details2.mst
rename to reg_tabular_details2.mst
index 325773f..6a34ed5 100644
--- a/tabular_details2.mst
+++ b/reg_tabular_details2.mst
@@ -18,7 +18,7 @@
     email: <address@hidden>
     snail: Chicares, 186 Belle Woods Drive, Glastonbury CT 06033, USA
 }}
-{{>header}}
+{{>reg_header}}
 
 <p align="center">Tabular Detail, continued</p>