Modelica.UsersGuide.Conventions.UsersGuide

The UsersGuide of each package should consist of the following classes

1. Contact information of the library officer and the co-authors
2. Optional Implementation Notes to give general information about the implementation
3. References for summarizing the literature of the package
4. Revision history to summarize the most important changes and improvements of the package

Extends from Modelica.Icons.Information (Icon for general information packages).

Package Content

Name	Description
Implementation	Implementation notes
References	References
Contact	Contact
RevisionHistory	Revision History

Modelica.UsersGuide.Conventions.UsersGuide.Implementation

This class summarizes general information about the implementation which is not stated elsewhere.

1. The <caption> tag is currently not supported in some tools.
2. The ∼ symbol (i.e., '∼' ) is currently not supported in some tools.
3. The ∝ symbol (i.e., '∝' ) is currently not supported in some tools.

Extends from Modelica.Icons.Information (Icon for general information packages).

Modelica.UsersGuide.Conventions.UsersGuide.References

1. Citation formats should be unified according to IEEE Transactions style.
2. Reference should be formatted as tables with two columns.

In the following the reference formats will be explained based on five examples:

• Journal (or conference) [Gao2008]
• Book [Andronov1973]
• Master's thesis [Woehrnschimmel1998]
• PhD thesis [Farnleitner1999]
• Technical report [Marlino2005]

The citation is also explained.

Example

<table border="0" cellspacing="0" cellpadding="2">
    <tr>
      <td>[Gao2008]</td>
      <td>Z. Gao, T. G. Habetler, R. G. Harley, and R. S. Colby,
        "A sensorless rotor temperature estimator for induction
                 machines based on a current harmonic spectral
                 estimation scheme,"
        <em>IEEE Transactions on Industrial Electronics</em>,
        vol. 55, no. 1, pp. 407-416, Jan. 2008.</td>
    </tr>
    <tr>
      <td>[Andronov1973]</td>
      <td>A. Andronov, E. Leontovich, I. Gordon, and A. Maier,
        <em>Theory of  Bifurcations of Dynamic Systems on a plane<em>,
        1st ed. New York: J. Wiley & Sons, 1973.</td>
    </tr>
    <tr>
      <td>[Woehrnschimmel1998]</td>
      <td>R. W&ouml;hrnschimmel,
        "Simulation, modeling and fault detection for vector
              controlled induction machines,"
        Master's thesis, Vienna University of Technology,
        Vienna, Austria, 1998.</td>
    </tr>
    <tr>
      <td>[Farnleitner1999]</td>
      <td>E. Farnleitner,
        "Computational Fluid dynamics analysis for rotating
              electrical machinery,"
        Ph.D. dissertation, University of Leoben,
        Department of Applied Mathematics, Leoben, Austria, 1999.</td>
    </tr>
    <tr>
      <td>[Marlino2005]</td>
      <td>L. D. Marlino,
        "Oak ridge national laboratory annual progress report for the
              power electronics and electric machinery program,"
      Oak Ridge National Laboratory, prepared for the U.S. Department of Energy,
      Tennessee, USA, Tech. Rep. FY2004 Progress Report, January 2005.</td>
    </tr>
</table>

appears as

Extends from Modelica.Icons.References (Icon for external references).

Modelica.UsersGuide.Conventions.UsersGuide.Contact

This class summarizes contact information of the contributing persons.

Example

<p>
Library officers responsible for the maintenance and for the
organization of the development of this library are listed in
<a href="modelica://Modelica.UsersGuide.Contact">Modelica.UsersGuide.Contact</a>.
</p>

<h4>Main authors</h4>

<p>
<strong>First author's name</strong><br>
First author's address<br>
next address line<br>
email: <a href="mailto:author1@example.org">author1@example.org</a><br>
web: <a href="https://www.example.org">https://www.example.org</a>
</p>

<p>
<strong>Second author's name</strong><br>
Second author's address<br>
next address line<br>
email: <a href="mailto:author2@example.org">author2@example.org</a>
</p>

<h4>Contributors to this library</h4>

<ul>
  <li>Person one</li>
  <li>...</li>
</ul>

<h4>Acknowledgements</h4>

<p>
The authors would like to thank following persons for their support ...
</p>

OR

<p>
We are thankful to our colleagues [names] who provided expertise to develop this library...
</p>

OR

<p>
The [partial] financial support for the development of this library by [organization]
is highly appreciated.
</p>

OR whatever

appears as

Library officers responsible for the maintenance and for the organization of the development of this library are listed in Modelica.UsersGuide.Contact.

Main authors

First author's name
First author's address
next address line
email: author1@example.org
web: https://www.example.org

Second author's name
Second author's address
next address line
email: author2@example.org

Contributors to this library

• Person one
• ...

Acknowledgements

The authors would like to thank following persons for their support ...

Extends from Modelica.Icons.Contact (Icon for contact information).

Modelica.UsersGuide.Conventions.UsersGuide.RevisionHistory

1. The revision history needs to answer the question: What has changed and what are the improvements over the previous versions and revision.
2. The revision history includes the documentation of the development history of each class and/or package.
3. Version number, date, author and comments shall be included. In case the version number is not known at the time of implementation, a dummy version number shall be used, e.g., 3.x.x. The version date shall be the date of the latest change.

Example

<table border="1" cellspacing="0" cellpadding="2">
    <tr>
      <th>Version</th>
      <th>Date</th>
      <th>Author</th>
      <th>Comment</th>
    </tr>
    ...
    <tr>
      <td>1.0.1</td>
      <td>2008-05-26</td>
      <td>A. Haumer<br>C. Kral</td>
      <td>Fixed bug in documentation</td>
    </tr>
    <tr>
      <td>1.0.0</td>
      <td>2008-05-21</td>
      <td>A. Haumer</td>
      <td>Initial version</td>
    </tr>
</table>

This code appears then as in the "Revisions" section below.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).