Changeset 3735 for devel-tools


Ignore:
Timestamp:
Apr 17, 2008, 9:23:10 PM (13 years ago)
Author:
orlov
Message:
  • Quick start guide.
Location:
devel-tools/trunk/eclipse/org.refal.rfpdt.help.guide
Files:
3 edited
1 moved

Legend:

Unmodified
Added
Removed
  • devel-tools/trunk/eclipse/org.refal.rfpdt.help.guide/html/gettingstarted/quickstart.html

    r3715 r3735  
    1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
    2 
     1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    32<html>
    43<head>
    5         <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
    6         <title>Main Topic</title>
     4<META http-equiv="Content-Type" content="text/html; charset=utf-8">
    75</head>
    86
    9 <body>
    10 <h1>Main Topic</h1>
    11 Please enter your text here.
     7<body bgcolor="#F5F0DC">
     8
     9<h1>Refal Plus development tools&nbsp;&mdash; quick start guide</h1>
     10
     11<p>
     12To use the Refal Plus development tools, switch to the Refal perspective (<nobr><q>Window/Open Perspective/Other/Refal</q></nobr>). 
     13In this perspective, the following wizards are available in your <q>File/New</q> menu:
     14</p>
     15
     16<ul>
     17
     18<li><b>Refal Plus  Project</b>: creates an empty Refal Plus project with a source directory called <q>src</q>;
     19
     20<li><b>Refal Plus  Package</b>: creates an empty Refal Plus package in the selected project's source directory;<li><b>Refal Plus  Module</b>: creates a Refal Plus module in a new source file of the selected package.
     21
     22</li>
     23</ul>
     24
     25<p>
     26Note that the use of these wizards is optional and an entire Refal Plus source
     27tree can be copied into the <q>src</q> directory of a project.   Remember to manually <q>refresh</q> (<q>File/Refresh</q>) the
     28<q>src</q> directory after the copy is completed.
     29</p>
     30
     31<h2>Building</h2>
     32<p>
     33Any Refal Plus source file that exists in the source directory will be compiled when the project is built.
     34If <q>Project/Build Automatically</q> is enabled, Refal Plus source files will be recompiled whenever they are saved.
     35Alternatively, otherwise, Refal Plus source files are recompiled when <q>Project/Build Project</q>
     36and <q>Project/Build All</q> are selected.
     37By default, classfiles are saved in the project's <q>bin</q> directory (to see it switch to Resource perspective).
     38<q>Project/Clean</q> will delete all classfiles in
     39the bin directory, as well as get rid of all project error markers.
     40As in the Java development tool, compilation errors
     41will appear as markers and as rows in the <q>Problems</q> view.
     42</p>
     43
     44<h2>Editing</h2>
     45<p>
     46The Refal Plus plugin enhances the editing of Refal Plus source files with compilation information.
     47This information is refreshed implicitly as you type the code.
     48The following editing services are supported:
     49</p>
     50<ul>
     51
     52<li><b>Hover Help</b>: when the mouse pointer hovers over an identifier, the Refal Plus editor will display
     53the type (i.e. Refal format) of the identifier.</li>
     54
     55<!-- <li><b>Hyperlink Navigation</b>: holding down the control/command key and clicking on an identifier will reveal
     56the identifier&#39;s definition in a Scala editors.</li> -->
     57
     58<!-- <li><b>Content Assist</b>: holding control/command and typing space will popup a list of identifiers that can be
     59used in the current editing context.  The only context that is currently supported is the completion of
     60an identifier that appears after a dot (&#39;.&#39;). For example, assuming that value &quot;list&quot; is of type &quot;scala.List,&quot; typing
     61control-space after the dot in &quot;list.&quot; will list all &quot;scala.List&quot; methods.
     62Content assist can also complete partially specified identifiers.
     63For example, typing control-space after &quot;to&quot; in &quot;list.to&quot; will replace &quot;to&quot; with &quot;toString&quot;,
     64which is the only list method that begins with &quot;to.&quot; </li> -->
     65
     66<!-- <li><b>Content Outline</b>: whenever compilation information is refreshed,
     67an alphabetically ordered &quot;Content Outline&quot; (Window/Show Views/Outline) is also refreshed.
     68Clicking on elements in the content outline will nagivate to their definitions. 
     69However, linking with the editor is not currently supported.</li> -->
     70
     71<li><b>Mark occurrences</b>: click on an identifier or a variable to highlight its definition and all references.</li>
     72
     73<!-- <li><b>Interperter Shell</b>: you can create an interperter shell in the Eclipse console to try out Scala expressions that can refer to the Scala code you are developing. 
     74To create an interpreter shell, open the context menu in the Package Explorer on a Scala project or Scala package, and select &quot;Create Interpreter.&quot;
     75Note that the interperter must be manually reset (through the reset button in the console view) if Scala code is changed and recompiled.</li> -->
     76
     77</ul>
     78
     79<p>
     80Compilation information is also used to implement syntax coloring and automatic source formatting.
     81The coloring scheme used to highlight a file and formatter options
     82can be configured at <nobr><q>Window/Preferences/Refal Plus</q></nobr>.
     83</p>
     84<p>
     85Note that the definition and the uses of a variable are highlighted differently by default, which is very helpfull with pattern matching. 
     86</p>
     87<p>
     88<b>Tip</b>: Use <b>Ctrl+I</b> shortcut for re-indenting the selection (or the current line),
     89<b>Ctrl+Shift+F</b> for re-indenting the whole file.
     90</p>
     91
     92<h2>Running</h2>
     93
     94<p>
     95Given a module that implements <code>Main</code> function,
     96the module can be executed as an application inside Eclipse.
     97The <code>Main</code> function <b>must</b> have the following format:
     98<code>$func Main /*empty*/ = e;</code>.
     99</p>
     100<p>
     101Select the <q>Run/Run As/Refal Plus Application</q> menu item.
     102</p>
     103<p>
     104Program arguments and environment can be configured in the <q>Run</q> dialog
     105(<q>Run/Open Run dialog...</q>).
     106</p>
     107
     108<h2>Debugging</h2> 
     109
     110<p>
     111You can also debug a Refal Plus application. To do this, select <nobr><q>Run/Debug As/Refal Plus Application</q></nobr> menu item.
     112Program arguments and environment can be configured in the <q>Debug</q> dialog
     113(<nobr><q>Run/Open Debug dialog...</q></nobr>).
     114Also you can set <q>Stop in Main</q> option there to stop the execution just after the program starts.
     115Eclipse will switch to Debug perspective which will allow you to step through the program examining the execution state.
     116</p>
     117<p>
     118The following debugging services are supported:
     119</p>
     120
     121<ul>
     122
     123<li><b>Breakpoints</b>: double-click the left ruler on the line where you want to stop the program execution.
     124When the program execution will be stopped at a breakpoint,
     125Eclipse will switch to the Debug perspective.</li>
     126
     127<!-- <li><b>Watchpoints</b>: to set a watchpoint on a field, use the &quot;Run/Toggle watchpoint&quot; menu item. The program execution will
     128then stop whenever the program access or modify the field value. The watchpoint can be accessed in the &quot;Breakpoints&quot; tab
     129of the Debug perspective.</li> -->
     130
     131<!-- <li><b>Expression evaluations</b>: you can evaluate expression given the current context of the running application using
     132the &quot;Expression&quot; tab of the Debug perspective. Only Java expressions are currently supported. The expressions will be computed
     133at each program stop (breakpoints, watchpoints, step, ...).</li> -->
     134
     135<li><b>Hot Code Replace</b>: while debugging a program you can modify it and the running program will be updated automatically.
     136If the modifications are too important, Eclipse will notify you. Welcome to powerfull debugging!</li>
     137
     138</ul>
     139
    12140</body>
    13141</html>
  • devel-tools/trunk/eclipse/org.refal.rfpdt.help.guide/html/toc.html

    r3549 r3735  
    77</head>
    88
    9 <body>
     9<body bgcolor="#F5F0DC">
    1010<h1>Table of Contents</h1>
    11 Please enter your text here.
     11<p>
     12<ul>
     13<li>Getting Started</li>
     14<ul>
     15                <li><a href="gettingstarted/quickstart.html">Quick start</a></li>
     16</ul>
     17</ul>
     18</p>
    1219</body>
    1320</html>
  • devel-tools/trunk/eclipse/org.refal.rfpdt.help.guide/toc.xml

    r3549 r3735  
    66      <anchor id="gettingstarted"/>
    77   </topic>
    8   <topic label="Concepts">
     8<!-- <topic label="Concepts">
    99      <anchor id="concepts"/>
    1010   </topic>
     
    1717   <topic label="Samples">
    1818      <anchor id="samples"/>
    19    </topic>
     19   </topic> -->
    2020</toc>
  • devel-tools/trunk/eclipse/org.refal.rfpdt.help.guide/tocgettingstarted.xml

    r3549 r3735  
    33
    44<toc label="Getting Started" link_to="toc.xml#gettingstarted">
    5         <topic label="Main Topic"  href="html/gettingstarted/maintopic.html">
    6                 <topic label="Sub Topic" href="html/gettingstarted/subtopic.html" />
     5        <topic label="Quick Start"  href="html/gettingstarted/quickstart.html">
    76        </topic>
    8         <topic label="Main Topic 2">
     7<!-- <topic label="Main Topic 2">
    98                <topic label="Sub Topic 2" href="html/gettingstarted/subtopic2.html" />
    10         </topic>
     9        </topic>
     10-->
    1111</toc>
Note: See TracChangeset for help on using the changeset viewer.