Improve documentation and help tools (#1307)

- Enhance help functions in modules/help_browser/functions/doc.m - Update homepage documentation in modules/main/help/en_US/md/homepage.md - `urlencode`: Replace special characters in URLs with escape characters. - `docroot`: Utility to retrieve or define the root directory of Nelson Help. - `ismodule`: second input argument `isprotected` added. - Updated various resource files across multiple modules (v1.11.0 family). - Updated RemoveDirectory.cpp to fix directory removal issues - Modified Which.cpp to improve functionality - Added new test file test_which.m to cover the changes
nelson-lang · Dec 23, 2024 · b2e908b · b2e908b
1 parent 3c66db9
commit b2e908b
Show file tree

Hide file tree

Showing 184 changed files with 1,211 additions and 709 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.11.0 (UNRELEASED)
+
+### Added
+
+- `urlencode`: Replace special characters in URLs with escape characters.
+- `docroot`: Utility to retrieve or define the root directory of Nelson Help.
+- `ismodule`: second input argument `isprotected` added.
+
+### Changed
+
+- Help Center: Access documentation in your system's web browser. Previously, the documentation was opened in the embedded Help browser.
+
 ## 1.10.0 (2024-12-14)
 
 ### Added

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -32,7 +32,7 @@ else()
 endif()
 # ==============================================================================
 set(Nelson_VERSION_MAJOR_DEFAULT 1)
-set(Nelson_VERSION_MINOR_DEFAULT 10)
+set(Nelson_VERSION_MINOR_DEFAULT 11)
 set(Nelson_VERSION_MAINTENANCE_DEFAULT 0)
 set(Nelson_VERSION_BUILD_DEFAULT 0)
 # ==============================================================================

diff --git a/etc/defaults.conf b/etc/defaults.conf
@@ -1,5 +1,6 @@
 {
     "update_url": "https://api.github.com/repos/nelson-lang/nelson/releases/latest",
     "website_url": "https://nelson-lang.github.io/nelson-website/",
-    "issues_url": "https://github.com/nelson-lang/nelson/issues"
-}
+    "issues_url": "https://github.com/nelson-lang/nelson/issues",
+    "docbook_url": "https://nelson-lang.github.io/nelson-gitbook/releases"
+}
diff --git a/modules/assert_functions/builtin/c/resources.rc b/modules/assert_functions/builtin/c/resources.rc
@@ -49,8 +49,8 @@ END
 //
 
 VS_VERSION_INFO VERSIONINFO
- FILEVERSION 1,10,0,0
- PRODUCTVERSION 1,10,0,0
+ FILEVERSION 1,11,0,0
+ PRODUCTVERSION 1,11,0,0
  FILEFLAGSMASK 0x17L
 #ifdef _DEBUG
  FILEFLAGS 0x1L
@@ -69,8 +69,8 @@ BEGIN
             VALUE "InternalName", "assert_functions_builtin"
             VALUE "OriginalFilename", "libnlsassert_functions_builtin.dll"
             VALUE "ProductName", "Nelson (assert_functions_builtin)"
-            VALUE "ProductVersion", "1,10,0,0"
-            VALUE "FileVersion", "1,10,0,0"
+            VALUE "ProductVersion", "1,11,0,0"
+            VALUE "FileVersion", "1,11,0,0"
             VALUE "LegalCopyright", "Nelson Copyright (C) 2016-present"
             VALUE "Comments", "All rights reserved."
             VALUE "CompanyName", "Allan CORNET"

diff --git a/modules/assert_functions/src/c/resources.rc b/modules/assert_functions/src/c/resources.rc
@@ -49,8 +49,8 @@ END
 //
 
 VS_VERSION_INFO VERSIONINFO
- FILEVERSION 1,10,0,0
- PRODUCTVERSION 1,10,0,0
+ FILEVERSION 1,11,0,0
+ PRODUCTVERSION 1,11,0,0
  FILEFLAGSMASK 0x17L
 #ifdef _DEBUG
  FILEFLAGS 0x1L
@@ -69,8 +69,8 @@ BEGIN
             VALUE "InternalName", "assert_functions"
             VALUE "OriginalFilename", "libnlsassert_functions.dll"
             VALUE "ProductName", "Nelson (assert_functions)"
-            VALUE "ProductVersion", "1,10,0,0"
-            VALUE "FileVersion", "1,10,0,0"
+            VALUE "ProductVersion", "1,11,0,0"
+            VALUE "FileVersion", "1,11,0,0"
             VALUE "LegalCopyright", "Nelson Copyright (C) 2016-present"
             VALUE "Comments", "All rights reserved."
             VALUE "CompanyName", "Allan CORNET"

diff --git a/modules/audio/builtin/c/resources.rc b/modules/audio/builtin/c/resources.rc
@@ -49,8 +49,8 @@ END
 //
 
 VS_VERSION_INFO VERSIONINFO
- FILEVERSION 1,10,0,0
- PRODUCTVERSION 1,10,0,0
+ FILEVERSION 1,11,0,0
+ PRODUCTVERSION 1,11,0,0
  FILEFLAGSMASK 0x17L
 #ifdef _DEBUG
  FILEFLAGS 0x1L
@@ -69,8 +69,8 @@ BEGIN
             VALUE "InternalName", "audio_builtin"
             VALUE "OriginalFilename", "libnlsaudio_builtin.dll"
             VALUE "ProductName", "Nelson (audio_builtin)"
-            VALUE "ProductVersion", "1,10,0,0"
-            VALUE "FileVersion", "1,10,0,0"
+            VALUE "ProductVersion", "1,11,0,0"
+            VALUE "FileVersion", "1,11,0,0"
             VALUE "LegalCopyright", "Nelson Copyright (C) 2016-present"
             VALUE "Comments", "All rights reserved."
             VALUE "CompanyName", "Allan CORNET"

diff --git a/modules/audio/src/c/resources.rc b/modules/audio/src/c/resources.rc
@@ -49,8 +49,8 @@ END
 //
 
 VS_VERSION_INFO VERSIONINFO
- FILEVERSION 1,10,0,0
- PRODUCTVERSION 1,10,0,0
+ FILEVERSION 1,11,0,0
+ PRODUCTVERSION 1,11,0,0
  FILEFLAGSMASK 0x17L
 #ifdef _DEBUG
  FILEFLAGS 0x1L
@@ -69,8 +69,8 @@ BEGIN
             VALUE "InternalName", "audio"
             VALUE "OriginalFilename", "libnlsaudio.dll"
             VALUE "ProductName", "Nelson (audio)"
-            VALUE "ProductVersion", "1,10,0,0"
-            VALUE "FileVersion", "1,10,0,0"
+            VALUE "ProductVersion", "1,11,0,0"
+            VALUE "FileVersion", "1,11,0,0"
             VALUE "LegalCopyright", "Nelson Copyright (C) 2016-present"
             VALUE "Comments", "All rights reserved."
             VALUE "CompanyName", "Allan CORNET"

diff --git a/modules/characters_encoding/builtin/c/resources.rc b/modules/characters_encoding/builtin/c/resources.rc
@@ -49,8 +49,8 @@ END
 //
 
 VS_VERSION_INFO VERSIONINFO
- FILEVERSION 1,10,0,0
- PRODUCTVERSION 1,10,0,0
+ FILEVERSION 1,11,0,0
+ PRODUCTVERSION 1,11,0,0
  FILEFLAGSMASK 0x17L
 #ifdef _DEBUG
  FILEFLAGS 0x1L
@@ -69,8 +69,8 @@ BEGIN
             VALUE "InternalName", "characters_encoding_builtin"
             VALUE "OriginalFilename", "libnlscharacters_encoding_builtin.dll"
             VALUE "ProductName", "Nelson (characters_encoding_builtin)"
-            VALUE "ProductVersion", "1,10,0,0"
-            VALUE "FileVersion", "1,10,0,0"
+            VALUE "ProductVersion", "1,11,0,0"
+            VALUE "FileVersion", "1,11,0,0"
             VALUE "LegalCopyright", "Nelson Copyright (C) 2016-present"
             VALUE "Comments", "All rights reserved."
             VALUE "CompanyName", "Allan CORNET"

diff --git a/modules/characters_encoding/no-src/c/resources.rc b/modules/characters_encoding/no-src/c/resources.rc
@@ -49,8 +49,8 @@ END
 //
 
 VS_VERSION_INFO VERSIONINFO
- FILEVERSION 1,10,0,0
- PRODUCTVERSION 1,10,0,0
+ FILEVERSION 1,11,0,0
+ PRODUCTVERSION 1,11,0,0
  FILEFLAGSMASK 0x17L
 #ifdef _DEBUG
  FILEFLAGS 0x1L
@@ -69,8 +69,8 @@ BEGIN
             VALUE "InternalName", "no-characters_encoding"
             VALUE "OriginalFilename", "libno-nlscharacters_encoding.dll"
             VALUE "ProductName", "Nelson (no-characters_encoding)"
-            VALUE "ProductVersion", "1,10,0,0"
-            VALUE "FileVersion", "1,10,0,0"
+            VALUE "ProductVersion", "1,11,0,0"
+            VALUE "FileVersion", "1,11,0,0"
             VALUE "LegalCopyright", "Nelson Copyright (C) 2016-present"
             VALUE "Comments", "All rights reserved."
             VALUE "CompanyName", "Allan CORNET"

diff --git a/modules/characters_encoding/src/c/resources.rc b/modules/characters_encoding/src/c/resources.rc
@@ -49,8 +49,8 @@ END
 //
 
 VS_VERSION_INFO VERSIONINFO
- FILEVERSION 1,10,0,0
- PRODUCTVERSION 1,10,0,0
+ FILEVERSION 1,11,0,0
+ PRODUCTVERSION 1,11,0,0
  FILEFLAGSMASK 0x17L
 #ifdef _DEBUG
  FILEFLAGS 0x1L
@@ -69,8 +69,8 @@ BEGIN
             VALUE "InternalName", "characters_encoding"
             VALUE "OriginalFilename", "libnlscharacters_encoding.dll"
             VALUE "ProductName", "Nelson (characters_encoding)"
-            VALUE "ProductVersion", "1,10,0,0"
-            VALUE "FileVersion", "1,10,0,0"
+            VALUE "ProductVersion", "1,11,0,0"
+            VALUE "FileVersion", "1,11,0,0"
             VALUE "LegalCopyright", "Nelson Copyright (C) 2016-present"
             VALUE "Comments", "All rights reserved."
             VALUE "CompanyName", "Allan CORNET"

diff --git a/modules/com_engine/builtin/c/resources.rc b/modules/com_engine/builtin/c/resources.rc
@@ -49,8 +49,8 @@ END
 //
 
 VS_VERSION_INFO VERSIONINFO
- FILEVERSION 1,10,0,0
- PRODUCTVERSION 1,10,0,0
+ FILEVERSION 1,11,0,0
+ PRODUCTVERSION 1,11,0,0
  FILEFLAGSMASK 0x17L
 #ifdef _DEBUG
  FILEFLAGS 0x1L
@@ -69,8 +69,8 @@ BEGIN
             VALUE "InternalName", "com_engine_builtin"
             VALUE "OriginalFilename", "libnlscom_engine_builtin.dll"
             VALUE "ProductName", "Nelson (com_engine_builtin)"
-            VALUE "ProductVersion", "1,10,0,0"
-            VALUE "FileVersion", "1,10,0,0"
+            VALUE "ProductVersion", "1,11,0,0"
+            VALUE "FileVersion", "1,11,0,0"
             VALUE "LegalCopyright", "Nelson Copyright (C) 2016-present"
             VALUE "Comments", "All rights reserved."
             VALUE "CompanyName", "Allan CORNET"

diff --git a/modules/com_engine/src/c/resources.rc b/modules/com_engine/src/c/resources.rc
@@ -49,8 +49,8 @@ END
 //
 
 VS_VERSION_INFO VERSIONINFO
- FILEVERSION 1,10,0,0
- PRODUCTVERSION 1,10,0,0
+ FILEVERSION 1,11,0,0
+ PRODUCTVERSION 1,11,0,0
  FILEFLAGSMASK 0x17L
 #ifdef _DEBUG
  FILEFLAGS 0x1L
@@ -69,8 +69,8 @@ BEGIN
             VALUE "InternalName", "com_engine"
             VALUE "OriginalFilename", "libnlscom_engine.dll"
             VALUE "ProductName", "Nelson (com_engine)"
-            VALUE "ProductVersion", "1,10,0,0"
-            VALUE "FileVersion", "1,10,0,0"
+            VALUE "ProductVersion", "1,11,0,0"
+            VALUE "FileVersion", "1,11,0,0"
             VALUE "LegalCopyright", "Nelson Copyright (C) 2016-present"
             VALUE "Comments", "All rights reserved."
             VALUE "CompanyName", "Allan CORNET"

diff --git a/modules/commons/src/c/resources.rc b/modules/commons/src/c/resources.rc
@@ -49,8 +49,8 @@ END
 //
 
 VS_VERSION_INFO VERSIONINFO
- FILEVERSION 1,10,0,0
- PRODUCTVERSION 1,10,0,0
+ FILEVERSION 1,11,0,0
+ PRODUCTVERSION 1,11,0,0
  FILEFLAGSMASK 0x17L
 #ifdef _DEBUG
  FILEFLAGS 0x1L
@@ -69,8 +69,8 @@ BEGIN
             VALUE "InternalName", "commons"
             VALUE "OriginalFilename", "libnlsCommons.dll"
             VALUE "ProductName", "Nelson (commons)"
-            VALUE "ProductVersion", "1,10,0,0"
-            VALUE "FileVersion", "1,10,0,0"
+            VALUE "ProductVersion", "1,11,0,0"
+            VALUE "FileVersion", "1,11,0,0"
             VALUE "LegalCopyright", "Nelson Copyright (C) 2016-present"
             VALUE "Comments", "All rights reserved."
             VALUE "CompanyName", "Allan CORNET"

diff --git a/modules/commons/src/include/Nelson_VERSION.h.in b/modules/commons/src/include/Nelson_VERSION.h.in
@@ -16,7 +16,7 @@
 #define NELSON_VERSION_MINOR @Nelson_VERSION_MINOR@
 #define NELSON_VERSION_MAINTENANCE @Nelson_VERSION_MAINTENANCE@
 #define NELSON_VERSION_BUILD @Nelson_VERSION_BUILD@
-#define NELSON_VERSION_COMMIT_HASH "9e906d3b6bccda9a0613da10e94c217433f8e95f"
+#define NELSON_VERSION_COMMIT_HASH "166d6e57091605744d4b1fd736e77bf3e7b3e8dc"
 
 /*VERSION string */
 #define __quote(x) #x

diff --git a/modules/commons/src/include/Nelson_VERSION.h.vc b/modules/commons/src/include/Nelson_VERSION.h.vc
@@ -13,10 +13,10 @@
 #define NELSON_PRODUCT_NAME "Nelson"
 #define NELSON_RELEASE_NAME "Fortitude"
 #define NELSON_VERSION_MAJOR 1
-#define NELSON_VERSION_MINOR 10
+#define NELSON_VERSION_MINOR 11
 #define NELSON_VERSION_MAINTENANCE 0
 #define NELSON_VERSION_BUILD 0
-#define NELSON_VERSION_COMMIT_HASH "9e906d3b6bccda9a0613da10e94c217433f8e95f"
+#define NELSON_VERSION_COMMIT_HASH "166d6e57091605744d4b1fd736e77bf3e7b3e8dc"
 
 /*VERSION string */
 #define __quote(x) #x

diff --git a/modules/console/builtin/c/resources.rc b/modules/console/builtin/c/resources.rc
@@ -49,8 +49,8 @@ END
 //
 
 VS_VERSION_INFO VERSIONINFO
- FILEVERSION 1,10,0,0
- PRODUCTVERSION 1,10,0,0
+ FILEVERSION 1,11,0,0
+ PRODUCTVERSION 1,11,0,0
  FILEFLAGSMASK 0x17L
 #ifdef _DEBUG
  FILEFLAGS 0x1L
@@ -69,8 +69,8 @@ BEGIN
             VALUE "InternalName", "console_builtin"
             VALUE "OriginalFilename", "libnlsconsole_builtin.dll"
             VALUE "ProductName", "Nelson (console_builtin)"
-            VALUE "ProductVersion", "1,10,0,0"
-            VALUE "FileVersion", "1,10,0,0"
+            VALUE "ProductVersion", "1,11,0,0"
+            VALUE "FileVersion", "1,11,0,0"
             VALUE "LegalCopyright", "Nelson Copyright (C) 2016-present"
             VALUE "Comments", "All rights reserved."
             VALUE "CompanyName", "Allan CORNET"

diff --git a/modules/console/src/c/resources.rc b/modules/console/src/c/resources.rc
@@ -49,8 +49,8 @@ END
 //
 
 VS_VERSION_INFO VERSIONINFO
- FILEVERSION 1,10,0,0
- PRODUCTVERSION 1,10,0,0
+ FILEVERSION 1,11,0,0
+ PRODUCTVERSION 1,11,0,0
  FILEFLAGSMASK 0x17L
 #ifdef _DEBUG
  FILEFLAGS 0x1L
@@ -69,8 +69,8 @@ BEGIN
             VALUE "InternalName", "console"
             VALUE "OriginalFilename", "libnlsconsole.dll"
             VALUE "ProductName", "Nelson (console)"
-            VALUE "ProductVersion", "1,10,0,0"
-            VALUE "FileVersion", "1,10,0,0"
+            VALUE "ProductVersion", "1,11,0,0"
+            VALUE "FileVersion", "1,11,0,0"
             VALUE "LegalCopyright", "Nelson Copyright (C) 2016-present"
             VALUE "Comments", "All rights reserved."
             VALUE "CompanyName", "Allan CORNET"

diff --git a/modules/constructors_functions/builtin/c/resources.rc b/modules/constructors_functions/builtin/c/resources.rc
@@ -49,8 +49,8 @@ END
 //
 
 VS_VERSION_INFO VERSIONINFO
- FILEVERSION 1,10,0,0
- PRODUCTVERSION 1,10,0,0
+ FILEVERSION 1,11,0,0
+ PRODUCTVERSION 1,11,0,0
  FILEFLAGSMASK 0x17L
 #ifdef _DEBUG
  FILEFLAGS 0x1L
@@ -69,8 +69,8 @@ BEGIN
             VALUE "InternalName", "constructors_functions_builtin"
             VALUE "OriginalFilename", "libnlsconstructors_functions_builtin.dll"
             VALUE "ProductName", "Nelson (constructors_functions_builtin)"
-            VALUE "ProductVersion", "1,10,0,0"
-            VALUE "FileVersion", "1,10,0,0"
+            VALUE "ProductVersion", "1,11,0,0"
+            VALUE "FileVersion", "1,11,0,0"
             VALUE "LegalCopyright", "Nelson Copyright (C) 2016-present"
             VALUE "Comments", "All rights reserved."
             VALUE "CompanyName", "Allan CORNET"

diff --git a/modules/constructors_functions/src/c/resources.rc b/modules/constructors_functions/src/c/resources.rc
@@ -49,8 +49,8 @@ END
 //
 
 VS_VERSION_INFO VERSIONINFO
- FILEVERSION 1,10,0,0
- PRODUCTVERSION 1,10,0,0
+ FILEVERSION 1,11,0,0
+ PRODUCTVERSION 1,11,0,0
  FILEFLAGSMASK 0x17L
 #ifdef _DEBUG
  FILEFLAGS 0x1L
@@ -69,8 +69,8 @@ BEGIN
             VALUE "InternalName", "constructors_functions"
             VALUE "OriginalFilename", "libnlsconstructors_functions.dll"
             VALUE "ProductName", "Nelson (constructors_functions)"
-            VALUE "ProductVersion", "1,10,0,0"
-            VALUE "FileVersion", "1,10,0,0"
+            VALUE "ProductVersion", "1,11,0,0"
+            VALUE "FileVersion", "1,11,0,0"
             VALUE "LegalCopyright", "Nelson Copyright (C) 2016-present"
             VALUE "Comments", "All rights reserved."
             VALUE "CompanyName", "Allan CORNET"

diff --git a/modules/core/builtin/c/resources.rc b/modules/core/builtin/c/resources.rc
@@ -49,8 +49,8 @@ END
 //
 
 VS_VERSION_INFO VERSIONINFO
- FILEVERSION 1,10,0,0
- PRODUCTVERSION 1,10,0,0
+ FILEVERSION 1,11,0,0
+ PRODUCTVERSION 1,11,0,0
  FILEFLAGSMASK 0x17L
 #ifdef _DEBUG
  FILEFLAGS 0x1L
@@ -69,8 +69,8 @@ BEGIN
             VALUE "InternalName", "core_builtin"
             VALUE "OriginalFilename", "libnlscore_builtin.dll"
             VALUE "ProductName", "Nelson (core_builtin)"
-            VALUE "ProductVersion", "1,10,0,0"
-            VALUE "FileVersion", "1,10,0,0"
+            VALUE "ProductVersion", "1,11,0,0"
+            VALUE "FileVersion", "1,11,0,0"
             VALUE "LegalCopyright", "Nelson Copyright (C) 2016-present"
             VALUE "Comments", "All rights reserved."
             VALUE "CompanyName", "Allan CORNET"