Improve the User's Guide slightly.

tinrabuzin · Dec 10, 2020 · 5d228dc · 5d228dc
1 parent 72f20e1
commit 5d228dc
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 26 deletions.
diff --git a/OpenIPSL/UsersGuide/Contact.mo b/OpenIPSL/UsersGuide/Contact.mo
@@ -1,5 +1,5 @@
 within OpenIPSL.UsersGuide;
-model Contact "References"
+model Contact "Contact"
   extends Modelica.Icons.Contact;
 
   annotation (Documentation(info="<html>
@@ -16,11 +16,11 @@ model Contact "References"
 <dd>&nbsp;&nbsp;</dd>
 
 <dt>Version 2.0.0 is organized by:</dt>
-<dd><a href=\"https://www.usn.no/english/about/contact-us/employees/dietmar-winkler\">Dietmar Winkler</a></dd>
+<dd><a href=\"https://github.com/dietmarw\">Dietmar Winkler</a></dd>
 <dd>Assistant Professor</dd>
-<dd>Department of Electrical engineering, Information Technology and Cybernetics</dd>
-<dd>University of South-Eastern Norway</dd>
-<dd>Laererskoleveien 40, 3679 Notodden</dd>
+<dd>Department of Electrical Engineering, Information Technology and Cybernetics</dd>
+<dd><a href=\"https://www.usn.no/english/\">University of South-Eastern Norway</a></dd>
+<dd>Campus Porsgrunn</dd>
 <dd>Norway</dd>
 <dd>email: <a href=\"mailto:[email protected]\">[email protected]</a></dd>
 </dl>
@@ -44,42 +44,42 @@ model Contact "References"
 
 <tr><td valign=\"top\"> Biswarup Mukherjee </td>
    <td valign=\"top\"> MINES ParisTech </td>
-   <td valign=\"top\"> email:<a href=\"mailto:[email protected]\">[email protected]</a></td>
+   <td valign=\"top\"><a href=\"mailto:[email protected]\">[email protected]</a></td>
 </tr>
 
 <tr><td valign=\"top\"> Giuseppe Laera </td>
    <td valign=\"top\"> Rensselaer Polytechnic Institute </td>
-   <td valign=\"top\"> email:<a href=\"mailto:[email protected]\">[email protected]</a></td>
+   <td valign=\"top\"><a href=\"mailto:[email protected]\">[email protected]</a></td>
 </tr>
 
 <tr><td valign=\"top\"> Manuel Navarro Catalan </td>
    <td valign=\"top\"> Rensselaer Polytechnic Institute </td>
-   <td valign=\"top\"> email:<a href=\"mailto:[email protected]\">[email protected]</a></td>
+   <td valign=\"top\"><a href=\"mailto:[email protected]\">[email protected]</a></td>
 </tr>
 
 <tr><td valign=\"top\"> Maxime Baudette </td>
    <td valign=\"top\"> Lawrence Berkeley National Laboratory </td>
-   <td valign=\"top\"> email:<a href=\"mailto:[email protected]\">[email protected]</a></td>
+   <td valign=\"top\"><a href=\"mailto:[email protected]\">[email protected]</a></td>
 </tr>
 
 <tr><td valign=\"top\"> Meaghan Podlaski </td>
    <td valign=\"top\"> Rensselaer Polytechnic Institute </td>
-   <td valign=\"top\"> email:<a href=\"mailto:[email protected]\">[email protected]</a></td>
+   <td valign=\"top\"><a href=\"mailto:[email protected]\">[email protected]</a></td>
 </tr>
 
 <tr><td valign=\"top\"> Sergio Dorado-Rojas </td>
    <td valign=\"top\"> Rensselaer Polytechnic Institute </td>
-   <td valign=\"top\"> email:<a href=\"mailto:[email protected]\">[email protected]</a></td>
+   <td valign=\"top\"><a href=\"mailto:[email protected]\">[email protected]</a></td>
 </tr>
 
 <tr><td valign=\"top\"> Tin Rabuzin </td>
    <td valign=\"top\"> KTH Royal Institute of Technology </td>
-   <td valign=\"top\"> email:<a href=\"mailto:[email protected]\">[email protected]</a></td>
+   <td valign=\"top\"><a href=\"mailto:[email protected]\">[email protected]</a></td>
 </tr>
 
 </table>
 
 
 </html>"));
 
-end Contact;
+end Contact;
diff --git a/OpenIPSL/UsersGuide/Conventions.mo b/OpenIPSL/UsersGuide/Conventions.mo
@@ -12,8 +12,9 @@ Here are some naming conventions that we try to obey:
 </p>
 <ul>
 <li> Names of the parameters and variables should correspond to those found in the respective documentation.</li>
-<li> Subscript should be denoted in Modelica with underscore, e.g. T_r or K_1. <b>Note:</b> some parameter names have first upper case letters and others lower case.</li>
-<li> Deviation signals such as delta omega, should be written as domega in Modelica.</li>
+<li> Subscript should be denoted in Modelica with underscore, e.g., <code>T_r</code> 
+or <code>K_1</code>. <b>Note:</b> some parameter names have first upper case letters and others lower case.</li>
+<li> Deviation signals such as &delta;&omega;, should be written as <code>domega</code> in Modelica.</li>
 <li> Parameters which are not to be entered by user and variables which are not to be seen by users should be <b>protected</b>.</li>
 <li> Parameters and variables should be declared as their specific type such as <code>Types.ApparentPower</code> for variables that are declared in MVA. <b>Note:</b> if the proper unit is not represented in Typees, units available in Modelica&apos;s SI (Systeme Internationale) should be used.</li>
 </ul>

diff --git a/OpenIPSL/UsersGuide/GettingStarted.mo b/OpenIPSL/UsersGuide/GettingStarted.mo
@@ -1,5 +1,5 @@
 within OpenIPSL.UsersGuide;
-model GettingStarted "Getting Started with OpenIPSL"
+model GettingStarted "Getting Started"
   extends Modelica.Icons.Information;
 
 
@@ -38,4 +38,4 @@ The library is, also, systematically checked using the two mentioned tools (see
 Nonetheless, it might be possible to face issues when using other <a href=\"https://modelica.org/tools\">Modelica Tools</a> that we have not fully tested.
 </p>
 </html>"));
-end GettingStarted;
+end GettingStarted;
diff --git a/OpenIPSL/UsersGuide/LibraryTesting.mo b/OpenIPSL/UsersGuide/LibraryTesting.mo
@@ -1,5 +1,5 @@
 within OpenIPSL.UsersGuide;
-model LibraryTesting "Library Testing and Verification Routines"
+model LibraryTesting "Testing and Verification"
   extends Modelica.Icons.Information;
 
 
@@ -15,10 +15,12 @@ The main idea is to try to capture different responses from the model being veri
 A model is considered to be verified if it passes all tests. Models that pass the verification procedure have a green dashed line around them.</p>
 
 <p>The regression testing is done separately in different Modelica-compliant tools (<a href=\"https://www.openmodelica.org/\">OpenModelica</a>  and <a href=\"http://www.3ds.com/products-services/catia/products/dymola\">Dymola</a>, for now) so models can be independently verified.
-A detailed view of all models that undergo the verification process can be found <a href=\"https://alsetlab.github.io/NYPAModelTransformation/reports\">here</a>. 
+A detailed view of all models that undergo the verification process can be found 
+in the <a href=\"https://alsetlab.github.io/NYPAModelTransformation/reports\">NYPA Model Transformation
+reports</a>. 
 The entire result verification procedure is done using <a href=\"https://github.com/modelica-tools/csv-compare\">CSV-Compare</a>.</p>
 
 <p>Automatic regression testing is not yet configured in our Travis CI routine.</p>
 
 </html>"));
-end LibraryTesting;
+end LibraryTesting;
diff --git a/OpenIPSL/UsersGuide/Overview.mo b/OpenIPSL/UsersGuide/Overview.mo
@@ -22,7 +22,7 @@ It also contains one model, <code>SystemBase</code>, which is going to be explai
 Within each subpakcage, the user will find models grouped into software tools from which each model design was extracted.
 </p>
 
-<table border=0 cellspacing=0 cellpadding=2>
+<table border=1 cellspacing=0 cellpadding=2>
 <tr><td valign=\"top\"><b>Subpackage</b> </td>
    <td valign=\"top\"><b>Description</b></td>
 </tr>
@@ -68,4 +68,4 @@ Within each subpakcage, the user will find models grouped into software tools fr
 </table>
 </p>
 </html>"));
-end Overview;
+end Overview;
diff --git a/OpenIPSL/UsersGuide/Publications.mo b/OpenIPSL/UsersGuide/Publications.mo
@@ -1,4 +1,4 @@
-within OpenIPSL.UsersGuide;
+within OpenIPSL.UsersGuide;
 model Publications "Publications"
   extends Modelica.Icons.References;
   annotation (Documentation(info="<html>
@@ -78,4 +78,4 @@ model Publications "Publications"
 </ul>
 
 </html>"));
-end Publications;
+end Publications;
diff --git a/OpenIPSL/UsersGuide/package.order b/OpenIPSL/UsersGuide/package.order
@@ -4,4 +4,4 @@ GettingStarted
 LibraryTesting
 Publications
 References
-Contact
+Contact
diff --git a/OpenIPSL/package.mo b/OpenIPSL/package.mo
@@ -2,7 +2,7 @@ package OpenIPSL "Open-Instance Power System Library"
   import SI = Modelica.SIunits;
   import C = Modelica.Constants;
 
-annotation (
+annotation (preferredView="info",
   Protection(access = Access.packageDuplicate),
   uses(Complex(version="3.2.3"), Modelica(version="3.2.3")),
   version="2.0.0-dev",