You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
improved description of new options in "Preferences"
still missing.
M drjava/lib/docs.jar
M docs/src/user/userdoc.docbook
git-svn-id: file:///tmp/test-svn/trunk@4593 fe72c1cf-3628-48e9-8b72-1c46755d3cff
Copy file name to clipboardExpand all lines: docs/src/user/userdoc.docbook
+58-13Lines changed: 58 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -185,7 +185,9 @@ Developed by: Java Programming Languages Team
185
185
<title>Auto-Completion</title>
186
186
<para>DrJava supports a very limited notion of auto-completion that is nonetheless useful. This feature is accessible as "Auto-Complete Word Under Cursor" in the Edit menu, and it is also bound to the keyboard shortcut <keycode>Ctrl-Shift-Space</keycode> by default. When invoked, DrJava will look at the word to the left of the cursor and attempt to auto-complete it, based on a list of documents currently open. If there is no unique auto-completion match, DrJava displays a <link linkend="predictive-input">predictive input dialog</link> with the auto-completion candidates.</para></formalpara>
187
187
<para>When a project is open, DrJava can also be configured to scan all class files after a compile to obtain the auto-completion information (see <link linkend="configuration">Configuring DrJava</link>). With that option set, DrJava can auto-complete the names of all classes in your project, even those of inner classes.</para>
188
-
<para>Please note that auto-completion currently only works for class names, is limited to user class names (i.e. it does not auto-complete Java API class names), and completely ignores all context except for the word to the left of the cursor (i.e. it may generate code that does not compile).</para>
188
+
<para>On the "Auto-Complete Word Under Cursor" diaog, there is a checkbox labeled "Java API". If this is checked, then DrJava will also use the class names from the Standard Java API as suggestions for auto-completion. If it is disabled, only class names from your own source files are used.</para>
189
+
<para>Next to the "OK" button is the "Fully Qualified" button. If the class "Integer" is selected, and the user presses "OK", DrJava will auto-complete the word to "Integer". If, however, "Fully Qualified" is used to close the dialog, DrJava will enter the entire fully qualified class name, "java.lang.Integer" in this case.</para>
190
+
<para>Please note that auto-completion currently only works for class names, and completely ignores all context except for the word to the left of the cursor (i.e. it may generate code that does not compile).</para>
189
191
190
192
<formalpara>
191
193
<title>Clipboard History</title>
@@ -810,7 +812,8 @@ learning tool.</para>
810
812
811
813
<section id="detachable-debugger">
812
814
<title>Detachable Debug Panel</title>
813
-
<para>TODO</para>
815
+
<para>When the Debug Panel is visible, it is normally attached to DrJava's main frame and displayed just above the bottom panes, and below the editor pane. To conserve screen space or make better use of dual monitors, the Debug Panel can also be detached.</para>
816
+
<para>To do this, click on the "Detach Debugger" menu item in the "Debug" menu and make sure that a checkmark appears next to "Detach Debugger". All debugger controls are now displayed in a separate window called "Debugger". To re-attach the "Debugger" window to DrJava's main frame, remove the checkmark next to "Detach Debugger" or close the "Debugger" window.</para>
814
817
</section>
815
818
</chapter>
816
819
@@ -903,8 +906,7 @@ public class Student {
903
906
<title>Java API Javadoc</title>
904
907
<para>If you have access to the Java API javadoc pages, DrJava allows you to quickly open a javadoc page for a class: With the "Open Java API Javadoc" item in the Tools menu (bound to <keycode>Shift+F6</keycode>), you can open a <link linkend="predictive-input">predictive input dialog</link> populated with all Java API classes. After you have selected a class, DrJava will try to open the corresponding javadoc page in a browser.</para>
905
908
<para>The "Open Java API Javadoc for Word Under Cursor" feature, also in the Tools menu and bound to <keycode>Ctrl+Shift+F6</keycode>, looks at the word the cursor is on and uses it as a starting point for the search. If there is a unique match, then DrJava will open the javadoc page immediately; otherwise this feature works just like "Open Java API Javadoc".</para>
906
-
<para>Note that this feature requires access to the Java API javadoc pages, e.g. on the internet. DrJava will use the version and location set in the "Javadoc" portion of the "Preferences" dialog (see <link linkend="configuration">Configuring DrJava</link>) and access that location the first time this feature is used during a DrJava session. You can use Java API javadoc pages on your local system by entering a URL beginning with "file://" followed by the directory the allclasses-frame.html file is in. You may also have to set the right values for the "Web Browser" and "Web Browser Command" settings in the "Resource Locations" portion of the "Preferences" dialog.</para>
907
-
<para>TODO: Fully qualified</para>
909
+
<para>Note that this feature requires access to the Java API javadoc pages, e.g. on the internet. DrJava will use the version and location set for "Java Version for 'Open Java API Javadoc'" in the "Javadoc" pane of the "Preferences" dialog (see <link linkend="configuration">Configuring DrJava</link>) and access that location the first time this feature is used during a DrJava session. You can use Java API javadoc pages on your local system by entering a URL beginning with "file://" followed by the directory the allclasses-frame.html file is in. You may also have to set the right values for the "Web Browser" and "Web Browser Command" settings in the "Resource Locations" portion of the "Preferences" dialog.</para>
908
910
</section>
909
911
910
912
</chapter>
@@ -927,36 +929,79 @@ public class Student {
927
929
928
930
<section id="ext-process-follow">
929
931
<title>Follow File</title>
930
-
<para>TODO</para>
932
+
<para>Using the "Follow File" option in the "Tools" menu, the user can
933
+
open a text file in one of the panes on the bottom of DrJava's main
934
+
frame and keep an eye on how it changes. DrJava checks every once in
935
+
a while (by default every 300 milliseconds) if the file has changed
936
+
and updates the display accordingly. The time between the updates
937
+
and how many lines are displayed (by default only the last 100) can
938
+
be controlled on the "Miscellaneous" pane of the "Preferences" frame
939
+
(see <link linkend="configuration">Configuring DrJava</link>).</para>
931
940
</section>
932
941
933
942
</chapter>
934
943
935
-
936
944
<!-- Chapter: Other Dialogs -->
937
945
<chapter id="other-dialogs">
938
946
<title>Other Dialogs</title>
939
947
<para>There are several other dialogs in DrJava that you may encounter.</para>
940
948
941
949
<section id="other-dialogs-new-version">
942
950
<title>Check for New Version</title>
943
-
<para>TODO</para>
951
+
<para>The DrJava development team works year-around to improve DrJava.
952
+
To make it easier for users to determine whether there is a newer
953
+
version available, DrJava now periodically polls the website for
954
+
the latest version (by default, this is done once a week). If
955
+
a new version is found, the user can press the "Download" button
956
+
to be taken directly to the web page with the latest version
957
+
of DrJava.</para>
958
+
<para>The "Check for New Version" dialog appears automatically
959
+
when DrJava is started and a new version is found, but the user can
960
+
perform a manual check by selecting "Check for New Version" in
961
+
the "Help" menu.</para>
944
962
945
963
<formalpara>
946
-
<title>Check for ...(type of new version)</title>
947
-
<para>TODO</para>
948
-
</formalpara>
964
+
<title>Check for (type of new version)</title>
965
+
<para>The DrJava developers release different kinds of versions:
966
+
Stable versions, which should not cause major problems; beta versions,
967
+
which are stable but not yet well tested; and development versions,
968
+
which contain new features or changes that may be problematic.</para>
969
+
</formalpara>
970
+
<para>By default, DrJava will only notify the user of new stable
971
+
or beta versions, but this setting can be changed by picking a
972
+
different "Check for" condition -- the user can check for stable versions
973
+
only, or be interested in all kinds of versions.</para>
949
974
</section>
950
975
951
976
952
977
<section id="other-dialogs-survey">
953
978
<title>Send System Information to DrJava Developers</title>
954
-
<para>TODO</para>
955
-
979
+
<para>It is tremendously helpful for the DrJava developers to
980
+
know what operating systems and versions of Java are being
981
+
used. To get a better overview, DrJava now includes a simple
982
+
and completely anonymous survey.</para>
983
+
<para>This survey transmits only the version number of DrJava
984
+
that is being used, the name and version of the operating
985
+
system, and the version and vendor of Java that is being
986
+
used. This information can in no way be traced back to
987
+
anyone's computer.</para>
988
+
<para>Every few months, DrJava will ask the user if these
989
+
pieces of information may be sent to the DrJava developers.</para>
990
+
<para>When DrJava notices that the user's system has changed
991
+
or that a new version of DrJava is being used, it may also
992
+
ask the user to participate in the survey. This usually
993
+
happens automatically when DrJava starts, but the user
994
+
can also elect to send information by using the "Send System
995
+
Information" item in the "Help" menu (multiple submissions
996
+
will be ignored).</para>
956
997
<formalpara>
957
998
<title>Never ask me again</title>
958
-
<para>TODO</para>
999
+
<para>If you do not want to be bothered again by this
1000
+
question, you can check the "Never ask me again" checkbox
1001
+
on the dialog, and DrJava will not ask you to participate
1002
+
in the survey anymore.</para>
959
1003
</formalpara>
1004
+
<para>Thank you for helping us make DrJava better!</para>
0 commit comments