class Equations "Equations"
extends Modelica.Icons.Information;
annotation (Documentation(info = "<html>\n\n<p>\nIn the context of <a href=\"http://www.w3c.org/\">HTML</a> documentation\nequations should have a graphical representation in PNG format. For that purpose tool\nspecific math typing capabilities can be used. Alternatively the LaTeX to HTML translator\n<a href=\"http://www.latex2html.org\">LaTeX2HTML</a>, or the\n<a href=\"http://www.homeschoolmath.net/worksheets/equation_editor.php\">Online Equation Editor</a>\nor <a href=\"http://www.codecogs.com/latex/eqneditor.php\">codecogs</a> can be used.\n</p>\n\n<p>\nA typical equation, e.g., of a Fourier synthesis, could look like<br>\n<img\n src=\"modelica://Modelica/Resources/Images/UsersGuide/Conventions/Documentation/Format/Equations/fourier.png\"><br>\nor<br>\n<img\n src=\"modelica://Modelica/Resources/Images/UsersGuide/Conventions/Documentation/Format/Equations/sample.png\"\n alt=\"y=a_1+a_2\"><br>\nIn an <code>alt</code> tag the original equation should be stored, e.g.,</p>\n<pre>\n<img\n src="modelica://Modelica/Resources/Images/UsersGuide/Conventions/Documentation/Format/Equations/sample.png"\n alt="y=a_1+a_2">\n</pre>\n\n<p>\nIf one wants to refer to particular variables and parameters in the documentation text, either a\ngraphical representation (PNG file) or italic fonts for regular physical symbols and lower case\n<a href=\"http://www.w3.org/TR/html4/sgml/entities.html\">Greek letters</a>\nshould be used. Full word variables and full word indices should be spelled within <code> and </code>.\nVector and array indices should be typeset as subscripts using the <sub> and </sub> tags.\n</p>\n\n<p> Examples for such variables and parameters are:\n<em>φ</em>, <em>φ</em><sub>ref</sub>, <em>v<sub>2</sub></em>, <code>useDamperCage</code>.\n</p>\n\n<h4>Numbered equations</h4>\n\n<p>For numbering equations a one row table with two columns should be used. The equation number should be placed in the right column:</p>\n\n<pre>\n<table border=\"0\" cellspacing=\"10\" cellpadding=\"2\">\n <tr>\n <td><img\n src="modelica://Modelica/Resources/Images/UsersGuide/Conventions/Documentation/Format/Equations/sample.png"\n alt="y=a_1+a_2"> </td>\n <td>(1)</td>\n </tr>\n</table>\n</pre>\n\n<p>appears as:</p>\n\n<table border=\"0\" cellspacing=\"10\" cellpadding=\"2\">\n <tr>\n <td><img\n src=\"modelica://Modelica/Resources/Images/UsersGuide/Conventions/Documentation/Format/Equations/sample.png\"\n alt=\"y=a_1+a_2\"></td>\n <td>(1)</td>\n </tr>\n</table>\n\n</html>"));
end Equations;