Skip to content

Commit f4d45f9

Browse files
v1.15 help files
1 parent 3014870 commit f4d45f9

File tree

186 files changed

+65330
-19949
lines changed

Some content is hidden

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

186 files changed

+65330
-19949
lines changed

docs/releases/en_US/v1.15.0/CHANGELOG.html

Lines changed: 54 additions & 144 deletions
Original file line numberDiff line numberDiff line change
@@ -42,158 +42,68 @@ <h1>Changelog</h1>
4242
<p>All notable changes to this project will be documented in this file.</p>
4343
<p>The format is based on <a href="https://keepachangelog.com/en/1.0.0/">Keep a Changelog</a>,
4444
and this project adheres to <a href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p>
45-
<h2>1.15.0 - (UNRELEASED)</h2>
45+
<h2>1.15.0 - (2025-11-21)</h2>
46+
<p>Starting with v1.15, Nelson for Windows is officially signed with a Certum-issued code-signing certificate.
47+
This is a major security milestone, ensuring the authenticity and integrity of Nelson’s Windows releases.</p>
48+
<p>Nelson remains a non-profit, community-driven project.
49+
The certificate represents a significant cost for a volunteer effort - any donation to help cover it is deeply appreciated.</p>
4650
<h3>Added</h3>
4751
<ul>
48-
<li>
49-
<p>Enhanced random number generation engine with new algorithms: <code>simdTwister</code>, <code>combRecursive</code>, <code>philox</code>, and <code>threefry</code>.</p>
50-
</li>
51-
<li>
52-
<p><code>randi</code>: Generate uniformly distributed random integers.</p>
53-
</li>
54-
<li>
55-
<p>New functions for sparse matrix generation:</p>
56-
<ul>
57-
<li><code>sprand</code>: Generate sparse matrices with uniformly distributed random values.</li>
58-
<li><code>sprandn</code>: Generate sparse matrices with normally distributed random values.</li>
59-
</ul>
60-
</li>
61-
<li>
62-
<p>Search Text in Console and Text Editor.</p>
63-
</li>
64-
<li>
65-
<p>Type support: Expanded support for missing types, increasing compatibility across functions and data structures.</p>
66-
</li>
67-
<li>
68-
<p><code>imresize</code>: Resize images by scale or to a specified output size, supporting both upscaling and downscaling.</p>
69-
</li>
70-
<li>
71-
<p>Variable Editor: Redesigned for improved usability and performance. Accessible via <code>openvar</code> or the GUI, it supports structured variables, tables, arrays, and nested data. Features include:</p>
72-
<ul>
73-
<li>Dynamic table view.</li>
74-
<li>Real-time updates from the execution context.</li>
75-
<li>Enhanced performance for large datasets.</li>
76-
<li>Copy-paste compatibility with Excel, LibreOffice, and OpenOffice.</li>
77-
</ul>
78-
</li>
79-
<li>
80-
<p>Continuation prompt: Context-aware prompts to enhance interactive command workflows.</p>
81-
</li>
82-
<li>
83-
<p>Expanded type support for missing types, increasing compatibility across functions and data structures.</p>
84-
</li>
85-
<li>
86-
<p><code>missing</code> function: Create missing values for arrays and tables, improving data handling and interoperability.</p>
87-
</li>
88-
<li>
89-
<p><code>renameStructField</code>: Rename fields in structures, simplifying data manipulation and refactoring.</p>
90-
</li>
91-
<li>
92-
<p><code>jsondecode(filename, '-file')</code>: Added <code>-file</code> argument for direct reading and decoding of JSON files from disk.</p>
93-
</li>
94-
<li>
95-
<p><code>tdigest</code>: Introduced t-digest algorithm for accurate quantile estimation with configurable compression parameters.</p>
96-
</li>
97-
<li>
98-
<p><code>crc32</code> builtin: Compute CRC32 checksum of a file or string.</p>
99-
</li>
100-
<li>
101-
<p><code>markdown</code>: Added option to select output format (<code>secure</code> or <code>advanced</code>).</p>
102-
</li>
103-
<li>
104-
<p><code>fwrite</code>: return also bytes count as second output argument.</p>
105-
</li>
106-
<li>
107-
<p><code>help</code>: Help for functions in Command Window.</p>
108-
</li>
109-
<li>
110-
<p>macOS Tahoe 26: CI setup and platform support.</p>
111-
</li>
112-
<li>
113-
<p>Python 3.14 support.</p>
114-
</li>
52+
<li>Pair Name/Value argument syntax for plotting (e.g. <code>plot(x, y, '--rs', LineWidth=2, MarkerEdgeColor='k')</code>).</li>
53+
<li>Support for ignored outputs in assignments (e.g. <code>[~, V, ~] = svd(A)</code>).</li>
54+
<li>New random engines: <code>simdTwister</code>, <code>combRecursive</code>, <code>philox</code>, <code>threefry</code>.</li>
55+
<li><code>randi</code>: uniform random integers.</li>
56+
<li><code>sprand</code>, <code>sprandn</code>: sparse random matrices (uniform and normal).</li>
57+
<li><code>mink</code>, <code>maxk</code>: k smallest / largest elements.</li>
58+
<li><code>subspace</code>: angle/distance between column spaces.</li>
59+
<li><code>std</code>: standard deviation.</li>
60+
<li><code>findpeaks</code>: local maxima detection.</li>
61+
<li><code>downsample</code>: integer-factor resampling.</li>
62+
<li><code>imresize</code>: image resizing (scale or target size).</li>
63+
<li><code>clabel</code>: contour labeling.</li>
64+
<li>Extended colormap placement locations: <code>north</code>, <code>south</code>, <code>east</code>, <code>west</code> and their outside variants.</li>
65+
<li>Variable Editor: redesigned UI with improved performance, structured/table/array support and copy-paste compatibility with common spreadsheet apps.</li>
66+
<li>Continuation prompt: context-aware interactive prompts.</li>
67+
<li><code>missing</code>: create missing values for arrays and tables.</li>
68+
<li><code>renameStructField</code>: rename structure fields.</li>
69+
<li><code>convertStringToCharArgs</code>: convert string/cell-of-strings to char-args.</li>
70+
<li><code>jsondecode(..., '-file')</code>: decode JSON directly from a file.</li>
71+
<li><code>tdigest</code>: t-digest quantile estimation.</li>
72+
<li><code>pascal</code> and <code>gallery</code> helper matrices.</li>
73+
<li><code>crc32</code> builtin: compute CRC32 of file/string.</li>
74+
<li><code>markdown</code>: output mode option (<code>secure</code> | <code>advanced</code>).</li>
75+
<li><code>fwrite</code>: also return written byte count as a second output.</li>
76+
<li><code>loadenv</code>: load environment variables from .env or text files.</li>
77+
<li><code>help</code>: function help available in Command Window.</li>
78+
<li><code>consolebox</code>: show/hide Windows terminal for Nelson session.</li>
79+
<li>CI / platform additions: macOS Tahoe 26, Fedora 43, Python 3.14, Visual Studio 2026 support.</li>
11580
</ul>
11681
<h3>Changed</h3>
11782
<ul>
118-
<li>
119-
<p>Help framework reworked for improved performance and usability:</p>
120-
<ul>
121-
<li>Multithreaded builds for faster performance.</li>
122-
<li>Enhanced search capabilities with extended functionality.</li>
123-
<li>Improved maintainability using Extensible Stylesheet Language Transformations (XSLT).</li>
124-
<li>Unified stylesheet for consistent appearance online and offline.</li>
125-
<li>Removed internal usage of Qt help support.</li>
126-
<li>Dark theme.</li>
127-
<li>Added French language support for Help.</li>
128-
<li>Introduced support for LaTeX formulas.</li>
129-
<li>Replaced <code>http://</code> links with <code>https://</code> for secure connections.</li>
130-
<li>Removed the <code>help_browser</code> module.</li>
131-
</ul>
132-
</li>
133-
<li>
134-
<p><code>jsondecode</code>: Integrated <a href="https://simdjson.org/">simdjson</a> for significantly improved performance and efficiency.</p>
135-
</li>
136-
<li>
137-
<p><code>fileread</code>: Enhanced performance for reading large files, reducing memory usage and increasing speed.</p>
138-
</li>
139-
<li>
140-
<p><code>fwrite</code>: returns the number of characters written for character data.</p>
141-
</li>
142-
<li>
143-
<p>i18nExtractor: Reworked for greater speed and modernized codebase, improving internationalization extraction reliability.</p>
144-
</li>
145-
<li>
146-
<p>Browser variable: Refactored for improved usability, reliability, and consistency in variable inspection.</p>
147-
</li>
148-
<li>
149-
<p>Third-party libraries on Windows: Updated support for HDF5, zlib, and matio, improving compatibility and stability.</p>
150-
</li>
151-
<li>
152-
<p>Qt: Upgraded to version 6.9.1 on Windows x64, providing better UI performance and compatibility with modern systems.</p>
153-
</li>
154-
<li>
155-
<p>Benchmarks: Updated <code>bench_jsonencode.json</code> to include larger datasets for more robust performance testing.</p>
156-
</li>
157-
<li>
158-
<p><code>xmldocchecker</code>: Improved with XSD schema validation for XML files.</p>
159-
</li>
160-
<li>
161-
<p><a href="https://github.com/nelson-lang/nelson/issues/1458">#1458</a>: Added support for Eigen 5.0.0 if detected.</p>
162-
</li>
163-
<li>
164-
<p>GitHub CI: Replaced MacOS Ventura with MacOS 15 Intel (<a href="https://github.com/nelson-lang/nelson/issues/1457">#1457</a>).</p>
165-
</li>
166-
<li>
167-
<p>Markdown renderer: Switched to the cmark library.</p>
168-
</li>
169-
<li>
170-
<p>External packages:</p>
171-
<ul>
172-
<li>Installing a Nelson external package now switches to local embedded help.</li>
173-
<li>External packages must be rebuilt with this version to use the new help format.</li>
174-
</ul>
175-
</li>
176-
<li>
177-
<p>Removed several dependencies on Boost to reduce build complexity and improve portability.</p>
178-
</li>
83+
<li><code>svd</code>: optimized for multithreading and large matrices.</li>
84+
<li>Help framework: reworked for performance and maintainability (multithreaded builds, improved search, unified stylesheet, XSLT, LaTeX formula support, French translations, removed Qt help dependency, secure links).</li>
85+
<li><code>jsondecode</code>: integrated <a href="https://simdjson.org/">simdjson</a> for faster parsing.</li>
86+
<li><code>fileread</code>: improved performance for large files.</li>
87+
<li><code>fwrite</code>: returns character count for character data.</li>
88+
<li><code>i18nExtractor</code>, browser variable and other internals: refactored for speed and reliability.</li>
89+
<li>Third-party library updates on Windows (HDF5, zlib, matio) and Qt upgraded to 6.10.0 (Win x64).</li>
90+
<li>Benchmarks and <code>xmldocchecker</code>: updated/improved.</li>
91+
<li>External packages: installing a package switches to local embedded help; packages must be rebuilt for the new help format.</li>
92+
<li>Removed several Boost dependencies to simplify builds.</li>
93+
<li>Private functions no longer appear in autocompletion.</li>
94+
<li>GitHub CI: MacOS Ventura replaced by MacOS 15 Intel.</li>
95+
<li>Markdown renderer switched to cmark.</li>
96+
<li><a href="https://github.com/nelson-lang/nelson/issues/1458">#1458</a> Optional support for Eigen 5.0.0 when detected.</li>
97+
<li><a href="https://github.com/nelson-lang/nelson/issues/1465">#1465</a> Test file renaming to bug_github_issue_XXX.</li>
17998
</ul>
18099
<h3>Fixed</h3>
181100
<ul>
182-
<li>
183-
<p><code>ans</code> variable: Ensured <code>ans</code> is only created for expressions, preventing unintended variable creation in the workspace.</p>
184-
</li>
185-
<li>
186-
<p><code>jsondecode</code>: Corrected parsing of arrays containing empty arrays, improving reliability and correctness.</p>
187-
</li>
188-
<li>
189-
<p>Julia engine works also with Julia 1.12.0</p>
190-
</li>
191-
<li>
192-
<p><a href="http://github.com/nelson-lang/nelson/issues/1462">#1462</a>: fwrite without specifying precision did not work as expected.</p>
193-
</li>
194-
<li>
195-
<p><code>eye</code> without input argument managed.</p>
196-
</li>
101+
<li><code>ans</code> variable: created only for expressions.</li>
102+
<li><code>jsondecode</code>: fixed parsing of arrays that contain empty arrays.</li>
103+
<li><code>fwrite</code>: fixed behavior when precision is unspecified.</li>
104+
<li><code>eye</code>: handled no-argument call correctly.</li>
105+
<li><a href="https://github.com/nelson-lang/nelson/issues/2">#2</a> Sparse type insertion &amp; extraction extended and corrected.</li>
106+
<li>Julia engine: compatibility with Julia 1.12.0</li>
197107
</ul>
198108
<h2>1.14.0 - (2025-05-30)</h2>
199109
<h3>Added</h3>

docs/releases/en_US/v1.15.0/audio/audiowrite.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
<div>
6464
<p>
6565
<b>audiowrite</b> writes an audio file.</p>
66-
<p>More 26 files format supported. See <b>audiosupportedformats</b> function to have all supported formats.</p>
66+
<p>More than 26 files format supported. See <b>audiosupportedformats</b> function to have all supported formats.</p>
6767
</div>
6868
</div>
6969
<div class="section">
Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
2+
<html xmlns:ext="http://io.github.nelson_lang/ext" lang="en">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5+
<title>consolebox</title>
6+
<link rel="stylesheet" href="highlight.css">
7+
<link rel="stylesheet" href="nelson_common.css">
8+
<script src="nelson_help.js"></script><style>
9+
@media (prefers-color-scheme: dark) {
10+
/* target both class names used in different XSLT outputs */
11+
.chapter-description, .chapter-desc { color: #e6eef8 !important; }
12+
.chapter-description p, .chapter-desc p { color: inherit !important; }
13+
}
14+
@media (prefers-color-scheme: light) {
15+
.chapter-description, .chapter-desc { color: #444 !important; }
16+
.chapter-description p, .chapter-desc p { color: inherit !important; }
17+
}
18+
</style>
19+
</head>
20+
<body>
21+
<a href="./index.html" class="home-summary-link"><button class="home-summary-btn" aria-label="Back to help index"><svg xmlns="http://www.w3.org/2000/svg" width="22" height="22" viewBox="0 0 24 24" fill="none" stroke="white" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M3 12L12 3l9 9"></path><path d="M9 21V12h6v9"></path><path d="M9 21h6"></path></svg></button></a><div class="header"><div class="title"><span class="keyword-title">consolebox</span></div></div>
22+
<div class="section syntax-section"><div class="subtitle">Displays or hides the Windows terminal associated with the Nelson session.</div></div>
23+
<div class="section syntax-section">
24+
<div class="section-title">
25+
<span class="syntax-icon">📝</span>Syntax</div>
26+
<pre class="syntax-block"><code class="language-matlab">consolebox(visibility)
27+
consolebox('toggle')
28+
status = consolebox('status')
29+
</code></pre>
30+
</div>
31+
<div class="section">
32+
<div class="section-title">
33+
<span class="syntax-icon">📥</span>Input Arguments</div>
34+
<table class="param-table">
35+
<tr>
36+
<th>Parameter</th>
37+
<th>Description</th>
38+
</tr>
39+
<tr>
40+
<td class="param-name">visibility</td>
41+
<td>a logical: true to show the console box, false to hide it</td>
42+
</tr>
43+
</table>
44+
</div>
45+
<div class="section">
46+
<div class="section-title">
47+
<span class="syntax-icon">📤</span>Output Arguments</div>
48+
<table class="param-table">
49+
<tr>
50+
<th>Parameter</th>
51+
<th>Description</th>
52+
</tr>
53+
<tr>
54+
<td class="param-name">status</td>
55+
<td>a logical: true if the console box is visible, false otherwise</td>
56+
</tr>
57+
</table>
58+
</div>
59+
<div class="section">
60+
<div class="section-title">
61+
<span class="syntax-icon">📄</span>Description</div>
62+
<div>
63+
<p>Displays or hides the Windows terminal associated with the Nelson session.</p>
64+
<p>Each Nelson session runs within its own consolebox. When the Nelson session ends, its corresponding consolebox is automatically terminated.</p>
65+
<p>The consolebox is a black terminal window that cannot be closed manually — the close (“X”) button in the upper-right corner is disabled. Forcing it to close will also terminate the Nelson session.</p>
66+
<p>Some low-level Nelson functions (and certain external libraries) output their messages directly to the consolebox.</p>
67+
<p>Since these messages could clutter the main Nelson console, they are not displayed there.</p>
68+
<p>Enabling the consolebox with consolebox on allows you to view these messages, which can be very useful for debugging.</p>
69+
</div>
70+
</div>
71+
<div class="section">
72+
<div class="section-title">
73+
<span class="syntax-icon">💡</span>Examples</div>
74+
<div class="example"><div style="display:flex;align-items:flex-start;gap:8px;">
75+
<pre class="syntax-block" style="flex:1 1 auto;margin:0;"><code class="language-matlab">consolebox(true)
76+
pause(10)
77+
consolebox('toggle')
78+
pause(10)
79+
consolebox(false)</code></pre>
80+
<button class="copy-btn" type="button" onclick="copyExample(this)" title="Copy"><svg xmlns="http://www.w3.org/2000/svg" width="18" height="18" viewBox="0 0 20 20" fill="none" style="display:block;"><rect x="7" y="3" width="10" height="14" rx="2" fill="white" fill-opacity="0.15" stroke="white" stroke-width="1.2"></rect><rect x="3" y="7" width="10" height="10" rx="2" fill="currentColor"></rect></svg></button>
81+
</div></div>
82+
</div>
83+
<div class="section">
84+
<div class="section-title">
85+
<span class="syntax-icon">🔗</span>See Also</div>
86+
<div><a class="see-also-link" href="../console/clc.html">clc</a></div>
87+
</div>
88+
<div class="section">
89+
<div class="section-title">
90+
<span class="syntax-icon">🕔</span>Version History</div>
91+
<table class="param-table">
92+
<tr>
93+
<th>Version</th>
94+
<th>Description</th>
95+
</tr>
96+
<tr>
97+
<td class="version">1.15.0</td>
98+
<td>initial version</td>
99+
</tr>
100+
</table>
101+
</div>
102+
<!--Author: Allan CORNET--><div class="section" style="margin-top:40px; text-align:center;">
103+
<a id="github-edit-link" class="github-edit-btn" target="_blank" rel="noopener noreferrer"><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M12 20h9"></path><path d="M16.5 3.5a2.121 2.121 0 0 1 3 3L7 19l-4 1 1-4L16.5 3.5z"></path></svg><span id="github-edit-text">Edit this page on GitHub</span></a><style>
104+
.github-edit-btn { display:inline-flex; align-items:center; gap:6px; font-size:14px; padding:6px 12px; border:1px solid #ddd; border-radius:4px; background:#f5f5f5; color:#333; text-decoration:none; transition:all 0.2s ease; }
105+
.github-edit-btn:hover { background:#e9e9e9; border-color:#ccc; color:#000; }
106+
</style>
107+
</div>
108+
</body>
109+
</html>

docs/releases/en_US/v1.15.0/console/help_toc_summary.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
<p>These features allow scripts and applications to communicate directly with the user through the console, making it easier to build interactive workflows and adapt output to the current terminal environment.</p>
1010
</chapter_description>
1111
<keyword name="clc" link="clc.html" description="Clear Command Window."/>
12+
<keyword name="consolebox" link="consolebox.html" description="Displays or hides the Windows terminal associated with the Nelson session."/>
1213
<keyword name="input" link="input.html" description="Display prompt and wait for user input."/>
1314
<keyword name="terminal_size" link="terminal_size.html" description="Query the size of the terminal window."/>
1415
</section>

docs/releases/en_US/v1.15.0/console/index.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@
2727
<a class="toc-link" href="clc.html" target="contentFrame">clc</a><div class="keyword-desc" style="font-size:0.92em; color:#888; margin-left:18px; margin-top:2px;">Clear Command Window.</div>
2828
</li>
2929
<li class="toc-entry">
30+
<a class="toc-link" href="consolebox.html" target="contentFrame">consolebox</a><div class="keyword-desc" style="font-size:0.92em; color:#888; margin-left:18px; margin-top:2px;">Displays or hides the Windows terminal associated with the Nelson session.</div>
31+
</li>
32+
<li class="toc-entry">
3033
<a class="toc-link" href="input.html" target="contentFrame">input</a><div class="keyword-desc" style="font-size:0.92em; color:#888; margin-left:18px; margin-top:2px;">Display prompt and wait for user input.</div>
3134
</li>
3235
<li class="toc-entry">

docs/releases/en_US/v1.15.0/data_analysis/help_toc_summary.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
<keyword name="min" link="min.html" description="Minimum elements of an array."/>
1919
<keyword name="prod" link="prod.html" description="Product of array elements."/>
2020
<keyword name="sort" link="sort.html" description="Sort array elements by quick sort algorithm."/>
21+
<keyword name="subspace" link="subspace.html" description="Measure of distance (angle) between two subspaces spanned by columns of matrices."/>
2122
<keyword name="sum" link="sum.html" description="Sum of array elements."/>
2223
<keyword name="unique" link="unique.html" description="Unique values."/>
2324
</section>

docs/releases/en_US/v1.15.0/data_analysis/index.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@
5454
<a class="toc-link" href="sort.html" target="contentFrame">sort</a><div class="keyword-desc" style="font-size:0.92em; color:#888; margin-left:18px; margin-top:2px;">Sort array elements by quick sort algorithm.</div>
5555
</li>
5656
<li class="toc-entry">
57+
<a class="toc-link" href="subspace.html" target="contentFrame">subspace</a><div class="keyword-desc" style="font-size:0.92em; color:#888; margin-left:18px; margin-top:2px;">Measure of distance (angle) between two subspaces spanned by columns of matrices.</div>
58+
</li>
59+
<li class="toc-entry">
5760
<a class="toc-link" href="sum.html" target="contentFrame">sum</a><div class="keyword-desc" style="font-size:0.92em; color:#888; margin-left:18px; margin-top:2px;">Sum of array elements.</div>
5861
</li>
5962
<li class="toc-entry">

0 commit comments

Comments
 (0)