Issue 8874 (#8999)

* Use specific release version instead of latest for users guide * Open the users guide corresponding to the installed version Fixes #8874
OpenModelica · May 23, 2022 · f8100c1 · f8100c1
1 parent c88cc98
commit f8100c1
Show file tree

Hide file tree

Showing 8 changed files with 28 additions and 18 deletions.
diff --git a/OMEdit/OMEditLIB/MainWindow.cpp b/OMEdit/OMEditLIB/MainWindow.cpp
@@ -2807,7 +2807,7 @@ void MainWindow::runOMSensPlugin()
  */
 void MainWindow::openUsersGuide()
 {
-  QUrl usersGuidePath("https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/");
+  QUrl usersGuidePath(QString("https://openmodelica.org/doc/OpenModelicaUsersGuide/%1/").arg(Helper::OpenModelicaUsersGuideVersion));
   QDesktopServices::openUrl(usersGuidePath);
 }
 

diff --git a/OMEdit/OMEditLIB/Modeling/InstallLibraryDialog.cpp b/OMEdit/OMEditLIB/Modeling/InstallLibraryDialog.cpp
@@ -51,7 +51,7 @@ InstallLibraryDialog::InstallLibraryDialog(QDialog *parent)
   setMinimumWidth(400);
   Label *pHeadingLabel = Utilities::getHeadingLabel(Helper::installLibrary);
   pHeadingLabel->setElideMode(Qt::ElideMiddle);
-  Label *pPackageManagerText = new Label(tr("The library will be installed using the <u><a href=\"https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/packagemanager.html#the-package-manager\">package manager</a></u>."));
+  Label *pPackageManagerText = new Label(tr("The library will be installed using the <u><a href=\"https://openmodelica.org/doc/OpenModelicaUsersGuide/%1/packagemanager.html#the-package-manager\">package manager</a></u>.").arg(Helper::OpenModelicaUsersGuideVersion));
   pPackageManagerText->setOpenExternalLinks(true);
   pPackageManagerText->setTextInteractionFlags(Qt::TextBrowserInteraction);
   // support levels

diff --git a/OMEdit/OMEditLIB/OMC/OMCProxy.cpp b/OMEdit/OMEditLIB/OMC/OMCProxy.cpp
@@ -259,7 +259,23 @@ bool OMCProxy::initializeOMC(threadData_t *threadData)
   connect(mpOMCInterface, SIGNAL(throwException(QString)), SLOT(showException(QString)));
   mHasInitialized = true;
   // get OpenModelica version
-  Helper::OpenModelicaVersion = getVersion();
+  QString version = getVersion();
+  Helper::OpenModelicaVersion = version;
+  // set users guide version
+  QString versionShort;
+  int dots = 0;
+  for (int i=0; i < version.length(); i++) {
+    if (version.at(i).isDigit()) {
+      versionShort.append(version.at(i));
+    } else if (version.at(i) == '.') {
+      dots++;
+      if (dots > 1) {
+        break;
+      }
+      versionShort.append(version.at(i));
+    }
+  }
+  Helper::OpenModelicaUsersGuideVersion = versionShort;
   // set OpenModelicaHome variable
   Helper::OpenModelicaHome = mpOMCInterface->getInstallationDirectoryPath().replace("\\", "/");
   // set ModelicaPath variale

diff --git a/OMEdit/OMEditLIB/OMC/OMCProxy.h b/OMEdit/OMEditLIB/OMC/OMCProxy.h
@@ -46,6 +46,7 @@ class ElementInfo;
 class StringHandler;
 class OMCInterface;
 class LibraryTreeItem;
+class QNetworkReply;
 
 typedef struct {
   QString mFromUnit;

diff --git a/OMEdit/OMEditLIB/Simulation/SimulationDialog.cpp b/OMEdit/OMEditLIB/Simulation/SimulationDialog.cpp
@@ -2046,11 +2046,8 @@ void SimulationDialog::enableDasslIdaOptions(QString method)
  */
 void SimulationDialog::showIntegrationHelp()
 {
-  QUrl integrationAlgorithmsPath ("https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/simulationflags.html#integration-methods");
-  if (!QDesktopServices::openUrl(integrationAlgorithmsPath)) {
-    QMessageBox::critical(this, QString("%1 - %2").arg(Helper::applicationName, Helper::error),
-                          GUIMessages::getMessage(GUIMessages::UNABLE_TO_OPEN_FILE).arg(integrationAlgorithmsPath.toString()), Helper::ok);
-  }
+  QUrl integrationAlgorithmsPath(QString("https://openmodelica.org/doc/OpenModelicaUsersGuide/%1/simulationflags.html#integration-methods").arg(Helper::OpenModelicaUsersGuideVersion));
+  QDesktopServices::openUrl(integrationAlgorithmsPath);
 }
 
 /*!
@@ -2112,11 +2109,8 @@ void SimulationDialog::browseEquationSystemInitializationFile()
  */
 void SimulationDialog::showSimulationFlagsHelp()
 {
-  QUrl simulationflagsPath ("https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/simulationflags.html");
-  if (!QDesktopServices::openUrl(simulationflagsPath)) {
-    QMessageBox::critical(this, QString("%1 - %2").arg(Helper::applicationName, Helper::error),
-                          GUIMessages::getMessage(GUIMessages::UNABLE_TO_OPEN_FILE).arg(simulationflagsPath.toString()), Helper::ok);
-  }
+  QUrl simulationflagsPath(QString("https://openmodelica.org/doc/OpenModelicaUsersGuide/%1/simulationflags.html").arg(Helper::OpenModelicaUsersGuideVersion));
+  QDesktopServices::openUrl(simulationflagsPath);
 }
 
 /*!

diff --git a/OMEdit/OMEditLIB/Simulation/TranslationFlagsWidget.cpp b/OMEdit/OMEditLIB/Simulation/TranslationFlagsWidget.cpp
@@ -203,9 +203,6 @@ QString TranslationFlagsWidget::commandLineOptions()
  */
 void TranslationFlagsWidget::showTranslationFlagsHelp()
 {
-  QUrl omcHelpTextPath ("https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/omchelptext.html");
-  if (!QDesktopServices::openUrl(omcHelpTextPath)) {
-    QMessageBox::critical(this, QString("%1 - %2").arg(Helper::applicationName, Helper::error),
-                          GUIMessages::getMessage(GUIMessages::UNABLE_TO_OPEN_FILE).arg(omcHelpTextPath.toString()), Helper::ok);
-  }
+  QUrl omcHelpTextPath(QString("https://openmodelica.org/doc/OpenModelicaUsersGuide/%1/omchelptext.html").arg(Helper::OpenModelicaUsersGuideVersion));
+  QDesktopServices::openUrl(omcHelpTextPath);
 }
diff --git a/OMEdit/OMEditLIB/Util/Helper.cpp b/OMEdit/OMEditLIB/Util/Helper.cpp
@@ -42,6 +42,7 @@ QString Helper::organization = "openmodelica";  /* case-sensitive string. Don't
 QString Helper::application = "omedit"; /* case-sensitive string. Don't change it. Used by ini settings file. */
 // Following four variables are set once we are connected to OMC......in OMCProxy::initializeOMC().
 QString Helper::OpenModelicaVersion = "";
+QString Helper::OpenModelicaUsersGuideVersion = "latest";
 QString Helper::OpenModelicaHome = "";
 QString Helper::ModelicaPath = "";
 QString Helper::userHomeDirectory = "";

diff --git a/OMEdit/OMEditLIB/Util/Helper.h b/OMEdit/OMEditLIB/Util/Helper.h
@@ -56,6 +56,7 @@ class Helper : public QObject
   static QString organization;
   static QString application;
   static QString OpenModelicaVersion;
+  static QString OpenModelicaUsersGuideVersion;
   static QString OpenModelicaHome;
   static QString ModelicaPath;
   static QString userHomeDirectory;