Exporting help in the HTML table format

FOR COMMERCIAL USE, PLEASE ENSURE YOU HAVE A COMMERCIAL LICENSE.
ANOTHER WAY TO SUPPORT MY WORK IS BY PURCHASING MY BOOK, CUSTOMER FIRST, VALUE NEXT.
THANK YOU FOR SUPPORTING MY WORK!

The tutorial consists of more than 200 live examples from 50 sections given separately for JAVA, C# and C++. Each of the examples can be copied and run on your own environment. In addition, mXparser provides an extensive collection of over 500 built-in math functions, expressions and symbols. Familiarize yourself with the scope and the syntax. Live testing is the best way to learn. Good luck! 🙂

Tutorial Math Collection API spec Download

Below is the code for JAVA, C# (the code for C# is almost identical) and C++. To copy the code, double-click inside the frame.

List of available options

Java/C# code
// JAVA: import org.mariuszgromada.math.mxparser.*;
// C#: using org.mariuszgromada.math.mxparser;
// ...

// Only built-in elements
String mXparser.getHelpAsHtmlTable();
String mXparser.getHelpAsHtmlTable(String query);
String mXparser.getHelpAsHtmlTable(
      boolean addHeader
      ,boolean addCaption
      ,boolean addFigure
     ,String caption
     ,String cssClass
   );
String mXparser.getHelpAsHtmlTable(
      String query
      ,boolean addHeader
      ,boolean addCaption
      ,boolean addFigure
      ,String caption
      ,String cssClass
   );
// JAVA: import org.mariuszgromada.math.mxparser.*;
// C#: using org.mariuszgromada.math.mxparser;
// ...

// Also with user-defined elements, when e is an instance of Expression
String e.getHelpAsHtmlTable();
String e.getHelpAsHtmlTable(String query);
String e.getHelpAsHtmlTable(
      boolean addHeader
      ,boolean addCaption
      ,boolean addFigure
     ,String caption
     ,String cssClass
   );
String e.getHelpAsHtmlTable(
      String query
      ,boolean addHeader
      ,boolean addCaption
      ,boolean addFigure
      ,String caption
      ,String cssClass
   );
C++ code
#include "org/mariuszgromada/math/mxparser.hpp"
// ...

// Only built-in elements
StringPtr mXparser::getHelpAsHtmlTable();
StringPtr mXparser::getHelpAsHtmlTable(const std::string &query);
StringPtr mXparser::getHelpAsHtmlTable(
      bool addHeader
      ,bool addCaption
      ,bool addFigure
     ,const std::string &caption
     ,const std::string &cssClass
   );
StringPtr mXparser::getHelpAsHtmlTable(
      const std::string &query
      ,bool addHeader
      ,bool addCaption
      ,bool addFigure
      ,const std::string &caption
      ,const std::string &cssClass
   );
#include "org/mariuszgromada/math/mxparser.hpp"
// ...

// Also with user-defined elements, when e is an instance of ExpressionPtr
StringPtr e->getHelpAsHtmlTable();
StringPtr e->getHelpAsHtmlTable(const std::string &query);
StringPtr e->getHelpAsHtmlTable(
      bool addHeader
      ,bool addCaption
      ,bool addFigure
     ,const std::string &caption
     ,const std::string &cssClass
   );
StringPtr e->getHelpAsHtmlTable(
      const std::string &query
      ,bool addHeader
      ,bool addCaption
      ,bool addFigure
      ,const std::string &caption
      ,const std::string &cssClass
   );

Query parameter syntax

For a basic in-line search, simply provide a word (e.g.: "sine") in the query parameter.
Advanced search is also possible, please use one of the tags below when formatting the query parameter:
  • "key=" – keyword (e.g.: "key=sin")
  • "desc=" – description (e.g.: "desc=trigonometric"),
  • "syn=" – syntax (e.g.: "syn=sin")
  • "type=" – type (e.g.: "type=unit")
  • "since=" – since (e.g.: "since=4.1")
  • "typeid=" – please refer to parser tokens (e.g.: "typeid=3")
  • "keyid=" – please refer to parser tokens (e.g.: "keyid=1004").

Only one tag can be used per search.

Other parameters

Other parameters are self-explanatory by their names. In case you need more details please refer the API documentation.

Case 1: Output with header + figure tag + standard caption + CSS class + advanced search

Java/C# code
// JAVA: import org.mariuszgromada.math.mxparser.*;
// C#: using org.mariuszgromada.math.mxparser;
// ...
String helpHtml = mXparser.getHelpAsHtmlTable(
		"type=Bitwise operator"
		,true
		,true
		,true
		,""
		,"wp-block-table"
	);

mXparser.consolePrint("\n");
mXparser.consolePrintln(helpHtml);
C++ code
#include "org/mariuszgromada/math/mxparser.hpp"
// ...
StringPtr helpHtml = mXparser::getHelpAsHtmlTable(
        "type=Bitwise operator"
        ,true
        ,true
        ,true
        ,""
        ,"wp-block-table"
    );

mXparser::consolePrint("\n");
mXparser::consolePrintln(helpHtml);
Code result
[mXparser-v.5.2.0] 
<figure class="wp-block-table">
<table>
<tbody>
<tr><th>Keyword</th><th>Type</th><th>Syntax</th><th>Since</th><th>Description</th></tr>
<tr><td>@~</td><td>Bitwise operator</td><td>@~a</td><td>4.0</td><td>Bitwise unary complement - Bitwise operator</td></tr>
<tr><td>@&amp;</td><td>Bitwise operator</td><td>a @&amp; b</td><td>4.0</td><td>Bitwise and AND - Bitwise operator</td></tr>
<tr><td>@^</td><td>Bitwise operator</td><td>a @^ b</td><td>4.0</td><td>Bitwise exclusive or XOR - Bitwise operator</td></tr>
<tr><td>@|</td><td>Bitwise operator</td><td>a @| b</td><td>4.0</td><td>Bitwise inclusive or OR - Bitwise operator</td></tr>
<tr><td>@&lt;&lt;</td><td>Bitwise operator</td><td>a @&lt;&lt; b</td><td>4.0</td><td>Signed left shift - Bitwise operator</td></tr>
<tr><td>@&gt;&gt;</td><td>Bitwise operator</td><td>a @&gt;&gt; b</td><td>4.0</td><td>Signed right shift - Bitwise operator</td></tr>
</tbody>
</table>
<figcaption>Help content limited to query: 'type=Bitwise operator'</figcaption>
</figure>
Above html code rendering
KeywordTypeSyntaxSinceDescription
@~Bitwise operator@~a4.0Bitwise unary complement – Bitwise operator
@&Bitwise operatora @& b4.0Bitwise and AND – Bitwise operator
@^Bitwise operatora @^ b4.0Bitwise exclusive or XOR – Bitwise operator
@|Bitwise operatora @| b4.0Bitwise inclusive or OR – Bitwise operator
@<<Bitwise operatora @<< b4.0Signed left shift – Bitwise operator
@>>Bitwise operatora @>> b4.0Signed right shift – Bitwise operator
Help content limited to query: ‘type=Bitwise operator’

Case 2: Output with header + standard caption + CSS class + advanced search

Java/C# code
// JAVA: import org.mariuszgromada.math.mxparser.*;
// C#: using org.mariuszgromada.math.mxparser;
// ...
String helpHtml = mXparser.getHelpAsHtmlTable(
		"type=Bitwise operator"
		,true
		,true
		,false
		,""
		,"wp-block-table"
	);

mXparser.consolePrint("\n");
mXparser.consolePrintln(helpHtml);
C++ code
#include "org/mariuszgromada/math/mxparser.hpp"
// ...

StringPtr helpHtml = mXparser::getHelpAsHtmlTable(
        "type=Bitwise operator"
        ,true
        ,true
        ,false
        ,""
        ,"wp-block-table"
    );

mXparser::consolePrint("\n");
mXparser::consolePrintln(helpHtml);
Code result
[mXparser-v.5.2.0] 
<table class="wp-block-table">
<caption>Help content limited to query: 'type=Bitwise operator'</caption>
<tbody>
<tr><th>Keyword</th><th>Type</th><th>Syntax</th><th>Since</th><th>Description</th></tr>
<tr><td>@~</td><td>Bitwise operator</td><td>@~a</td><td>4.0</td><td>Bitwise unary complement - Bitwise operator</td></tr>
<tr><td>@&amp;</td><td>Bitwise operator</td><td>a @&amp; b</td><td>4.0</td><td>Bitwise and AND - Bitwise operator</td></tr>
<tr><td>@^</td><td>Bitwise operator</td><td>a @^ b</td><td>4.0</td><td>Bitwise exclusive or XOR - Bitwise operator</td></tr>
<tr><td>@|</td><td>Bitwise operator</td><td>a @| b</td><td>4.0</td><td>Bitwise inclusive or OR - Bitwise operator</td></tr>
<tr><td>@&lt;&lt;</td><td>Bitwise operator</td><td>a @&lt;&lt; b</td><td>4.0</td><td>Signed left shift - Bitwise operator</td></tr>
<tr><td>@&gt;&gt;</td><td>Bitwise operator</td><td>a @&gt;&gt; b</td><td>4.0</td><td>Signed right shift - Bitwise operator</td></tr>
</tbody>
</table>
Above html code rendering
Help content limited to query: ‘type=Bitwise operator’
KeywordTypeSyntaxSinceDescription
@~Bitwise operator@~a4.0Bitwise unary complement – Bitwise operator
@&Bitwise operatora @& b4.0Bitwise and AND – Bitwise operator
@^Bitwise operatora @^ b4.0Bitwise exclusive or XOR – Bitwise operator
@|Bitwise operatora @| b4.0Bitwise inclusive or OR – Bitwise operator
@<<Bitwise operatora @<< b4.0Signed left shift – Bitwise operator
@>>Bitwise operatora @>> b4.0Signed right shift – Bitwise operator

Case 3: Output with header + user caption + CSS class + advanced search

Java/C# code
// JAVA: import org.mariuszgromada.math.mxparser.*;
// C#: using org.mariuszgromada.math.mxparser;
// ...
String helpHtml = mXparser.getHelpAsHtmlTable(
		"type=Bitwise operator"
		,true
		,true
		,false
		,"This is a caption"
		,"wp-block-table"
	);

mXparser.consolePrint("\n");
mXparser.consolePrintln(helpHtml);
C++ code
#include "org/mariuszgromada/math/mxparser.hpp"
// ...
StringPtr helpHtml = mXparser::getHelpAsHtmlTable(
        "type=Bitwise operator"
        ,true
        ,true
        ,false
        ,"This is a caption"
        ,"wp-block-table"
    );

mXparser::consolePrint("\n");
mXparser::consolePrintln(helpHtml);
Code result
[mXparser-v.5.2.0] 
<table class="wp-block-table">
<caption>This is a caption</caption>
<tbody>
<tr><th>Keyword</th><th>Type</th><th>Syntax</th><th>Since</th><th>Description</th></tr>
<tr><td>@~</td><td>Bitwise operator</td><td>@~a</td><td>4.0</td><td>Bitwise unary complement - Bitwise operator</td></tr>
<tr><td>@&amp;</td><td>Bitwise operator</td><td>a @&amp; b</td><td>4.0</td><td>Bitwise and AND - Bitwise operator</td></tr>
<tr><td>@^</td><td>Bitwise operator</td><td>a @^ b</td><td>4.0</td><td>Bitwise exclusive or XOR - Bitwise operator</td></tr>
<tr><td>@|</td><td>Bitwise operator</td><td>a @| b</td><td>4.0</td><td>Bitwise inclusive or OR - Bitwise operator</td></tr>
<tr><td>@&lt;&lt;</td><td>Bitwise operator</td><td>a @&lt;&lt; b</td><td>4.0</td><td>Signed left shift - Bitwise operator</td></tr>
<tr><td>@&gt;&gt;</td><td>Bitwise operator</td><td>a @&gt;&gt; b</td><td>4.0</td><td>Signed right shift - Bitwise operator</td></tr>
</tbody>
</table>
Above html code rendering
This is a caption
KeywordTypeSyntaxSinceDescription
@~Bitwise operator@~a4.0Bitwise unary complement – Bitwise operator
@&Bitwise operatora @& b4.0Bitwise and AND – Bitwise operator
@^Bitwise operatora @^ b4.0Bitwise exclusive or XOR – Bitwise operator
@|Bitwise operatora @| b4.0Bitwise inclusive or OR – Bitwise operator
@<<Bitwise operatora @<< b4.0Signed left shift – Bitwise operator
@>>Bitwise operatora @>> b4.0Signed right shift – Bitwise operator

Case 4: Output with no header and no caption and no CSS class + advanced search

Java/C# code
// JAVA: import org.mariuszgromada.math.mxparser.*;
// C#: using org.mariuszgromada.math.mxparser;
// ...
String helpHtml = mXparser.getHelpAsHtmlTable(
		"type=Bitwise operator"
		,false
		,false
		,false
		,""
		,""
	);

mXparser.consolePrint("\n");
mXparser.consolePrintln(helpHtml);
C++ code
#include "org/mariuszgromada/math/mxparser.hpp"
// ...

StringPtr helpHtml = mXparser::getHelpAsHtmlTable(
        "type=Bitwise operator"
        ,false
        ,false
        ,false
        ,""
        ,""
    );

mXparser::consolePrint("\n");
mXparser::consolePrintln(helpHtml);
Code result
[mXparser-v.5.2.0] 
<table>
<tbody>
<tr><td>@~</td><td>Bitwise operator</td><td>@~a</td><td>4.0</td><td>Bitwise unary complement - Bitwise operator</td></tr>
<tr><td>@&amp;</td><td>Bitwise operator</td><td>a @&amp; b</td><td>4.0</td><td>Bitwise and AND - Bitwise operator</td></tr>
<tr><td>@^</td><td>Bitwise operator</td><td>a @^ b</td><td>4.0</td><td>Bitwise exclusive or XOR - Bitwise operator</td></tr>
<tr><td>@|</td><td>Bitwise operator</td><td>a @| b</td><td>4.0</td><td>Bitwise inclusive or OR - Bitwise operator</td></tr>
<tr><td>@&lt;&lt;</td><td>Bitwise operator</td><td>a @&lt;&lt; b</td><td>4.0</td><td>Signed left shift - Bitwise operator</td></tr>
<tr><td>@&gt;&gt;</td><td>Bitwise operator</td><td>a @&gt;&gt; b</td><td>4.0</td><td>Signed right shift - Bitwise operator</td></tr>
</tbody>
</table>
Above html code rendering
@~Bitwise operator@~a4.0Bitwise unary complement – Bitwise operator
@&Bitwise operatora @& b4.0Bitwise and AND – Bitwise operator
@^Bitwise operatora @^ b4.0Bitwise exclusive or XOR – Bitwise operator
@|Bitwise operatora @| b4.0Bitwise inclusive or OR – Bitwise operator
@<<Bitwise operatora @<< b4.0Signed left shift – Bitwise operator
@>>Bitwise operatora @>> b4.0Signed right shift – Bitwise operator
Nuget – Package Manager (C#, F#, Visual Basic, …)

Install-Package MathParser.org-mXparser-Version 6.1.1

Nuget – .NET CLI

dotnet add package MathParser.org-mXparser--version 6.1.1

Nuget – Package Reference

<PackageReference Include="MathParser.org-mXparser"Version="6.1.1"/>

Maven – Dependency (Java, Kotlin, Scala, Groovy, …)

<dependency>
<groupid>
org.mariuszgromada.math</groupid>
<artifactid>
MathParser.org-mXparser</artifactid>
<version>
6.1.1</version>
</dependency>

Maven – Gradle

implementation 'org.mariuszgromada.math:MathParser.org-mXparser:6.1.1'

CMake – Dependency / FetchContent (C++, MSVC, LLVM/Clang, GNU/GCC, MinGW, MSYS2, WSL, Windows, Linux, Unix, MacOS)

include(FetchContent)
FetchContent_Declare(
MathParserOrgMxParser
GIT_REPOSITORY
https://github.com/mariuszgromada/MathParser.org-mXparser.git
GIT_TAG
v.6.1.1
SOURCE_SUBDIR CURRENT/cpp/lib
)
FetchContent_MakeAvailable(
MathParserOrgMxParser)
mxparser_link(YourExecutable)

GitHub

git clone https://github.com/mariuszgromada/MathParser.org-mXparser

OTHER DOWNLOAD OPTIONS

Download latest release – v.6.1.0 Sagitara: .NET bin onlyDownload latest release – v.6.1.0 Sagitara: JAVA bin onlyDownload latest release – v.6.1.0 Sagitara: bin + doc

NEWS FROM MATHPARSER.ORG
SOURCE CODE

Source code .zipSource code .tar.gz
View on GitHubMathSpace.pl

My other creative spaces

DONATION
Did you find the software useful?
Please consider donation 🙂
DONATE