Changeset 145

Timestamp:

11/14/05 15:05:17 (19 years ago)

Author:

boris

Message:

• updated manual

Location:

trunk/org.modelica.mdt/doc

Files:

• ch1.html (modified) (2 diffs)
• ch2.html (modified) (1 diff)
• toc.xml (modified) (1 diff)

trunk/org.modelica.mdt/doc/ch1.html

@@ -4 +4 @@
 <h1>Modelica Development Tooling Help</h1>
 <p>
-Modelica Development Tooling (MDT) Plug-In extends Eclipse to provide an environment
-for working with Modelica projects. These features are provided:
-</p>
+Modelica Development Tooling (MDT) Plug-In integrates Open Modelica compiler with
+Eclipse. MDT, together with Open Modelica compiler provides an environment for
+working with Modelica projects.
+
+<h2 id = "features">Features</h2>
+MDT is still in the early development stages but it does provide a simple
+environment for a modelica programmer. Following features are implemented so far:
+
 <ul>
-<li>Modelica Projects management</li>
-<li>Modelica Sourcecode Editing support</li>
+<li>browsing support for modelica classes</li>
+<li>syntax color highlighting</li>
+<li>syntax checking</li>
 </ul>
 
@@ -17 +23 @@
 <a href="http://www.liu.se">Linköping University</a> as part of a 
 <a href="http://www.ida.liu.se/~pelab/modelica/OpenModelica.html">Open Modelica</a>
-effort. Open Modelica aims at creating a complete development environment for Modelica development.
+effort. Open Modelica aims at creating a complete development environment for 
+Modelica development.
 </p>
 <h2 id = "requirements">Requirements</h2>
 
 <p>
-To be able to use this package of fine software you will need a number of other packages of fine software.
-These are:
+MDT requires at least 
+OpenModelica compiler
+<a href="http://www.ida.liu.se/labs/pelab/modelica/OpenModelica.html#Download">
+version 1.3</a> and Eclipse 3.1. Other
+versions of Open Modelica and Eclipse may work, but have not been tested.
 </p>
 
-<ul>
-<li><a href="http://www.ida.liu.se/~pelab/modelica/OpenModelica.html">Open Modelica</a></li>
-<li><a href="http://www.cygwin.com/">Cygwin</a></li>
-<li><a href="http://www.eclipse.org/cdt/">C/C++ Development Tooling Eclipse plug-in</a></li>
-</ul>
 <p>
 Happy compiling!

trunk/org.modelica.mdt/doc/ch2.html

@@ -4 +4 @@
 <h1>Getting started</h1>
 
+<h2 id = "configurate_omc">Configuring the Open Modelica Compiler</h2>
+
+MDT need to be able to locate the binary of the compiler. It uses the
+environment variable OPENMODELICAHOME to do so.<br>
+If you have problems using MDT make sure that OPENMODELICAHOME is set to the 
+folder where the Open Modelica Compiler is installed. In other words 
+OPENMODELICAHOME must point to the folder that contais Open Modelica compiler
+binary. It is named omc.exe on Windows Platform and omc on Unix platforms.
+
+<h2 id = "using_modelica_perspective">Using Modelica Perspective</h2>
+
 <p>
-The most convenient way to work with Modelica projects is to switch to the Modelica perspective.
-To switch to the Modelica perspective, choose the <b>Window</b> menu item, pick <b>Open Perspective</b>
+The most convenient way to work with Modelica projects is to use to the
+Modelica perspective. To switch to the Modelica perspective, choose the 
+<b>Window</b> menu item, pick <b>Open Perspective</b>
  followed by <b>Other...</b>
-Select <b>Modelica</b> option from the dialog presented and click <b>OK</b>. Not <b>Cancel</b>. Or any other button.
+Select <b>Modelica</b> option from the dialog presented and click <b>OK</b>.
+Not <b>Cancel</b>. Or any other button.
 </p>
+
+
+
 <h2 id = "making_a_project">Making a project</h2>
 <p>

trunk/org.modelica.mdt/doc/toc.xml

@@ -2 +2 @@
 
   <topic label="Getting Started" href="doc/ch2.html">
+      <topic label="Configuring Open Modelica Compiler" 
+             href="doc/ch2.html#configurate_omc"/>
+      <topic label="Using Modelica Perspective" 
+             href="doc/ch2.html#using_modelica_perspective"/>
       <topic label="Making a project" href="doc/ch2.html#making_a_project"/>
       <topic label="Importing a project" href="doc/ch2.html#importing_a_project"/>