[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
Rejected Re: [cdt-patch] Updates to Reference section of User Docs
|
Dave,
Can
you send the images as a zip or tar file? The images in this
patch seem to be corrupted (at least when I apply that part of the
patch) -- the rest of the patch looks good.
-
Dave
Dave Williams/Ottawa/Contr/IBM@IBMCA
Sent by: cdt-patch-admin@xxxxxxxxxxx
04/08/2004 07:34 PM
Please respond to
cdt-patch |
|
To
| cdt-patch@xxxxxxxxxxx
|
cc
|
|
Subject
| [cdt-patch] Updates to Reference
section of User Docs |
|
Added in screen captures and updated material for C/C++ Editor, Content
Assist and Search dialog boxes.
Dave Williams
Technical Writer
Rational Software
IBM Software Group
(613) 591-2962
Index: cdt_o_ceditor_pref.htm
===================================================================
RCS file: /home/tools/org.eclipse.cdt.doc.user/reference/cdt_o_ceditor_pref.htm,v
retrieving revision 1.2
diff -u -r1.2 cdt_o_ceditor_pref.htm
--- cdt_o_ceditor_pref.htm 19 Dec 2003 20:47:28 -0000 1.2
+++ cdt_o_ceditor_pref.htm 8 Apr 2004 23:07:11 -0000
@@ -2,54 +2,49 @@
<html lang="en">
<head>
-<meta http-equiv="Content-Language" content="en-us">
-<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
-<meta name="ProgId" content="FrontPage.Editor.Document">
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>C/C++ editor, code templates and search preferences</title>
-<link rel="stylesheet" type="text/css" href="../help.css">
+ <meta http-equiv="Content-Language" content="en-us">
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <title>C/C++ editor, code templates and search preferences</title>
+ <link rel="stylesheet" type="text/css" href="../help.css">
</head>
<body>
-<h1>C/C++ editor, code templates and search preferences</h1>
+<h1>C/C++ editor, code template, and search preferences</h1>
-<p>This section describes the preferences pages for the C/C++ editor, code
-templates and search features.</p>
+<p>This section describes how to set preferences for the C/C++ editor, code
+templates, and the search feature.</p>
<table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="508">
<tr>
- <th align="left" valign="bottom" width="244">To learn about</th>
+ <th align="left" valign="bottom" width="244">To change preferences for</th>
<th align="left" width="241">See</th>
</tr>
<tr>
- <td align="left" width="244">General C/C++ editor preferences</td>
- <td align="left" width="241"><a href="cdt_u_c_editor_gen.htm">General page,
- Preferences window</a></td>
+ <td align="left" width="244">C/C++ editor</td>
+ <td align="left" width="241"><a href="cdt_u_c_editor_gen.htm">General page, Preferences window</a></td>
</tr>
<tr>
- <td align="left" width="244">C/C++ editor annotations preferences</td>
- <td align="left" width="241"><a href="cdt_u_c_editor_anno.htm">Annotations
- page, Preferences window</a></td>
+ <td align="left" width="244">C/C++ editor annotations</td>
+ <td align="left" width="241"><a href="cdt_u_c_editor_anno.htm">Annotations page, Preferences window</a></td>
</tr>
<tr>
- <td align="left" width="244">C/C++ editor text color preferences</td>
+ <td align="left" width="244">C/C++ editor text color</td>
<td align="left" width="241"><a href="cdt_u_c_editor_color.htm">Colors page,
Preferences window</a></td>
</tr>
<tr>
- <td align="left" width="244">C/C++ editor preference Content Assist
- preferences</td>
+ <td align="left" width="244">C/C++ editor Content Assist Feature</td>
<td align="left" width="241"><a href="cdt_u_c_editor_con_assist.htm">Content
Assist page, Preferences window</a></td>
</tr>
<tr>
- <td align="left" width="244">C/C++ editor Code Templates preferences</td>
+ <td align="left" width="244">C/C++ editor code template</td>
<td align="left" width="241"><a href="cdt_u_code_temp.htm">Code Templates
page, Preferences window</a></td>
</tr>
<tr>
- <td align="left" width="244">C/C++ editor Search preferences</td>
+ <td align="left" width="244">C/C++ editor search feature</td>
<td align="left" width="241"><a href="cdt_u_search.htm">C/C++ search page,
Search dialog box</a></td>
</tr>
Index: cdt_u_c_editor_anno.htm
===================================================================
RCS file: /home/tools/org.eclipse.cdt.doc.user/reference/cdt_u_c_editor_anno.htm,v
retrieving revision 1.2
diff -u -r1.2 cdt_u_c_editor_anno.htm
--- cdt_u_c_editor_anno.htm 19 Dec 2003 20:47:28 -0000 1.2
+++ cdt_u_c_editor_anno.htm 8 Apr 2004 23:07:11 -0000
@@ -2,12 +2,10 @@
<html lang="en">
<head>
-<meta http-equiv="Content-Language" content="en-us">
-<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
-<meta name="ProgId" content="FrontPage.Editor.Document">
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>Annotations page, Preferences window</title>
-<link rel="stylesheet" type="text/css" href="../help.css">
+ <meta http-equiv="Content-Language" content="en-us">
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <title>Annotations page, Preferences window</title>
+ <link rel="stylesheet" type="text/css" href="../help.css">
</head>
<!--INFOPOP
Customize the appearance of the C/C++ Editor.
@@ -16,19 +14,18 @@
<h1>Annotations page, Preferences window</h1>
-<p>The Annotations page of the Preferences window lets you customize the
-appearance of annotations in the C/C++ editor.</p>
+<p>You can customize the appearance of annotations in the C/C++ editor on the Annotations page of the Preferences Window.</p>
+<p><img src="../images/editor_annotations_preferences.png" border="0" width="670" height="607" alt="Editor Annotations Preferences Dialog Box"></p>
<dl>
<dt>Annotation Presentation Options</dt>
- <dd>Lists items that can be displayed in a specified color.</dd>
+ <dd>Lists items, such as breakpoints, bookmarks, or index markers, for which you can specify a color.</dd>
<dt>Show in Text</dt>
- <dd>Displays the selected annotation type in the text. The
- corresponding text is underlined.</dd>
+ <dd>Displays in the text the selected type of annotation. The corresponding text is underlined.</dd>
<dt>Show in Overview Ruler</dt>
<dd>Displays the selected annotation type in the overview ruler.</dd>
<dt>Annotations Color</dt>
- <dd>Specifies the color in which to display an annotation.</dd>
+ <dd>Specifies the color in which to display the selected item.</dd>
</dl>
<p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21"> <br>
Index: cdt_u_c_editor_color.htm
===================================================================
RCS file: /home/tools/org.eclipse.cdt.doc.user/reference/cdt_u_c_editor_color.htm,v
retrieving revision 1.2
diff -u -r1.2 cdt_u_c_editor_color.htm
--- cdt_u_c_editor_color.htm 19 Dec 2003 20:47:28 -0000 1.2
+++ cdt_u_c_editor_color.htm 8 Apr 2004 23:07:11 -0000
@@ -2,12 +2,10 @@
<html lang="en">
<head>
-<meta http-equiv="Content-Language" content="en-us">
-<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
-<meta name="ProgId" content="FrontPage.Editor.Document">
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>Colors page, Preferences window</title>
-<link rel="stylesheet" type="text/css" href="../help.css">
+ <meta http-equiv="Content-Language" content="en-us">
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <title>Colors page, Preferences window</title>
+ <link rel="stylesheet" type="text/css" href="../help.css">
</head>
<!--INFOPOP
@@ -17,19 +15,20 @@
<h1>Colors page, Preferences window</h1>
-<p>The Colors page of the Preferences window lets you customize the appearance of the C/C++ editor.</p>
+<p>You can customize the appearance of the C/C++ editor on the Colors page of the Preferences window.</p>
+<p><img src="../images/editor_color_preferences.png" border="0" width="670" height="607" alt="Editor Color Preferences Dialog Box"></p>
<dl>
<dt>System Default</dt>
- <dd>Uses the system default background color.</dd>
+ <dd>Uses the system default for the background color.</dd>
<dt>Custom</dt>
<dd>Changes the background color.</dd>
<dt>Foreground</dt>
- <dd>Lists items that can be displayed in a specified color.</dd>
+ <dd>Lists items, such as comments, keywords, and strings, for which you can specify a color.</dd>
<dt>Color</dt>
<dd>Specifies the color in which to display the selected item.</dd>
<dt>Bold</dt>
- <dd>Bolds the selected item.</dd>
+ <dd>Makes the selected item bold.</dd>
</dl>
<p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21"> <br>
Index: cdt_u_c_editor_con_assist.htm
===================================================================
RCS file: /home/tools/org.eclipse.cdt.doc.user/reference/cdt_u_c_editor_con_assist.htm,v
retrieving revision 1.2
diff -u -r1.2 cdt_u_c_editor_con_assist.htm
--- cdt_u_c_editor_con_assist.htm 19 Dec 2003 20:47:28 -0000 1.2
+++ cdt_u_c_editor_con_assist.htm 8 Apr 2004 23:07:11 -0000
@@ -2,12 +2,10 @@
<html lang="en">
<head>
-<meta http-equiv="Content-Language" content="en-us">
-<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
-<meta name="ProgId" content="FrontPage.Editor.Document">
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>Content Assist page, Preferences window</title>
-<link rel="stylesheet" type="text/css" href="../help.css">
+ <meta http-equiv="Content-Language" content="en-us">
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <title>Content Assist page, Preferences window</title>
+ <link rel="stylesheet" type="text/css" href="../help.css">
</head>
<!--INFOPOP
Customize how the Content Assist feature works.
@@ -16,24 +14,38 @@
<h1>Content Assist page, Preferences window</h1>
-<p>The Contents Assist page of the Preferences window, lets you customize how the Content Assist feature works.</p>
+<p>You can customize the Content Assist feature on the Contents Assist page of the C/C++ Editor Preferences window. To change the Content Assist preferences click
+<b>Window > Preferences > C/C++ > C++ Editor > Content Assist.</b></p>
+<p>
+<img src="../images/contentAssist_preferences.png" border="0" width="667" height="525" alt="Content Assist Preferences Dialog Box">
+</p>
+
<dl>
- <dt>Insert single proposals automatically</dt>
- <dd>Inserts an element into your code when it is the only item in the Content Assist
- list.</dd>
- <dt>Enable auto activation</dt>
- <dd>Opens Content Assist when you type the first letter
- of an element in the C/C++ editor for which there is a code template or an
- element that begins with the same letter.</dd>
- <dt>Auto activation delay</dt>
- <dd>Specifies the number of seconds before Content Assist is
- activated.</dd>
- <dt>Auto activation triggers for C:</dt>
- <dd>Specifies a character that, if typed in the C/C++ editor, causes code assist to
- be invoked immediately before the delay times out.</dd>
- <dt>Background for completion proposals</dt>
- <dd>Specifies the background color for the Content Assist dialog box.</dd>
+ <p><dt>Search scope for completion proposals</dt>
+ <dd>You can configure the Content Assist feature to select proposals from items contained only in the current file and included files, or from the current project.</dd>
+
+ <p><dt>Insert single proposals automatically</dt>
+ <dd>Inserts an element into your code when the Content Assist feature finds only one proposal.</dd>
+
+ <p><dt>Present proposals in alphabetical order</dt>
+ <dd>Proposals, by default, appear in order of relevance determined by context, scope and prefix. Alternatively, you can configure the Content Assist feature to order its proposals alphabetically.</dd>
+
+ <p><dt>Content Assist parsing timeout (in milliseconds)
+ <dd>For very large projects, the Content Assist feature might slow the response of the plugin as the Content Assist feature searches the project for proposals. This setting stops the Content Assist search when it reaches the specified threshold.<dd>
+
+ <p><dt>Auto activation</dt>
+ <dd>Certain predefined triggers force the Content Assist feature to activate. You can disable the predefined triggers with these checkboxes.
+
+ <p><dt>Auto activation delay</dt>
+ <dd>Specifies the number of milliseconds before Content Assist is activated.</dd>
+
+ <p><dt>Background for completion proposals</dt>
+ <dd>Specifies the background color of the Content Assist dialog box.</dd>
+
+ <p><dt>Foreground for completion proposals</dt>
+ <dd>Specifies the foreground color of the Content Assist dialog box.</dd>
+
</dl>
<p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21"> <br>
Index: cdt_u_c_editor_gen.htm
===================================================================
RCS file: /home/tools/org.eclipse.cdt.doc.user/reference/cdt_u_c_editor_gen.htm,v
retrieving revision 1.2
diff -u -r1.2 cdt_u_c_editor_gen.htm
--- cdt_u_c_editor_gen.htm 19 Dec 2003 20:47:28 -0000 1.2
+++ cdt_u_c_editor_gen.htm 8 Apr 2004 23:07:11 -0000
@@ -2,12 +2,10 @@
<html lang="en">
<head>
-<meta http-equiv="Content-Language" content="en-us">
-<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
-<meta name="ProgId" content="FrontPage.Editor.Document">
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>General page, Preferences window</title>
-<link rel="stylesheet" type="text/css" href="../help.css">
+ <meta http-equiv="Content-Language" content="en-us">
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <title>General page, Preferences window</title>
+ <link rel="stylesheet" type="text/css" href="../help.css">
</head>
<!--INFOPOP
@@ -17,18 +15,21 @@
<h1>General page, Preferences window</h1>
-<p>The General page of the Preferences window lets you customize the appearance of the C/C++ editor.</p>
-
+<p>You can customize the appearance of the C/C++ editor on the General page of the Preferences window.</p>
+ <p><img src="../images/editor_general_preferences.png" border="0" width="670" height="607" alt="Editor General Preferences Dialog Box"></p>
<dl>
+ <dt>Text Font</dt>
+ <dd>Changes the font of the text in the workbench.</dd>
<dt>Displayed tab width</dt>
- <dd>Specifies the tab width as a number of characters. For example <b>4</b>,
- means the tab width will be 4 characters wide.</dd>
+ <dd>Specifies the width of the tab as a number of characters. For example a value of <b>4</b>,
+ means that the tab width is 4-characters wide.</dd>
<dt>Print margin column</dt>
- <dd>Specifies the print margin width as a number of characters.</dd>
+ <dd>Specifies the width of the print margin as a number of characters. For example a value of
+ <b>80</b> means that the print area is 80-characters wide.</dd>
<dt>Insert space for tabs</dt>
- <dd>Inserts spaces instead of a tab character when your press <b>Tab</b>.</dd>
+ <dd>Inserts a space instead of a tab character when you press <tt>Tab</tt>.</dd>
<dt>Highlight matching brackets</dt>
- <dd>Highlights matching brackets.</dd>
+ <dd>When the cursor is beside a bracket, the matching bracket is highlighted.</dd>
<dt>Show line numbers</dt>
<dd>Displays line numbers in the left margin.</dd>
<dt>Highlight current line</dt>
@@ -36,11 +37,11 @@
<dt>Show overview ruler</dt>
<dd>Displays the overview ruler on the right margin.</dd>
<dt>Show print margin</dt>
- <dd>Displays the print margin.</dd>
+ <dd>Displays the print margin in the editor.</dd>
<dt>Appearance color options</dt>
- <dd>Lists items that can be displayed in a specified color.</dd>
+ <dd>Lists the items for which you can specify a color.</dd>
<dt>Color</dt>
- <dd>Changes the color of the item selected in the list.</dd>
+ <dd>Changes the color of the item that is selected in the list.</dd>
</dl>
<p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21"> <br>
Index: cdt_u_code_temp.htm
===================================================================
RCS file: /home/tools/org.eclipse.cdt.doc.user/reference/cdt_u_code_temp.htm,v
retrieving revision 1.2
diff -u -r1.2 cdt_u_code_temp.htm
--- cdt_u_code_temp.htm 19 Dec 2003 20:47:28 -0000 1.2
+++ cdt_u_code_temp.htm 8 Apr 2004 23:07:11 -0000
@@ -2,12 +2,10 @@
<html lang="en">
<head>
-<meta http-equiv="Content-Language" content="en-us">
-<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
-<meta name="ProgId" content="FrontPage.Editor.Document">
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>Code Templates page, Preferences window</title>
-<link rel="stylesheet" type="text/css" href="../help.css">
+ <meta http-equiv="Content-Language" content="en-us">
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <title>Code Templates page, Preferences window</title>
+ <link rel="stylesheet" type="text/css" href="../help.css">
</head>
<!--INFOPOP
Create, edit, remove, import, or export code templates.
@@ -17,14 +15,16 @@
<h1>Code Templates page, Preferences window</h1>
-<p>The Code Templates page of the Preferences window lets you create, edit
-import and export code templates.</p>
+<p>You can manipulate any of the common code templates that are predefined within the CDT. To modify, delete, export,
+import, or create your own templates click <b>Window > Preferences > C/C++ > Code Templates</b>.</p>
+
+<img src="../images/code_templates.png" border="0" width="737" height="539" alt="Code Templates Dialog Box">
<dl>
<dt>New</dt>
<dd>Creates a new code template.</dd>
<dt>Edit</dt>
- <dd>Edits the code template selected in the list.</dd>
+ <dd>Edits the code template that is selected in the list.</dd>
<dt>Remove</dt>
<dd>Removes the selected code templates from the list.</dd>
<dt>Import</dt>
@@ -34,11 +34,9 @@
<dt>Export All</dt>
<dd>Exports all templates in the list.</dd>
<dt>Enable All</dt>
- <dd>Makes all templates available when the Content Assist feature is
- invoked.</dd>
+ <dd>Makes all templates available when you invoke the Content Assist feature.</dd>
<dt>Disable All</dt>
- <dd>Makes all templates unavailable when the Content Assist feature is
- invoked. </dd>
+ <dd>Makes all templates unavailable when you invoke the Content Assist feature. </dd>
</dl>
<p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21"> <br>
Index: cdt_u_search.htm
===================================================================
RCS file: /home/tools/org.eclipse.cdt.doc.user/reference/cdt_u_search.htm,v
retrieving revision 1.2
diff -u -r1.2 cdt_u_search.htm
--- cdt_u_search.htm 19 Dec 2003 20:47:28 -0000 1.2
+++ cdt_u_search.htm 8 Apr 2004 23:07:11 -0000
@@ -2,12 +2,10 @@
<html lang="en">
<head>
-<meta http-equiv="Content-Language" content="en-us">
-<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
-<meta name="ProgId" content="FrontPage.Editor.Document">
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>C/C++ search page, Search dialog box</title>
-<link rel="stylesheet" type="text/css" href="../help.css">
+ <meta http-equiv="Content-Language" content="en-us">
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <title>C/C++ search page, Search dialog box</title>
+ <link rel="stylesheet" type="text/css" href="../help.css">
</head>
<!--INFOPOP
Search for C/C++ elements.
@@ -16,9 +14,8 @@
<h1>C/C++ search page, Search dialog box</h1>
-<p>The C/C++ search page of the Search dialog box lets you search for C/C++
-elements.</p>
-
+<p>You can search for C/C++ elements on the C/C++ search page of the Search dialog box.</p>
+<p><img src="../images/search.png" border="0" width="512" height="394" alt="Search Dialog Box"></p>
<dl>
<dt>Search string</dt>
<dd>Specifies a search string.</dd>
@@ -29,7 +26,7 @@
(functions that are not members of a class, struct, or union).</dd>
<dt>Variable</dt>
<dd>Searches for variables that are not members of a class,
- struct or union.</dd>
+ struct, or union.</dd>
<dt>Union</dt>
<dd>Searches for unions.</dd>
<dt>Method</dt>
@@ -48,14 +45,14 @@
<dd>Limits the search to declarations.</dd>
<dt>Definitions</dt>
<dd>Limits the search to definitions (for functions, methods,
- variables and fields).</dd>
+ variables, and fields).</dd>
<dt>References</dt>
<dd>Limits the search to references.</dd>
<dt>All Occurrences</dt>
<dd>Includes declarations, definitions, and references in the
search.</dd>
<dt>Workspace</dt>
- <dd>Searches the eclipse workspace.</dd>
+ <dd>Searches the Eclipse workspace.</dd>
<dt>Selected Resources</dt>
<dd>Includes selected resources in the search.</dd>
<dt>Working Set</dt>
Index: images/Idea.jpg
===================================================================
RCS file: images/Idea.jpg
diff -N images/Idea.jpg
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ images/Idea.jpg 1 Jan 1970 00:00:00 -0000
@@ -0,0 +1,94 @@
+ÿØÿà JFIF XX ÿÛ C
+
+
+
+
+
+
+
+
+ÿÛ C
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ÿÂ V x"