class Figures "Figures"
extends Modelica.Icons.Information;
annotation (Documentation(info = "<html>\n<p>\nFigures should in particular be included to examples to discuss the problems and results of the respective model. The library developers are yet encouraged to add figures to the documentation of other components to support the understanding of the users of the library.\n</p>\n\n<ol>\n<li> Figures have to be placed <strong>outside</strong> of paragraphs to be HTML compliant.</li>\n<li> Figures need to have <strong>at least</strong> a <code>src</code> and an <code>alt</code> attribute defined to be HTML compliant.</li>\n<li> Technical figures should be placed within a table environment. Each technical figure should then also have a caption. The figure caption starts with a capital letter.</li>\n<li> Illustration can be embedded without table environment.</li>\n</ol>\n\n<h4>Location of files</h4>\n\nThe <code>PNG</code> files should be placed in a folder which exactly represents the package structure.\n\n<h5>Example 1</h5>\n\n<p>This example shows how an illustration should be embedded in the Example\n<a href=\"modelica://Modelica.Blocks.Examples.PID_Controller\">PID_Controller</a> of the\n<a href=\"modelica://Modelica.Blocks\">Blocks</a> package.</p>\n\n<pre>\n<img src=\"modelica://Modelica/Resources/Images/Blocks/PID_controller.png\"\n alt=\"PID_controller.png\">\n</pre>\n\n<h5>Example 2</h5>\n\n<p>This is a simple example of a technical figure with caption.</p>\n\n<pre>\n<table border=\"0\" cellspacing=\"0\" cellpadding=\"2\">\n <caption align=\"bottom\">Caption starts with a capital letter</caption>\n <tr>\n <td>\n <img src=\"modelica://Modelica/Resources/Images/Blocks/PID_controller.png\"\n alt=\"PID_controller.png\">\n </td>\n </tr>\n</table>\n</pre>\n\n<h5>Example 3</h5>\n\n<p>To refer to a certain figure, a figure number may be added. In such case the figure name (Fig.) including the figure enumeration (1,2,...) have to be displayed bold using <code><strong></code> and <code></strong></code>.</p>\n<p>The figure name and enumeration should look like this: <strong>Fig. 1:</strong></p>\n<p>Figures have to be enumerated manually.</p>\n\n<pre>\n<table border=\"0\" cellspacing=\"0\" cellpadding=\"2\">\n <caption align=\"bottom\"><strong>Fig. 2: </strong>Caption starts with a capital letter</caption>\n <tr>\n <td>\n <img src=\"modelica://Modelica/Resources/Images/Blocks/PID_controller.png\"\n alt=\"PID_controller.png\">\n </td>\n </tr>\n</table>\n</pre>\n\n</html>"));
end Figures;