Skip to content

Commit 588f91e

Browse files
Enhance XML and Markdown Documentation Rendering
- Updated XSLT files to apply templates for parameter descriptions in HTML output, improving the rendering of complex descriptions. - Introduced a new template for rendering inline links in both HTML and Markdown formats, enhancing navigation within documentation. - Added emoji icons to various text labels in the Markdown output for better visual appeal and clarity. - Improved test scripts to skip tests if XML documentation is missing, ensuring robustness in test execution. - Created a new script to check XML documentation integrity across modules, enhancing documentation quality assurance. - Refactored existing XML documentation files for consistency and clarity, including translations and formatting adjustments.
1 parent 56f17bc commit 588f91e

File tree

70 files changed

+3037
-464
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+3037
-464
lines changed

.github/workflows/codeql-analysis-cpp.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ jobs:
3838
- name: Install dependencies
3939
run: |
4040
sudo apt-get update
41-
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
41+
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
4242
4343
# Build the bit of source code that we want to see analysed
4444
- name: Build

ROADMAP.md

Lines changed: 63 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,95 @@
11
# Roadmap
22

3-
The roadmap is a living document, and it is likely that priorities will change, but the list below should give some indication of our plans for the next major release, and for the future.
3+
The roadmap is a living document. Priorities will change, but the list below gives an indication of planned work for the next major release and beyond.
44

5-
Please feel free to file issues on this repository if you have questions, concerns, or suggestions.
5+
Please file issues on this repository if you have questions, concerns, or suggestions.
6+
7+
## Table of Contents
8+
9+
- [Nelson 2.0.0](#nelson-200)
10+
- [Core Improvements](#core-improvements)
11+
- [Documentation & Format rework](#documentation--format-rework)
12+
- [Modules and Extensions](#modules-and-extensions)
13+
- [User Interface (GUI)](#user-interface-gui)
14+
- [Plotting Features](#plotting-features)
15+
- [Data Handling and Compatibility](#data-handling-and-compatibility)
16+
- [How Can You Contribute?](#how-can-you-contribute)
17+
- [Contributing to the Roadmap](#contributing-to-the-roadmap)
18+
- [Previous roadmap](#previous-roadmap)
619

720
## Nelson 2.0.0
821

922
### Core Improvements
1023

11-
- Bug resolution and ongoing maintenance,
12-
- Native package development/support:
13-
- ArchLinux (DONE v1.3.0),
14-
- macOs,
15-
- Fedora (DONE v1.14.0),
16-
- NixOS (DONE v1.11.0),
17-
- Ubuntu 24.04 ARM64 (DONE v1.11.0),
18-
- etc ...
19-
- Integration of Windows ARM64 support,
20-
- Performance optimization for increased speed,
21-
- Code factorization for improved maintainability,
22-
- Expansion of compatible functions,
23-
- Comprehensive support for sparse operations.
24+
- Bug resolution and ongoing maintenance
25+
- Native package development/support
26+
- ArchLinux (DONE v1.3.0)
27+
- macOS
28+
- Fedora (DONE v1.14.0)
29+
- NixOS (DONE v1.11.0)
30+
- Ubuntu 24.04 ARM64 (DONE v1.11.0)
31+
- etc.
32+
- Integration of Windows ARM64 support
33+
- Performance optimization for increased speed
34+
- Code factorization for improved maintainability
35+
- Expansion of compatible functions
36+
- Comprehensive support for sparse operations
37+
38+
### Documentation
39+
40+
- Rework help_tools into a searchable, context‑aware help system (Markdown sources) (DONE v1.15.0)
41+
- Provide multi‑format export (LaTeX/Pandoc → PDF/HTML/DOCX) (DONE v1.15.0)
42+
- Publish a versioned online docs site with autogenerated API reference and search (DONE v1.15.0)
43+
- Add contributor tooling (DONE v1.15.0)
44+
- Localization (French) (DONE v1.15.0)
2445

2546
### Modules and Extensions
2647

27-
- Julia interface (DONE v1.12.0),
28-
- Compatible python interface (DONE v1.5.0),
29-
- Incorporate an Image Processing module,
30-
- Optimization of code execution using NPU/GPU arrays,
31-
- Integrate additional numerical methods,
32-
- xlsx reader/writer on all platforms,
33-
- NetCDF reader/writer,
34-
- Nelson as an FMU engine (LGPL v3),
35-
- FMI import support,
36-
- LLMs features,
37-
- Extend compatibility with WebAssembly (wasm),
38-
- Commands and functionalities related to debugging and code editing,
39-
- VS Code server,
40-
- Jupyter kernel.
48+
- Julia interface (DONE v1.12.0)
49+
- Compatible python interface (DONE v1.5.0)
50+
- Incorporate an Image Processing module
51+
- Optimization of code execution using NPU/GPU arrays
52+
- Integrate additional numerical methods
53+
- xlsx reader/writer on all platforms
54+
- NetCDF reader/writer
55+
- Nelson as an FMU engine (LGPL v3)
56+
- FMI import support
57+
- LLMs features
58+
- Extend compatibility with WebAssembly (wasm)
59+
- Commands and functionalities related to debugging and code editing
60+
- VS Code server
61+
- Jupyter kernel
4162

4263
### User Interface (GUI)
4364

44-
- History browser (DONE v1.1),
45-
- File browser (DONE v1.1),
46-
- Workspace browser (DONE v1.1),
47-
- Variable browser (DONE v1.15),
48-
- RSS viewer,
49-
- Demo viewer,
50-
- Include a Webview for enhanced web interaction.
65+
- History browser (DONE v1.1)
66+
- File browser (DONE v1.1)
67+
- Workspace browser (DONE v1.1)
68+
- Variable browser (DONE v1.15)
69+
- RSS viewer
70+
- Demo viewer
71+
- Include a Webview for enhanced web interaction
5172

5273
### Plotting Features
5374

54-
- Introduction of uicontrol (v1.7.0),
55-
- Implementation of contour plots (DONE v1.3.0),
56-
- Enhancement of plot interaction features (e.g., zoom functionality, etc.) (DONE v1.2.0).
75+
- Introduction of uicontrol (v1.7.0)
76+
- Implementation of contour plots (DONE v1.3.0)
77+
- Enhancement of plot interaction features (e.g., zoom) (DONE v1.2.0)
5778

5879
### Data Handling and Compatibility
5980

60-
- Development of Table, Timeseries, and Dictionary-compatible objects,
81+
- Development of Table, Timeseries, and Dictionary-compatible objects
6182
- dictionary (DONE v1.5.0)
6283
- table (DONE v1.8.0)
6384
- Rework and extend the interpreter for enhanced compatibility
6485

6586
## How Can You Contribute?
6687

67-
Our short-term objectives are outlined above, with the aim of distributing the workload to encourage community involvement. If you wish to contribute, please comment on relevant issues to avoid duplication of effort. If a maintainer is already assigned to an issue you're interested in, reach out to them on GitHub to offer your assistance.
88+
Our short-term objectives are outlined above to encourage community involvement. If you wish to contribute, comment on relevant issues to avoid duplication. If a maintainer is already assigned to an issue, reach out on GitHub to offer assistance.
6889

6990
## Contributing to the Roadmap
7091

71-
The roadmap process reflecting our commitment to transparency. As we continue to structure and document project objectives, we encourage collaboration with the community to focus our efforts on prioritized topics. Feel free to propose additions or adjustments to the roadmap as needed.
92+
The roadmap process reflects our commitment to transparency. As we structure and document project objectives, we encourage community collaboration to focus efforts on prioritized topics. Propose additions or adjustments to the roadmap as needed.
7293

7394
## Previous roadmap
7495

modules/audio/help/en_US/xml/soundsc.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
<description>
3636
<p>
3737
<b>soundsc</b> scales the values of audio signal <b
38-
>y </b>to fit in the range from <b>–1.0</b> to <b
38+
>y </b> to fit in the range from <b>–1.0</b> to <b
3939
>1.0</b> and play as sound.
4040
</p>
4141
</description>

modules/audio/help/fr_FR/xml/soundsc.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
<description>
3737
<p>
3838
<b>soundsc</b> met à l'échelle les valeurs du signal audio <b
39-
>y </b>pour s'adapter à la plage de <b>–1.0</b> à <b
39+
>y </b> pour s'adapter à la plage de <b>–1.0</b> à <b
4040
>1.0</b> et joue comme son.
4141
</p>
4242
</description>

modules/control_system/help/fr_FR/xml/balreal.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@
3838
</param_output>
3939
<description>
4040
<p>
41-
<b>balreal(sys)</b> calculates a balanced realization, denoted as <b
42-
>sysb</b>, for the stable segment of the linear time-invariant (LTI) model <b
41+
<b>balreal(sys)</b> calcule une réalisation équilibrée, notée <b
42+
>sysb</b>, pour la partie stable du modèle linéaire invariant dans le temps (LTI) <b
4343
>sys</b>.</p>
4444
<p
4545
>Ce processus s'applique aussi bien aux systèmes continus que discrets. Si <b

modules/control_system/help/fr_FR/xml/bdschur.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<param_output>
2424
<param_output_item>
2525
<param_name>T</param_name>
26-
<param_description>Transformation matrix.</param_description>
26+
<param_description>Matrice de transformation.</param_description>
2727
</param_output_item>
2828
<param_output_item>
2929
<param_name>B</param_name>
@@ -34,9 +34,9 @@
3434
<description>
3535
<p>
3636
<b
37-
>[T, B] = bdschur(A, CONDMAX)</b> calculates a transformation matrix <b
38-
>T</b>, where <b
39-
>B = T \ A * T</b> results in a block diagonal matrix with each block being a quasi upper-triangular Schur matrix, ensuring the diagonalization of matrix A while preserving certain structural properties.</p>
37+
>[T, B] = bdschur(A, CONDMAX)</b> calcule une matrice de transformation <b
38+
>T</b>, <b
39+
>B = T \ A * T</b> donne une matrice diagonale par blocs, chaque bloc étant une matrice de Schur quasi triangulaire supérieure, assurant la diagonalisation de la matrice A tout en préservant certaines propriétés structurelles.</p>
4040
</description>
4141
<used_function>MB03RD</used_function>
4242
<bibliography

modules/control_system/help/fr_FR/xml/bode.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,19 @@
2121
<param_input_item>
2222
<param_name>wIn</param_name>
2323
<param_description
24-
>a cell {wmin, wmax} or a vector [wmin:wmax].</param_description>
24+
>une cellule {wmin, wmax} ou un vecteur [wmin:wmax].</param_description>
2525
</param_input_item>
2626
<param_input_item>
2727
<param_name>lineSpec</param_name>
2828
<param_description
29-
>Line style, marker, and color.</param_description>
29+
>Style de ligne, marqueur et couleur.</param_description>
3030
</param_input_item>
3131
</param_input>
3232
<param_output>
3333
<param_output_item>
3434
<param_name>magnitude</param_name>
3535
<param_description
36-
>Magnitude: size 1 x 1 x k (SISO).</param_description>
36+
>Amplitude : taille 1 x 1 x k (SISO).</param_description>
3737
</param_output_item>
3838
<param_output_item>
3939
<param_name>phase</param_name>

modules/control_system/help/fr_FR/xml/c2d.xml

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,17 @@
2020
<param_input_item>
2121
<param_name>B</param_name>
2222
<param_description
23-
>Input-to-state matrix: Nx-by-Nu matrix.</param_description>
23+
>Matrice entrée-état : matrice Nx-par-Nu.</param_description>
2424
</param_input_item>
2525
<param_input_item>
2626
<param_name>Ts</param_name>
27-
<param_description>Sample time: positive scalar.</param_description>
27+
<param_description
28+
>Temps d'échantillonnage : scalaire positif.</param_description>
2829
</param_input_item>
2930
<param_input_item>
3031
<param_name>sysc</param_name>
3132
<param_description
32-
>Continuous-time dynamic system: LTI model.</param_description>
33+
>Système dynamique en temps continu : modèle LTI.</param_description>
3334
</param_input_item>
3435
<param_input_item>
3536
<param_name>method</param_name>
@@ -38,30 +39,32 @@
3839
</param_input_item>
3940
<param_input_item>
4041
<param_name>w0</param_name>
41-
<param_description>prewarp frequency.</param_description>
42+
<param_description>fréquence de pré-distorsion.</param_description>
4243
</param_input_item>
4344
</param_input>
4445
<param_output>
4546
<param_output_item>
4647
<param_name>P</param_name>
47-
<param_description>phi</param_description>
48+
<param_description
49+
>Matrice de transition d'état (phi)</param_description>
4850
</param_output_item>
4951
<param_output_item>
5052
<param_name>G</param_name>
51-
<param_description>gamma</param_description>
53+
<param_description
54+
>gamma (matrice de commande discrète)</param_description>
5255
</param_output_item>
5356
<param_output_item>
5457
<param_name>sysd</param_name>
55-
<param_description>Discrete-time model</param_description>
58+
<param_description>Modèle en temps discret</param_description>
5659
</param_output_item>
5760
</param_output>
5861
<description>
59-
<p>The function <b
60-
>sysd = c2d(sysc, Ts)</b> discretizes the continuous-time dynamic system model <b
61-
>sysc</b> using a zero-order hold on the inputs with a sample time of <b
62+
<p>La fonction <b
63+
>sysd = c2d(sysc, Ts)</b> discrétise le modèle dynamique en temps continu <b
64+
>sysc</b> en utilisant un maintien d'ordre zéro sur les entrées avec un temps d'échantillonnage de <b
6265
>Ts</b>.</p>
63-
<p>For instance, you can use <b
64-
>sysd = c2d(sysc, Ts, method)</b> to explicitly specify the discretization method.</p>
66+
<p>Par exemple, vous pouvez utiliser <b
67+
>sysd = c2d(sysc, Ts, method)</b> pour spécifier explicitement la méthode de discrétisation.</p>
6568
</description>
6669
<examples>
6770
<example_item>

modules/control_system/help/fr_FR/xml/compreal.xml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,11 @@
4949
<p>
5050
<b
5151
>[A, B, C, D, E] = compreal(numerator, denominator)</b> calcule une réalisation d'espace d'état représentée par les matrices A, B, C, D et E.</p>
52-
<p>The <b
53-
>E</b> matrix is an empty matrix (identity matrix) when there are at least as many poles as zeros.</p>
54-
<p>However, if there are more zeros than poles, the <b
55-
>E</b> matrix becomes singular.</p>
52+
<p>La matrice <b
53+
>E</b> est une matrice vide (matrice identité) lorsqu'il y a au moins autant de pôles que de zéros.</p>
54+
<p
55+
>Cependant, si le nombre de zéros dépasse celui des pôles, la matrice <b
56+
>E</b> devient singulière.</p>
5657
</description>
5758
<examples>
5859
<example_item>

modules/control_system/help/fr_FR/xml/freqresp.xml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,18 @@
1111
<param_input>
1212
<param_input_item>
1313
<param_name>sys</param_name>
14-
<param_description>LTI model</param_description>
14+
<param_description>modèle LTI</param_description>
1515
</param_input_item>
1616
<param_input_item>
1717
<param_name>w</param_name>
18-
<param_description>Frequencies: vector</param_description>
18+
<param_description>Fréquences : vecteur.</param_description>
1919
</param_input_item>
2020
</param_input>
2121
<param_output>
2222
<param_output_item>
2323
<param_name>H</param_name>
24-
<param_description>Frequency response values</param_description>
24+
<param_description
25+
>Valeurs de réponse en fréquence</param_description>
2526
</param_output_item>
2627
<param_output_item>
2728
<param_name>wout</param_name>

0 commit comments

Comments
 (0)