added documentation to mig-reporter for the captions feature

[migration-tools.git] / mig-bin / mig-reporter

diff --git a/mig-bin/mig-reporter b/mig-bin/mig-reporter
index 421a312..79410f7 100755 (executable)
--- a/mig-bin/mig-reporter
+++ b/mig-bin/mig-reporter
@@ -32,6 +32,10 @@ Allows you to override the default evergreen_staged_report.xml in the mig-xml fo
 
 Pushes output to an Excel file instead of asciidoc file. 
 
+--captions or --captions_off
+
+Adds the captions tag to asciidoc header to turn off captions in generated output.
+
 =back
 
 =cut
@@ -74,6 +78,7 @@ my $next_arg_is_added_page_title;
 my $added_page_file;
 my $next_arg_is_added_page_file;
 my $excel_output = 0;
+my $captions_off = 0;
 my $i = 0;
 my $parser = XML::LibXML->new();
 my $lines_per_page = 42;
@@ -140,6 +145,10 @@ foreach my $arg (@ARGV) {
         $excel_output = 1;
         next;
     }
+    if ($arg eq '--captions_off' or $arg eq '--captions') {
+        $captions_off = 1;
+        next;
+    }
     if ($arg eq '--debug') {
         $debug_flag = 1;
         next;
@@ -171,7 +180,7 @@ if ($excel_output == 1) {
     $workbook = Excel::Writer::XLSX->new( $report_file );
 } else {
     open($fh, '>', $report_file) or abort("Could not open output file!");
-    write_title_page($report_title,$fh,$analyst);
+    write_title_page($report_title,$fh,$analyst,$captions_off);
 };
 
 if (defined $added_page_file and defined $added_page_title) { 
@@ -331,6 +340,7 @@ sub write_title_page {
     my $rt = shift;
     my $fh = shift;
     my $a = shift;
+    my $captions_off = shift;
 
     my @abbr = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
     my $l = length($report_title);
@@ -341,6 +351,7 @@ sub write_title_page {
     print $fh "$a\n";
     #print $fh ":title-logo-image: image::eolilogosmall.png[pdfwidth=3in]\n";
     print $fh ":toc:\n";
+    if ($captions_off == 1) { print $fh ":caption:\n"; }
     print $fh "\n";
 }