Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Merge pull request #3911 from alexbruy/generic-help
Generic help for QGIS
- Loading branch information
Showing
14 changed files
with
533 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!DOCTYPE html> | ||
<html> | ||
<head> | ||
<title>No help found</title> | ||
<meta charset="UTF-8"> | ||
</head> | ||
<body> | ||
<center><a href="http://qgis.org"><img src="qgis-icon-60x60.png" border=0></a></center> | ||
<h1><center>Oops!</center></h1> | ||
<p>QGIS help is currently not available. This is likely because:</p> | ||
<ul> | ||
<li>No internet connection is available</li> | ||
<li>The offline help files are not available or the location of these | ||
files is not properly configured</li> | ||
<li>No help content is available for the requested topic</li> | ||
</ul> | ||
<p>Please check that the correct location of the offline help files is | ||
specified in the QGIS options dialog (Settings → Options →System).</p> | ||
</body> | ||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
/** \ingroup gui | ||
* \class QgsHelp | ||
* @brief Helper class for showing help topic URI for the given key. | ||
* | ||
* Help can be stored online, on the local directory or on the intranet | ||
* server. Location of the QGIS help can be configured in QGIS options. | ||
* Multiple locations are supported, they will be used in order of | ||
* preference, from top to bottom. | ||
* | ||
* URI construction takes in account following information: | ||
* - QGIS version | ||
* - language of the QGIS UI | ||
* | ||
* If no help found, default error page with information how to setup | ||
* help system will be shown. | ||
* | ||
* @note added in QGIS 3.0 | ||
*/ | ||
class QgsHelp | ||
{ | ||
%TypeHeaderCode | ||
#include <qgshelp.h> | ||
%End | ||
|
||
public: | ||
|
||
/** Opens help topic for the given help key using default system | ||
* web browser. If help topic not found, builtin error page shown. | ||
* @param key key which identified help topic | ||
* @note added in QGIS 3.0 | ||
*/ | ||
static void openHelp( const QString& key ); | ||
|
||
/** Returns URI of the help topic for the given key. If help topic | ||
* not found, URI of the builtin error page returned. | ||
* @param key key which identified help topic | ||
* @note added in QGIS 3.0 | ||
*/ | ||
static QUrl helpUrl( const QString& key ); | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.