Make documentation buttons etc. open docs.opensimcreator.com (#1048).

Author: adamkewley

CHANGELOG.md

@@ -5,6 +5,8 @@ on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## [Upcoming Release]
 
+- The documentation link shown on the splash screen or help menu is now
+  set at compile time to be equal to `docs.opensimcreator.com` (#1048).
 - Attempting to import an incorrect `.osim` file into the mesh importer now
   results in a log error message rather than a crashing exception
   (thanks @davidpagnon, #1050).

libopensimcreator/Platform/OpenSimCreatorApp.cpp

@@ -179,13 +179,3 @@ TabRegistry& osc::OpenSimCreatorApp::upd_tab_registry()
 {
     return *singleton<TabRegistry>();
 }
-
-std::string osc::OpenSimCreatorApp::docs_url() const
-{
-    if (const auto runtime_url = settings().find_value("docs_url")) {
-        return to<std::string>(*runtime_url);
-    }
-    else {
-        return "https://docs.opensimcreator.com";
-    }
-}

libopensimcreator/Platform/OpenSimCreatorApp.h

@@ -41,7 +41,5 @@ namespace osc
         using App::show;
 
         TabRegistry& upd_tab_registry();
-
-        std::string docs_url() const;
     };
 }

libopensimcreator/UI/Shared/MainMenu.cpp

@@ -436,16 +436,19 @@ void osc::MainMenuAboutTab::onDraw()
     {
         ui::set_num_columns(2);
 
-        ui::draw_text("OpenSim Creator Documentation");
-        ui::next_column();
-        ui::push_id(id++);
-        if (ui::draw_button(OSC_ICON_LINK " open"))
+        if (auto docsURL = App::get().metadata().documentation_url())
         {
-            open_url_in_os_default_web_browser(OpenSimCreatorApp::get().docs_url());
+            ui::draw_text("OpenSim Creator Documentation");
+            ui::next_column();
+            ui::push_id(id++);
+            if (ui::draw_button(OSC_ICON_LINK " open"))
+            {
+                open_url_in_os_default_web_browser(*docsURL);
+            }
+            ui::draw_tooltip_body_only_if_item_hovered("this will open the documentation in a separate browser window");
+            ui::pop_id();
+            ui::next_column();
         }
-        ui::draw_tooltip_body_only_if_item_hovered("this will open the (locally installed) documentation in a separate browser window");
-        ui::pop_id();
-        ui::next_column();
 
         if (auto repoURL = App::get().metadata().repository_url())
         {

libopensimcreator/UI/SplashTab.cpp

@@ -262,8 +262,10 @@ class osc::SplashTab::Impl final : public TabPrivate {
             App::post_event<OpenTabEvent>(*parent(), std::move(tab));
         }
         ui::add_screenshot_annotation_to_last_drawn_item("SplashTab/ImportMeshesMenuItem");
-        if (ui::draw_menu_item(OSC_ICON_BOOK " Open Documentation")) {
-            open_url_in_os_default_web_browser(OpenSimCreatorApp::get().docs_url());
+        if (const auto docsURL = App::get().metadata().documentation_url()) {
+            if (ui::draw_menu_item(OSC_ICON_BOOK " Open Documentation")) {
+                open_url_in_os_default_web_browser(*docsURL);
+            }
         }
     }
 

liboscar/Platform/AppMetadata.h

@@ -33,6 +33,9 @@ namespace osc
         std::optional<CStringView> repository_url() const { return repository_url_; }
         void set_repository_url(std::string_view new_repository_url) { repository_url_ = new_repository_url; }
 
+        std::optional<CStringView> documentation_url() const { return documentation_url_; }
+        void set_documentation_url(std::string_view new_documentation_url) { documentation_url_ = new_documentation_url; }
+
         std::optional<CStringView> help_url() const { return help_url_; }
         void set_help_url(std::string_view new_help_url) { help_url_ = new_help_url; }
 
@@ -51,6 +54,7 @@ namespace osc
         std::optional<std::string> version_string_;
         std::optional<std::string> build_id_;
         std::optional<std::string> repository_url_;
+        std::optional<std::string> documentation_url_;
         std::optional<std::string> help_url_;
     };
 }

osc/CMakeLists.txt

@@ -6,6 +6,12 @@ set(
     "the internet location of the software's repo - used by in-app links, installers, etc."
 )
 mark_as_advanced(OSC_REPO_URL)
+set(
+    OSC_DOCS_URL "https://docs.opensimcreator.com"
+    CACHE STRING
+    "a url for the software's documentation - used by in-app links, installers, etc."
+)
+mark_as_advanced(OSC_DOCS_URL)
 set(
     OSC_HELP_URL "https://github.com/ComputationalBiomechanicsLab/opensim-creator/discussions"
     CACHE STRING

osc/osc.cpp

@@ -35,6 +35,7 @@ namespace
         metadata.set_build_id(OSC_BUILD_ID);
         metadata.set_repository_url(OSC_REPO_URL);
         metadata.set_help_url(OSC_HELP_URL);
+        metadata.set_documentation_url(OSC_DOCS_URL);
         return metadata;
     }
 }

osc/osc_config.h.in

@@ -28,11 +28,16 @@
 
 // char[]
 //
-// the internet location of the OSC repo. Used by in-app links, shortcuts, etc.
-// to the repo so that users can just click and go, rather than having to separately
-// browse to the repo
+// a URL for OSC's source code repo. Used by in-app links, shortcuts, etc. so that
+// users can just click and go, rather than having to separately browse to it.
 #define OSC_REPO_URL "@OSC_REPO_URL@"
 
+// char[]
+//
+// a URL for the OSC's documentation Used by in-app links, shortcuts, etc. so that
+// users can just click and go, rather than having to separately browse to it.
+#define OSC_DOCS_URL "@OSC_DOCS_URL@"
+
 // char[]
 //
 // the internet location for a "help site", which is loosely defined as somewhere the user

osc/osc_dev_config.toml.in

@@ -12,7 +12,6 @@
 # INSTALL configuration file.
 
 resources = "@CMAKE_CURRENT_SOURCE_DIR@/../resources"
-docs_url = "file://@CMAKE_CURRENT_SOURCE_DIR@/../docs/build/index.html"
 
 # change this if you need OSC to print more information to the log
 # log_level = "trace"  # trace < debug < info < warn < err < critical