.Modelica.UsersGuide.Conventions.Documentation.Format.Figures

Information

Figures 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.

1. Figures have to be placed outside of paragraphs to be HTML compliant.
2. Figures need to have at least a src and an alt attribute defined to be HTML compliant.
3. 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.
4. Illustration can be embedded without table environment.

Location of files

The PNG files should be placed in a folder which exactly represents the package structure.

Examples

Example 1

This example shows how an illustration should be embedded in the Example PID_Controller of the Blocks package.

<img src="modelica://Modelica/Resources/Images/Blocks/PID_controller.png"
     alt="PID_controller.png">

Example 2

This is a simple example of a technical figure with caption.

<table border="0" cellspacing="0" cellpadding="2">
  <caption align="bottom">Caption starts with a capital letter</caption>
  <tr>
    <td>
      <img src="modelica://Modelica/Resources/Images/Blocks/PID_controller.png"
           alt="PID_controller.png">
    </td>
  </tr>
</table>

Example 3

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 <strong> and </strong>.

The figure name and enumeration should look like this: Fig. 1:

Figures have to be enumerated manually.

<table border="0" cellspacing="0" cellpadding="2">
  <caption align="bottom"><strong>Fig. 2:</strong> Caption starts with a capital letter</caption>
  <tr>
    <td>
      <img src="modelica://Modelica/Resources/Images/Blocks/PID_controller.png"
           alt="PID_controller.png">
    </td>
  </tr>
</table>