The UsersGuide of each package should consist of the following classes
Extends from Modelica.Icons.Information (Icon for general information packages).
Name | Description |
---|---|
Implementation | Implementation notes |
References | References |
Contact | Contact |
RevisionHistory | Revision History |
This class summarizes general information about the implementation which is not stated elsewhere.
<caption>
tag is currently not supported in some tools.∼
symbol (i.e., '∼' ) is currently not supported in some tools.∝
symbol (i.e., '∝' ) is currently not supported in some tools.Extends from Modelica.Icons.Information (Icon for general information packages).
In the following the reference formats will be explained based on five examples:
The citation is also explained.
<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 href="https://ieeexplore.ieee.org/document/4401132">A sensorless rotor temperature estimator for induction machines based on a current harmonic spectral estimation scheme</a>", <em>IEEE Transactions on Industrial Electronics</em>, vol. 55, no. 1, pp. 407-416, Jan. 2008. </td> </tr> <tr> <td>[Kral2018]</td> <td>C. Kral, <em>Modelica - object oriented modeling of polyphase electric machines</em> (in German), München: Hanser Verlag, 2018, <a href="https://doi.org/10.3139/9783446457331">DOI 10.3139/9783446457331</a>, ISBN 978-3-446-45551-1. </td> </tr> <tr> <td>[Woehrnschimmel1998]</td> <td>R. Wö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, <a href="https://doi.org/10.2172/974618">DOI 10.2172/974618</a>. </td> </tr> </table>
appears as
[Gao2008] | 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", IEEE Transactions on Industrial Electronics, vol. 55, no. 1, pp. 407-416, Jan. 2008. |
[Kral2018] | C. Kral, Modelica - object oriented modeling of polyphase electric machines (in German), München: Hanser Verlag, 2018, DOI 10.3139/9783446457331, ISBN 978-3-446-45551-1. |
[Woehrnschimmel1998] | R. Wöhrnschimmel, "Simulation, modeling and fault detection for vector controlled induction machines", Master's thesis, Vienna University of Technology, Vienna, Austria, 1998. |
[Farnleitner1999] | E. Farnleitner, "Computational Fluid dynamics analysis for rotating electrical machinery", Ph.D. dissertation, University of Leoben, Department of Applied Mathematics, Leoben, Austria, 1999. |
[Marlino2005] | 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, DOI 10.2172/974618. |
Extends from Modelica.Icons.References (Icon for external references).
This class summarizes contact information of the contributing persons.
<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.
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
The authors would like to thank following persons for their support ...
Extends from Modelica.Icons.Contact (Icon for contact information).
3.x.x
. The version date shall be the date of the
latest change.<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).
Automatically generated Thu Oct 1 16:07:32 2020.