1 |
|
<!--//--><script>var PrxLC=new Date(0);var PrxModAtr=0;var PrxInst; if(!PrxInst++) PrxRealOpen=window.open;function PrxOMUp(){PrxLC=new Date();}function PrxNW(){return(this.window);} function PrxOpen(url,nam,atr){ if(PrxLC){ var cdt=new Date(); cdt.setTime(cdt.getTime()-PrxLC.getTime()); if(cdt.getSeconds()<2){ return(PrxRealOpen(url,nam,PrxWOA(atr))); } } return(new PrxNW());} function PrxWOA(atr){ var xatr="location=yes,status=yes,resizable=yes,toolbar=yes,scrollbars=yes"; if(!PrxModAtr) return(atr); if(atr){ var hm; hm=atr.match(/height=[0-9]+/i); if(hm) xatr+="," + hm; hm=atr.match(/width=[0-9]+/i); if(hm) xatr+="," + hm; } return(xatr);}window.open=PrxOpen;</script> |
2 |
|
<!--//--><script> function NoError(){return(true);} onerror=NoError; </script> |
3 |
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> |
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> |
4 |
<html> |
<HTML><HEAD><TITLE>FreeRIDE: UserDoc</TITLE> |
5 |
<head> |
<LINK REL="stylesheet" HREF="/wiki.css"> |
6 |
<title>FreeRIDE: UserDoc</title> |
</HEAD><BODY BGCOLOR="white"> |
7 |
<link rel="stylesheet" href="/wiki.css"> |
<H2><a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> User Documentation</H2> |
8 |
</head> |
|
9 |
<body bgcolor="white"> |
<H3>Introduction</H3> |
10 |
<h2><a href="wiki.pl?FreeRIDE">FreeRIDE</a> User Documentation</h2> |
|
11 |
<p></p> |
<p> |
12 |
<h3>Introduction</h3> |
The goal of <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> is simple, yet ambitious: to become THE cross-platform IDE of choice for the Ruby community. We want <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> to be a first-class IDE on par with those available for other languages. These goals include: |
13 |
<p>The goal of <a href="wiki.pl?FreeRIDE">FreeRIDE</a> is simple, yet ambitious: |
<p> |
14 |
to become THE cross-platform IDE of choice for the Ruby community. We want |
<UL> |
15 |
<a href="wiki.pl?FreeRIDE">FreeRIDE</a> to be a first-class IDE on par with |
<li> <strong>Cross-Platform</strong> -- <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> will run on as many platforms as possible. |
16 |
those available for other languages. These goals include:</p> |
<li> <strong>International</strong> -- <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> will be easily translated into other languages and will include features that make it easier to develop Ruby applications that can be internationalized. |
17 |
<p></p> |
<li> <strong>Plugin Architecture</strong> -- <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a>'s plugin architecture will make it easy for any developer to extend the features of <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a>. |
18 |
<ul> |
<li> <strong>Extreme Programming</strong> -- <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> will include features that make it easy to use many practices that have been popularized by the Extreme Programming method. This will include collaboration support for remote pair programming, unit testing support for test-first coding, refactoring support, and more. |
19 |
<li> <strong>Cross-Platform</strong> -- <a href="wiki.pl?FreeRIDE">FreeRIDE</a> |
<li> <strong>Code Editing & Navigation</strong> -- All the now-standard code editing and navigation features you would find in any high-end IDE, including syntax highlighting, code completion, template expansion, class browsing, etc. |
20 |
will run on as many platforms as possible.</li> |
</UL> |
21 |
<li> <strong>International</strong> -- <a href="wiki.pl?FreeRIDE">FreeRIDE</a> |
<p> |
22 |
will be easily translated into other languages and will include features |
Please realize that this is a very early release of <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> and we have a long way to go before we realize these goals. This release includes basic functionality and an extremely flexible plugin architecture that makes it easy to add extensions. |
23 |
that make it easier to develop Ruby applications that can be internationalized. |
<p> |
24 |
</li> |
<H3>Overview</H3> |
25 |
<li> <strong>Plugin Architecture</strong> -- <a |
|
26 |
href="wiki.pl?FreeRIDE">FreeRIDE</a>'s plugin architecture will make it |
<p> |
27 |
easy for any developer to extend the features of <a |
This user documentation is fairly minimal. But it doesn’t need to be extensive (at least not yet), because what has been implemented so far is very straightforward and operates pretty much like any other GUI-based IDE or code editor. You should find its use to be familiar and comfortable (if not, then please let us know). |
28 |
href="wiki.pl?FreeRIDE">FreeRIDE</a>.</li> |
<p> |
29 |
<li> <strong>Extreme Programming</strong> -- <a |
<a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> is built on a very flexible plugin architecture that allows it to be easily extended. In fact, except for the code that implements the plugin system, the entire <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> IDE is implemented as a set of plugins. If you are interested in creating your own plugins to add new capabilities to <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a>, or if you want to join the <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> project, please read the DeveloperDocumentation<a href="http://www.rubyide.org/cgi-bin/wiki.pl?action=edit&id=DeveloperDocumentation">?</a>. |
30 |
href="wiki.pl?FreeRIDE">FreeRIDE</a> will include features that make it |
<p> |
31 |
easy to use many practices that have been popularized by the Extreme Programming |
The following features have been implemented in this release of <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a>: |
32 |
method. This will include collaboration support for remote pair programming, |
<UL> |
33 |
unit testing support for test-first coding, refactoring support, and more. |
<li> Edit multiple files in a tabbed edit panel with Ruby syntax highlighting and auto-indenting. |
34 |
</li> |
<li> Navigate within a source file using the Source Browser (a tree-style parsing of your code showing all modules, classes, methods, etc.). |
35 |
<li> <strong>Code Editing & Navigation</strong> -- All the now-standard |
<li> Debug your code using the integrated debugger. |
36 |
code editing and navigation features you would find in any high-end IDE, |
<li> (For <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> developers:) visually inspect the state of the internal Databus. |
37 |
including syntax highlighting, code completion, template expansion, class |
</UL> |
38 |
browsing, etc.</li> |
<p> |
39 |
</ul> |
The code editing panel is implemented using Scintilla and should be familiar to anyone who has used Scite or any other Scintilla-based code editor. It includes basic code-editing features like syntax highlighting, auto-indenting, and the expected basic navigation (Ctrl-tab to move by word, shift-key to extend selections, tab-key to indent selections, etc.). |
40 |
<p>Please realize that this is a very early release of <a |
<p> |
41 |
href="wiki.pl?FreeRIDE">FreeRIDE</a> and we have a long way to go before |
<H3>Installing <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a></H3> |
42 |
we realize these goals. This release includes basic functionality and an |
|
43 |
extremely flexible plugin architecture that makes it easy to add extensions. |
<p> |
44 |
</p> |
To run properly <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> requires 3 external software components: |
45 |
<p></p> |
<p> |
46 |
<h3>Overview</h3> |
<UL> |
47 |
<p>This user documentation is fairly minimal. But it doesn’t need to be extensive |
<li> <a href="http://www.fox-toolkit.org">[FOX]</a>, a cross-platform C/C++ GUI Toolkit that is now gaining a wide acceptance in the Ruby community (version 1.0.x with x > 26) |
48 |
(at least not yet), because what has been implemented so far is very straightforward |
<li> <a href="http://www.fxruby.org">[FXRuby]</a>, the ruby interface to the FOX library (version 1.0.16 or above, but do not use 1.0.17) |
49 |
and operates pretty much like any other GUI-based IDE or code editor. You |
<li> <a href="http://www.nongnu.org/fxscintilla/">[FXScintilla]</a>, a FOX port of the <a href="http://www.scintilla.org/">[Scintilla]</a> widget editor (version 1.49.0 or above) |
50 |
should find its use to be familiar and comfortable (if not, then please let |
</UL> |
51 |
us know).</p> |
<p> |
52 |
<p><a href="wiki.pl?FreeRIDE">FreeRIDE</a> is built on a very flexible plugin |
For Windows users a <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> specific Ruby distribution is made available by Andy Hunt and includes FOX, FXRuby and FXScintilla. You can get it <a href="http://rubygarden.com/ruby?WindowsInstaller">[here]</a>. |
53 |
architecture that allows it to be easily extended. In fact, except for the |
<p> |
54 |
code that implements the plugin system, the entire <a |
For Linux users it is very likely that your favorite distro comes with the FOX toolkit either already installed or available as a contrib. FXRuby and FXscintilla are available on the projects web site (see hyperlinks above). Worst case you can get the 3 of them from the <a href="http://www.rubyide.org/files">[FreeRIDE file repository]</a>. |
55 |
href="wiki.pl?FreeRIDE">FreeRIDE</a> IDE is implemented as a set of plugins. |
<p> |
56 |
If you are interested in creating your own plugins to add new capabilities |
<a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> also relies on a number of other Ruby packages but they come with the <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> software (redist directory). The reason why we did that is: |
57 |
to <a href="wiki.pl?FreeRIDE">FreeRIDE</a>, or if you want to join the <a |
<UL> |
58 |
href="wiki.pl?FreeRIDE">FreeRIDE</a> project, please read the DeveloperDocumentation<a |
<li> to make installation easier |
59 |
href="wiki.pl?action=edit&id=DeveloperDocumentation">?</a>.</p> |
<li> to make sure that <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> uses the right version of the package |
60 |
<p>The following features have been implemented in this release of <a |
<li> minize <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> impact on your Ruby installation. |
61 |
href="wiki.pl?FreeRIDE">FreeRIDE</a>:</p> |
</UL> |
62 |
<ul> |
<p> |
63 |
<li> Edit multiple files in a tabbed edit panel with Ruby syntax highlighting |
<p> |
64 |
and auto-indenting.</li> |
<H3>Running <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a></H3> |
65 |
<li> Navigate within a source file using the Source Browser (a tree-style |
|
66 |
parsing of your code showing all modules, classes, methods, etc.).</li> |
<p> |
67 |
<li> Debug your code using the integrated debugger.</li> |
The directory in which you installed <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> contains a system script named "run.bat" that will start <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a>. In Linux you would use “sh run.bat” and in Windows you can simply execute this script directly. |
68 |
<li> (For <a href="wiki.pl?FreeRIDE">FreeRIDE</a> developers:) visually |
<p> |
69 |
inspect the state of the internal Databus.</li> |
<a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> is entirely written in Ruby so, depending on the speed of your computer, it may take a while for <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> to start up. Once <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> has started, however, performance should be good. |
70 |
</ul> |
<p> |
71 |
<p>The code editing panel is implemented using Scintilla and should be familiar |
<H3>Menu Commands</H3> |
72 |
to anyone who has used Scite or any other Scintilla-based code editor. It |
|
73 |
includes basic code-editing features like syntax highlighting, auto-indenting, |
<p> |
74 |
and the expected basic navigation (Ctrl-tab to move by word, shift-key to |
For the most part, the menu commands should be familiar and obvious. |
75 |
extend selections, tab-key to indent selections, etc.).</p> |
<p> |
76 |
<p></p> |
<H4>The File Menu</H4> |
77 |
<h3>Installing <a href="wiki.pl?FreeRIDE">FreeRIDE</a></h3> |
|
78 |
<p>To run properly <a href="wiki.pl?FreeRIDE">FreeRIDE</a> requires 3 external |
<p> |
79 |
software components:</p> |
<UL> |
80 |
<p></p> |
<li> <em>New</em> -- opens a new, empty edit window. |
81 |
<ul> |
<li> <em>Open</em> -- Opens an existing file for editing. |
82 |
<li> <a href="http://www.fox-toolkit.org">[FOX]</a>, a cross-platform C/C++ |
<li> <em>Close</em> -- Closes the currently active edit window. |
83 |
GUI Toolkit that is now gaining a wide acceptance in the Ruby community (version |
<li> <em>Save</em> -- Saves the changes in the currently active edit window. |
84 |
1.0.x with x > 26)</li> |
<li> <em>Save As</em> -- Saves the currently active edit window under a new filename. |
85 |
<li> <a href="http://fxruby.sf.net">[FXRuby]</a>, the ruby interface to |
<li> <em>Exit</em> -- Terminates <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a>. |
86 |
the FOX library (version 1.0.16 or above)</li> |
</UL> |
87 |
<li> <a href="http://www.nongnu.org/fxscintilla/">[FXScintilla]</a>, a |
<p> |
88 |
FOX port of the <a href="http://www.scintilla.org/">[Scintilla]</a> widget |
<H4>The Edit Menu</H4> |
89 |
editor (version 1.49.0 or above)</li> |
|
90 |
</ul> |
<p> |
91 |
<p>For Windows users a <a href="wiki.pl?FreeRIDE">FreeRIDE</a> specific Ruby |
<UL> |
92 |
distribution is made available by Andy Hunt and includes FOX, FXRuby and |
<li> <em>Undo</em> -- Undoes the last editing operation. |
93 |
FXScintilla. You can get it <a |
<li> <em>Redo</em> -- Reapplies the last editing operation that was removed by the Undo command. |
94 |
href="http://rubygarden.com/ruby?WindowsInstaller">[here]</a>.</p> |
<li> <em>Cut</em> -- Cuts the selected text to the clipboard. |
95 |
<p>For Linux users it is very likely that your favorite distro comes with |
<li> <em>Copy</em> -- Copies the selected text to the clipboard. |
96 |
the FOX toolkit either already installed or available as a contrib. FXRuby |
<li> <em>Paste</em> -- Pastes the contents of the clipboard at the current location (or replacing the current selection) in the edited file. |
97 |
and FXscintilla are available on the projects web site (see hyperlinks above). |
</UL> |
98 |
Worst case you can get the 3 of them from the <a |
<p> |
99 |
href="http://www.rubyide.org/files">[FreeRIDE file repository]</a>.</p> |
<H4>The View Menu</H4> |
100 |
<p><a href="wiki.pl?FreeRIDE">FreeRIDE</a> also relies on a number of other |
|
101 |
Ruby packages but they come with the <a href="wiki.pl?FreeRIDE">FreeRIDE</a> |
<p> |
102 |
software (redist directory). The reason why we did that is:</p> |
<UL> |
103 |
<ul> |
<li> <em>Ouput Window</em> -- Toggles the display of the Output Window. |
104 |
<li> to make installation easier</li> |
<li> <em>File List</em> -- Toggles the display of the File-List pane. |
105 |
<li> to make sure that <a href="wiki.pl?FreeRIDE">FreeRIDE</a> uses the |
<li> <em>Source Browser</em> -- Toggles the display of the Source-Browser pane. |
106 |
right version of the package</li> |
</UL> |
107 |
<li> minize <a href="wiki.pl?FreeRIDE">FreeRIDE</a> impact on your Ruby |
<p> |
108 |
installation.</li> |
<H4>The Run Menu</H4> |
109 |
</ul> |
|
110 |
<p></p> |
<p> |
111 |
<p></p> |
<UL> |
112 |
<h3>Running <a href="wiki.pl?FreeRIDE">FreeRIDE</a></h3> |
<li> <em>Debug</em> – Starts the debugger and executes the Ruby program in the current edit window. |
113 |
<p>The directory in which you installed <a href="wiki.pl?FreeRIDE">FreeRIDE</a> |
<li> <em>Run</em> – Executes the Ruby program in the current edit window, displaing its output in the Output Window. |
114 |
contains a system script named "run.bat" that will start <a |
<li> <em>Clear Output</em> – Clears all text in the Output Window. |
115 |
href="wiki.pl?FreeRIDE">FreeRIDE</a>. In Linux you would use “sh run.bat” |
</UL> |
116 |
and in Windows you can simply execute this script directly.</p> |
<p> |
117 |
<p><a href="wiki.pl?FreeRIDE">FreeRIDE</a> is entirely written in Ruby so, |
<H4>The Tools Menu</H4> |
118 |
depending on the speed of your computer, it may take a while for <a |
|
119 |
href="wiki.pl?FreeRIDE">FreeRIDE</a> to start up. Once <a |
<p> |
120 |
href="wiki.pl?FreeRIDE">FreeRIDE</a> has started, however, performance should |
<UL> |
121 |
be good.</p> |
<li> <em>Databus Inspector</em> -- Opens the Databus Inspector window (used to debug <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> plugins). |
122 |
<p></p> |
</UL> |
123 |
<h3>Menu Commands</h3> |
<p> |
124 |
<p>For the most part, the menu commands should be familiar and obvious.</p> |
<H4>The Help Menu</H4> |
125 |
<p></p> |
|
126 |
<h4>The File Menu</h4> |
<p> |
127 |
<p></p> |
<UL> |
128 |
<ul> |
<li> <em>Help</em> -- Displays help on using <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a>.. |
129 |
<li> <em>New</em> -- opens a new, empty edit window.</li> |
<li> <em>About</em> -- The standard, obligatory about box. |
130 |
<li> <em>Open</em> -- Opens an existing file for editing.</li> |
</UL> |
131 |
<li> <em>Close</em> -- Closes the currently active edit window.</li> |
<p> |
132 |
<li> <em>Save</em> -- Saves the changes in the currently active edit window. |
<H3>The Default Keyboard Shortcuts</H3> |
133 |
</li> |
|
134 |
<li> <em>Save As</em> -- Saves the currently active edit window under a |
<p> |
135 |
new filename.</li> |
<PRE> |
136 |
<li> <em>Exit</em> -- Terminates <a href="wiki.pl?FreeRIDE">FreeRIDE</a>. |
Ctrl+C Copy |
137 |
</li> |
Ctrl+D Debug |
138 |
</ul> |
Ctrl+L File Browser |
139 |
<p></p> |
Ctrl+N New File |
140 |
<h4>The Edit Menu</h4> |
Ctrl+O Open File |
141 |
<p></p> |
Ctrl+S Save |
142 |
<ul> |
Ctrl+Shift+S Save As |
143 |
<li> <em>Undo</em> -- Undoes the last editing operation.</li> |
Ctrl+V Paste |
144 |
<li> <em>Redo</em> -- Reapplies the last editing operation that was removed |
Ctrl+W Close File |
145 |
by the Undo command.</li> |
Ctrl+X Cut |
146 |
<li> <em>Cut</em> -- Cuts the selected text to the clipboard.</li> |
Ctrl+Y Redo |
147 |
<li> <em>Copy</em> -- Copies the selected text to the clipboard.</li> |
Ctrl+Z Undo |
148 |
<li> <em>Paste</em> -- Pastes the contents of the clipboard at the current |
F5 Run |
149 |
location (or replacing the current selection) in the edited file.</li> |
Ctrl+F5 Clear Output Window |
150 |
</ul> |
F7 Source Navigator |
151 |
<p></p> |
F8 Output Window |
152 |
<h4>The Run Menu</h4> |
</PRE> |
153 |
<p></p> |
<p> |
154 |
<ul> |
<H3>The Source Browser</H3> |
155 |
<li> <em>Debug</em> – Starts the debugger and executes the Ruby program |
|
156 |
in the current edit window.</li> |
<p> |
157 |
</ul> |
The Source Browser helps shows you the structure of your source code and lets you jump directly to differently parts of your source code. It does this by parsing your source code and displaying an outline of the contents of your source code as hierarchical tree. Clicking on an item in the tree (like a method name or a class name) will cause the editing pane to jump directly to that item in your source code. |
158 |
<p></p> |
<p> |
159 |
<h4>The Tools Menu</h4> |
The Source Browser is occupies a docked window pane the runs down the left side of the <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> window (if the Source Browser is not visible, you may need to use you mouse to grab the splitter bar at the left of the editing pane and drag it to the right). |
160 |
<p></p> |
<p> |
161 |
<ul> |
Currently, you must manually force the Source Browser to refresh (reparse the source code) after you have made changes to your source code. This is a temporary measure that was needed to maintain adequate performance. The long term goal is to make this completely automatic. |
162 |
<li> <em>Databus Inspector</em> -- Opens the Databus Inspector window (used |
<p> |
163 |
to debug <a href="wiki.pl?FreeRIDE">FreeRIDE</a> plugins).</li> |
<H3>Debugging</H3> |
164 |
</ul> |
|
165 |
<p></p> |
<p> |
166 |
<h4>The Help Menu</h4> |
(to be written) – Note: shift-click left in margin of the edit-pane to set or clear a breakpoint. |
167 |
<p></p> |
<p> |
168 |
<ul> |
<H3>The Databus Inspector</H3> |
169 |
<li> <em>User Help</em> -- Displays help on using <a |
|
170 |
href="wiki.pl?FreeRIDE">FreeRIDE</a>..</li> |
<p> |
171 |
<li> <em>Developer Help</em> -- Displays help on developing <a |
The Databus Inspector is a GUI tool for interactively exploring the current state of the internal Databus that is the central communications hub for all <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> plugins. This will only be of interest to developers who are creating and debugging <a href="http://www.rubyide.org/cgi-bin/wiki.pl?FreeRIDE">FreeRIDE</a> plugins. |
172 |
href="wiki.pl?FreeRIDE">FreeRIDE</a> plugins.</li> |
<p> |
173 |
<li> <em>About</em> -- The standard, obligatory about box.</li> |
Please see the developer documentation for more details about the Databus. |
174 |
</ul> |
<p> |
175 |
<p></p> |
Version: $Id$ |
176 |
<h3>The Default Keyboard Shortcuts</h3> |
<center><hr width=200>Copyright © rubyide.org</center></BODY></HTML><!--//--><script>if(document.layers){document.captureEvents(Event.MOUSEUP);}document.onmouseup=PrxOMUp;</script> |
|
<p></p> |
|
|
<pre> Ctrl+C Copy <br> Ctrl+D Debug <br> Ctrl+L File Browser <br> Ctrl+N New File <br> Ctrl+O Open File <br> Ctrl+S Save <br> Ctrl+Shift+S Save As <br> Ctrl+V Paste <br> Ctrl+W Close File <br> Ctrl+X Cut<br> Ctrl+Y Redo<br> Ctrl+Z Undo<br> F7 Source Navigator<br></pre> |
|
|
<p></p> |
|
|
<h3>The Source Browser</h3> |
|
|
<p>The Source Browser helps shows you the structure of your source code and |
|
|
lets you jump directly to differently parts of your source code. It does |
|
|
this by parsing your source code and displaying an outline of the contents |
|
|
of your source code as hierarchical tree. Clicking on an item in the tree |
|
|
(like a method name or a class name) will cause the editing pane to jump |
|
|
directly to that item in your source code.</p> |
|
|
<p>The Source Browser is occupies a docked window pane the runs down the |
|
|
left side of the <a href="wiki.pl?FreeRIDE">FreeRIDE</a> window (if the Source |
|
|
Browser is not visible, you may need to use you mouse to grab the splitter |
|
|
bar at the left of the editing pane and drag it to the right).</p> |
|
|
<p>Currently, you must manually force the Source Browser to refresh (reparse |
|
|
the source code) after you have made changes to your source code. This is |
|
|
a temporary measure that was needed to maintain adequate performance. The |
|
|
long term goal is to make this completely automatic.</p> |
|
|
<p></p> |
|
|
<h3>Debugging</h3> |
|
|
<p>(to be written) – Note: shift-click left in margin of the edit-pane to |
|
|
set or clear a breakpoint.</p> |
|
|
<p></p> |
|
|
<h3>The Databus Inspector</h3> |
|
|
<p>The Databus Inspector is a GUI tool for interactively exploring the current |
|
|
state of the internal Databus that is the central communications hub for |
|
|
all <a href="wiki.pl?FreeRIDE">FreeRIDE</a> plugins. This will only be of |
|
|
interest to developers who are creating and debugging <a |
|
|
href="wiki.pl?FreeRIDE">FreeRIDE</a> plugins.</p> |
|
|
<p>Please see the developer documentation for more details about the Databus. |
|
|
</p> |
|
|
<p>Version: $Id$</p> |
|
|
<center> |
|
|
<hr width="200">Copyright © rubyide.org</center> |
|
|
<br> |
|
|
</body> |
|
|
</html> |
|