Skip to content

Commit f1aa1d0

Browse files
author
mgricken
committed
QuickStart documentation update.
git-svn-id: file:///tmp/test-svn/trunk@4972 fe72c1cf-3628-48e9-8b72-1c46755d3cff
1 parent d3fa1d4 commit f1aa1d0

File tree

3 files changed

+193
-32
lines changed

3 files changed

+193
-32
lines changed

‎docs/src/quickstart/quickstart.docbook‎

Lines changed: 192 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<book id="index">
1010
<!-- Meta info -->
1111
<bookinfo>
12-
<date>2006-8-18</date>
12+
<date>2009-08-03</date>
1313
<title>A Quick Start Guide to DrJava</title>
1414
</bookinfo>
1515
<toc></toc>
@@ -45,7 +45,7 @@ introduce you to some of its key features.</para>
4545
Do a search for "Download Java JDK"
4646
</para> </listitem>
4747
<listitem> <para>
48-
Select the most recent build of Java from the list of options you see. We recommend Java 5.0 (formerly called Java 1.5) assuming that you are using the current beta release of DrJava. Recent releases of DrJava are not compatible with versions of the JDK prior to 1.4. Older versions of DrJava are compatible with Java 1.3 and Java 1.4 but not Java 5.0.
48+
Select the most recent build of Java from the list of options you see. We recommend Java 6, assuming that you are using a current release of DrJava. Recent releases of DrJava are not compatible with versions of the JDK prior to Java 5 (previously called Java 1.5.0). Older versions of DrJava are compatible with Java 1.3 and Java 1.4.
4949
</para> </listitem>
5050
<listitem> <para>
5151
Click on the link to download the JDK.
@@ -70,7 +70,7 @@ introduce you to some of its key features.</para>
7070
Go to <ulink url="http://www.drjava.org">http://www.drjava.org.</ulink>
7171
</para></listitem>
7272
<listitem><para>
73-
Select which build of DrJava is right for you, and click on the appropriate button. We using the most recent beta release since it supports all of the Java 5.0 language extensions, which make Java programming simpler. We also recommend that Windows users download the <filename>.exe</filename> file, that Mac OS X users use the <filename>osx.tar.gz</filename> version, and that other users download the <filename>.jar</filename> version. If you have problems with the beta release of DrJava, you can roll back to the stable version but it does not support Java 1.5 langauge. Experienced users may want to experiment with other versions of DrJava including the most recent
73+
Select which build of DrJava is right for you, and click on the appropriate button. We recommend using the most recent stable or beta releases since they support all of the Java 5 language extensions and Java 6 APIs, which make Java programming simpler. We also recommend that Windows users download the <filename>.exe</filename> file, that Mac OS X users use the <filename>osx.tar.gz</filename> version, and that other users download the <filename>.jar</filename> version. If you have problems with a beta release of DrJava, you can roll back to the most recent stable version. Experienced users may want to experiment with other versions of DrJava including the most recent
7474
Development Build jar instead. To do so, click on the "more download options" link.
7575
<mediaobject>
7676
<imageobject>
@@ -727,6 +727,11 @@ read -1, indicating of the end of the stream.</para>
727727
<title>Tools.jar Location:</title>
728728
<para>The directory of your tools.jar file which has the compiler and debugger. This file is usually created during the installation of the Java JDK.</para>
729729
</formalpara></listitem>
730+
731+
<listitem><formalpara>
732+
<title>Display All Compiler Versions:</title>
733+
<para>By default, DrJava only displays one compiler per major version, even if multiple updates are found (Example: You have JDK 6 Updates 10 and 14 installed; DrJava will only display JDK 6 Update 14). To display all compiler versions, mark this checkbox. Note: You have to restart DrJava when you change this setting.</para>
734+
</formalpara></listitem>
730735

731736
<listitem><formalpara>
732737
<title>Extra Classpath:</title>
@@ -761,6 +766,11 @@ read -1, indicating of the end of the stream.</para>
761766
<title>Look and Feel:</title>
762767
<para> Specify what theme DrJava uses</para>
763768
</formalpara></listitem>
769+
770+
<listitem><formalpara>
771+
<title>Plastic Theme:</title>
772+
<para> If Plastic is selected as Look and Feel, then the specific theme can be selected here</para>
773+
</formalpara></listitem>
764774

765775
<listitem><formalpara>
766776
<title>Toolbar Buttons:</title>
@@ -773,18 +783,13 @@ read -1, indicating of the end of the stream.</para>
773783
</formalpara></listitem>
774784

775785
<listitem><formalpara>
776-
<title>Save Window Size and Position:</title>
777-
<para>Check this if you want the size and position of the main DrJava window to be saved on exit.</para>
786+
<title>Show sample of source code when fast switching:</title>
787+
<para>Choose whether a sample of the source code around the current caret position should be shown in the Fast Switch window.</para>
778788
</formalpara></listitem>
779789

780790
<listitem><formalpara>
781-
<title>Save "xxx"Dialog Position:</title>
782-
<para>Check this if you want the size and position of the "xxx" dialog to be saved on exit (different choices for "xxx").</para>
783-
</formalpara></listitem>
784-
785-
<listitem><formalpara>
786-
<title>Reset "xxx" Dialog Position and Size:</title>
787-
<para>Press this button to reset the size and position of the "xxx" dialog (different choices for "xxx"). This can be useful if the dialog was displayed outside the screen for some reason and is not accessible.</para>
791+
<title>Show Code Preview Popups:</title>
792+
<para>Whether a sample of the source code around the document location should be shown in the Breakpoints, Bookmarks and Find Results panes.</para>
788793
</formalpara></listitem>
789794

790795
<listitem><formalpara>
@@ -802,6 +807,11 @@ read -1, indicating of the end of the stream.</para>
802807
<para>DrJava can auto-complete the names of user classes. If this option is checked, DrJava will scan all class files that were created after each compile to obtain the names, even of inner classes. IF this option is not checked, DrJava can only auto-complete the names of the documents that are open. Selecting this option slows down compiles.</para>
803808
</formalpara></listitem>
804809

810+
<listitem><formalpara>
811+
<title>Consider Java API Classes for Auto Completion:</title>
812+
<para>When this option is enabled, DrJava will include the names of the standard Java API classes in the list of names used for auto-completion.</para>
813+
</formalpara></listitem>
814+
805815
</itemizedlist>
806816

807817
<mediaobject>
@@ -862,6 +872,40 @@ read -1, indicating of the end of the stream.</para>
862872

863873
</section>
864874

875+
<section id="windowpos">
876+
<title>Window Positions</title>
877+
<para>The Window Positions category allows you to control if DrJava saves the positions of its windows. </para>
878+
879+
<itemizedlist>
880+
<listitem><formalpara>
881+
<title>Save Window Size and Position:</title>
882+
<para>Check this if you want the size and position of the main DrJava window to be saved on exit.</para>
883+
</formalpara></listitem>
884+
885+
<listitem><formalpara>
886+
<title>Save "xxx"Dialog Position:</title>
887+
<para>Check this if you want the size and position of the "xxx" dialog to be saved on exit (different choices for "xxx").</para>
888+
</formalpara></listitem>
889+
890+
<listitem><formalpara>
891+
<title>Reset "xxx" Dialog Position and Size:</title>
892+
<para>Press this button to reset the size and position of the "xxx" dialog (different choices for "xxx"). This can be useful if the dialog was displayed outside the screen for some reason and is not accessible.</para>
893+
</formalpara></listitem>
894+
895+
<listitem><formalpara>
896+
<title>Detach Tabbed Panes:</title>
897+
<para>By default, the tabbed panes are attached to the bottom of DrJava's main window. By selecting this option, DrJava displays the tabbed panes in their own separate window.</para>
898+
</formalpara></listitem>
899+
900+
<listitem><formalpara>
901+
<title>Detach Debugger:</title>
902+
<para>By default, the debugger pane is displayed in DrJava's main window. By selecting this option, DrJava displays the debugger in its own separate window.</para>
903+
</formalpara></listitem>
904+
905+
</itemizedlist>
906+
907+
</section>
908+
865909
<section id="keybindings">
866910
<title>Key Bindings</title>
867911

@@ -888,6 +932,35 @@ read -1, indicating of the end of the stream.</para>
888932

889933
</section>
890934

935+
<section id="interactionsoptions">
936+
<title>Interactions Pane</title>
937+
938+
<para> The Interactions Pane category allows you to set options for the Interactions Pane.</para>
939+
<itemizedlist>
940+
<listitem><formalpara>
941+
<title>Size of Interactions History:</title>
942+
<para>Specifies how many interactions will be stored in the history for you to scroll through using the up arrow.</para>
943+
</formalpara></listitem>
944+
945+
<listitem><formalpara>
946+
<title>Enable the "Auto Import" Dialog:</title>
947+
<para>When this option is enabled, DrJava will display a dialog to automatically import classes when a class name is interpreted but not known. After the class has been selected, DrJava will execute the appropriate "import" statement and re-execute the line that caused the dialog to appear.</para>
948+
</formalpara></listitem>
949+
950+
<listitem><formalpara>
951+
<title>Classes to Auto-Import:</title>
952+
<para>This option allows you to select classes and packages that should be imported automatically whenever the Interactions Pane is reset. List fully-qualified class names (e.g. java.util.ArrayList, or packages ending with a *, e.g. java.util.*).</para>
953+
</formalpara></listitem>
954+
955+
<listitem><formalpara>
956+
<title>Restore last working directory of the Interactions Pane on start up:</title>
957+
<para>If this option is enabled, DrJava will restore the directory that was last used in the Interactions Pane. If it is disabled, DrJava will always use the value of the "user.home" property.</para>
958+
</formalpara></listitem>
959+
960+
</itemizedlist>
961+
962+
</section>
963+
891964
<section id="debuggeroptions">
892965
<title>Debugger Options</title>
893966
<para>The Debugger Menu gives you more control over the debugger.</para>
@@ -979,8 +1052,8 @@ read -1, indicating of the end of the stream.</para>
9791052
</section>
9801053

9811054
<section id="notificationpreferences">
982-
<title>Notifications Menu</title>
983-
<para>The Notifications menu lets you say whether or not you want notifications on certain actions. This is the place to come if you accidentally turn off a warning and want to turn it back on.</para>
1055+
<title>Notifications Options</title>
1056+
<para>The Notifications category lets you say whether or not you want notifications on certain actions. This is the place to come if you accidentally turn off a warning and want to turn it back on.</para>
9841057

9851058
<mediaobject>
9861059
<imageobject>
@@ -991,9 +1064,9 @@ read -1, indicating of the end of the stream.</para>
9911064
</section>
9921065

9931066
<section id="miscellaneouspreferences">
994-
<title>Miscellaneous Menu</title>
1067+
<title>Miscellaneous Options</title>
9951068

996-
<para> The Miscellaneous menu contains all of the options that did not fit neatly into one of the above categories.</para>
1069+
<para> The Miscellaneous category contains all of the options that did not fit neatly into one of the above categories.</para>
9971070

9981071
<itemizedlist mark="opencircle">
9991072
<listitem><formalpara>
@@ -1002,13 +1075,13 @@ read -1, indicating of the end of the stream.</para>
10021075
</formalpara></listitem>
10031076

10041077
<listitem><formalpara>
1005-
<title>Size of Interactions History:</title>
1006-
<para>Specifies how many interactions will be stored in the history for you to scroll through using the up arrow.</para>
1078+
<title>Recent Files List Size:</title>
1079+
<para>Specifies how many of your most recently open files are displayed when you open the "File" menu on the toolbar.</para>
10071080
</formalpara></listitem>
10081081

10091082
<listitem><formalpara>
1010-
<title>Recent Files List Size:</title>
1011-
<para>Specifies how many of your most recently open files are displayed when you open the "File" menu on the toolbar.</para>
1083+
<title>Maximum Size of Browser History:</title>
1084+
<para>Specifies how many source code locations are stored in the browser history. This history can be used to go back and forth, like in a web browser.</para>
10121085
</formalpara></listitem>
10131086

10141087
<listitem>
@@ -1038,27 +1111,48 @@ read -1, indicating of the end of the stream.</para>
10381111
</formalpara></listitem>
10391112

10401113
<listitem><formalpara>
1114+
<title>Require test classes in projects to end in "Test":</title>
1115+
<para>Whether to require that JUnit test classes in projects end in "Test". If this is enabled, classes that do not end in "Test" will not be considered JUnit tests when in project mode.</para>
1116+
</formalpara></listitem>
1117+
1118+
<!-- <listitem><formalpara>
10411119
<title>Allow Access of Private Members in Interactions Pane:</title>
10421120
<para>A great option for testing, because it gives you more flexibility than normal. However, it can also lead to confusion for beginning students since private fields cannot normally be accessed outside of their classes.</para>
1121+
</formalpara></listitem> -->
1122+
1123+
<listitem><formalpara>
1124+
<title>Put the focus in the definitions pane after find/replace:</title>
1125+
<para>If this option is checked, the focus will be put in the definitions pane after using "Find". If this is not checked, then the focus will remain in the Find/Replace tab.</para>
10431126
</formalpara></listitem>
1044-
1127+
10451128
<listitem><formalpara>
1046-
<title>Show Sample of Source Code when Fast Switching:</title>
1047-
<para>Shows part of the source code when you use ctrl-tilde to quickly switch between documents.</para>
1129+
<title>Forcefully Quit DrJava:</title>
1130+
<para>On some systems (namely tablet PCs), DrJava does not shut down properly when quit. Select this option to remedy this problem.</para>
10481131
</formalpara></listitem>
10491132

10501133
<listitem><formalpara>
1051-
<title>Put the focus in the definitions pane after find/replace.</title>
1052-
<para>If this option is checked, the focus will be put in the definitions pane after using "Find". If this is not checked, then the focus will remain in the Find/Replace tab.</para>
1134+
<title>Enable Remote Control:</title>
1135+
<para>Java's "remote control" allows other applications to control certain aspects of DrJava, for example what file is displayed. This feature is also necessary if you want to double-click on a .java file to open the file in an existing instance of DrJava.</para>
10531136
</formalpara></listitem>
1054-
</itemizedlist>
1055-
</listitem>
1056-
10571137

10581138
<listitem><formalpara>
1059-
<title>JVM Args for Interactions</title>
1060-
<para>Allows you to pass arguments to the JVM that controls the Interactions Pane.</para>
1139+
<title>Remote Control Port:</title>
1140+
<para>Selects the port that Drjava uses for its remote control.</para>
1141+
</formalpara></listitem>
1142+
1143+
<listitem><formalpara>
1144+
<title>Follow File Delay:</title>
1145+
<para>Specifies the number of milliseconds that have to pass before DrJava will update a "Follow File" window again.</para>
10611146
</formalpara></listitem>
1147+
1148+
<listitem><formalpara>
1149+
<title>Maximum Lines in "Follow File" Window:</title>
1150+
<para>Specifies the number of of lines that a "Follow File" window may contain. If a file has more than this many lines, only the end of the file will be displayed.</para>
1151+
</formalpara></listitem>
1152+
1153+
</itemizedlist>
1154+
</listitem>
1155+
10621156
</itemizedlist>
10631157

10641158
<mediaobject>
@@ -1068,7 +1162,74 @@ read -1, indicating of the end of the stream.</para>
10681162
</mediaobject>
10691163

10701164
</section>
1071-
1165+
1166+
<section id="filetypesoptions">
1167+
<title>File Types</title>
1168+
1169+
<para>Configurable options for file types. Note that the options here are only available on Windows, and only if the .exe file is used.</para>
1170+
<para>.drjava files are DrJava project files. .djapp files are DrJava add-ons. .java files are Java source files.</para>
1171+
1172+
<itemizedlist mark="opencircle">
1173+
<listitem><formalpara>
1174+
<title>Associate .drjava and .djapp Files with DrJava</title>
1175+
<para>Set the file type associations so that double-clicking on .drjava and .djapp files in the Windows Explorer will open them in DrJava.</para>
1176+
</formalpara></listitem>
1177+
1178+
<listitem><formalpara>
1179+
<title>Remove .drjava and .djapp File Associations</title>
1180+
<para>Remove the association of .drjava and .djapp files with DrJava.</para>
1181+
</formalpara></listitem>
1182+
1183+
<listitem><formalpara>
1184+
<title>Associate .java Files with DrJava</title>
1185+
<para>Set the file type associations so that double-clicking on .java files in the Windows Explorer will open them in DrJava.</para>
1186+
</formalpara></listitem>
1187+
1188+
<listitem><formalpara>
1189+
<title>Remove .java File Associations</title>
1190+
<para>Remove the association of .java files with DrJava.</para>
1191+
</formalpara></listitem>
1192+
1193+
<listitem><formalpara>
1194+
<title>Automatically assign .java, .drjava and .djapp Files to DrJava</title>
1195+
<para>Specifies whether Drjava should automatically associate .java, .drjava and .djapp files with DrJava so those files are opened with DrJava when double-clicked. When set to the default, "ask me at startup", DrJava will check at startup if those associations exist, and if not, present a dialog allowing the user to set the file associations. Setting this option to "always" will set the file associations automatically at startup without user interaction. Setting it to "never" will not change file associations nor ask the user.</para>
1196+
</formalpara></listitem>
1197+
1198+
</itemizedlist>
1199+
1200+
</section>
1201+
1202+
1203+
<section id="jvmsoptions">
1204+
<title>JVM Options</title>
1205+
1206+
<para>The JVM category contains options for the two Java Virtual Machines (JVMs) that DrJava uses.</para>
1207+
1208+
<itemizedlist mark="opencircle">
1209+
<listitem><formalpara>
1210+
<title>Maximum Heap Size for Main JVM in MB</title>
1211+
<para>Specifies how many megabytes of memory Java should use for the Main JVM (the main part of DrJava including the editor and compiler). The "default" setting leaves this up to Java. If you experience "Out of memory" errors, set this to a value that is larger than 64 MB (default in Java 5) but smaller than the amount of physical memory you have. If it is still too small, choose the next bigger setting. Note: You have to restart DrJava for changes to become effective.</para>
1212+
</formalpara></listitem>
1213+
1214+
<listitem><formalpara>
1215+
<title>JVM Args for Main JVM</title>
1216+
<para>Specifies the JVM arguments that should be used for DrJava's Main JVM, other than the maximum heap size (-Xmx), which is controlled using the option above. Note: You have to restart DrJava for changes to become effective.</para>
1217+
</formalpara></listitem>
1218+
1219+
<listitem><formalpara>
1220+
<title>Maximum Heap Size for Interactions JVM in MB</title>
1221+
<para>Specifies how many megabytes of memory Java should use for the Interactions JVM (used to interpret code in the Interactions Pane and to run programs developed in DrJava). The "default" setting leaves this up to Java. If you experience "Out of memory" errors, set this to a value that is larger than 64 MB (default in Java 5) but smaller than the amount of physical memory you have. If it is still too small, choose the next bigger setting. Note: You have to reset the Interactions Pane for changes to become effective.</para>
1222+
</formalpara></listitem>
1223+
1224+
<listitem><formalpara>
1225+
<title>JVM Args for Interactions JVM</title>
1226+
<para>Specifies the JVM arguments that should be used for DrJava's Interactions JVM, other than the maximum heap size (-Xmx), which is controlled using the option above. Note: You have to reset the Interactions Pane for changes to become effective.</para>
1227+
</formalpara></listitem>
1228+
1229+
</itemizedlist>
1230+
1231+
</section>
1232+
10721233
</chapter>
10731234

10741235

‎docs/src/user/userdoc.docbook‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1656,7 +1656,7 @@ DrJava</link>).</para>
16561656
<varlistentry>
16571657
<term>Restore last working directory of the Interactions Pane on start up (<varname>sticky.interactions.dir = true</varname>)</term>
16581658
<listitem>
1659-
<para>If this option is enabled, DrJava will restore the directory that was last used in the Interactions Pane. If it is disabled, DrJava will always use the value of the "iuser.home" property.</para>
1659+
<para>If this option is enabled, DrJava will restore the directory that was last used in the Interactions Pane. If it is disabled, DrJava will always use the value of the "user.home" property.</para>
16601660
</listitem>
16611661
</varlistentry>
16621662

‎drjava/lib/docs.jar‎

5.56 KB
Binary file not shown.

0 commit comments

Comments
 (0)