Write HTML-Headers in Title Case in platform.doc.isv (II)

eclipse-platform · Oct 4, 2024 · 91854c5 · 91854c5
1 parent d20d722
commit 91854c5
Show file tree

Hide file tree

Showing 90 changed files with 205 additions and 221 deletions.
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua.htm
@@ -10,9 +10,9 @@
 </head>
 <body>
 
-<h1>User assistance support</h1>
+<h1>User Assistance Support</h1>
 
-<h3>What is user assistance?</h3>
+<h3>What Is User Assistance?</h3>
 
 <p>
 User assistance is a set of components that together introduce the user

diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet.htm
@@ -10,9 +10,9 @@
 </head>
 <body>
 
-<h2>Cheat sheets</h2>
+<h2>Cheat Sheets</h2>
 
-<h3><b>Guiding the user through tasks</b></h3>
+<h3><b>guiding the User Through Tasks</b></h3>
 
 <p>
 Even when the platform UI filters out unneeded functionality, there is still a steep learning
@@ -30,7 +30,7 @@ <h3><b>Guiding the user through tasks</b></h3>
 Each task is represented by a simple cheat sheet. </li>
 </ul>
 
-<h3>Related links</h3>
+<h3>Related Links</h3>
 <p>
 <a href="../../org.eclipse.platform.doc.user/reference/ref-cheatsheets.htm">Working with cheat sheets</a><br>
 <a href="../../org.eclipse.platform.doc.user/reference/ref-composite-cheatsheets.htm">Working with composite cheat sheets</a><br>

diff --git a/...se.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_composite.htm b/...se.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_composite.htm
@@ -23,7 +23,7 @@
   </head>
   <body>
     <h2>
-      Composite cheat sheets
+      Composite Cheat Sheets
     </h2>
     <p>
       <a href=
@@ -36,7 +36,7 @@ <h2>
       org.eclipse.ui.cheatsheets.cheatSheetContent</a></b> extension point.
     </p>
     <h3>
-      Content file format
+      Content File Format
     </h3>
     <p>
       The composite cheat sheet content itself is defined in a separate file
@@ -77,7 +77,7 @@ <h3>
     </p>
 
     <h3>
-      Cheat sheet task parameters
+      Cheat Sheet Task Parameters
     </h3>
     <p>
       If a task has kind = "cheatsheet" a cheat sheet will be opened when that
@@ -130,7 +130,7 @@ <h3>
       </tr>
     </table>
     <h3>
-      Example of a composite cheat sheet
+      Example of a Composite Cheat Sheet
     </h3>
 
     <p>
@@ -217,7 +217,7 @@ <h3>
     </p>
 
     <h3>
-      Related links
+      Related Links
     </h3>
     <p>
       <a href=

diff --git a/...orm.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_composite_content.htm b/...orm.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_composite_content.htm
@@ -11,7 +11,7 @@
 </head>
 <body>
 
-<h3>Composite cheat sheet content file XML format</h3>
+<h3>Composite Cheat Sheet Content File XML Format</h3>
 
 <h6 class="CaptionFigColumn">Identifier: </h6>org.eclipse.ui.cheatsheets.composite_schema
 <h6 class="CaptionFigColumn">Since: </h6>3.2

diff --git a/...e.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_guidelines.htm b/...e.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_guidelines.htm
@@ -10,15 +10,14 @@
 </head>
 <body>
 
-<h2>Cheat sheet authoring guidelines</h2>
+<h2>Cheat Sheet Authoring Guidelines</h2>
 
 <p>
 Cheat sheets and composite cheat sheets enable a user to achieve a goal by 
 completing a sequence of steps. These guidelines discuss when to use cheat 
 sheets and how to best write a cheat sheet. </p>
 
-<h3>
-When to create cheat sheets</h3>
+<h3>When to Create Cheat Sheets</h3>
 
 <p>
 Cheat sheets are well suited to tasks which consist of&nbsp; steps which lead 
@@ -29,24 +28,22 @@ <h3>
 usually contain up to 10 steps and can be completed in a half an hour or less. 
 For larger tasks consider using a composite cheat sheet. </p>
 
-<h3>
-When to create composite cheat sheets</h3>
+<h3>When to Create Composite Cheat Sheets</h3>
 
 <p>
 Composite cheat sheets are used to for 
 providing guidance through a task which is too large to describe in a single 
 cheat sheet or which has multiple goals. A composite cheat sheet can be used to 
 describe a sequence of tasks each of which builds on its predecessor. </p>
 
-<h3>
-When not to use cheat sheets</h3>
+<h3>When Not to Use Cheat Sheets</h3>
 
 <p>
 Cheat sheets work best when problem can be solved by a sequence of simple steps. Cheat sheets are not a substitute for the help system which allows for 
 creation of HTML pages with rich graphics and random access of information using 
 search and hyperlinks. Cheat sheets are not intended for tasks which require a 
 large amount of text to be input by the user. </p>
-<h3>Guidelines for creating a cheat sheet</h3>
+<h3>Guidelines for Creating a Cheat Sheet</h3>
 <ul>
   <li>Choose a short and meaningful title.</li>
   <li>Utilize links to the help system in cheat sheet tasks whenever possible to 
@@ -83,7 +80,7 @@ <h3>Guidelines for creating a cheat sheet</h3>
   <li>Test cheat sheets with the error log view open so you can see if any 
   warnings are written to the log.</li>
 </ul>
-<h3>Guidelines for creating a composite cheat sheet</h3>
+<h3>Guidelines for Creating a Composite Cheat Sheet</h3>
 <ul>
   <li>A composite cheat sheet should contain tasks that are related by a common 
   theme.</li>
@@ -101,7 +98,7 @@ <h3>Guidelines for creating a composite cheat sheet</h3>
   which tasks can be started.</li>
 </ul>
 
-<h3>Related links</h3>
+<h3>Related Links</h3>
 <p>
 <a href="../../org.eclipse.platform.doc.user/reference/ref-cheatsheets.htm">Working with cheat sheets</a><br>
 <a href="../../org.eclipse.platform.doc.user/reference/ref-composite-cheatsheets.htm">Working with composite cheat sheets</a><br>

diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_simple.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_simple.htm
@@ -10,7 +10,7 @@
 </head>
 <body>
 
-<h2>Simple cheat sheets</h2>
+<h2>Simple Cheat Sheets</h2>
 
 <P >
 Cheat sheets guide the user through a series of complex tasks to achieve
@@ -29,7 +29,7 @@ <h2>Simple cheat sheets</h2>
 translated into other languages.
 </P>
 <h4>
-Contributing a cheat sheet</h4>
+Contributing a Cheat Sheet</h4>
 <p>Contributing a cheat sheet is pretty straightforward.  Let's look at a cheat sheet contributed by the
 JDT for building a simple Java application.
 </p>
@@ -54,7 +54,7 @@ <h4>
 appear in the <b>Other</b> category.
 <p align="center">
 <img border="0" src="images/cheatsheets.png" alt="Cheat sheet dialog"></p>
-<h4>Cheat sheet items</h4>
+<h4>Cheat Sheet Items</h4>
 <p>
 The real work for cheat sheets is done in the content file.  The content file is an XML file whose name and location
 are specified in the <b>contentFile</b> attribute.  The path for the file is relative to the plug-in's directory.  (Note
@@ -144,7 +144,7 @@ <h4>Subitems</h4>
 be visited in any particular order.  Subitems may also define actions that automatically perform the subtask for
 the user.  Subitem actions are described in the same way as item actions. 
 </p>
-<h4>Conditional expressions and cheat sheet variables</h4>
+<h4>Conditional Expressions and Cheat Sheet Variables</h4>
 <p>
 Conditional expressions can be used to define cheat sheet elements whose content or behavior depends upon a
 particular condition being true.  Conditions are described in the <b>condition</b> element of a subitem
@@ -184,7 +184,7 @@ <h4>Conditional expressions and cheat sheet variables</h4>
 </pre>
 The action to be performed is chosen based on the value of the <tt>v1</tt> variable.  If the variable
 value is neither <tt>a</tt> or <tt>b</tt>, it is considered an error.
-<h4>Repeated subitems</h4>
+<h4>Repeated Subitems</h4>
 <p>Repeated subitems describe a subitem that can can expand into 0, 1, or more similar substeps.  The
 substeps are individualized using the special variable <tt>${this}</tt>.  This variable will be replaced by
 the values specified in the <b>values</b> attribute.  The values attribute is a string of values that are separated
@@ -202,8 +202,7 @@ <h4>Repeated subitems</h4>
 action paramater value.  It can also be accessed from the 
 <a href="../reference/api/org/eclipse/ui/cheatsheets/ICheatSheetManager.html"><b>ICheatSheetManager</b></a>
 while the action is executing.
-<h4>
-Cheat sheet listeners</h4>
+<h4>Cheat Sheet Listeners</h4>
 <p>
 In some cases, you may want to change other parts of your UI if a cheat sheet is active.
 For example, you may have an editor that shows special annotations if a cheat sheet is guiding the
@@ -215,8 +214,7 @@ <h4>
 <a href="../reference/api/org/eclipse/ui/cheatsheets/ICheatSheetEvent.html"><b>ICheatSheetEvent</b></a> when there
 is a change in the cheat sheet's life cycle, such as when it opens, closes, or completes.  
 </p>
-<h4>
-Contributing attributes to an existing cheat sheet</h4>
+<h4>Contributing Attributes to an Existing Cheat Sheet</h4>
 <p>
 The <b><a href="../reference/extension-points/org_eclipse_ui_cheatsheets_cheatSheetItemExtension.html">org.eclipse.ui.cheatsheets.cheatSheetItemExtension</a></b>
 extension can be used to contribute arbitrary attributes to a pre-existing cheat sheet.  
@@ -228,7 +226,7 @@ <h4>
 See the extension point documentation for more detail.
 </p>
 
-<h4>Related links</h4>
+<h4>Related Links</h4>
 <p>
 <a href="../../org.eclipse.platform.doc.user/reference/ref-cheatsheets.htm">Working with cheat sheets</a><br>
 <a href="ua_cheatsheet_composite.htm">Creating composite cheat sheets</a><br>

diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic.htm
@@ -16,9 +16,9 @@
 </head>
 <body>
 
-<h2>Dynamic content</h2>
+<h2>Dynamic Content</h2>
 
-<h3>What is dynamic content?</h3>
+<h3>What Is Dynamic Content?</h3>
 
 <p>
 Several user assistance components allow you to provide dynamic content. This
@@ -98,7 +98,7 @@ <h3>XML Annotations</h3>
 </pre>
 <hr>
 
-<h3>Content producers</h3>
+<h3>Content Producers</h3>
 
 <p>
 A content producer is a mechanism for plugging-in Java code to produce the document

diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic_extensions.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic_extensions.htm
@@ -22,18 +22,14 @@
     </style>
   </head>
   <body>
-    <h2>
-      Content extensions
-    </h2>
+    <h2>Content Extensions</h2>
     <p>
       A content extension is either a contribution of content into a known
       anchor (similar to an extension into an extension point), or the
       replacement of an existing element in a document.
     </p>
 
-    <h3>
-      Contributing into anchors
-    </h3>
+    <h3>Contributing Into Anchors</h3>
     <p>
       Anchor elements (e.g. <code>&lt;anchor id="my_anchor"/&gt;</code>) can be
       specified in any user assistance XML document, and represent places at
@@ -108,9 +104,7 @@ <h3>
       it was explicitly added into the original document.
     </p>
 
-    <h3>
-      Replacing content
-    </h3>
+    <h3>Replacing Content</h3>
     <p>
       Any XML element in a user assistance document that has an <code>id</code>
       attribute that is unique to that document can be replaced with any other
@@ -151,9 +145,7 @@ <h3>
       <code>org.eclipse.ui.intro.configExtension</code></a> extension point)
     </p>
 
-    <h3>
-      Path format
-    </h3>
+    <h3>Path Format</h3>
     <p>
       The format of the <code>path</code> attribute is
       <code>/pluginId/path/file.xml#elementId</code>, except welcome where it

diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic_filters.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic_filters.htm
@@ -37,7 +37,7 @@ <h2>Filters</h2>
 core expressions</a>, which is the same syntax used to filter menu contributions, etc from the UI.
 </p>
 
-<h3>System tests</h3>
+<h3>System Tests</h3>
 
 <p>
 Expressions check criteria by performing tests. One type of test is a system test, which tests
@@ -128,7 +128,7 @@ <h3>System tests</h3>
 expressions syntax</a> specification for more details.</em>
 </p>
 
-<h3>Property tests</h3>
+<h3>Property Tests</h3>
 
 <p>
 In addition to system tests, you can test any property of an available object as long as
@@ -277,7 +277,7 @@ <h3>Property tests</h3>
 expressions syntax</a> specification for more details on how to write expressions.</em>
 </p>
 
-<h3>Defining your own test</h3>
+<h3>Defining Your Own Test</h3>
 
 The core expressions framework allows you define your own test that can test
 on any arbitrary property of any object that is accessible through the variables defined for
@@ -308,7 +308,7 @@ <h3>
       &lt;/enablement&gt;
     &lt;/topic&gt;</pre>
 
-<h3>Filter attributes/elements <span class="warning">(deprecated)</span></h3>
+<h3>Filter Attributes/Elements <span class="warning">(deprecated)</span></h3>
 
 <p>
 Prior to the 3.3, filters were specified using <code>filter</code> attributes or elements.
@@ -502,7 +502,7 @@ <h3>Information Center</h3>
 see <a href="ua_help_setup_preferences.htm">help system customization</a>. 
 </p>
 
-<h3>Where can I use filters?</h3>
+<h3>Where Can I Use Filters?</h3>
 
 <p>
 Filtering can be used in any XML-based user assistance document, such as help XHTML topics,

diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic_includes.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic_includes.htm
@@ -67,7 +67,7 @@ <h2>
     </p>
 
     <h3>
-      Where can I use includes?
+      Where Can I Use Includes?
     </h3>
     <p>
       See below for a list of the document types in which includes can be used.

diff --git a/...pse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_abstract_scope.htm b/...pse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_abstract_scope.htm
@@ -18,7 +18,7 @@
   </head>
   <body>
     <h2>
-      Using AbstractHelpScope to filter an information center
+      Using AbstractHelpScope to Filter an Information Center
     </h2>
     <p>
       An information center can be used to serve information for more than one

diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content.htm
@@ -10,7 +10,7 @@
 </head>
 <body>
 
-<h2>Help content</h2>
+<h2>Help Content</h2>
 
 <p><b>Building a help plug-in</b></p>
 

diff --git a/...pse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active.htm b/...pse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active.htm
@@ -10,7 +10,7 @@
 </head>
 <body>
 
-<h2>Active help</h2>
+<h2>Active Help</h2>
 
 <p>Active help is the ability to invoke Eclipse code from on-line
 documentation.&nbsp;It is implemented by including some JavaScript in your

diff --git a/...tform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_action.htm b/...tform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_action.htm
@@ -10,7 +10,7 @@
 </head>
 <body>
 
-<h3>Writing the help action</h3>
+<h3>Writing the Help Action</h3>
 
 <p>The interface <a href="../reference/api/org/eclipse/help/ILiveHelpAction.html"><b>ILiveHelpAction</b></a>
 is used to build an active help action.</p>
-Original file line number
+Diff line change
@@ Expand Up / @@ -67,7 +67,7 @@ <h2> @@
         </p>
         <h3>
-          Where can I use includes?
+          Where Can I Use Includes?
         </h3>
         <p>
           See below for a list of the document types in which includes can be used.
@@ Expand Down @@