Skip to content

Commit 5a6a6d7

Browse files
v1.11.0 help files
1 parent b486714 commit 5a6a6d7

26 files changed

Lines changed: 245204 additions & 241126 deletions

File tree

docs/releases/en_US/v1.11.0/changelogs/CHANGELOG.html

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -159,16 +159,31 @@ <h1 id="changelog"><a class="header" href="#changelog">Changelog</a></h1>
159159
<p>All notable changes to this project will be documented in this file.</p>
160160
<p>The format is based on <a href="https://keepachangelog.com/en/1.0.0/">Keep a Changelog</a>,
161161
and this project adheres to <a href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p>
162-
<h2 id="1110-unreleased"><a class="header" href="#1110-unreleased">1.11.0 (UNRELEASED)</a></h2>
162+
<h2 id="1110-2025-01-11"><a class="header" href="#1110-2025-01-11">1.11.0 (2025-01-11)</a></h2>
163163
<h3 id="added"><a class="header" href="#added">Added</a></h3>
164164
<ul>
165+
<li><a href="http://github.com/nelson-lang/nelson/issues/1321">#1321</a> <code>mustBeSparse</code> validator function.</li>
166+
<li><a href="http://github.com/nelson-lang/nelson/issues/1322">#1322</a> <code>cmdsep</code>: Command separator for current operating system.</li>
165167
<li><code>urlencode</code>: Replace special characters in URLs with escape characters.</li>
166168
<li><code>docroot</code>: Utility to retrieve or define the root directory of Nelson Help.</li>
167169
<li><code>ismodule</code>: second input argument <code>isprotected</code> added.</li>
170+
<li><code>editor('editor_command', cmd)</code> allows to change text editor in Nelson (for example: VS Code).</li>
171+
<li><code>NELSON_RUNTIME_PATH</code> environment variable added by installer on Windows.</li>
172+
<li><code>--vscode</code> command line argument added.</li>
173+
<li>NixOS 24.11 packaging (see <a href="https://github.com/nelson-lang/nelson/blob/master/BUILDING_Linux.md">BUILDING_Linux.md</a>).</li>
168174
</ul>
169175
<h3 id="changed"><a class="header" href="#changed">Changed</a></h3>
170176
<ul>
171177
<li>Help Center: Access documentation in your system's web browser. Previously, the documentation was opened in the embedded Help browser.</li>
178+
<li>CA certificate store update.</li>
179+
<li>fmt library dependency updated.</li>
180+
<li>BS::threadpool library dependency updated.</li>
181+
<li>Advanced terminal updated (common for all platforms without GUI, auto completion, search history).</li>
182+
<li>Python 3.13.1 supported.</li>
183+
</ul>
184+
<h3 id="fixed"><a class="header" href="#fixed">Fixed</a></h3>
185+
<ul>
186+
<li><a href="http://github.com/nelson-lang/nelson/issues/1324">#1324</a> Cell display could not be interrupted.</li>
172187
</ul>
173188
<h2 id="1100-2024-12-14"><a class="header" href="#1100-2024-12-14">1.10.0 (2024-12-14)</a></h2>
174189
<h3 id="added-1"><a class="header" href="#added-1">Added</a></h3>
@@ -200,7 +215,7 @@ <h3 id="changed-1"><a class="header" href="#changed-1">Changed</a></h3>
200215
<li><code>strjust</code>: rework the function to be more fast and robust.</li>
201216
<li><code>datenum</code>: support '' as format for compatibility.</li>
202217
</ul>
203-
<h3 id="fixed"><a class="header" href="#fixed">Fixed</a></h3>
218+
<h3 id="fixed-1"><a class="header" href="#fixed-1">Fixed</a></h3>
204219
<ul>
205220
<li><a href="http://github.com/nelson-lang/nelson/issues/1303">#1303</a> <code>datevec</code> result must be normalized.</li>
206221
<li><a href="http://github.com/nelson-lang/nelson/issues/1297">#1297</a> some features have no help files.</li>
@@ -298,7 +313,7 @@ <h3 id="changed-3"><a class="header" href="#changed-3">Changed</a></h3>
298313
<ul>
299314
<li>CodeQL Github action updated.</li>
300315
</ul>
301-
<h3 id="fixed-1"><a class="header" href="#fixed-1">Fixed</a></h3>
316+
<h3 id="fixed-2"><a class="header" href="#fixed-2">Fixed</a></h3>
302317
<ul>
303318
<li>fix 'units' refresh for 'axes' object.</li>
304319
</ul>
@@ -379,7 +394,7 @@ <h3 id="changed-5"><a class="header" href="#changed-5">Changed</a></h3>
379394
<p>dtl 1.2.0</p>
380395
</li>
381396
</ul>
382-
<h3 id="fixed-2"><a class="header" href="#fixed-2">Fixed</a></h3>
397+
<h3 id="fixed-3"><a class="header" href="#fixed-3">Fixed</a></h3>
383398
<ul>
384399
<li><a href="http://github.com/nelson-lang/nelson/issues/1210">#1210</a> <code>bode</code> did not unwrap phase.</li>
385400
<li><a href="http://github.com/nelson-lang/nelson/issues/1206">#1206</a> <code>balance</code> yields wrong Transformation Matrix.</li>
@@ -432,7 +447,7 @@ <h3 id="changed-6"><a class="header" href="#changed-6">Changed</a></h3>
432447
<li>help files generated sorted by name on all platforms.</li>
433448
<li>on windows, Qt libraries used are in debug mode.</li>
434449
</ul>
435-
<h3 id="fixed-3"><a class="header" href="#fixed-3">Fixed</a></h3>
450+
<h3 id="fixed-4"><a class="header" href="#fixed-4">Fixed</a></h3>
436451
<ul>
437452
<li><a href="http://github.com/nelson-lang/nelson/issues/1195">#1195</a> <code>strcmp({'a'},["a"])</code> did not return expected value.</li>
438453
</ul>
@@ -474,7 +489,7 @@ <h3 id="changed-7"><a class="header" href="#changed-7">Changed</a></h3>
474489
<li>warning about 'Matrix is singular to working precision' for inv matrix.</li>
475490
<li>tests webtools skipped if connection fails or not available.</li>
476491
</ul>
477-
<h3 id="fixed-4"><a class="header" href="#fixed-4">Fixed</a></h3>
492+
<h3 id="fixed-5"><a class="header" href="#fixed-5">Fixed</a></h3>
478493
<ul>
479494
<li><a href="http://github.com/nelson-lang/nelson/issues/1144">#1144</a> test_run markdown help file had a typo.</li>
480495
<li><a href="http://github.com/nelson-lang/nelson/issues/1143">#1143</a> Linux Snapcraft version did not allow to use python.</li>
@@ -539,7 +554,7 @@ <h3 id="changed-8"><a class="header" href="#changed-8">Changed</a></h3>
539554
<li><a href="http://github.com/nelson-lang/nelson/issues/1134">#1134</a> [CI] MacOS X Ventura disabled (Install dependencies fails)</li>
540555
<li><code>struct</code> supports scalar string array as field name.</li>
541556
</ul>
542-
<h3 id="fixed-5"><a class="header" href="#fixed-5">Fixed</a></h3>
557+
<h3 id="fixed-6"><a class="header" href="#fixed-6">Fixed</a></h3>
543558
<ul>
544559
<li><a href="http://github.com/nelson-lang/nelson/issues/1110">#1110</a> add help about build and use C/C++ on fly.</li>
545560
<li><a href="http://github.com/nelson-lang/nelson/issues/1124">#1124</a> unexpected result from long statements on Multiple Lines.</li>
@@ -579,7 +594,7 @@ <h3 id="changed-9"><a class="header" href="#changed-9">Changed</a></h3>
579594
<li>Camera view reworked.</li>
580595
<li>Minimal screen resolution supported 800x600.</li>
581596
</ul>
582-
<h3 id="fixed-6"><a class="header" href="#fixed-6">Fixed</a></h3>
597+
<h3 id="fixed-7"><a class="header" href="#fixed-7">Fixed</a></h3>
583598
<ul>
584599
<li>Change directory with file browser line editor did not work as expected.</li>
585600
<li>Template to create a function with file browser was wrong.</li>

docs/releases/en_US/v1.11.0/engine/executable.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,7 @@ <h2 id="input-argument"><a class="header" href="#input-argument">Input argument<
174174
<li>-F filename - If this option is present then Nelson script file is executed just after startup file execution) into an existing Nelson's process or creates it.</li>
175175
<li>--help - help about program options.</li>
176176
<li>--version - Return Nelson version.</li>
177+
<li>--vscode - enable Visual Studio Code mode.</li>
177178
<li>--open - opens files arg2 ... argN must be valid/existing filenames.</li>
178179
<li>--mat - load files arg2 ... argN must be valid/existing .nh5 or .mat filenames.</li>
179180
<li>--nostartup - disable the main Nelson script file executed at startup.</li>
@@ -191,6 +192,9 @@ <h2 id="description"><a class="header" href="#description">Description</a></h2>
191192
<p><b>nelson-cli</b>: basic terminal, no gui (no dependency to gui framework), no history, no completion (iso latin encoding)</p>
192193
<p><b>nelson-adv-cli</b>: advanced terminal, no graphical console, history, completion available (UTF-16 support)</p>
193194
<p><b>nelson-gui</b>: graphical console, history, completion available (UTF-16 support)</p>
195+
<p/>
196+
<p>If you have installed Nelson on Windows, the <b>NELSON_RUNTIME_PATH</b> environment variable will be defined.</p>
197+
<p>It allows to call easily Nelson <b>"%NELSON_RUNTIME_PATH%\nelson.bat"</b>.</p>
194198
<h2 id="examples"><a class="header" href="#examples">Examples</a></h2>
195199
<pre><code class="language-matlab">nelson-adv-cli -q -e "a = 1 + 2"
196200
</code></pre>
@@ -204,6 +208,8 @@ <h2 id="history"><a class="header" href="#history">History</a></h2>
204208
<div class="table-wrapper"><table><thead><tr><th>Version</th><th>Description</th></tr></thead><tbody>
205209
<tr><td>1.0.0</td><td>initial version</td></tr>
206210
<tr><td>1.4.0</td><td>--without_python added</td></tr>
211+
<tr><td>1.11.0</td><td>About NELSON_RUNTIME_PATH environment variable added</td></tr>
212+
<tr><td>1.11.0</td><td>--vsocde argument</td></tr>
207213
</tbody></table>
208214
</div>
209215
<h2 id="author"><a class="header" href="#author">Author</a></h2>
Lines changed: 235 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,235 @@
1+
<!DOCTYPE HTML>
2+
<html lang="en" class="light sidebar-visible" dir="ltr">
3+
<head>
4+
<!-- Book generated using mdBook -->
5+
<meta charset="UTF-8">
6+
<title>cmdsep - Nelson</title>
7+
8+
9+
<!-- Custom HTML head -->
10+
11+
<meta name="description" content="">
12+
<meta name="viewport" content="width=device-width, initial-scale=1">
13+
<meta name="theme-color" content="#ffffff">
14+
15+
<link rel="icon" href="../favicon.svg">
16+
<link rel="shortcut icon" href="../favicon.png">
17+
<link rel="stylesheet" href="../css/variables.css">
18+
<link rel="stylesheet" href="../css/general.css">
19+
<link rel="stylesheet" href="../css/chrome.css">
20+
<link rel="stylesheet" href="../css/print.css" media="print">
21+
22+
<!-- Fonts -->
23+
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
24+
<link rel="stylesheet" href="../fonts/fonts.css">
25+
26+
<!-- Highlight.js Stylesheets -->
27+
<link rel="stylesheet" href="../highlight.css">
28+
<link rel="stylesheet" href="../tomorrow-night.css">
29+
<link rel="stylesheet" href="../ayu-highlight.css">
30+
31+
<!-- Custom theme stylesheets -->
32+
33+
34+
<!-- Provide site root to javascript -->
35+
<script>
36+
var path_to_root = "../";
37+
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
38+
</script>
39+
<!-- Start loading toc.js asap -->
40+
<script src="../toc.js"></script>
41+
</head>
42+
<body>
43+
<div id="body-container">
44+
<!-- Work around some values being stored in localStorage wrapped in quotes -->
45+
<script>
46+
try {
47+
var theme = localStorage.getItem('mdbook-theme');
48+
var sidebar = localStorage.getItem('mdbook-sidebar');
49+
50+
if (theme.startsWith('"') && theme.endsWith('"')) {
51+
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
52+
}
53+
54+
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
55+
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
56+
}
57+
} catch (e) { }
58+
</script>
59+
60+
<!-- Set the theme before any content is loaded, prevents flash -->
61+
<script>
62+
var theme;
63+
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
64+
if (theme === null || theme === undefined) { theme = default_theme; }
65+
const html = document.documentElement;
66+
html.classList.remove('light')
67+
html.classList.add(theme);
68+
html.classList.add("js");
69+
</script>
70+
71+
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
72+
73+
<!-- Hide / unhide sidebar before it is displayed -->
74+
<script>
75+
var sidebar = null;
76+
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
77+
if (document.body.clientWidth >= 1080) {
78+
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
79+
sidebar = sidebar || 'visible';
80+
} else {
81+
sidebar = 'hidden';
82+
}
83+
sidebar_toggle.checked = sidebar === 'visible';
84+
html.classList.remove('sidebar-visible');
85+
html.classList.add("sidebar-" + sidebar);
86+
</script>
87+
88+
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
89+
<!-- populated by js -->
90+
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
91+
<noscript>
92+
<iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
93+
</noscript>
94+
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
95+
<div class="sidebar-resize-indicator"></div>
96+
</div>
97+
</nav>
98+
99+
<div id="page-wrapper" class="page-wrapper">
100+
101+
<div class="page">
102+
<div id="menu-bar-hover-placeholder"></div>
103+
<div id="menu-bar" class="menu-bar sticky">
104+
<div class="left-buttons">
105+
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
106+
<i class="fa fa-bars"></i>
107+
</label>
108+
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
109+
<i class="fa fa-paint-brush"></i>
110+
</button>
111+
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
112+
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
113+
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
114+
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
115+
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
116+
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
117+
</ul>
118+
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
119+
<i class="fa fa-search"></i>
120+
</button>
121+
</div>
122+
123+
<h1 class="menu-title">Nelson</h1>
124+
125+
<div class="right-buttons">
126+
<a href="../print.html" title="Print this book" aria-label="Print this book">
127+
<i id="print-button" class="fa fa-print"></i>
128+
</a>
129+
<a href="https://nelson-lang.github.io/nelson-gitbook/" title="Git repository" aria-label="Git repository">
130+
<i id="git-repository-button" class="fa fa-github"></i>
131+
</a>
132+
133+
</div>
134+
</div>
135+
136+
<div id="search-wrapper" class="hidden">
137+
<form id="searchbar-outer" class="searchbar-outer">
138+
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
139+
</form>
140+
<div id="searchresults-outer" class="searchresults-outer hidden">
141+
<div id="searchresults-header" class="searchresults-header"></div>
142+
<ul id="searchresults">
143+
</ul>
144+
</div>
145+
</div>
146+
147+
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
148+
<script>
149+
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
150+
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
151+
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
152+
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
153+
});
154+
</script>
155+
156+
<div id="content" class="content">
157+
<main>
158+
<h1 id="cmdsep"><a class="header" href="#cmdsep">cmdsep</a></h1>
159+
<p>Command separator for current operating system.</p>
160+
<h2 id="syntax"><a class="header" href="#syntax">Syntax</a></h2>
161+
<ul>
162+
<li>sep = cmdsep()</li>
163+
</ul>
164+
<h2 id="output-argument"><a class="header" href="#output-argument">Output argument</a></h2>
165+
<ul>
166+
<li>sep - a string: on windows "&amp;&amp;", on linux ";"</li>
167+
</ul>
168+
<h2 id="description"><a class="header" href="#description">Description</a></h2>
169+
<p><b>cmdsep</b> returns the command separator for current operating system.</p>
170+
<p>This function is used by Nelson to build command lines for unix and dos operating systems.</p>
171+
<h2 id="example"><a class="header" href="#example">Example</a></h2>
172+
<pre><code class="language-matlab">unix("cd c:/ " + cmdsep() + " nelson")
173+
</code></pre>
174+
<h2 id="see-also"><a class="header" href="#see-also">See also</a></h2>
175+
<p><a href="unix.html">unix</a>.</p>
176+
<h2 id="history"><a class="header" href="#history">History</a></h2>
177+
<div class="table-wrapper"><table><thead><tr><th>Version</th><th>Description</th></tr></thead><tbody>
178+
<tr><td>1.11.0</td><td>initial version</td></tr>
179+
</tbody></table>
180+
</div>
181+
<h2 id="author"><a class="header" href="#author">Author</a></h2>
182+
<p>Allan CORNET</p>
183+
184+
</main>
185+
186+
<nav class="nav-wrapper" aria-label="Page navigation">
187+
<!-- Mobile navigation buttons -->
188+
<a rel="prev" href="../os_functions/index.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
189+
<i class="fa fa-angle-left"></i>
190+
</a>
191+
192+
<a rel="next prefetch" href="../os_functions/computer.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
193+
<i class="fa fa-angle-right"></i>
194+
</a>
195+
196+
<div style="clear: both"></div>
197+
</nav>
198+
</div>
199+
</div>
200+
201+
<nav class="nav-wide-wrapper" aria-label="Page navigation">
202+
<a rel="prev" href="../os_functions/index.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
203+
<i class="fa fa-angle-left"></i>
204+
</a>
205+
206+
<a rel="next prefetch" href="../os_functions/computer.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
207+
<i class="fa fa-angle-right"></i>
208+
</a>
209+
</nav>
210+
211+
</div>
212+
213+
214+
215+
216+
<script>
217+
window.playground_copyable = true;
218+
</script>
219+
220+
221+
<script src="../elasticlunr.min.js"></script>
222+
<script src="../mark.min.js"></script>
223+
<script src="../searcher.js"></script>
224+
225+
<script src="../clipboard.min.js"></script>
226+
<script src="../highlight.js"></script>
227+
<script src="../book.js"></script>
228+
229+
<!-- Custom JS scripts -->
230+
<script src="../theme/matlab.min.js"></script>
231+
232+
233+
</div>
234+
</body>
235+
</html>

0 commit comments

Comments
 (0)