haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Redirect to website when help files are missing 

In case the documentation and help files from kicad-doc are not
installed or are located in a folder where KiCad cannot find them, an
info dialog is shown offering the user the option to access the online
help system instead.

Fixes https://gitlab.com/kicad/code/kicad/issues/2142
This commit is contained in:
Marcus A. Romer 2021-04-13 20:06:09 +02:00 committed by Wayne Stambaugh
parent c5e77e9739
commit 6fdf567b21
1 changed files with 25 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
common/tool/common_control.cpp
View File

@ -25,6 +25,7 @@
#include <bitmaps.h> #include <bitmaps.h>
#include <build_version.h> #include <build_version.h>
#include <common.h> // for SearchHelpFileFullPath #include <common.h> // for SearchHelpFileFullPath
#include <pgm_base.h>
#include <tool/actions.h> #include <tool/actions.h>
#include <tool/tool_manager.h> #include <tool/tool_manager.h>
#include <eda_draw_frame.h> #include <eda_draw_frame.h>
@ -40,6 +41,7 @@
#define URL_GET_INVOLVED "https://kicad.org/contribute/" #define URL_GET_INVOLVED "https://kicad.org/contribute/"
#define URL_DONATE "https://go.kicad.org/app-donate" #define URL_DONATE "https://go.kicad.org/app-donate"
#define URL_DOCUMENTATION "https://docs.kicad.org/"
/// URL to launch a new issue with pre-populated description /// URL to launch a new issue with pre-populated description
@ -169,6 +171,10 @@ int COMMON_CONTROL::ShowHelp( const TOOL_EVENT& aEvent )
wxString helpFile; wxString helpFile;
wxString msg; wxString msg;
// the URL of help files is "https://docs.kicad.org/<version>/<language>/<name>/"
const wxString baseUrl = URL_DOCUMENTATION + GetMajorMinorVersion() + "/"
+ Pgm().GetLocale()->GetName().BeforeLast( '_' ) + "/";
/* We have to get document for beginners, /* We have to get document for beginners,
* or the full specific doc * or the full specific doc
* if event id is wxID_INDEX, we want the document for beginners. * if event id is wxID_INDEX, we want the document for beginners.
@ -195,10 +201,16 @@ int COMMON_CONTROL::ShowHelp( const TOOL_EVENT& aEvent )
if( !helpFile ) if( !helpFile )
{ {
msg = wxString::Format( _( "Help file \"%s\" or\n\"%s\" could not be found." ), msg = wxString::Format( _( "Help file \"%s\" or\n\"%s\" could not be found.\n"
"Do you want to access the KiCad online help?" ),
names[0], names[1] ); names[0], names[1] );
wxMessageBox( msg ); wxMessageDialog dlg( NULL, msg, _( "File Not Found" ),
wxYES_NO | wxNO_DEFAULT | wxCANCEL );
if( dlg.ShowModal() != wxID_YES )
return -1; return -1;
helpFile = baseUrl + names[0] + "/";
} }
} }
else else
@ -209,9 +221,16 @@ int COMMON_CONTROL::ShowHelp( const TOOL_EVENT& aEvent )
if( !helpFile ) if( !helpFile )
{ {
msg = wxString::Format( _( "Help file \"%s\" could not be found." ), base_name ); msg = wxString::Format( _( "Help file \"%s\" could not be found.\n"
wxMessageBox( msg ); "Do you want to access the KiCad online help?" ),
base_name );
wxMessageDialog dlg( NULL, msg, _( "File Not Found" ),
wxYES_NO | wxNO_DEFAULT | wxCANCEL );
if( dlg.ShowModal() != wxID_YES )
return -1; return -1;
helpFile = baseUrl + base_name + "/";
} }
} }