Skip to content

feat(help): rework help system and add French translations #1469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 24 commits into from
Oct 26, 2025
Merged

feat(help): rework help system and add French translations #1469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
407ecb7
help v2 in progress ...
Nelson-numerical-software Sep 21, 2025
7271c82
chore: regenerate all images (windows x64 , release) (#1461)
Nelson-numerical-software Oct 12, 2025
030828a
doc: missing french translation
Nelson-numerical-software Oct 12, 2025
5006c9d
doc: missing images
Nelson-numerical-software Oct 12, 2025
5a25b62
doc: missing images
Nelson-numerical-software Oct 12, 2025
f116de2
add latex support in help files
Nelson-numerical-software Oct 16, 2025
f325d9f
add button edit on github
Nelson-numerical-software Oct 17, 2025
3b84835
chore: remove qhelpgenerator no more required
Nelson-numerical-software Oct 18, 2025
f0731d9
chore: fix typo
Nelson-numerical-software Oct 18, 2025
c3e3101
chore: embed xml files
Nelson-numerical-software Oct 18, 2025
8580051
update translations
Nelson-numerical-software Oct 19, 2025
02a405b
embed mathjax
Nelson-numerical-software Oct 19, 2025
8dde3b2
fix syntax colorization examples
Nelson-numerical-software Oct 19, 2025
a1608c1
fix duplicate files
Nelson-numerical-software Oct 19, 2025
da657c7
colorize syntax block
Nelson-numerical-software Oct 19, 2025
d73cebd
Enhance XML and Markdown Documentation Rendering
Nelson-numerical-software Oct 20, 2025
909887a
fix CodeQL warnings
Nelson-numerical-software Oct 21, 2025
c4ce98c
fix dark theme support (syntax, examples)
Nelson-numerical-software Oct 21, 2025
32f6363
Enhance dark theme support across various components and improve colo…
Nelson-numerical-software Oct 21, 2025
85b4773
CodeQL Warnings export functions for PDF, SVG, TIFF, and GIF formats;…
Nelson-numerical-software Oct 22, 2025
b669437
doc: update changelog
Nelson-numerical-software Oct 23, 2025
8317e6f
feat(doc): 'help' for functions in Command Window
Nelson-numerical-software Oct 24, 2025
14b4c40
chore: renaming
Nelson-numerical-software Oct 24, 2025
9fbc810
chore: xml module
Nelson-numerical-software Oct 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
2 changes: 1 addition & 1 deletion .github/workflows/codeql-analysis-cpp.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ jobs:
- name: Install dependencies
run: |
sudo apt-get update
sudo apt -y install apt-transport-https ca-certificates gnupg software-properties-common wget ninja-build xvfb libopenmpi-dev autotools-dev libtool automake openmpi-bin gettext pkg-config libffi-dev libicu-dev libxml2-dev liblapack-dev liblapacke-dev fftw3 fftw3-dev libasound-dev portaudio19-dev libsndfile1-dev libtag1-dev alsa-utils libsqlite3-dev libgl-dev hdf5-tools zlib1g-dev libcurl4-openssl-dev libgit2-dev libboost-all-dev libeigen3-dev libhdf5-dev libmatio-dev qt6-base-dev libqt6svg6-dev qt6-declarative-dev qt6-documentation-tools qml6-module-qtquick qml6-module-qtquick-templates qml6-module-qtquick-controls qml6-module-qtquick-window qml6-module-qtquick-dialogs qml6-module-qtqml-workerscript qml6-module-qtquick-layouts assistant-qt6 qt6-tools-dev libgif-dev
sudo apt -y install apt-transport-https ca-certificates gnupg software-properties-common wget ninja-build xvfb libopenmpi-dev autotools-dev libtool automake openmpi-bin gettext pkg-config libffi-dev libicu-dev libxml2-dev libxslt1-dev liblapack-dev liblapacke-dev fftw3 fftw3-dev libasound-dev portaudio19-dev libsndfile1-dev libtag1-dev alsa-utils libsqlite3-dev libgl-dev hdf5-tools zlib1g-dev libcurl4-openssl-dev libgit2-dev libboost-all-dev libeigen3-dev libhdf5-dev libmatio-dev qt6-base-dev libqt6svg6-dev qt6-declarative-dev qt6-documentation-tools qml6-module-qtquick qml6-module-qtquick-templates qml6-module-qtquick-controls qml6-module-qtquick-window qml6-module-qtquick-dialogs qml6-module-qtqml-workerscript qml6-module-qtquick-layouts assistant-qt6 qt6-tools-dev libgif-dev

# Build the bit of source code that we want to see analysed
- name: Build
Expand Down
308 changes: 169 additions & 139 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,64 @@
# LICENCE_BLOCK_END
#==============================================================================
# This .gitignore for Nelson

#==============================================================================
# Build artifacts and directories
#==============================================================================
build/
chocolatey/nelson/*.nupkg
nelson*.snap
tests_*.xml
tests_*.json
benchmark_all-*.xml
benchmark_all-*.json
a.out
cmake_hdf5_test.out
compile_commands.json
checks.json
/$tf
.ninja_deps
.ninja_log
build.ninja
result
#==============================================================================
# CMake generated files
#==============================================================================
NelsonConfigVersion.cmake
CMakeFiles/
_CPack_Packages/
Makefile
CMakeCache.txt
CPackConfig.cmake
CPackSourceConfig.cmake
cmake_install.cmake
install_manifest.txt
/tools/CMake/
#==============================================================================
# Compiled libraries and binaries
#==============================================================================
*.dll
*.lib
*.a
*.so
*.so.*
*.dylib
*.dylib.*
*-exec
*.exe
*.exp
*.ilk
*.pdb
*.jsc
#==============================================================================
# Package files
#==============================================================================
chocolatey/nelson/*.nupkg
nelson*.snap
Nelson-*-*.tar.Z
Nelson-*-*.tar.gz
nelson-*.deb
nelson*.rpm
nelson*.dmg
nelson*.zip
parts/
prime/
stage/
#==============================================================================
# Binary directories
#==============================================================================
/bin/*/mkl
/bin/*/openblas
/bin/*/qml
Expand All @@ -29,41 +76,16 @@ checks.json
/bin/*/libnlsblaslapack.dll.manifest
/bin/*/nelson-cli.exe
/bin/*/nelson_f2c
/modules/main/help/*/html/CHANGELOG.html
/modules/main/help/*/html/CHANGELOG-0.1.x.html
/modules/main/help/*/html/CHANGELOG-0.2.x.html
/modules/main/help/*/html/CHANGELOG-0.3.x.html
/modules/main/help/*/html/CHANGELOG-0.4.x.html
/modules/main/help/*/html/CHANGELOG-0.5.x.html
/modules/main/help/*/html/CHANGELOG-0.6.x.html
/modules/main/help/*/html/CHANGELOG-0.7.x.html
/modules/main/help/*/html/license.html
/modules/main/help/*/html/gpl-3.0.html
/modules/main/help/*/html/lgpl-3.0.html
bin/linux/*.so.*
bin/linux/*-exec
bin/macos/*.dylib.*
bin/macos/*-exec
#==============================================================================
# Module directories and files
#==============================================================================
/modules/*/nls*_autogen
/modules/modules.m
/module_skeleton/
*.settings
*.qmlc
*.jsc
*.user
*.opensdf
*.dll
*.sdf
*.bak
*.exp
*.ilk
*.lib
*.pdb
*.exe
*.lastcodeanalysissucceeded
*.psess
*.inspxe
*.suo
*.tlog
*.orig
*.tmp
*.cppcheck
/modules/qml_engine/nlsQml_engine_automoc.dir/
/modules/text_editor/nlsText_editor_automoc.dir/
/modules/*/builtin/c/x64
Expand All @@ -87,7 +109,39 @@ checks.json
/modules/*/moc_*.cpp
/modules/*/*_automoc.cpp
/modules/gui/nlsGui_automoc.dir
/modules/*/help/en_US/md/*.html
/modules/*/src/c/*/x64
/modules/*/src/c/*/Debug
/modules/*/src/c/*/Release
/modules/commons/src/include/Nelson_VERSION.h
/modules/commons/src/include/nlsBuildConfig.h
/modules/core/src/include/Nelson_VERSION.h
modules/slicot/src/f2c/*.c
#==============================================================================
# Help related files
#==============================================================================
/modules/help_tools/help/*.json
/modules/*/help/*/md/*.html
/modules/*/help/*/*.nhz
/modules/*/help/*/*.qch
/modules/main/help/*/html/CHANGELOG.html
/modules/main/help/*/html/CHANGELOG-0.1.x.html
/modules/main/help/*/html/CHANGELOG-0.2.x.html
/modules/main/help/*/html/CHANGELOG-0.3.x.html
/modules/main/help/*/html/CHANGELOG-0.4.x.html
/modules/main/help/*/html/CHANGELOG-0.5.x.html
/modules/main/help/*/html/CHANGELOG-0.6.x.html
/modules/main/help/*/html/CHANGELOG-0.7.x.html
/modules/main/help/*/html/license.html
/modules/main/help/*/html/gpl-3.0.html
/modules/main/help/*/html/lgpl-3.0.html
/modules/main/help/*/html/homepage.html
/modules/*/help/*/html
modules/main/help/*/md/lgpl-3.0.md
modules/main/help/*/md/gpl-3.0.md
/modules/help_tools/thirdparty/highlight.js
#==============================================================================
# Main CLI and GUI files
#==============================================================================
/modules/main/nelson_sio_cli/x64
/modules/main/nelson_sio_cli/Debug
/modules/main/nelson_sio_cli/Release
Expand All @@ -111,57 +165,17 @@ checks.json
/modules/main/nelson_gui/*/r000sc
/modules/main/nelson_gui/My Inspector XE Results - Nelson-cli/
/modules/main/nelson_gui/Resource.aps
/modules/main/help/*/html/homepage.html
/modules/python_engine/thirdparty/
*.vspx
My Advisor XE Results - *
*.inspxeproj
*.dflginspxe
*.infoinspxe
################################################################################
NelsonConfigVersion.cmake
CMakeFiles/
_CPack_Packages/
Makefile
*.*~
CMakeCache.txt
CPackConfig.cmake
CPackSourceConfig.cmake
cmake_install.cmake
install_manifest.txt
*.a
*.so
*.dylib
Nelson-*-*.tar.Z
Nelson-*-*.tar.gz
nelson-*.deb
nelson*.rpm
nelson*.dmg
nelson*.zip
bin/linux/*.so.*
bin/linux/*-exec
bin/linux/*.so.*
bin/linux/*-exec
bin/macos/*.dylib.*
bin/macos/*-exec
/modules/help_tools/thirdparty/highlight.js
#==============================================================================
# Tools related files
#==============================================================================
/tools/gettext/bin
.DS_Store
/tools/gettext/i18nExtractor/Release
/tools/gettext/i18nExtractor/Debug
/tools/gettext/i18nExtractor/x64
/tools/gettext/generatemo/*/*/*.log
/tools/gettext/i18nExtractor/*/*/*.log
/tools/gettext/license.txt
/tools/gettext/gettext-license.txt
################################################################################
*.ipdb
*.iobj
*.opendb
*.qch
*.plog
*.i-*
################################################################################
/tools/gettext/i18nExtractor/Debug
/tools/gettext/generatemo/Release
/tools/gettext/i18nExtractor/x64/
Expand All @@ -181,32 +195,18 @@ bin/macos/*-exec
/tools/buildhelp/Debug
/tools/doxygen/nelson_doxygen
/tools/doxygen/nelson_doxygen.zip
################################################################################
# previous place
/modules/core/src/include/Nelson_VERSION.h
################################################################################
/modules/commons/src/include/Nelson_VERSION.h
/modules/commons/src/include/nlsBuildConfig.h
/modules/*/src/c/*/x64
/modules/*/src/c/*/Debug
/modules/*/src/c/*/Release
################################################################################
/Nelson.VC.db
.vs/
*.PVS-Studio.cfg
*.PVS-Studio.preprocess.cmd
*.PVS-Studio.cmd
*.PVS-Studio.preprocess.cmd.rsp
*.i
*.PVS-Studio.compilerVersion.cmd
enc_temp_folder
################################################################################
/tools/CMake/
################################################################################
/*/*/.vscode
.vscode
################################################################################
# module_skeleton
#==============================================================================
# Third-party directories and files
#==============================================================================
/modules/python_engine/thirdparty/
node_modules/
package-lock.json
modules/mex/examples/rust-mex-builder/helloworld/Cargo.lock
modules/mex/examples/rust-mex-builder/helloworld/build.rs
modules/mex/examples/rust-mex-builder/helloworld/target/
#==============================================================================
# Module skeleton files
#==============================================================================
module_skeleton/builtin/CMakeLists.txt
module_skeleton/builtin/cleaner.m
module_skeleton/builtin/loader.m
Expand All @@ -217,34 +217,64 @@ module_skeleton/src/cleaner.m
module_skeleton/src/loader.m
module_skeleton/src/unloader.m
module_skeleton/*/*.manifest
################################################################################
a.out
cmake_hdf5_test.out
################################################################################
#==============================================================================
# Locale related files
#==============================================================================
locale/nelson.pot
locale/??_??/
################################################################################
modules/main/help/*/md/lgpl-3.0.md
modules/main/help/*/md/gpl-3.0.md
################################################################################
package-lock.json
node_modules/
################################################################################
#==============================================================================
# Test and benchmark files
#==============================================================================
tests_*.xml
tests_*.json
benchmark_all-*.xml
benchmark_all-*.json
#==============================================================================
# IDE and editor related files
#==============================================================================
.vs/
.vscode
/*/*/.vscode
*.PVS-Studio.cfg
*.PVS-Studio.preprocess.cmd
*.PVS-Studio.cmd
*.PVS-Studio.preprocess.cmd.rsp
*.PVS-Studio.compilerVersion.cmd
/Nelson.VC.db
.qt/
################################################################################
modules/mex/examples/rust-mex-builder/helloworld/Cargo.lock
modules/mex/examples/rust-mex-builder/helloworld/build.rs
modules/mex/examples/rust-mex-builder/helloworld/target/
################################################################################
parts/
prime/
stage/
################################################################################
result
################################################################################
.ninja_deps
.ninja_log
build.ninja
################################################################################
modules/slicot/src/f2c/*.c
################################################################################
*.settings
*.qmlc
*.user
*.opensdf
*.sdf
*.suo
*.cppcheck
*.opendb
#==============================================================================
# Temporary, backup and log files
#==============================================================================
*.bak
*.*~
*.tmp
*.log
*.lastcodeanalysissucceeded
*.psess
*.inspxe
*.vspx
*.tlog
*.orig
*.inspxeproj
*.dflginspxe
*.infoinspxe
*.ipdb
*.iobj
*.nhz
*.plog
*.i-*
*.i
enc_temp_folder
My Advisor XE Results - *
#==============================================================================
# Miscellaneous
#==============================================================================
/$tf
.DS_Store
1 change: 1 addition & 0 deletions .prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ modules/sio_client/src/socket_io/lib
modules/commons/src/include/nlohmann
modules/stream_manager/tests/bench_fileread.json
modules/json/tests/bench_jsonencode.json
modules/help_tools/help/nelson_help_*.json
modules/json/src/cpp/simdjson.cpp
modules/json/src/cpp/simdjson.h
bin/
Expand Down
3 changes: 0 additions & 3 deletions BUILDING_Linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,6 @@ WITHOUT_GUI_MODULE:BOOL=OFF
// Disable HDF5 module.
WITHOUT_HDF5_MODULE:BOOL=OFF

// Disable HELP_BROWSER module.
WITHOUT_HELP_BROWSER_MODULE:BOOL=OFF

// Disable HELP_TOOLS module.
WITHOUT_HELP_TOOLS_MODULE:BOOL=OFF

Expand Down
Loading
Loading