New Help IDs for Sphinx-generated help

cpaulgilman · cpaulgilman · commit f480c42f823e · 2025-12-15T14:31:06.000-08:00
Help ID is path to HTML file with no extension &lt;folder&gt;/&lt;filename&gt;. For example Help ID "battery-storage/battery_dispatch_fom" points to battery_dispatch_fom.html in "/help/html/battery-storage" folder.
diff --git a/deploy/runtime/startup.lk b/deploy/runtime/startup.lk
diff --git a/src/casewin.cpp b/src/casewin.cpp
@@ -2320,7 +2320,7 @@ void NumericRangeDialog::OnCommand(wxCommandEvent &evt)
 	switch(evt.GetId())
 	{
 	case wxID_HELP:
-		SamApp::ShowHelp("edit_parametric_variables");
+		SamApp::ShowHelp("window-reference/win_edit_parametric_variables");
 		break;
 
 	case ID_values:
diff --git a/src/combinecases.cpp b/src/combinecases.cpp
@@ -125,7 +125,7 @@ void CombineCasesDialog::OnEvt(wxCommandEvent& e)
 	switch (e.GetId())
 	{
 		case wxID_HELP:
-			SamApp::ShowHelp("combine_cases");
+			SamApp::ShowHelp("window-reference/win_combine_cases");
 			break;
 		case ID_chlCases:
 			{
diff --git a/src/library.cpp b/src/library.cpp
@@ -109,7 +109,7 @@ class SettingsDialog : public wxDialog
 			break;
 
 		case wxID_HELP:			
-			SamApp::ShowHelp("weather_manage_folders");
+			SamApp::ShowHelp("weather-data/weather_manage_folders");
 			break;
 		}
 	}
diff --git a/src/lossadj.cpp b/src/lossadj.cpp
@@ -437,7 +437,7 @@ class LossAdjustmentDialog : public wxDialog
 		switch( e.GetId() )
 		{
 		case wxID_HELP:
-			SamApp::ShowHelp("edit_losses");
+			SamApp::ShowHelp("window-reference/win_edit_losses");
 			break;
 		//case ID_ENABLE_HOURLY:
         case ID_ENABLE_INDEX:
diff --git a/src/main.cpp b/src/main.cpp
@@ -949,7 +949,7 @@ void MainWindow::OnCommand( wxCommandEvent &evt )
 	switch( evt.GetId() )
 	{
 	case wxID_HELP:
-		SamApp::ShowHelp( cwin ? cwin->GetCurrentContext() : wxString("welcome_page") );
+		SamApp::ShowHelp( cwin ? cwin->GetCurrentContext() : wxString("index") );
 		break;
 	case wxID_ABOUT:
 		SamApp::ShowHelp( ":about" );
diff --git a/src/materials.cpp b/src/materials.cpp
@@ -205,7 +205,7 @@ void MatPropDialog::OnCommand(wxCommandEvent &evt)
 	{
 	case ID_IMPORT: Import(); break;
 	case ID_EXPORT: Export(); break;
-	case wxID_HELP: SamApp::ShowHelp("edit_material_properties"); break;
+	case wxID_HELP: SamApp::ShowHelp("window-reference/win_edit_material_properties"); break;
 	}
 }
 
diff --git a/src/nohrsc.cpp b/src/nohrsc.cpp
@@ -222,7 +222,7 @@ void NOHRSCDialog::OnEvt(wxCommandEvent& e)
 	switch (e.GetId())
 		{
 		case wxID_HELP:
-			SamApp::ShowHelp("NOHRSC_advanced_download");
+			SamApp::ShowHelp("window-reference/win_nohrsc_advanced_download");
 			break;
 	case ID_btnResources:
 		{
diff --git a/src/nsrdb.cpp b/src/nsrdb.cpp
@@ -185,7 +185,7 @@ void NSRDBDialog::OnEvt( wxCommandEvent &e )
 	switch( e.GetId() )
 	{
 		case wxID_HELP:
-			SamApp::ShowHelp("nsrdb_advanced_download");
+			SamApp::ShowHelp("window-reference/win_nsrdb_advanced_download");
 			break;
 		case ID_btnResources:
 			{
diff --git a/src/parametric.cpp b/src/parametric.cpp
@@ -3630,7 +3630,7 @@ void Parametric_QS::OnCommand(wxCommandEvent &evt)
 		}
 		case wxID_HELP:
 		{
-			SamApp::ShowHelp("parametric_quick_setup");
+			SamApp::ShowHelp("window-reference/win_parametric_quick_setup");
 			break;
 		}
 		case  ID_setupOption:
diff --git a/src/ptesdesignptdialog.cpp b/src/ptesdesignptdialog.cpp
@@ -892,7 +892,7 @@ void PTESDesignPtDialog::OnEvt(wxCommandEvent& e)
         }
         case wxID_HELP:
         {
-            SamApp::ShowHelp("ptes_design_pt");
+            SamApp::ShowHelp("window-reference/win_ptes_design_pt");
             break;
         }
     }
diff --git a/src/s3tool.cpp b/src/s3tool.cpp
@@ -2418,15 +2418,9 @@ void ShadeTool::OnCommand( wxCommandEvent &evt)
 		break;
 	case wxID_HELP:
 #ifdef S3D_STANDALONE
-		
-#if defined(__WXMSW__)||defined(__WXOSX__)
-		m_book->SetSelection( PG_HELP );
-#else
 		wxLaunchDefaultBrowser( "file:///" + m_dataPath + "/help/index.html" );
-#endif
-
 #else
-		SamApp::ShowHelp( "3d_shade_calculator" );
+		SamApp::ShowHelp( "shade-calculator-reference/sc-overview" );
 #endif
 		break;
 	}
diff --git a/src/shadingfactors.cpp b/src/shadingfactors.cpp
@@ -479,7 +479,7 @@ class ShadingDialog : public wxDialog
 		switch( e.GetId() )
 		{
 		case wxID_HELP:
-			SamApp::ShowHelp("edit_shading_data");
+			SamApp::ShowHelp("window-reference/win_edit_shading_data");
 			break;
 		case ID_ENABLE_HOURLY:
 		case ID_ENABLE_MXH:
diff --git a/src/variablegrid.cpp b/src/variablegrid.cpp
@@ -1245,7 +1245,7 @@ void VariableGridFrame::OnCommand(wxCommandEvent &evt)
 		SendToExcel();
 		break;
 	case wxID_HELP:
-		SamApp::ShowHelp( "inputs_browser" );
+		SamApp::ShowHelp( "reference/inputs_browser" );
 		break;
 	case ID_FILTER:
 		UpdateGrid();
diff --git a/src/wavetoolkit.cpp b/src/wavetoolkit.cpp
@@ -206,7 +206,7 @@ void WaveDownloadDialog::OnEvt( wxCommandEvent &e )
 	switch( e.GetId() )
 	{
 		case wxID_HELP:
-			SamApp::ShowHelp("wave_download");
+			SamApp::ShowHelp("window-reference/win_wave_download");
 			break;
         case ID_radSingleYear:
         case ID_radMultiYear:
diff --git a/src/welcome.cpp b/src/welcome.cpp
@@ -483,7 +483,7 @@ void WelcomeScreen::OnCommand( wxCommandEvent &evt )
 		break;
 
 	case wxID_HELP:
-		SamApp::ShowHelp( "welcome_page" );
+		SamApp::ShowHelp( "getting-started/welcome_page" );
 		break;
 
 	case wxID_EXIT:
diff --git a/src/widgets.cpp b/src/widgets.cpp
@@ -464,7 +464,7 @@ class AFTableDataDialog : public wxDialog
 	void OnCommand(wxCommandEvent& evt)
 	{
 		if (evt.GetId() == wxID_HELP)
-			SamApp::ShowHelp("edit_data_table_row");
+			SamApp::ShowHelp("window-reference/win_edit_data_table_row");
 	}
 
 	DECLARE_EVENT_TABLE();
@@ -681,7 +681,7 @@ class MonthlyFactorDialog : public wxDialog
 	{
 		if (evt.GetId() == wxID_HELP)
 		{
-			SamApp::ShowHelp("edit_monthly_values");
+			SamApp::ShowHelp("window-reference/win_edit_monthly_values");
 		}
 	}
 
@@ -1944,7 +1944,7 @@ class AFDataArrayDialog : public wxDialog
 		}
 		else if (evt.GetId() == wxID_HELP)
 		{
-			SamApp::ShowHelp("edit_array");
+			SamApp::ShowHelp("window-reference/win_edit_array");
 		}
 
 	}
@@ -2576,7 +2576,7 @@ class AFDataLifetimeArrayDialog : public wxDialog
 		}
 		else if (evt.GetId() == wxID_HELP)
 		{
-			SamApp::ShowHelp("edit_data_lifetime");
+			SamApp::ShowHelp("window-reference/win_edit_data_lifetime");
 		}
 
 	}
@@ -3527,7 +3527,7 @@ class AFStringArrayDialog : public wxDialog
 		}
 		else if (evt.GetId() == wxID_HELP)
 		{
-			SamApp::ShowHelp("edit_array");
+			SamApp::ShowHelp("window-reference/win_edit_array");
 		}
 	}
 
diff --git a/src/windtoolkit.cpp b/src/windtoolkit.cpp
@@ -160,7 +160,7 @@ void WindToolkitDialog::OnEvt( wxCommandEvent &e )
 	switch( e.GetId() )
 	{
 	case wxID_HELP:
-		SamApp::ShowHelp("wind_toolkit_download");
+		SamApp::ShowHelp("window-reference/win_wind_toolkit_download");
 		break;
 	case ID_radAddress:
 	case ID_radLatLon:

Original file line number	Diff line number	Diff line change
`@@ -2320,7 +2320,7 @@ void NumericRangeDialog::OnCommand(wxCommandEvent &evt)`
`2320`	`2320`	`switch(evt.GetId())`
`2321`	`2321`	`{`
`2322`	`2322`	`case wxID_HELP:`
`2323`		`- SamApp::ShowHelp("edit_parametric_variables");`
	`2323`	`+ SamApp::ShowHelp("window-reference/win_edit_parametric_variables");`
`2324`	`2324`	`break;`
`2325`	`2325`
`2326`	`2326`	`case ID_values:`
Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,7 @@ void CombineCasesDialog::OnEvt(wxCommandEvent& e)`
`125`	`125`	`switch (e.GetId())`
`126`	`126`	`{`
`127`	`127`	`case wxID_HELP:`
`128`		`- SamApp::ShowHelp("combine_cases");`
	`128`	`+ SamApp::ShowHelp("window-reference/win_combine_cases");`
`129`	`129`	`break;`
`130`	`130`	`case ID_chlCases:`
`131`	`131`	`{`
Original file line number	Diff line number	Diff line change
`@@ -109,7 +109,7 @@ class SettingsDialog : public wxDialog`
`109`	`109`	`break;`
`110`	`110`
`111`	`111`	`case wxID_HELP:`
`112`		`- SamApp::ShowHelp("weather_manage_folders");`
	`112`	`+ SamApp::ShowHelp("weather-data/weather_manage_folders");`
`113`	`113`	`break;`
`114`	`114`	`}`
`115`	`115`	`}`
Original file line number	Diff line number	Diff line change
`@@ -437,7 +437,7 @@ class LossAdjustmentDialog : public wxDialog`
`437`	`437`	`switch( e.GetId() )`
`438`	`438`	`{`
`439`	`439`	`case wxID_HELP:`
`440`		`- SamApp::ShowHelp("edit_losses");`
	`440`	`+ SamApp::ShowHelp("window-reference/win_edit_losses");`
`441`	`441`	`break;`
`442`	`442`	`//case ID_ENABLE_HOURLY:`
`443`	`443`	`case ID_ENABLE_INDEX:`
Original file line number	Diff line number	Diff line change
`@@ -949,7 +949,7 @@ void MainWindow::OnCommand( wxCommandEvent &evt )`
`949`	`949`	`switch( evt.GetId() )`
`950`	`950`	`{`
`951`	`951`	`case wxID_HELP:`
`952`		`- SamApp::ShowHelp( cwin ? cwin->GetCurrentContext() : wxString("welcome_page") );`
	`952`	`+ SamApp::ShowHelp( cwin ? cwin->GetCurrentContext() : wxString("index") );`
`953`	`953`	`break;`
`954`	`954`	`case wxID_ABOUT:`
`955`	`955`	`SamApp::ShowHelp( ":about" );`
Original file line number	Diff line number	Diff line change
`@@ -205,7 +205,7 @@ void MatPropDialog::OnCommand(wxCommandEvent &evt)`
`205`	`205`	`{`
`206`	`206`	`case ID_IMPORT: Import(); break;`
`207`	`207`	`case ID_EXPORT: Export(); break;`
`208`		`- case wxID_HELP: SamApp::ShowHelp("edit_material_properties"); break;`
	`208`	`+ case wxID_HELP: SamApp::ShowHelp("window-reference/win_edit_material_properties"); break;`
`209`	`209`	`}`
`210`	`210`	`}`
`211`	`211`
Original file line number	Diff line number	Diff line change
`@@ -222,7 +222,7 @@ void NOHRSCDialog::OnEvt(wxCommandEvent& e)`
`222`	`222`	`switch (e.GetId())`
`223`	`223`	`{`
`224`	`224`	`case wxID_HELP:`
`225`		`- SamApp::ShowHelp("NOHRSC_advanced_download");`
	`225`	`+ SamApp::ShowHelp("window-reference/win_nohrsc_advanced_download");`
`226`	`226`	`break;`
`227`	`227`	`case ID_btnResources:`
`228`	`228`	`{`
Original file line number	Diff line number	Diff line change
`@@ -185,7 +185,7 @@ void NSRDBDialog::OnEvt( wxCommandEvent &e )`
`185`	`185`	`switch( e.GetId() )`
`186`	`186`	`{`
`187`	`187`	`case wxID_HELP:`
`188`		`- SamApp::ShowHelp("nsrdb_advanced_download");`
	`188`	`+ SamApp::ShowHelp("window-reference/win_nsrdb_advanced_download");`
`189`	`189`	`break;`
`190`	`190`	`case ID_btnResources:`
`191`	`191`	`{`
Original file line number	Diff line number	Diff line change
`@@ -3630,7 +3630,7 @@ void Parametric_QS::OnCommand(wxCommandEvent &evt)`
`3630`	`3630`	`}`
`3631`	`3631`	`case wxID_HELP:`
`3632`	`3632`	`{`
`3633`		`- SamApp::ShowHelp("parametric_quick_setup");`
	`3633`	`+ SamApp::ShowHelp("window-reference/win_parametric_quick_setup");`
`3634`	`3634`	`break;`
`3635`	`3635`	`}`
`3636`	`3636`	`case ID_setupOption:`