Bug #229327 : CDT help pages for Property Tabs are not accessible

author: Oleg Krasilnikov 2008-05-14 16:11:11 +0000
committer: Oleg Krasilnikov 2008-05-14 16:11:11 +0000
commit: 8981d60e3351b1713cfdb6954c2e8a3b21a68374 (patch)
tree: 6392b323b1a9d59cb6850dcd636c6bb462992a41 /doc
parent: 0864dbf857eb4661655aab231ed6a7cdd4de348f (diff)
download: org.eclipse.cdt-8981d60e3351b1713cfdb6954c2e8a3b21a68374.tar.gz
org.eclipse.cdt-8981d60e3351b1713cfdb6954c2e8a3b21a68374.tar.xz
org.eclipse.cdt-8981d60e3351b1713cfdb6954c2e8a3b21a68374.zip
10 files changed, 298 insertions, 5 deletions
diff --git a/doc/org.eclipse.cdt.doc.user/contexts_CDT.xml b/doc/org.eclipse.cdt.doc.user/contexts_CDT.xml
index b9aee2cc2ae..8e673b2ab33 100644
--- a/doc/org.eclipse.cdt.doc.user/contexts_CDT.xml
+++ b/doc/org.eclipse.cdt.doc.user/contexts_CDT.xml
@@ -476,4 +476,25 @@
    label="Language Mappings"/> 
 </context>                   
 
+<context id="cdt_u_pref_multi_cfg">
+   <description></description>
+   <topic href="reference/cdt_u_pref_multi_cfg.htm"    	
+   label="Multi Configuration Edit tab"/> 
+</context>                   
+<context id="cdt_u_pref_prop_pages">
+   <description></description>
+   <topic href="reference/cdt_u_pref_prop_pages.htm"    	
+   label="Property Pages Settins tab"/> 
+</context>                   
+<context id="cdt_u_pref_wizard_defaults">
+   <description></description>
+   <topic href="reference/cdt_u_pref_wizard_defaults.htm"    	
+   label="CDT New Project Wizard Defaults tab"/> 
+</context>                   
+<context id="cdt_u_pref_wizard_toolchains">
+   <description></description>
+   <topic href="reference/cdt_u_pref_wizard_toolchains.htm"    	
+   label="Preferred Toolchains tab"/> 
+</context>                   
+
 </contexts>
diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_pref-multi-cfg.png b/doc/org.eclipse.cdt.doc.user/images/cdt_pref-multi-cfg.png
new file mode 100644
index 00000000000..bc593fe53a6
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/images/cdt_pref-multi-cfg.png
diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_pref-prop-pages.png b/doc/org.eclipse.cdt.doc.user/images/cdt_pref-prop-pages.png
new file mode 100644
index 00000000000..167a0ab303b
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/images/cdt_pref-prop-pages.png
diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_pref-wizard-defaults.png b/doc/org.eclipse.cdt.doc.user/images/cdt_pref-wizard-defaults.png
new file mode 100644
index 00000000000..dfbbd0516e9
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/images/cdt_pref-wizard-defaults.png
diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_pref-wizard-toolchains.png b/doc/org.eclipse.cdt.doc.user/images/cdt_pref-wizard-toolchains.png
new file mode 100644
index 00000000000..f8d4aa698f5
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/images/cdt_pref-wizard-toolchains.png
diff --git a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_pref_multi_cfg.htm b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_pref_multi_cfg.htm
new file mode 100644
index 00000000000..5d401446383
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_pref_multi_cfg.htm
@@ -0,0 +1,61 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html lang="en">
+
+<head>
+	<meta http-equiv="Content-Language" content="en-us">
+	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+	<title>Multi-Configuration Edit preferences</title>
+	<link rel="stylesheet" type="text/css" href="../help.css">
+</head>
+<body>
+
+<h1>Multi-Configuration Edit preferences</h1>
+
+<p>Since CDT 5.0, user is able to edit properties for 
+multiple project configurations simultaneously.</p>
+<p>Either all configuations or some of them can be selected.</p>
+<p>But, then we deal with string list property values, 
+it is not obvious how to concatenate them, if they differ.</p>
+
+
+<p><img src="../images/cdt_pref-multi-cfg.png" alt="Multi-Configuration Edit preferences tab"></p>
+<dl>
+  <dt>String list Display Mode</dt>
+  <dd>Specifies how values will be shown.<br>
+  There are 2 options: conjunction or disjunction.
+  <ul>
+  <li><b>Conjunction</b> shows common elements only, so if 1st configuration has 
+  value &lt;A, B, C&gt; and 2nd configuration has &lt;B, C, D&gt;, &lt;B, C&gt; will be shown. 
+  <li><b>Disjunction</b> shows all existing elements except doubles, so if 1st configuration has 
+  value &lt;A, B, C&gt; and 2nd configuration has &lt;B, C, D&gt;, &lt;A, B, C, D&gt; will be shown. 
+  </ul>
+  Note that Display mode can be changed directly on each tab which deals with string lists.
+  Result is immediate: data on the tab refereshed according to selected mode.<br>
+  </dd>
+  <dt>String list Write Mode</dt>
+  <dd>Specifies how values will be saved.<br>
+  There are 2 options: modify or replace.
+  <ul>
+  <li><b>Modify mode</b> adds, changes or removes elements affected by user's actions.
+  Elements which were not touched by user are left unchanged.<br>   
+  Example: cfg1 has &lt;A, B, C&gt;; cfg2 has &lt;B, C, D&gt;.<br>
+  User removed B and added F.<br>
+  Result: cfg1 has &lt;A, C, F&gt;; cfg2 has &lt;C, D, F&gt;.
+  <li><b>Replace mode</b> puts currently visible elements to all configurations.
+  Old contents will be lost.<br>
+  Example: cfg1 has &lt;A, B, C&gt;; cfg2 has &lt;B, C, D&gt;.<br>
+  Visible list depends of Display mode: &lt;B, C&gt; or &lt;A, B, C, D&gt;.<br>
+  User removed B and added F.<br>
+  Result: both cfgs will contain either &lt;C, F&gt; or &lt;A, C, D, F&gt; depending of Display mode.
+  </ul>
+  Note that Write mode can be changed directly on each tab which deals with string lists.<br>
+  </dd>
+  <dt>Restore Defaults</dt>
+  <dd>Sets all parameters to default values</dd>
+  <dt>Apply</dt>
+  <dd>Saves current settings.</dd>
+</dl>
+
+</body>
+
+</html>
diff --git a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_pref_prop_pages.htm b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_pref_prop_pages.htm
new file mode 100644
index 00000000000..350968b9e15
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_pref_prop_pages.htm
@@ -0,0 +1,52 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html lang="en">
+
+<head>
+	<meta http-equiv="Content-Language" content="en-us">
+	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+	<title>Property Pages Settings preferences</title>
+	<link rel="stylesheet" type="text/css" href="../help.css">
+</head>
+<body>
+
+<h1>Property Pages Settings preferences</h1>
+
+<p>These settings affect behaviour of CDT property pages.</p>
+<p><img src="../images/cdt_pref-prop-pages.png" alt="Property Pages Settings preferences tab"></p>
+<dl>
+  <dt>Show 'Manage Configurations...' button</dt>
+  <dd>Shows or hides corresponding button, normally placed on every property page.<br>
+      If this button is hidden, Manage operation can be accessed from Main Menu or Context Menu.</dd>
+  <dt>Display 'Data hierarchy' tab</dt>
+  <dd>Displays auxilliary tab which allows browsing data of project configurations.
+      This feature is useful for debug purposes mostly, so it's disabled by default.</dd>
+  <dt>Display 'Tool Chain Editor' tab</dt>
+  <dd>Shows or hides corresponding tab. Normally, users need not to edit tool chains manually.</dd>
+  <dt>Save property dialog bounds</dt>
+  <dd>Defines how property dialog parameters will be preserved: 
+  <ul>
+    <li>Save dialog size only (position is set by system).
+    <li>Save dialog and position (next time, dialog will be shown on the same place with the same size).
+    <li>Do not save at all (size and position is set by system each time when dialog is shown).
+  </ul>
+  </dd>
+  <dt>Discovery profiles naming rule</dt>
+  <dd>Discovery profiles have unique IDs, but their names may be duplicate, 
+      expecially if they are contributed by different developers. So there 
+      are 4 way to distinguish them in the list on Discovery tab:
+  <ul>
+    <li>Show names if they are unique. Else show Name + ID.
+    <li>Show names if they are unique. Else show IDs only.
+    <li>Always show Name + ID.
+    <li>Always show IDs only.
+  </ul>
+  </dd>
+  <dt>Restore Defaults</dt>
+  <dd>Sets all parameters to default values</dd>
+  <dt>Apply</dt>
+  <dd>Saves current settings.</dd>
+</dl>
+
+</body>
+
+</html>
diff --git a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_pref_wizard_defaults.htm b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_pref_wizard_defaults.htm
new file mode 100644
index 00000000000..2908639e3da
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_pref_wizard_defaults.htm
@@ -0,0 +1,34 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html lang="en">
+
+<head>
+	<meta http-equiv="Content-Language" content="en-us">
+	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+	<title>CDT Project Wizard Defaults preferences</title>
+	<link rel="stylesheet" type="text/css" href="../help.css">
+</head>
+<body>
+
+<h1>CDT Project Wizard Defaults preferences</h1>
+
+<p>These settings affect CDT New Project Wizard behaviour.<p>
+<p><img src="../images/cdt_pref-wizard-defaults.png" alt="CDT Project Wizard Defaults preferences tab"></p>
+<dl>
+  <dt>Show only supported toolchains, by default</dt>
+  <dd>Allows to filter out toolchains which are not supported by system.<br>
+      If disabled, all toolchains known to CDT are shown.<br>
+      Note that this mode can be switched directly in Project Wizard dialog.
+  </dd>
+  <dt>Group old-style toolchains to &lt;Others&gt; folder</dt>
+  <dd>Old-style toolchains do not distinguish project types (executable, shared library or static library).<br>
+      So they can be either placed to list's root, or grouped in &lt;Others&gt; folder on the left pane of Wizard.
+  </dd>
+  <dt>Restore Defaults</dt>
+  <dd>Sets all parameters to default values</dd>
+  <dt>Apply</dt>
+  <dd>Saves current settings.</dd>
+</dl>
+
+</body>
+
+</html>
diff --git a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_pref_wizard_toolchains.htm b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_pref_wizard_toolchains.htm
new file mode 100644
index 00000000000..db8130676f6
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_pref_wizard_toolchains.htm
@@ -0,0 +1,40 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html lang="en">
+
+<head>
+	<meta http-equiv="Content-Language" content="en-us">
+	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+	<title>CDT Project Wizard Toolchains preferences</title>
+	<link rel="stylesheet" type="text/css" href="../help.css">
+</head>
+<body>
+
+<h1>CDT Project Wizard Toolchains preferences</h1>
+
+<p>These settings define which toolchains are selected in CDT New Project Wizard by default.<p>
+<p><img src="../images/cdt_pref-wizard-toolchains.png" alt="CDT Project Wizard Toolchains preferences tab"></p>
+<dl>
+  <dt>Project types:</dt>
+  <dd>The same project types list as shown in Project Wizard.</dd>
+  <dt>Toolchain:</dt>
+  <dd>The same list of toolchains as shown in Project Wizard.</dd>
+  <dt>Make toolchain(s) preferred</dt>
+  <dd>Makes selected toolchain(s) preferred.<br>
+     In this tab, preferred toolchains are marked by arrow icon ("&gt;").<br>
+     In Project Wizard dialog, preferred toolchain is selected by default.<br>
+     If there are more than one toolchain preferred, the first of them will be selected.<br>
+     If there are no toolchains preferred, the first in the whole list will be selected.
+  </dd>
+  <dt>Make toolchain(s) not preferred</dt>
+  <dd>Removes preference mark from selected toolchain(s).</dd>
+  <dt>Show project types and toolchains only if they are supported on the platform</dt>
+  <dd>The same control as on Project Wizard page. Defines whether unsupported project types and toolchains are hidden or shown.</dd>
+  <dt>Restore Defaults</dt>
+  <dd>Sets all parameters to default values</dd>
+  <dt>Apply</dt>
+  <dd>Saves current settings.</dd>
+</dl>
+
+</body>
+
+</html>
diff --git a/doc/org.eclipse.cdt.doc.user/topics_Reference.xml b/doc/org.eclipse.cdt.doc.user/topics_Reference.xml
index cd70ed7d01e..7bbe1f14f10 100644
--- a/doc/org.eclipse.cdt.doc.user/topics_Reference.xml
+++ b/doc/org.eclipse.cdt.doc.user/topics_Reference.xml
@@ -86,7 +86,9 @@
 			<topic label="Settings" href="reference/cdt_u_make_settings_pref.htm"/>			
 		</topic>
 		
-		<topic label="New CDT project wizard" href="reference/cdt_o_proj_prop_pages.htm">
+		<topic label="New CDT project wizard">
+                        <topic label="Preferred Toolchains tab" href="reference/cdt_u_pref_wizard_toolchains.htm"/> 
+                        <topic label="Wizard Defaults tab" href="reference/cdt_u_pref_wizard_defaults.htm"/> 
 			<topic label="Makefile Project pages" >
 				<topic label="Binary parsers" href="reference/cdt_u_newproj_parser_binary.htm"/>
 				<topic label="Error parsers" href="reference/cdt_u_newproj_parser_error.htm"/>
@@ -95,16 +97,99 @@
 				<topic label="Behaviour" href="reference/cdt_u_newproj_behavior.htm"/>
 			</topic>
 		</topic>
-
+		<topic label="Property Pages Settings" href="reference/cdt_u_pref_prop_pages.htm">
+			<topic label="Multiple Configurations Edit" href="reference/cdt_u_pref_multi_cfg.htm"/>
+	        </topic>
 	</topic>
 	
 	<!-- PROJECT PROPERTIES TOPICS -->
 	<topic label="C/C++ Properties" href="reference/cdt_u_properties.htm">
-		<topic label="C/C++ Project properties" href="reference/cdt_o_prop_proj.htm"/>
-		<topic label="C/C++ Folder properies" href="reference/cdt_o_prop_folder.htm"/>
-		<topic label="C/C++ File Properties" href="reference/cdt_o_prop_file.htm"/>
+		<topic label="C/C++ Project properties" href="reference/cdt_o_prop_proj.htm">
+			<topic label="Resource page" href="reference/cdt_u_prop_resource.htm"/>
+			<topic label="Builders page" href="reference/cdt_u_prop_builders.htm"/>
+			<topic label="Common C/C++ Configurations handling">
+				<topic label="Manage Configurations dialog" href="reference/cdt_u_prop_manage_dialog.htm"/>
+				<topic label="Create Configuration dialog" href="reference/cdt_u_prop_manage_newdialog.htm"/>
+				<topic label="Rename Configuration dialog" href="reference/cdt_u_prop_manage_rendialog.htm"/>
+                        </topic>  
+			<topic label="C/C++ Build">
+				<topic label="Build Variables page  " href="reference/cdt_u_prop_build_variables.htm"/>
+				<topic label="Discovery options page" href="reference/cdt_u_prop_build_discovery.htm"/>
+				<topic label="Environment page"       href="reference/cdt_u_prop_build_environment.htm"/>
+				<topic label="Settings page">
+					<topic label="Tool Settings tab " href="reference/cdt_u_prop_build_settings_tool.htm"/>
+					<topic label="Build Steps tab   " href="reference/cdt_u_prop_build_settings_steps.htm"/>
+					<topic label="Build Artifact tab" href="reference/cdt_u_prop_build_settings_artifact.htm"/>
+					<topic label="Binary Parsers tab" href="reference/cdt_u_prop_build_settings_binparser.htm"/>
+					<topic label="Error Parsers tab " href="reference/cdt_u_prop_build_settings_errparser.htm"/>
+				</topic>  
+				<topic label="Tool chain editor page" href="reference/cdt_u_prop_build_toolchain.htm"/>
+                        </topic>  
+			<topic label="C/C++ General" href="reference/cdt_u_prop_general.htm">
+				<topic label="Documentation page  " href="reference/cdt_u_prop_general_doc.htm"/>
+				<topic label="Export Settings page" href="reference/cdt_u_prop_general_exp.htm"/>
+				<topic label="File Types page      " href="reference/cdt_u_prop_general_typ.htm"/>
+				<topic label="Indexer page         " href="reference/cdt_u_prop_general_idx.htm"/>
+				<topic label="Language Mapping page" href="reference/cdt_u_prop_general_lng.htm"/>
+				<topic label="Paths and Symbols page">
+					<topic label="Includes tab       " href="reference/cdt_u_prop_general_pns_inc.htm"/>
+					<topic label="Symbols tab        " href="reference/cdt_u_prop_general_pns_sym.htm"/>
+					<topic label="Libraries tab      " href="reference/cdt_u_prop_general_pns_lib.htm"/>
+					<topic label="Libraries path tab " href="reference/cdt_u_prop_general_pns_libpath.htm"/>
+					<topic label="Source Location tab" href="reference/cdt_u_prop_general_pns_src.htm"/>
+					<topic label="Output Location tab" href="reference/cdt_u_prop_general_pns_out.htm"/>
+					<topic label="References tab     " href="reference/cdt_u_prop_general_pns_ref.htm"/>
+					<topic label="Data Hierarchy tab " href="reference/cdt_u_prop_general_pns_hier.htm"/>
+                                </topic> 
+                        </topic>  
+			<topic label="Project References page" href="reference/cdt_u_prop_ref.htm"/>
+			<topic label="Run/Debug Settings page" href="reference/cdt_u_prop_rundebug.htm"/>
+                </topic>
+
+		<topic label="C/C++ Folder properies" href="reference/cdt_o_prop_folder.htm">
+			<topic label="Resource page" href="reference/cdt_u_fprop_resource.htm"/>
+			<topic label="C/C++ Build">
+				<topic label="Discovery options page" href="reference/cdt_u_fprop_discovery.htm"/>
+				<topic label="Settings page">
+					<topic label="Tool Settings tab" href="reference/cdt_u_fprop_toolsettings.htm"/>
+				</topic>  
+				<topic label="Tool chain editor page" href="reference/cdt_u_prop_build_toolchain.htm"/>
+                        </topic>  
+			<topic label="C/C++ General" href="reference/cdt_u_prop_general.htm">
+				<topic label="Paths and Symbols page">
+					<topic label="Includes tab      " href="reference/cdt_u_prop_general_pns_inc.htm"/>
+					<topic label="Symbols tab       " href="reference/cdt_u_prop_general_pns_sym.htm"/>
+					<topic label="Libraries tab     " href="reference/cdt_u_prop_general_pns_lib.htm"/>
+					<topic label="Libraries path tab" href="reference/cdt_u_prop_general_pns_libpath.htm"/>
+					<topic label="Data Hierarchy tab" href="reference/cdt_u_prop_general_pns_hier.htm"/>
+                                </topic> 
+                        </topic>  
+			<topic label="Run/Debug Settings page" href="reference/cdt_u_prop_rundebug.htm"/>
+                </topic>
+
+		<topic label="C/C++ File Properties" href="reference/cdt_o_prop_file.htm">
+			<topic label="Resource page" href="reference/cdt_u_fprop_resource.htm"/>
+			<topic label="C/C++ Build">
+				<topic label="Discovery options page" href="reference/cdt_u_fileprop_discovery.htm"/>
+				<topic label="Settings page">
+					<topic label="Tool Settings tab" href="reference/cdt_u_fileprop_toolsettings.htm"/>
+					<topic label="Build Steps tab  " href="reference/cdt_u_fileprop_steps.htm"/>
+				</topic>  
+				<topic label="Tool Chain Editor page" href="reference/cdt_u_prop_build_toolchain.htm"/>
+                        </topic>  
+			<topic label="C/C++ General" href="reference/cdt_u_prop_general.htm">
+				<topic label="Language Mapping page" href="reference/cdt_u_fileprop_lng.htm"/>
+				<topic label="Paths and Symbols page">
+					<topic label="Includes tab      " href="reference/cdt_u_fileprop_inc.htm"/>
+					<topic label="Symbols tab       " href="reference/cdt_u_fileprop_sym.htm"/>
+					<topic label="Data Hierarchy tab" href="reference/cdt_u_prop_general_pns_hier.htm"/>
+                                </topic> 
+                        </topic>  
+			<topic label="Run/Debug Settings page" href="reference/cdt_u_prop_rundebug.htm"/>
+                </topic>
 	</topic>
 	
+
 	<!-- NEW PROJECT WIZARD TOPICS -->
 	<topic label="C/C++ New Project Wizard" href="reference/cdt_u_new_proj_wiz.htm">
             <topic label="Set Project Name and Location" href="reference/cdt_u_new_proj_wiz_name.htm"/>
author	Oleg Krasilnikov	2008-05-14 16:11:11 +0000
committer	Oleg Krasilnikov	2008-05-14 16:11:11 +0000
commit	8981d60e3351b1713cfdb6954c2e8a3b21a68374 (patch)
tree	6392b323b1a9d59cb6850dcd636c6bb462992a41 /doc
parent	0864dbf857eb4661655aab231ed6a7cdd4de348f (diff)
download	org.eclipse.cdt-8981d60e3351b1713cfdb6954c2e8a3b21a68374.tar.gz org.eclipse.cdt-8981d60e3351b1713cfdb6954c2e8a3b21a68374.tar.xz org.eclipse.cdt-8981d60e3351b1713cfdb6954c2e8a3b21a68374.zip