Add "FAQs" to in-app documentation.

sandialabs · Sep 29, 2023 · 6faa307 · ckuethe · Oct 4, 2023 · wcjohns
1 parent 8926e80
commit 6faa307
Show file tree

Hide file tree

Showing 31 changed files with 1,405 additions and 29 deletions.
diff --git a/InterSpec_resources/static_text/faqs/auto_peak_search_btn.png b/InterSpec_resources/static_text/faqs/auto_peak_search_btn.png
diff --git a/InterSpec_resources/static_text/faqs/auto_peak_search_dialog.png b/InterSpec_resources/static_text/faqs/auto_peak_search_dialog.png
diff --git a/InterSpec_resources/static_text/faqs/changing_spec_files.png b/InterSpec_resources/static_text/faqs/changing_spec_files.png
diff --git a/InterSpec_resources/static_text/faqs/drf_prev_dialog.png b/InterSpec_resources/static_text/faqs/drf_prev_dialog.png
diff --git a/InterSpec_resources/static_text/faqs/drf_save_dialog.png b/InterSpec_resources/static_text/faqs/drf_save_dialog.png
diff --git a/InterSpec_resources/static_text/faqs/drf_select_btn.png b/InterSpec_resources/static_text/faqs/drf_select_btn.png
diff --git a/InterSpec_resources/static_text/faqs/drf_select_btn_empty.png b/InterSpec_resources/static_text/faqs/drf_select_btn_empty.png
diff --git a/InterSpec_resources/static_text/faqs/drf_select_defaults.png b/InterSpec_resources/static_text/faqs/drf_select_defaults.png
diff --git a/InterSpec_resources/static_text/faqs/energy_cal_tab.png b/InterSpec_resources/static_text/faqs/energy_cal_tab.png
diff --git a/InterSpec_resources/static_text/faqs/faqs.css b/InterSpec_resources/static_text/faqs/faqs.css
@@ -54,7 +54,11 @@
 {
   border-top: 1px solid black;
   margin-top: 2px;
-  width: 100%;
+  width: calc( 100% - 20px );
   display: block;
   overflow-x: hidden;
+  padding-top: 5px;
+  padding-left: 10px;
+  padding-right: 10px;
+  padding-bottom: 5px;
 }
diff --git a/InterSpec_resources/static_text/faqs/faqs.xml b/InterSpec_resources/static_text/faqs/faqs.xml
diff --git a/InterSpec_resources/static_text/faqs/isocs_ecc_import.png b/InterSpec_resources/static_text/faqs/isocs_ecc_import.png
diff --git a/InterSpec_resources/static_text/faqs/make_drf_fixed_geom.png b/InterSpec_resources/static_text/faqs/make_drf_fixed_geom.png
diff --git a/InterSpec_resources/static_text/faqs/manager_sum_spectra.png b/InterSpec_resources/static_text/faqs/manager_sum_spectra.png
diff --git a/InterSpec_resources/static_text/faqs/mult_nuc_contrib_cb.png b/InterSpec_resources/static_text/faqs/mult_nuc_contrib_cb.png
diff --git a/InterSpec_resources/static_text/faqs/normalize_spectra.png b/InterSpec_resources/static_text/faqs/normalize_spectra.png
diff --git a/InterSpec_resources/static_text/faqs/ref_photopeak_cascade_opt.png b/InterSpec_resources/static_text/faqs/ref_photopeak_cascade_opt.png
diff --git a/InterSpec_resources/static_text/faqs/sample_dets.png b/InterSpec_resources/static_text/faqs/sample_dets.png
diff --git a/InterSpec_resources/static_text/faqs/se_right_click.png b/InterSpec_resources/static_text/faqs/se_right_click.png
diff --git a/InterSpec_resources/static_text/faqs/shielding_toggle.png b/InterSpec_resources/static_text/faqs/shielding_toggle.png
diff --git a/InterSpec_resources/static_text/faqs/shielding_toggle_generic.png b/InterSpec_resources/static_text/faqs/shielding_toggle_generic.png
diff --git a/InterSpec_resources/static_text/faqs/spec_meas_manager_1.png b/InterSpec_resources/static_text/faqs/spec_meas_manager_1.png
diff --git a/InterSpec_resources/static_text/faqs/th232_out_of_equilibrium.png b/InterSpec_resources/static_text/faqs/th232_out_of_equilibrium.png
diff --git a/InterSpec_resources/static_text/faqs/time_char_opt.png b/InterSpec_resources/static_text/faqs/time_char_opt.png
diff --git a/InterSpec_resources/static_text/faqs/time_char_opt_2.png b/InterSpec_resources/static_text/faqs/time_char_opt_2.png
diff --git a/InterSpec_resources/static_text/faqs/time_history_full_energy_range.jpg b/InterSpec_resources/static_text/faqs/time_history_full_energy_range.jpg
diff --git a/InterSpec_resources/static_text/faqs/time_history_u235_energy_range.jpg b/InterSpec_resources/static_text/faqs/time_history_u235_energy_range.jpg
diff --git a/InterSpec_resources/static_text/faqs/time_opt_int.png b/InterSpec_resources/static_text/faqs/time_opt_int.png
diff --git a/InterSpec_resources/static_text/spectrum_file_format_descriptions.xml b/InterSpec_resources/static_text/spectrum_file_format_descriptions.xml
@@ -11,7 +11,7 @@
 
     Please see https://www.nist.gov/pml/radiation-physics/ansiieee-n4242-2020-version, or https://www.nist.gov/programs-projects/documentary-standards-ansiieee-n4242-standard for more information.
 
-    Note: the N42-2012 files produced by InterSpec contains a <DHS:InterSpec></DHS:InterSpec> element, in violation of the specification, and which may cause some XML parsers troubles; there also may be other small deviations from the specifications - these issues are known, and intended to be fixed in the future.
+    Note: the N42-2012 files produced by InterSpec contains a &lt;DHS:InterSpec&gt;&lt;/DHS:InterSpec&gt; element, in violation of the specification, and which may cause some XML parsers troubles; there also may be other small deviations from the specifications - these issues are known, and intended to be fixed in the future.
   </message>
 
   <message id="N42-2006">
@@ -25,7 +25,7 @@
   <message id="CHN">
     This options produces an integer binary CHN file.
 
-    This format holds a single spectrum, measurment start time, spectrum title (up to 63 characters), detector description, and current energy calibration. 
+    This format holds a single spectrum, measurement start time, spectrum title (up to 63 characters), detector description, and current energy calibration. 
 
     Energy deviation pairs, neutron counts, InterSpec specific information (DRF, activity fits, etc), as well as any other meta information, will not be included in the output file.
   </message>
@@ -79,23 +79,23 @@
   <message id="SPC (int)">
     This options produces a single-spectrum, integer-based binary SPC file.
 
-    This format includes the gamma spectrum, neutron counts, gps info, measurment start time, detector serial number, and energy calibration.  
+    This format includes the gamma spectrum, neutron counts, gps info, measurement start time, detector serial number, and energy calibration.  
 
     Energy deviation pairs, analysis results, InterSpec specific information (DRFs, peaks fit, fit activities, etc), and other meta information will not be included.
   </message>
 
   <message id="SPC (float)">
     This options produces a single-spectrum, float-based binary SPC file.
 
-    This format includes the gamma spectrum, neutron counts, gps info, measurment start time, detector serial number, and energy calibration.  
+    This format includes the gamma spectrum, neutron counts, gps info, measurement start time, detector serial number, and energy calibration.  
 
     Energy deviation pairs, analysis results, InterSpec specific information (DRFs, peaks fit, fit activities, etc), and other meta information will not be included.
   </message>
 
   <message id="SPC (ascii)">
     This options produces a single-spectrum ASCII SPC file.  
 
-    This format includes the gamma spectrum, neutron counts, gps info, measurment start time, detector serial number, energy calibration, some detector analysis information, manufacturer, and model information.
+    This format includes the gamma spectrum, neutron counts, gps info, measurement start time, detector serial number, energy calibration, some detector analysis information, manufacturer, and model information.
 
     Energy deviation pairs, some analysis information results, InterSpec specific information (DRFs, peaks fit, fit activities, etc), and possibly some, but not all, meta information will not be included.
   </message>

diff --git a/src/InterSpec.cpp b/src/InterSpec.cpp
@@ -1640,6 +1640,16 @@ void InterSpec::hotKeyPressed( const unsigned int value )
         createExportSpectrumFileDialog();
         break;
 
+    // Temporarily add shortcut for showing FAQ window during development
+      case 'f': case 'F':
+      {
+        showWelcomeDialog( true );
+        if( m_useInfoWindow )
+          m_useInfoWindow->showFaqTab();
+        break;
+      }
+
+
       case 37: case 38: case 39: case 40:
         arrowKeyPressed( value );
         break;

diff --git a/src/InterSpecApp.cpp b/src/InterSpecApp.cpp
@@ -372,6 +372,7 @@ void InterSpecApp::setupDomEnvironment()
         case 'k': // Clear showing reference photopeak lines
         case 's': // Store
         case 'l': // Log/Linear
+        case 'f': case 'F': // Show FAQs - for development only
         case 'e': case 'E': // Export file dialog
           if( $(".Wt-dialogcover").is(':visible') ) // Dont do shortcut when there is a blocking-dialog showing
             return;