Skip to content

Commit 01be6f1

Browse files
author
mgricken
committed
Documentation update.
git-svn-id: file:///tmp/test-svn/trunk@5260 fe72c1cf-3628-48e9-8b72-1c46755d3cff
1 parent db53a1a commit 01be6f1

File tree

3 files changed

+52
-1
lines changed

3 files changed

+52
-1
lines changed

‎docs/src/quickstart/quickstart.docbook‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -812,6 +812,16 @@ read -1, indicating of the end of the stream.</para>
812812
<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>
813813
</formalpara></listitem>
814814

815+
<listitem><formalpara>
816+
<title>Display Right Margin:</title>
817+
<para>Enable this option to let DrJava display a vertical line representing the right margin of the document.</para>
818+
</formalpara></listitem>
819+
820+
<listitem><formalpara>
821+
<title>Right Margin Position:</title>
822+
<para>This option controls the position of the right margin. By default, the right margin line is displayed after 120 columns, provided the "Display Right Margin" option above is enabled.</para>
823+
</formalpara></listitem>
824+
815825
</itemizedlist>
816826

817827
<mediaobject>
@@ -957,6 +967,11 @@ read -1, indicating of the end of the stream.</para>
957967
<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>
958968
</formalpara></listitem>
959969

970+
<listitem><formalpara>
971+
<title>Smart Run ('java') Command:</title>
972+
<para>If this option is enabled, DrJava will run applets and ACM Java Task Force Programs using the 'java' command or the "Run" and "Run Project" buttons as well. These applets and ACM Java Task Force Programs do not need to have a main method to be run, as long as they are proper applets or ACM Java Task Force Programs.</para>
973+
</formalpara></listitem>
974+
960975
<listitem><formalpara>
961976
<title>Enforce access control:</title>
962977
<para>This option controls the access control DrJava performs when class members are accessed. If the option is set to 'private and package only', then access control is used for all class members that are private or package private. If it is set to 'private only', then access control is used only for private members, and the other access levels can always be accessed. If it is set to 'disabled', all class members can be accessed, regardless of their access level. (Note: Currently, access control in DrJava's Interactions Pane has not been fully implemented; at most, access is checked for private and package private members; protected members can always be accessed.)</para>

‎docs/src/user/userdoc.docbook‎

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,11 @@ Developed by: Java Programming Languages Team
202202
<title>Clipboard History</title>
203203
<para>Any text you copy or cut out of DrJava documents will be placed in the clipboard history, and the last 10 entries are kept (that number is configurable, see <link linkend="configuration">Configuring DrJava</link>). To access one of the entries in the history, use the "Paste from History" command in the Edit menu or press <keycode>Ctrl+Shift+V</keycode>. In the dialog that opens up, you can browse the history and select the entry to paste. In addition to inserting the text at the cursor, the selected entry will also be moved to the top of the clipboard history, and will therefore subsequently be available with the regular paste command.</para></formalpara>
204204
<para>The clipboard history is a great tool to minimize scrolling and document switching: Instead of going back and forth several times, you can just "copy, copy, copy" several pieces of code in a row, then go to another place in the code and do "paste, paste from history, paste from history".</para>
205+
206+
<formalpara>
207+
<title>Right Margin</title>
208+
<para>DrJava can display a line after a specified number of columns, representing the right margin of the document. By default, this line is displayed after 120 columns. You can type past this line, and it has no effect on the saved files or executed programs, but the right margin line can help you format your source code more uniformly.</para></formalpara>
209+
<para>You can enable or disable the right margin line in the Display category of the Preferences window. The color of the line can be changed in the Colors category of the Preferences. (See <link linkend="configuration">Configuring DrJava</link>.)</para>
205210
</section>
206211

207212
<section id="edit-multiple">
@@ -427,6 +432,8 @@ Welcome to DrJava.
427432

428433
<para>DrJava also displays either a "Run Project" or a "Run" button in its toolbar, depending on whether you have specified a "Main Class" for the project or not, respectively. "Run Project" will run the main method of the project's "Main Class", while "Run" while execute the main method of the currently open document.</para>
429434

435+
<para>If "Smart Run ('java') Command" option is enabled, DrJava will also run applets and ACM Java Task Force programs using the <literal>java</literal> command and the "Run" or "Run Project" buttons (see <link linkend="configuration">Configuring DrJava</link>).</para>
436+
430437
<formalpara>
431438
<title>Running the Document as Applet</title>
432439
<para>For users who write Java applets, DrJava has a built-in applet viewer that supports calling the <filename>run()</filename> method of a class in the Interactions Pane by simply entering "applet" followed by the class name. Any arguments will be passed to the constructor as strings. For example, to create <filename>MyApplet(String a, String b)</filename> with arguments "arg1" and "arg2" and then call the object's <filename>run()</filename> method, type the following into the Interactions Pane:</para>
@@ -1438,6 +1445,21 @@ to.</para>
14381445
<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>
14391446
</listitem>
14401447
</varlistentry>
1448+
1449+
<varlistentry>
1450+
<term>Display Right Margin (<varname>display.right.margin = true</varname>)</term>
1451+
<listitem>
1452+
<para>Enable this option to let DrJava display a vertical line representing the right margin of the document.</para>
1453+
</listitem>
1454+
</varlistentry>
1455+
1456+
<varlistentry>
1457+
<term>Right Margin Position (<varname>right.margin.columns = 120</varname>)</term>
1458+
<listitem>
1459+
<para>This option controls the position of the right margin. By default, the right margin line is displayed after 120 columns, provided the "Display Right Margin" option above is enabled.</para>
1460+
</listitem>
1461+
</varlistentry>
1462+
14411463
</variablelist>
14421464

14431465
</section>
@@ -1480,7 +1502,7 @@ to.</para>
14801502

14811503
</section>
14821504

1483-
<!-- Fonts -->
1505+
<!-- Colors -->
14841506
<section id="config-options-color">
14851507
<title>Color Options</title>
14861508
<para>Colors are defined similarly to HTML colors: as six hexadecimal digits preceded by a pound sign. The first two digits specify a red value, the next two specify a green value, and the next two specify a blue value. For example, <constant>#00FF00</constant> would be a bright green. (In most cases, using the color chooser in the Preferences window is the simplest approach.)</para>
@@ -1641,6 +1663,13 @@ to.</para>
16411663
</listitem>
16421664
</varlistentry>
16431665

1666+
<varlistentry>
1667+
<term>Right Margin Color (<varname>right.margin.color = #CCCCCC</varname>)</term>
1668+
<listitem>
1669+
<para>Used as line color for the vertical line representing the right margin of the document, if the line is enabled.</para>
1670+
</listitem>
1671+
</varlistentry>
1672+
16441673
</variablelist>
16451674

16461675
</section>
@@ -1790,6 +1819,13 @@ to.</para>
17901819
</listitem>
17911820
</varlistentry>
17921821

1822+
<varlistentry>
1823+
<term>Smart Run ('java') Command (<varname>smart.run.for.applets.and.programs = true</varname>)</term>
1824+
<listitem>
1825+
<para>If this option is enabled, DrJava will run applets and ACM Java Task Force Programs using the 'java' command or the "Run" and "Run Project" buttons as well. These applets and ACM Java Task Force Programs do not need to have a main method to be run, as long as they are proper applets or ACM Java Task Force Programs.</para>
1826+
</listitem>
1827+
</varlistentry>
1828+
17931829
<varlistentry>
17941830
<term>Enforce access control (<varname>dynamicjava.access.control = disabled</varname>)</term>
17951831
<listitem>

‎drjava/lib/docs.jar‎

1.06 KB
Binary file not shown.

0 commit comments

Comments
 (0)