Skip to content

Commit a990212

Browse files
Nelson-numerical-softwareNelson-numerical-software
committed
help v0.2.3
1 parent cc8e468 commit a990212

12 files changed

Lines changed: 253 additions & 2 deletions

File tree

‎en/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
![banner](banner_homepage.png)
22

3-
### Nelson 0.2.2.0
3+
### Nelson 0.2.3.0
44

55
This is an pre-release of Nelson.
66

‎en/SUMMARY.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,13 +256,16 @@
256256
* [int2str](./string/int2str.md)
257257
* [mat2str](./string/mat2str.md)
258258
* [newline](./string/newline.md)
259+
* [replace](./string/replace.md)
259260
* [startsWith](./string/startsWith.md)
260261
* [str2double](./string/str2double.md)
261262
* [strcmp](./string/strcmp.md)
262263
* [strcmpi](./string/strcmpi.md)
263264
* [strfind](./string/strfind.md)
265+
* [strlength](./string/strlength.md)
264266
* [strncmp](./string/strncmp.md)
265267
* [strncmpi](./string/strncmpi.md)
268+
* [strrep](./string/strrep.md)
266269
* [tolower](./string/tolower.md)
267270
* [toupper](./string/toupper.md)
268271

@@ -444,6 +447,7 @@
444447

445448
* [help_tools](./help_tools/README.md)
446449
* [buildhelp](./help_tools/buildhelp.md)
450+
* [buildhelpmd](./help_tools/buildhelpmd.md)
447451
* [buildhelpweb](./help_tools/buildhelpweb.md)
448452
* [headcomments](./help_tools/headcomments.md)
449453
* [htmltopdf](./help_tools/htmltopdf.md)
@@ -452,6 +456,7 @@
452456
* [xmldocchecker](./help_tools/xmldocchecker.md)
453457
* [xmldoctohelp](./help_tools/xmldoctohelp.md)
454458
* [xmldoctohtml](./help_tools/xmldoctohtml.md)
459+
* [xmldoctomd](./help_tools/xmldoctomd.md)
455460

456461

457462
* [localization](./localization/README.md)

‎en/help_tools/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ help tools
99

1010

1111
* [buildhelp](buildhelp.md) - Build help of Nelson's modules.
12+
* [buildhelpmd](buildhelpmd.md) - Build help of Nelson's modules for GitBook.
1213
* [buildhelpweb](buildhelpweb.md) - Build help of Nelson's modules for website.
1314
* [headcomments](headcomments.md) - Display Nelson function header comments.
1415
* [htmltopdf](htmltopdf.md) - Convers html page to pdf.
@@ -17,6 +18,7 @@ help tools
1718
* [xmldocchecker](xmldocchecker.md) - Checks a xml documentation file.
1819
* [xmldoctohelp](xmldoctohelp.md) - Converts xml Nelson help files to Nelson format.
1920
* [xmldoctohtml](xmldoctohtml.md) - Converts xml Nelson help files to html.
21+
* [xmldoctomd](xmldoctomd.md) - Converts xml Nelson help files to markdown format.
2022

2123

2224

‎en/help_tools/SUMMARY.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
* [help_tools](README.md)
22
* [buildhelp](buildhelp.md)
3+
* [buildhelpmd](buildhelpmd.md)
34
* [buildhelpweb](buildhelpweb.md)
45
* [headcomments](headcomments.md)
56
* [htmltopdf](htmltopdf.md)
@@ -8,4 +9,5 @@
89
* [xmldocchecker](xmldocchecker.md)
910
* [xmldoctohelp](xmldoctohelp.md)
1011
* [xmldoctohtml](xmldoctohtml.md)
12+
* [xmldoctomd](xmldoctomd.md)
1113

‎en/help_tools/buildhelpmd.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
2+
3+
# buildhelpmd
4+
5+
Build help of Nelson's modules for GitBook.
6+
7+
## Syntax
8+
9+
- buildhelpmd(dirdest)
10+
- buildhelpmd(dirdest, module_name)
11+
12+
## Input argument
13+
14+
- dirdest - a string: a path destination.
15+
- module_name - a string: module name (module must be loaded).
16+
17+
## Description
18+
19+
20+
<p><b>buildhelpmd</b> generates help files for GitBook (markdown).</p>
21+
22+
23+
## Example
24+
25+
```matlab
26+
buildhelpmd(tempdir());
27+
buildhelpmd(tempdir(), 'core');
28+
```
29+
30+
## See also
31+
32+
[buildhelp](buildhelp.md), [doc](../help_browser/doc.md).
33+
## History
34+
35+
|Version|Description|
36+
|------|------|
37+
|1.0.0|initial version|
38+
39+
40+
## Author
41+
42+
Allan CORNET
43+
44+
45+

‎en/help_tools/xmldoctomd.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
2+
3+
# xmldoctomd
4+
5+
Converts xml Nelson help files to markdown format.
6+
7+
## Syntax
8+
9+
- status = xmldoctomd(source_dirs, destination_dir, main_title, overwrite)
10+
11+
## Input argument
12+
13+
- source_dirs - a cell of string: list of xml filenames.
14+
- destination_dir - a string: directory destination.
15+
- main_title - a string: title of main index.
16+
- overwrite - a logical: force overwrite if file destination already exists
17+
18+
## Output argument
19+
20+
- status - a logical: files generated or not.
21+
22+
## Description
23+
24+
25+
<p><b>xmldoctomd</b> converts xml Nelson help files to markdown format.</p>
26+
27+
28+
## See also
29+
30+
[xmldocbuild](xmldocbuild.md), [buildhelpmd](buildhelpmd.md), [buildhelpweb](buildhelpweb.md).
31+
## History
32+
33+
|Version|Description|
34+
|------|------|
35+
|1.0.0|initial version|
36+
37+
38+
## Author
39+
40+
Allan CORNET
41+
42+
43+

‎en/string/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,16 @@ string type functions
1515
* [int2str](int2str.md) - Convert an integer array to a string
1616
* [mat2str](mat2str.md) - Matrix to String.
1717
* [newline](newline.md) - Returns a newline character.
18+
* [replace](replace.md) - Replaces strings in another.
1819
* [startsWith](startsWith.md) - checks if string starts with pattern.
1920
* [str2double](str2double.md) - Converts a string to double.
2021
* [strcmp](strcmp.md) - Strings comparaison.
2122
* [strcmpi](strcmpi.md) - Strings comparaison (case insensitive).
2223
* [strfind](strfind.md) - Find a string in another.
24+
* [strlength](strlength.md) - Length of strings in cell of strings.
2325
* [strncmp](strncmp.md) - Compares first n characters of strings.
2426
* [strncmpi](strncmpi.md) - Compares first n characters of strings (case sensitive).
27+
* [strrep](strrep.md) - Replaces strings in another.
2528
* [tolower](tolower.md) - Lower case conversion.
2629
* [toupper](toupper.md) - Upper case conversion.
2730

‎en/string/SUMMARY.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,16 @@
66
* [int2str](int2str.md)
77
* [mat2str](mat2str.md)
88
* [newline](newline.md)
9+
* [replace](replace.md)
910
* [startsWith](startsWith.md)
1011
* [str2double](str2double.md)
1112
* [strcmp](strcmp.md)
1213
* [strcmpi](strcmpi.md)
1314
* [strfind](strfind.md)
15+
* [strlength](strlength.md)
1416
* [strncmp](strncmp.md)
1517
* [strncmpi](strncmpi.md)
18+
* [strrep](strrep.md)
1619
* [tolower](tolower.md)
1720
* [toupper](toupper.md)
1821

‎en/string/replace.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
2+
3+
# replace
4+
5+
Replaces strings in another.
6+
7+
## Syntax
8+
9+
- res = replace(str, old, new)
10+
11+
## Input argument
12+
13+
- str - a string or cell of strings.
14+
- old - a string or cell of strings to find.
15+
- new - a string or cell of strings.
16+
17+
## Output argument
18+
19+
- res - a string or cell of strings.
20+
21+
## Description
22+
23+
24+
<p><b>replace</b> replaces strings in another.</p>
25+
<p><b>replace</b> and <b>strrep</b> replace strings but <b>replace</b> is recommended.</p>
26+
27+
28+
## Example
29+
30+
```matlab
31+
r = replace('This is a string.', 'is', 'is not')
32+
r = replace({'cccc','ccbbcca'},{'cc','bb'},{'cc'})
33+
```
34+
35+
## See also
36+
37+
[strrep](strrep.md).
38+
## History
39+
40+
|Version|Description|
41+
|------|------|
42+
|1.0.0|initial version|
43+
44+
45+
## Author
46+
47+
Allan CORNET
48+
49+
50+

‎en/string/strlength.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
2+
3+
# strlength
4+
5+
Length of strings in cell of strings.
6+
7+
## Syntax
8+
9+
- len = strlength(ce)
10+
11+
## Input argument
12+
13+
- ce - a string or cell of strings.
14+
15+
## Output argument
16+
17+
- len - a matrix of integer values: length of strings.
18+
19+
## Description
20+
21+
<b>strlength</b> returns length of strings in cell of strings.
22+
23+
## Example
24+
25+
```matlab
26+
str = 'To make a mountain out of a molehill';
27+
k = strlength(str)
28+
29+
A = {'Nel', 'son'; 'Toolboxes', 'Modules'}
30+
k = strlength(A)
31+
```
32+
33+
## See also
34+
35+
[strcmp](strcmp.md).
36+
## History
37+
38+
|Version|Description|
39+
|------|------|
40+
|1.0.0|initial version|
41+
42+
43+
## Author
44+
45+
Allan CORNET
46+
47+
48+

0 commit comments

Comments
 (0)