Git commit b0ab05a07111d3749b899ebf61ff355992dc4a32 by Stefan Gerlach. Committed on 24/12/2016 at 04:12. Pushed by sgerlach into branch 'master'.
improved documentation of parser functions M +288 -263 doc/index.docbook https://commits.kde.org/labplot/b0ab05a07111d3749b899ebf61ff355992dc4a32 diff --git a/doc/index.docbook b/doc/index.docbook index afc46786..4c5a9d38 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -51,8 +51,8 @@ </copyright> <legalnotice>&FDLNotice;</legalnotice> -<date>2016-11-01</date> -<releaseinfo>3.3.0</releaseinfo> +<date>2016-12-24</date> +<releaseinfo>3.3.1</releaseinfo> <abstract> <para> @@ -1533,249 +1533,13 @@ data sources for the curves, add legends, export everything to pdf) would also h </chapter> -<chapter id="faq"> -<title>Questions and Answers</title> - -<qandaset id="faqlist"> - -<qandaentry> -<question> -<para>For which platforms is &LabPlot; available?</para> -</question> -<answer> -<para> -&LabPlot; is developed for Unix platforms and uses the &Qt; toolkit and &kde;. Normally you can expect &LabPlot; -to build and run on every platform &kde; (>=4) supports. -A recent list of supported platforms and tips for compiling and running &LabPlot; can be found on -<ulink url="http://labplot.wiki.sourceforge.net/Download";> -http://labplot.wiki.sourceforge.net/Download</ulink>. -</para> -</answer> -</qandaentry> - -<qandaentry><question> -<para>How do I export the active worksheet as image?</para> -</question> -<answer><para> -The standard way is to use <menuchoice><guimenu>File</guimenu><guimenuitem>Export</guimenuitem></menuchoice>. All &Qt; supported image formats are allowed. Just select the desired format and the active worksheet is exported. -</para></answer> -</qandaentry> - -<qandaentry> -<question> -<para>How do I use Greek letters for title, axes label, &etc;?</para> -</question> -<answer> -<para> - Use <guiicon>π</guiicon> button to open character selector window or <guiicon>&tex;</guiicon> to generate Greek letters and other symbols using &latex;. -</para> -</answer> -</qandaentry> - -<qandaentry> -<question> -<para>I miss an important feature. What can I do?</para> -</question> -<answer> -<para> -Please take a look at the TODO file in the documentation of &LabPlot;. -Here, all planned features are listed in more or -less sorted order which I will implement in future releases of &LabPlot;. -If you like to have additional -features or like to have a listed feature soon, mail me your wishes and, if possible, send me -example data or a short -description of what you like to do. -It is not unlikely that your feature will appear in the next stable release -of &LabPlot; :-) -</para> -</answer> -</qandaentry> - -<qandaentry><question> -<para>Many Analysis functions are disabled. What can I do?</para> -</question> -<answer><para> -It looks like your &LabPlot; package was compiled without GSL (&GNU; Scientific Library) support. &LabPlot; was designed to even work on systems that -are missing most of the standard libraries. Many distributions are shipping &LabPlot; packages without this additional functionality. In this case some functions are not available. Fortunately some programs (like <application>pstoedit</application> or <application>texvc</application>) can be added without recompiling &LabPlot;. You can always check your system environment in the help menu of &LabPlot;. -</para> -<para> -The packages provided on the official download page are always built with the standard libraries (GSL, &etc;). You should use them -to have all the features. -</para> -</answer> -</qandaentry> - -<qandaentry><question> -<para>I want to help. How can I contribute to &LabPlot;?</para> -</question> -<answer><para> -Yes, of course. There are a lot things to do. Even if you don't know anything about programming we always -need people to find bugs, test things and make suggestions. Also the translation and documentation always -needs a lot of work. -</para></answer> -</qandaentry> - - -</qandaset> -</chapter> - -<chapter id="license"> - -<title>License</title> - -<para>&LabPlot;</para> -<para> -Program copyright © 2007-2016 Stefan Gerlach <email>stefan.gerl...@uni-konstanz.de</email> -Program copyright © 2008-2016 Alexander Semke <email>alexander.se...@web.de</email> -</para> - -<important> -<para> -&LabPlot; is still under development. There is a long list of missing features that will be implemented in later versions of &LabPlot;. -</para> -</important> - -<para> -Because there are a lot things to do, developers need every help you can give. Any contribution like wishes, corrections, -patches, bug reports or screen shots is welcome. -</para> - -<para> -Documentation copyright © 2007-2016 Stefan Gerlach -<email>stefan.gerl...@uni-konstanz.de</email> - -Documentation copyright © 2008-2015 Alexander Semke -<email>alexander.se...@web.de</email> - -Documentation copyright © 2014 Yuri Chornoivan -<email>yurc...@ukr.net</email> -</para> - -<!-- TRANS:CREDIT_FOR_TRANSLATORS --> - -&underFDL; -&underGPL; - -</chapter> - -<appendix id="installation"> -<title>Installation</title> - -<sect1 id="getting-labplot"> -<title>How to Obtain &LabPlot;</title> - -<para> -&LabPlot; can be found on its homepage at sourceforge.net: -<ulink url="http://labplot.sf.net";>http://labplot.sf.net</ulink>. -There is an overview about all available packages at -<ulink url="http://labplot.wiki.sourceforge.net/Download";>http://labplot.wiki.sourceforge.net/Download</ulink>. -bug-fixed packages are released regular and can be found there too. -</para> -</sect1> - -<sect1 id="requirements"> -<title>Requirements</title> - -<para> -In order to successfully use &LabPlot;, you need at least a standard &Qt; 5 and &kde; KF5 installation, the &GNU; scientific library (GSL), &cantor; libcantor library. -</para> - -<!-- <para> -Optional &LabPlot; uses the following programs/libraries when available: -</para> - -<itemizedlist> -<listitem><para> -&GNU; scientific library (GSL) : used for special functions in the parser and most of the analysis functions. -</para></listitem> -</itemizedlist> ---> - -</sect1> - -<sect1 id="compilation"> -<title>Compilation and Installation</title> - -&install.compile.documentation; - -</sect1> - -</appendix> - -<appendix id="command-line-options"> -<title>Command Line Options</title> -<sect1 id="specify-a-file"> -<title>Specify a File</title> - -<para> -When starting &LabPlot; from the command prompt, you can supply the name of a project file (ending with .lml, .lml.gz, .lml.bz2 or .lml.xz): -<cmdsynopsis> -<command>labplot2</command> -<arg rep="repeat"><replaceable>file.lml</replaceable></arg> -</cmdsynopsis> -</para> - -</sect1> - -<sect1> -<title>Other Command Line Options</title> - -<para>The following command line help options are available</para> -<variablelist> -<varlistentry> -<term><command>labplot2 <option>--help</option></command></term> -<listitem><para>This lists the most basic options available at the - command line.</para></listitem> -</varlistentry> - -<varlistentry> -<term><command>labplot2 <option>--help-qt</option></command></term> -<listitem><para>This lists the options available for changing the -way &LabPlot; interacts with &Qt;.</para></listitem> -</varlistentry> - -<varlistentry> -<term><command>labplot2 <option>--help-kde</option></command></term> -<listitem><para>This lists the options available for changing the way -&LabPlot; interacts with &kde;.</para></listitem> -</varlistentry> - -<varlistentry> -<term><command>labplot2 <option>--help-all</option></command></term> -<listitem><para>This lists all of the command line options.</para></listitem> -</varlistentry> - - -<varlistentry> -<term><command>labplot2 <option>--no-splash</option></command></term> -<listitem><para>do not show the splash screen</para></listitem> -</varlistentry> - -<varlistentry> -<term><command>labplot2 <option>--author</option></command></term> -<listitem><para>Lists &LabPlot;'s author in the terminal window</para></listitem> -</varlistentry> - -<varlistentry> -<term><command>labplot2 <option>--version</option></command></term> -<listitem><para>Lists version information for &Qt;, &kde;, and &LabPlot;. -Also available through <command>labplot2 <option>-v</option></command> -</para></listitem> -</varlistentry> - -</variablelist> - -</sect1> -</appendix> - - -<appendix id="parser"> +<chapter id="parser"> <title>Parser functions</title> <para> The &LabPlot; parser allows you to use following functions: </para> -<sect1 id="parser-normal"> +<sect1 id="parser-standard"> <title>Standard functions</title> <informaltable pgwide="1"><tgroup cols="2"> @@ -1784,22 +1548,12 @@ The &LabPlot; parser allows you to use following functions: <tbody> -<row><entry>acos(x)</entry><entry><action>Arc cosine</action></entry></row> -<row><entry>acosh(x)</entry><entry><action>Arc hyperbolic cosine</action></entry></row> -<row><entry>asin(x)</entry><entry><action>Arcsine</action></entry></row> -<row><entry>asinh(x)</entry><entry><action>Arc hyperbolic sine</action></entry></row> -<row><entry>atan(x)</entry><entry><action>Arctangent</action></entry></row> -<row><entry>atan2(y,x)</entry><entry><action>Arctangent function of two variables</action></entry></row> -<row><entry>atanh(x)</entry><entry><action>Arc hyperbolic tangent</action></entry></row> <row><entry>cbrt(x)</entry><entry><action>Cube root</action></entry></row> <row><entry>ceil(x)</entry><entry><action>Truncate upward to integer</action></entry></row> -<row><entry>cos(x)</entry><entry><action>Cosine</action></entry></row> -<row><entry>cosh(x)</entry><entry><action>Hyperbolic cosine</action></entry></row> <row><entry>exp(x)</entry><entry><action>Exponential, base e</action></entry></row> <row><entry>expm1(x)</entry><entry><action>exp(x)-1</action></entry></row> <row><entry>fabs(x)</entry><entry><action>Absolute value</action></entry></row> <row><entry>gamma(x)</entry><entry><action>Gamma function</action></entry></row> -<row><entry>hypot(x,y)</entry><entry><action>Hypotenuse function √{x<superscript>2</superscript> + y<superscript>2</superscript>}</action></entry></row> <row><entry>ln(x)</entry><entry><action>Logarithm, base e</action></entry></row> <row><entry>log(x)</entry><entry><action>Logarithm, base e</action></entry></row> <row><entry>log10(x)</entry><entry><action>Logarithm, base 10</action></entry></row> @@ -1807,17 +1561,59 @@ The &LabPlot; parser allows you to use following functions: <row><entry>pow(x,n)</entry><entry><action>power function x<superscript>n</superscript></action></entry></row> <row><entry>rint(x)</entry><entry><action>round to nearest integer</action></entry></row> <row><entry>round(x)</entry><entry><action>round to nearest integer</action></entry></row> -<row><entry>sin(x)</entry><entry><action>Sine</action></entry></row> -<row><entry>sinh(x)</entry><entry><action>Hyperbolic sine</action></entry></row> <row><entry>sqrt(x)</entry><entry><action>Square root</action></entry></row> -<row><entry>tan(x)</entry><entry><action>Tangent</action></entry></row> -<row><entry>tanh(x)</entry><entry><action>Hyperbolic tangent</action></entry></row> <row><entry>tgamma(x)</entry><entry><action>Gamma function</action></entry></row> <row><entry>trunc(x)</entry><entry><action>Returns the greatest integer less than or equal to x</action></entry></row> </tbody></tgroup></informaltable> </sect1> +<sect1 id="parser-trig"> +<title>Trigonometric functions</title> + +<informaltable pgwide="1"><tgroup cols="2"> + +<thead><row><entry>Function</entry><entry>Description</entry></row></thead> + +<tbody> + + <row><entry>sin(x)</entry><entry><action>Sine</action></entry></row> + <row><entry>cos(x)</entry><entry><action>Cosine</action></entry></row> + <row><entry>tan(x)</entry><entry><action>Tangent</action></entry></row> + <row><entry>asin(x)</entry><entry><action>Inverse sine</action></entry></row> + <row><entry>acos(x)</entry><entry><action>Inverse cosine</action></entry></row> + <row><entry>atan(x)</entry><entry><action>Inverse tangent</action></entry></row> + <row><entry>atan2(y,x)</entry><entry><action>Inverse tangent function of two variables</action></entry></row> + <row><entry>sinh(x)</entry><entry><action>Hyperbolic sine</action></entry></row> + <row><entry>cosh(x)</entry><entry><action>Hyperbolic cosine</action></entry></row> + <row><entry>tanh(x)</entry><entry><action>Hyperbolic tangent</action></entry></row> + <row><entry>asinh(x)</entry><entry><action>Inverse hyperbolic sine</action></entry></row> + <row><entry>acosh(x)</entry><entry><action>Inverse hyperbolic cosine</action></entry></row> + <row><entry>atanh(x)</entry><entry><action>Inverse hyperbolic tangent</action></entry></row> + <row><entry>sec(x)</entry><entry><action>Secant</action></entry></row> + <row><entry>csc(x)</entry><entry><action>Cosecant</action></entry></row> + <row><entry>cot(x)</entry><entry><action>Cotangent</action></entry></row> + <row><entry>asec(x)</entry><entry><action>Inverse secant</action></entry></row> + <row><entry>acsc(x)</entry><entry><action>Inverse cosecant</action></entry></row> + <row><entry>acot(x)</entry><entry><action>Inverse cotangent</action></entry></row> + <row><entry>sech(x)</entry><entry><action>Hyperbolic secant</action></entry></row> + <row><entry>csch(x)</entry><entry><action>Hyperbolic cosecant</action></entry></row> + <row><entry>coth(x)</entry><entry><action>Hyperbolic cotangent</action></entry></row> + <row><entry>asech(x)</entry><entry><action>Inverse hyperbolic secant</action></entry></row> + <row><entry>acsch(x)</entry><entry><action>Inverse hyperbolic cosecant</action></entry></row> + <row><entry>acoth(x)</entry><entry><action>Inverse hyperbolic cotangent</action></entry></row> + <row><entry>sinc(x)</entry><entry><action>Sinc function sin(π x) / (π x)</action></entry></row> + <row><entry>logsinh(x)</entry><entry><action>log(sinh(x)) for x > 0</action></entry></row> + <row><entry>logcosh(x)</entry><entry><action>log(cosh(x))</action></entry></row> + <row><entry>hypot(x,y)</entry><entry><action>Hypotenuse function √{x<superscript>2</superscript> + y<superscript>2</superscript>}</action></entry></row> + <row><entry>hypot3(x,y,z)</entry><entry><action>√{x<superscript>2</superscript> + y<superscript>2</superscript> + z<superscript>2</superscript>}</action></entry></row> + <row><entry>anglesymm(α)</entry><entry><action>force the angle α to lie in the range (-π,π]</action></entry></row> + <row><entry>anglepos(α)</entry><entry><action>force the angle α to lie in the range (0,2π]</action></entry></row> + +</tbody></tgroup></informaltable> +</sect1> + + <sect1 id="parser-gsl"> <title>Special functions</title> <para> @@ -2006,11 +1802,6 @@ For more information about the functions see the documentation of GSL. <row><entry>J3(x)</entry><entry><action>transport function J(3,x)</action></entry></row> <row><entry>J4(x)</entry><entry><action>transport function J(4,x)</action></entry></row> <row><entry>J5(x)</entry><entry><action>transport function J(5,x)</action></entry></row> -<row><entry>sinc(x)</entry><entry><action>sinc(x) = sin(π x) / (π x)</action></entry></row> -<row><entry>logsinh(x)</entry><entry><action>log(sinh(x)) for x > 0</action></entry></row> -<row><entry>logcosh(x)</entry><entry><action>log(cosh(x))</action></entry></row> -<row><entry>anglesymm(α)</entry><entry><action>force the angle α to lie in the range (-π,π]</action></entry></row> -<row><entry>anglepos(α)</entry><entry><action>force the angle α to lie in the range (0,2π]</action></entry></row> <row><entry>zetaint(n)</entry><entry><action>Riemann zeta function ζ(n) for integer n</action></entry></row> <row><entry>zeta(s)</entry><entry><action>Riemann zeta function ζ(s) for arbitrary s</action></entry></row> <row><entry>zetam1int(n)</entry><entry><action>Riemann ζ function minus 1 for integer n</action></entry></row> @@ -2021,10 +1812,6 @@ For more information about the functions see the documentation of GSL. <row><entry>eta(s)</entry><entry><action>eta function η(s) for arbitrary s</action></entry></row> <row><entry>gsl_log1p(x)</entry><entry><action>log(1+x)</action></entry></row> <row><entry>gsl_expm1(x)</entry><entry><action>exp(x)-1</action></entry></row> -<row><entry>gsl_hypot(x,y)</entry><entry><action>√{x<superscript>2</superscript> + y<superscript>2</superscript>}</action></entry></row> -<row><entry>gsl_acosh(x)</entry><entry><action>arccosh(x)</action></entry></row> -<row><entry>gsl_asinh(x)</entry><entry><action>arcsinh(x)</action></entry></row> -<row><entry>gsl_atanh(x)</entry><entry><action>arctanh(x)</action></entry></row> </tbody> </tgroup> </informaltable> @@ -2294,7 +2081,245 @@ For more information about this constants see the documentation of GSL. </sect1> +</chapter> + + +<chapter id="faq"> +<title>Questions and Answers</title> + +<qandaset id="faqlist"> + +<qandaentry> +<question> +<para>For which platforms is &LabPlot; available?</para> +</question> +<answer> +<para> +&LabPlot; is developed for Unix platforms and uses the &Qt; toolkit and &kde;. Normally you can expect &LabPlot; +to build and run on every platform &kde; (>=4) supports. +A recent list of supported platforms and tips for compiling and running &LabPlot; can be found on +<ulink url="http://labplot.wiki.sourceforge.net/Download";> +http://labplot.wiki.sourceforge.net/Download</ulink>. +</para> +</answer> +</qandaentry> + +<qandaentry><question> +<para>How do I export the active worksheet as image?</para> +</question> +<answer><para> +The standard way is to use <menuchoice><guimenu>File</guimenu><guimenuitem>Export</guimenuitem></menuchoice>. All &Qt; supported image formats are allowed. Just select the desired format and the active worksheet is exported. +</para></answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I use Greek letters for title, axes label, &etc;?</para> +</question> +<answer> +<para> + Use <guiicon>π</guiicon> button to open character selector window or <guiicon>&tex;</guiicon> to generate Greek letters and other symbols using &latex;. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>I miss an important feature. What can I do?</para> +</question> +<answer> +<para> +Please take a look at the TODO file in the documentation of &LabPlot;. +Here, all planned features are listed in more or +less sorted order which I will implement in future releases of &LabPlot;. +If you like to have additional +features or like to have a listed feature soon, mail me your wishes and, if possible, send me +example data or a short +description of what you like to do. +It is not unlikely that your feature will appear in the next stable release +of &LabPlot; :-) +</para> +</answer> +</qandaentry> + +<qandaentry><question> +<para>Many Analysis functions are disabled. What can I do?</para> +</question> +<answer><para> +It looks like your &LabPlot; package was compiled without GSL (&GNU; Scientific Library) support. &LabPlot; was designed to even work on systems that +are missing most of the standard libraries. Many distributions are shipping &LabPlot; packages without this additional functionality. In this case some functions are not available. Fortunately some programs (like <application>pstoedit</application> or <application>texvc</application>) can be added without recompiling &LabPlot;. You can always check your system environment in the help menu of &LabPlot;. +</para> +<para> +The packages provided on the official download page are always built with the standard libraries (GSL, &etc;). You should use them +to have all the features. +</para> +</answer> +</qandaentry> + +<qandaentry><question> +<para>I want to help. How can I contribute to &LabPlot;?</para> +</question> +<answer><para> +Yes, of course. There are a lot things to do. Even if you don't know anything about programming we always +need people to find bugs, test things and make suggestions. Also the translation and documentation always +needs a lot of work. +</para></answer> +</qandaentry> + + +</qandaset> +</chapter> + +<chapter id="license"> + +<title>License</title> + +<para>&LabPlot;</para> +<para> +Program copyright © 2007-2016 Stefan Gerlach <email>stefan.gerl...@uni-konstanz.de</email> +Program copyright © 2008-2016 Alexander Semke <email>alexander.se...@web.de</email> +</para> + +<important> +<para> +&LabPlot; is still under development. There is a long list of missing features that will be implemented in later versions of &LabPlot;. +</para> +</important> + +<para> +Because there are a lot things to do, developers need every help you can give. Any contribution like wishes, corrections, +patches, bug reports or screen shots is welcome. +</para> + +<para> +Documentation copyright © 2007-2016 Stefan Gerlach +<email>stefan.gerl...@uni-konstanz.de</email> + +Documentation copyright © 2008-2015 Alexander Semke +<email>alexander.se...@web.de</email> + +Documentation copyright © 2014 Yuri Chornoivan +<email>yurc...@ukr.net</email> +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-labplot"> +<title>How to Obtain &LabPlot;</title> + +<para> +&LabPlot; can be found on its homepage at sourceforge.net: +<ulink url="http://labplot.sf.net";>http://labplot.sf.net</ulink>. +There is an overview about all available packages at +<ulink url="http://labplot.wiki.sourceforge.net/Download";>http://labplot.wiki.sourceforge.net/Download</ulink>. +bug-fixed packages are released regular and can be found there too. +</para> +</sect1> + +<sect1 id="requirements"> +<title>Requirements</title> + +<para> +In order to successfully use &LabPlot;, you need at least a standard &Qt; 5 and &kde; KF5 installation, the &GNU; scientific library (GSL), &cantor; libcantor library. +</para> + +<!-- <para> +Optional &LabPlot; uses the following programs/libraries when available: +</para> + +<itemizedlist> +<listitem><para> +&GNU; scientific library (GSL) : used for special functions in the parser and most of the analysis functions. +</para></listitem> +</itemizedlist> +--> + +</sect1> + +<sect1 id="compilation"> +<title>Compilation and Installation</title> + +&install.compile.documentation; + +</sect1> + </appendix> +<appendix id="command-line-options"> +<title>Command Line Options</title> +<sect1 id="specify-a-file"> +<title>Specify a File</title> + +<para> +When starting &LabPlot; from the command prompt, you can supply the name of a project file (ending with .lml, .lml.gz, .lml.bz2 or .lml.xz): +<cmdsynopsis> +<command>labplot2</command> +<arg rep="repeat"><replaceable>file.lml</replaceable></arg> +</cmdsynopsis> +</para> + +</sect1> + +<sect1> +<title>Other Command Line Options</title> + +<para>The following command line help options are available</para> +<variablelist> +<varlistentry> +<term><command>labplot2 <option>--help</option></command></term> +<listitem><para>This lists the most basic options available at the + command line.</para></listitem> +</varlistentry> + +<varlistentry> +<term><command>labplot2 <option>--help-qt</option></command></term> +<listitem><para>This lists the options available for changing the +way &LabPlot; interacts with &Qt;.</para></listitem> +</varlistentry> + +<varlistentry> +<term><command>labplot2 <option>--help-kde</option></command></term> +<listitem><para>This lists the options available for changing the way +&LabPlot; interacts with &kde;.</para></listitem> +</varlistentry> + +<varlistentry> +<term><command>labplot2 <option>--help-all</option></command></term> +<listitem><para>This lists all of the command line options.</para></listitem> +</varlistentry> + + +<varlistentry> +<term><command>labplot2 <option>--no-splash</option></command></term> +<listitem><para>do not show the splash screen</para></listitem> +</varlistentry> + +<varlistentry> +<term><command>labplot2 <option>--author</option></command></term> +<listitem><para>Lists &LabPlot;'s author in the terminal window</para></listitem> +</varlistentry> + +<varlistentry> +<term><command>labplot2 <option>--version</option></command></term> +<listitem><para>Lists version information for &Qt;, &kde;, and &LabPlot;. +Also available through <command>labplot2 <option>-v</option></command> +</para></listitem> +</varlistentry> + +</variablelist> + +</sect1> +</appendix> + + + &documentation.index; </book>
