From 91854c523bdbc72a5ee858d5d87d3a36f4bdb245 Mon Sep 17 00:00:00 2001 From: Matthias Becker Date: Fri, 4 Oct 2024 15:18:33 +0200 Subject: [PATCH] Write HTML-Headers in Title Case in platform.doc.isv (II) --- .../org.eclipse.platform.doc.isv/guide/ua.htm | 4 ++-- .../guide/ua_cheatsheet.htm | 6 +++--- .../guide/ua_cheatsheet_composite.htm | 10 +++++----- .../guide/ua_cheatsheet_composite_content.htm | 2 +- .../guide/ua_cheatsheet_guidelines.htm | 17 +++++++---------- .../guide/ua_cheatsheet_simple.htm | 18 ++++++++---------- .../guide/ua_dynamic.htm | 6 +++--- .../guide/ua_dynamic_extensions.htm | 16 ++++------------ .../guide/ua_dynamic_filters.htm | 10 +++++----- .../guide/ua_dynamic_includes.htm | 2 +- .../guide/ua_help_abstract_scope.htm | 2 +- .../guide/ua_help_content.htm | 2 +- .../guide/ua_help_content_active.htm | 2 +- .../guide/ua_help_content_active_action.htm | 2 +- .../guide/ua_help_content_active_debug.htm | 10 +++++----- .../guide/ua_help_content_active_invoke.htm | 2 +- .../guide/ua_help_content_command.htm | 2 +- .../ua_help_content_command_authoring.htm | 2 +- .../guide/ua_help_content_criteria.htm | 12 ++++++------ .../guide/ua_help_content_files.htm | 6 +++--- .../guide/ua_help_content_manifest.htm | 2 +- .../guide/ua_help_content_nested.htm | 6 +++--- .../guide/ua_help_content_toc.htm | 2 +- .../guide/ua_help_content_xhtml.htm | 2 +- .../guide/ua_help_context.htm | 2 +- .../guide/ua_help_context_dynamic.htm | 2 +- .../guide/ua_help_context_id.htm | 2 +- .../guide/ua_help_context_xml.htm | 8 ++++---- .../guide/ua_help_infocenter_preferences.htm | 8 ++++---- .../guide/ua_help_search.htm | 2 +- .../guide/ua_help_search_types.htm | 2 +- .../guide/ua_help_setup.htm | 6 +++--- .../guide/ua_help_setup_about.htm | 2 +- .../guide/ua_help_setup_infocenter.htm | 10 +++++----- .../guide/ua_help_setup_nav.htm | 2 +- .../guide/ua_help_setup_preferences.htm | 10 +++++----- .../guide/ua_help_setup_preindex.htm | 8 ++++---- .../guide/ua_help_setup_rcp.htm | 2 +- .../guide/ua_help_setup_standalone.htm | 8 ++++---- .../guide/ua_help_war.htm | 4 ++-- .../guide/ua_intro_cust_static.htm | 2 +- .../guide/ua_intro_define_content.htm | 2 +- .../guide/ua_intro_defining.htm | 2 +- .../guide/ua_intro_defining_config.htm | 2 +- .../guide/ua_intro_ext_custom_url.htm | 2 +- .../guide/ua_intro_ext_standbypart.htm | 2 +- .../guide/ua_intro_ext_theme.htm | 4 ++-- .../guide/ua_intro_extending.htm | 2 +- .../guide/ua_intro_extending_content.htm | 2 +- .../guide/ua_intro_hello_world.htm | 2 +- .../guide/ua_intro_minimal.htm | 8 ++++---- .../guide/ua_intro_universal.htm | 6 +++--- .../guide/ua_intro_universal_contributing.htm | 2 +- .../guide/ua_intro_universal_defaults.htm | 2 +- .../guide/ua_intro_universal_extending.htm | 4 ++-- .../guide/ua_intro_universal_links.htm | 2 +- .../guide/ua_intro_universal_preference.htm | 2 +- .../guide/ua_intro_xhtml.htm | 2 +- .../guide/ua_statushandling.htm | 2 +- .../guide/ua_statushandling_defining.htm | 2 +- .../guide/ua_statushandling_sample.htm | 2 +- .../guide/workbench.htm | 2 +- .../guide/workbench_advext_activities.htm | 16 ++++++++-------- .../guide/workbench_advext_contexts.htm | 6 +++--- .../guide/workbench_cmd_bindings.htm | 2 +- .../guide/workbench_cmd_commands.htm | 2 +- .../guide/workbench_cmd_handlers.htm | 8 ++++---- .../guide/workbench_cmd_menus.htm | 8 ++++---- .../guide/workbench_jobs.htm | 8 ++++---- .../guide/workbench_perspectives.htm | 13 +++++-------- .../guide/workbench_resources.htm | 2 +- .../guide/workbench_scalability.htm | 2 +- .../guide/workbench_statushandling.htm | 14 +++++++------- .../workbench_statushandling_defining.htm | 4 ++-- .../guide/wrkAdv_accessibility.htm | 8 ++++---- .../guide/wrkAdv_commands_handlers.htm | 2 +- .../guide/wrkAdv_efs_resources.htm | 2 +- .../guide/wrkAdv_encoding.htm | 2 +- .../guide/wrkAdv_keyBindings.htm | 2 +- .../guide/wrkAdv_keyBindings_accelConfig.htm | 4 ++-- .../guide/wrkAdv_keyBindings_accelSet.htm | 2 +- .../guide/wrkAdv_keyBindings_actionDef.htm | 2 +- .../guide/wrkAdv_keyBindings_contexts.htm | 2 +- .../guide/wrkAdv_marker_support.htm | 2 +- .../guide/wrkAdv_markerhelp.htm | 2 +- .../guide/wrkAdv_markerresolution.htm | 2 +- .../guide/wrkAdv_markers.htm | 2 +- .../guide/wrkAdv_singleclick.htm | 8 ++++---- .../guide/wrkAdv_undo.htm | 14 +++++++------- .../guide/wrkAdv_workingsets.htm | 4 ++-- 90 files changed, 205 insertions(+), 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 index 5890646f388..efd7bf825ea 100644 --- 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 @@ -

User assistance support

+

User Assistance Support

-

What is user assistance?

+

What Is User Assistance?

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 index 6f988399132..461acea246f 100644 --- 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 @@ -

Cheat sheets

+

Cheat Sheets

-

Guiding the user through tasks

+

guiding the User Through Tasks

Even when the platform UI filters out unneeded functionality, there is still a steep learning @@ -30,7 +30,7 @@

Guiding the user through tasks

Each task is represented by a simple cheat sheet. -

Related links

+

Related Links

Working with cheat sheets
Working with composite cheat sheets
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_composite.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_composite.htm index d8e0ddfde64..617e98eba35 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_composite.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_composite.htm @@ -23,7 +23,7 @@

- Composite cheat sheets + Composite Cheat Sheets

org.eclipse.ui.cheatsheets.cheatSheetContent extension point.

- Content file format + Content File Format

The composite cheat sheet content itself is defined in a separate file @@ -77,7 +77,7 @@

- Cheat sheet task parameters + Cheat Sheet Task Parameters

If a task has kind = "cheatsheet" a cheat sheet will be opened when that @@ -130,7 +130,7 @@

- Example of a composite cheat sheet + Example of a Composite Cheat Sheet

@@ -217,7 +217,7 @@

- Related links + Related Links

-

Composite cheat sheet content file XML format

+

Composite Cheat Sheet Content File XML Format

Identifier:
org.eclipse.ui.cheatsheets.composite_schema
Since:
3.2 diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_guidelines.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_guidelines.htm index 2763f754d3e..68d9177a429 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_guidelines.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_guidelines.htm @@ -10,15 +10,14 @@ -

Cheat sheet authoring guidelines

+

Cheat Sheet Authoring Guidelines

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.

-

-When to create cheat sheets

+

When to Create Cheat Sheets

Cheat sheets are well suited to tasks which consist of  steps which lead @@ -29,8 +28,7 @@

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.

-

-When to create composite cheat sheets

+

When to Create Composite Cheat Sheets

Composite cheat sheets are used to for @@ -38,15 +36,14 @@

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.

-

-When not to use cheat sheets

+

When Not to Use Cheat Sheets

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.

-

Guidelines for creating a cheat sheet

+

Guidelines for Creating a Cheat Sheet

-

Guidelines for creating a composite cheat sheet

+

Guidelines for Creating a Composite Cheat Sheet

-

Related links

+

Related Links

Working with cheat sheets
Working with composite cheat sheets
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 index ffc402dbb01..6714e0db82f 100644 --- 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 @@ -

Simple cheat sheets

+

Simple Cheat Sheets

Cheat sheets guide the user through a series of complex tasks to achieve @@ -29,7 +29,7 @@

Simple cheat sheets

translated into other languages.

-Contributing a cheat sheet

+Contributing a Cheat Sheet

Contributing a cheat sheet is pretty straightforward. Let's look at a cheat sheet contributed by the JDT for building a simple Java application.

@@ -54,7 +54,7 @@

appear in the Other category.

Cheat sheet dialog

-

Cheat sheet items

+

Cheat Sheet Items

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 contentFile attribute. The path for the file is relative to the plug-in's directory. (Note @@ -144,7 +144,7 @@

Subitems

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.

-

Conditional expressions and cheat sheet variables

+

Conditional Expressions and Cheat Sheet Variables

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 condition element of a subitem @@ -184,7 +184,7 @@

Conditional expressions and cheat sheet variables

The action to be performed is chosen based on the value of the v1 variable. If the variable value is neither a or b, it is considered an error. -

Repeated subitems

+

Repeated Subitems

Repeated subitems describe a subitem that can can expand into 0, 1, or more similar substeps. The substeps are individualized using the special variable ${this}. This variable will be replaced by the values specified in the values attribute. The values attribute is a string of values that are separated @@ -202,8 +202,7 @@

Repeated subitems

action paramater value. It can also be accessed from the ICheatSheetManager while the action is executing. -

-Cheat sheet listeners

+

Cheat Sheet Listeners

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 @@

ICheatSheetEvent when there is a change in the cheat sheet's life cycle, such as when it opens, closes, or completes.

-

-Contributing attributes to an existing cheat sheet

+

Contributing Attributes to an Existing Cheat Sheet

The org.eclipse.ui.cheatsheets.cheatSheetItemExtension extension can be used to contribute arbitrary attributes to a pre-existing cheat sheet. @@ -228,7 +226,7 @@

See the extension point documentation for more detail.

-

Related links

+

Related Links

Working with cheat sheets
Creating composite cheat sheets
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 index 5c1c1a416a0..d18239f187b 100644 --- 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 @@ -

Dynamic content

+

Dynamic Content

-

What is dynamic content?

+

What Is Dynamic Content?

Several user assistance components allow you to provide dynamic content. This @@ -98,7 +98,7 @@

XML Annotations


-

Content producers

+

Content Producers

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 index 483f33624a7..4b5b642a715 100644 --- 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 @@ -

- Content extensions -

+

Content Extensions

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.

-

- Contributing into anchors -

+

Contributing Into Anchors

Anchor elements (e.g. <anchor id="my_anchor"/>) can be specified in any user assistance XML document, and represent places at @@ -108,9 +104,7 @@

it was explicitly added into the original document.

-

- Replacing content -

+

Replacing Content

Any XML element in a user assistance document that has an id attribute that is unique to that document can be replaced with any other @@ -151,9 +145,7 @@

org.eclipse.ui.intro.configExtension extension point)

-

- Path format -

+

Path Format

The format of the path attribute is /pluginId/path/file.xml#elementId, 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 index 4e8b194cec7..0f1d6e27de3 100644 --- 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 @@

Filters

core expressions, which is the same syntax used to filter menu contributions, etc from the UI.

-

System tests

+

System Tests

Expressions check criteria by performing tests. One type of test is a system test, which tests @@ -128,7 +128,7 @@

System tests

expressions syntax specification for more details.

-

Property tests

+

Property Tests

In addition to system tests, you can test any property of an available object as long as @@ -277,7 +277,7 @@

Property tests

expressions syntax specification for more details on how to write expressions.

-

Defining your own test

+

Defining Your Own Test

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 @@

</enablement> </topic> -

Filter attributes/elements (deprecated)

+

Filter Attributes/Elements (deprecated)

Prior to the 3.3, filters were specified using filter attributes or elements. @@ -502,7 +502,7 @@

Information Center

see help system customization.

-

Where can I use filters?

+

Where Can I Use Filters?

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 index 90af295808f..1682b3dca7e 100644 --- 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 @@

- Where can I use includes? + Where Can I Use Includes?

See below for a list of the document types in which includes can be used. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_abstract_scope.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_abstract_scope.htm index cdac5ee4f82..024bdc80ec9 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_abstract_scope.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_abstract_scope.htm @@ -18,7 +18,7 @@

- Using AbstractHelpScope to filter an information center + Using AbstractHelpScope to Filter an Information Center

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 index 5a7f7134e97..07e5b7436d6 100644 --- 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 @@ -

Help content

+

Help Content

Building a help plug-in

diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active.htm index 0fafd1bf58d..99f6ac83bdd 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active.htm @@ -10,7 +10,7 @@ -

Active help

+

Active Help

Active help is the ability to invoke Eclipse code from on-line documentation. It is implemented by including some JavaScript in your diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_action.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_action.htm index 9c711e3cdbb..cd02f8c9cf3 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_action.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_action.htm @@ -10,7 +10,7 @@ -

Writing the help action

+

Writing the Help Action

The interface ILiveHelpAction is used to build an active help action.

diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_debug.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_debug.htm index bd18f63b78d..53abc086c8d 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_debug.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_debug.htm @@ -10,7 +10,7 @@ -

Tips for debugging active help

+

Tips for Debugging Active Help

The code and markup that triggered our active help link looks pretty @@ -18,7 +18,7 @@

Tips for debugging active help

to work?

-

Test your action ahead of time

+

Test Your Action Ahead of Time

If your action implementation is fairly involved, you should invoke the @@ -26,7 +26,7 @@

Test your action ahead of time

that the action is error-free before invoking it from the JavaScript. 

-

Ensure the JavaScript is running

+

Ensure the JavaScript Is Running

You can modify "liveHelp.js" (make a copy of this from the plugins/org.eclipse.help @@ -47,7 +47,7 @@

Ensure the JavaScript is running

then you have a problem in the HTML markup.

-

Debug the active help action

+

Debug the Active Help Action

Once you know that the JavaScript is running, you can debug your action from @@ -67,7 +67,7 @@

Debug the active help action

the action as you would any other Java code.

-

Make sure your UI code is wrapped in Display.syncExec

+

Make Sure Your UI Code Is Wrapped in Display.syncExec

A common runtime problem is improperly accessing UI code from the thread that diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_invoke.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_invoke.htm index 3180f87d3e1..f13d362c472 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_invoke.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_invoke.htm @@ -10,7 +10,7 @@ -

Invoking the action from HTML

+

Invoking the Action From HTML

To include active help links in your documentation, you must first declare the diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_command.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_command.htm index 0740fa292a8..86a64a91047 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_command.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_command.htm @@ -10,7 +10,7 @@ -

Embedding commands in help

+

Embedding Commands in Help

It is possible to create links to workbench commands in help content. When the user clicks the link, the command will be executed. This feature is similar diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_command_authoring.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_command_authoring.htm index 8c253e879e9..8729de8f76d 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_command_authoring.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_command_authoring.htm @@ -10,7 +10,7 @@ -

Authoring a command link

+

Authoring a Command Link

To include command links in your documentation, you must first declare the diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_criteria.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_criteria.htm index 33760e32b1d..33db60218f3 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_criteria.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_criteria.htm @@ -9,20 +9,20 @@ -

Adding criteria to help content

+

Adding Criteria to Help Content

This page will explain how to activate criteria. To enable criteria you need define which criteria are associated with each topic and also set preferences which tell the help system to show criteria. The association between criteria and topics can be either in a toc file or using a criteria provider class.

-

What are criteria?

+

What Are Criteria?

Some topics of the plug-in might only be of interest to certain users, for example a topic may be specific to the linux platform. The document writer can define a criterion "platform" with values such as "linux", "windows" etc applied to different topics. The user can then filter the documentation to show only documents applicable to a specific platform.

-

How to define criteria in a table of contents file

+

How to Define Criteria in a Table of Contents File

When defining a table of contents file criteria information can be appended according to these steps:

-

How to define criteria using a criteria provider

+

How to Define Criteria Using a Criteria Provider

As an alternative to defining criteria in a table of contents file the extension point org.eclipse.criteriaProvider can be used to define a class which will associate criteria with topics. @@ -62,7 +62,7 @@

How to define criteria using a criteria provider

-

Criteria localization

+

Criteria Localization

The names and values of criteria can be localized. Follow these steps to add localization information for criteria:

-

How to set the preferences to enable criteria

+

How to Set the Preferences to Enable Criteria

Define the necessary preferences in your plugin customization file.