Skip to content

Commit 1e74269

Browse files
committed
Improve and fix the markdown documentation
- Add a .project file to `docs` folder for a project named `org.eclipse.platform.ui.docs` - Remove internal table of content entries. - Fix broken links and avoid absolute raw and self links.
1 parent 08c79bf commit 1e74269

34 files changed

+169
-904
lines changed

docs/.project

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<projectDescription>
3+
<name>org.eclipse.pde.ui.docs</name>
4+
<comment></comment>
5+
<projects>
6+
</projects>
7+
<buildSpec>
8+
</buildSpec>
9+
<natures>
10+
</natures>
11+
</projectDescription>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
eclipse.preferences.version=1
2+
encoding/<project>=UTF-8

docs/Accessibility_Features.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,24 @@ Having said that there are places within the Platform UI that have been given so
1414

1515
The TitleAreaDialog is the abstract superclass of WizardDialog and PreferenceDialog among others. It has an area that is used to display status and error messages. When an error is displayed a user using an assistive technology such as a screen reader may need to give focus to the error in order to read it. We do this by using a non editable Text rather than a label in the message area of the dialog.
1616

17-
![Titleareadialog.png](https://raw.githubusercontent.com/eclipse-platform/eclipse.platform.ui/master/docs/images/Titleareadialog.png)
17+
![Titleareadialog.png](images/Titleareadialog.png)
1818

1919
**IconAndMessageDialog**
2020

2121
Screen readers try and do thier best to read the content of a dialog but tend to give up when they hit the first non labelled child of the Shell. We changed the IconAndMessageDialog (parent of MessageDialog, ErrorDialog and many others) to have a label that is a direct child of the shell so that it is already read.
2222

23-
![Confirm.png](https://raw.githubusercontent.com/eclipse-platform/eclipse.platform.ui/master/docs/images/Confirm.png)
23+
![Confirm.png](images/Confirm.png)
2424

2525
**High Contrast Presentation Change**
2626

2727
Eclipse ships with 2 presentations - the default presentation (which uses the font settings defined in the JFace resources properties for each platform and Locale) and the system default presentation which only uses the system fonts and colours. When you switch into High Contrast Mode Eclipse will prompt you for a restart and switch the presentation to the default one.
2828

29-
![Highcontrast.png](https://raw.githubusercontent.com/eclipse-platform/eclipse.platform.ui/master/docs/images/Highcontrast.png)
29+
![Highcontrast.png](images/Highcontrast.png)
3030

3131

3232
**Accessible Listeners**
3333

3434
In places where we do not provide information that can be read by default by a screenreader we use the SWT IAcccesibleListener interface to specify a value. The Windows inspect32 tool is a good way to see the information a screenreader will get. Below is a screenshot of the ColorFieldEditor with the inspect32 window open.
3535

36-
![Accessiblelistener.png](https://raw.githubusercontent.com/eclipse-platform/eclipse.platform.ui/master/docs/images/Accessiblelistener.png)
36+
![Accessiblelistener.png](images/Accessiblelistener.png)
3737

docs/CSS.md

-14
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,6 @@
11
Eclipse
22
======
33

4-
Contents
5-
--------
6-
7-
* [1 Overview](#Overview)
8-
* [2 Sample](#Sample)
9-
* [3 SWT Mapping](#SWT-Mapping)
10-
* [3.1 Widget: Control](#Widget-Control)
11-
* [3.2 Widget: Button](#Widget-Button)
12-
* [3.3 Widget: Label](#Widget-Label)
13-
* [3.4 Widget: CTabFolder](#Widget-CTabFolder)
14-
* [3.5 Widget: CTabItem](#Widget-CTabItem)
15-
* [3.6 Widget: CTabFolder with e4Renderer](#Widget-CTabFolder-with-e4Renderer)
16-
* [2 Pseudo classes which can be used in CSS to style SWT widgets](#Pseudo-classes-which-can-be-used-in-CSS-to-style-SWT-widgets)
17-
* [3 Using CSS in Eclipse 3.6](#Using-CSS-in-Eclipse-36)
184

195
Overview
206
--------

docs/Command_Core_Expressions.md

+1-15
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,11 @@ Command Core Expressions
33

44
Core expressions are declarative or programmatic expressions based on the org.eclipse.core.expressions plugin.
55

6-
Contents
7-
--------
8-
9-
* [1 Expressions and the Command Framework](#Expressions-and-the-Command-Framework)
10-
* [2 Variables and the Command Framework](#Variables-and-the-Command-Framework)
11-
* [3 Property Testers](#Property-Testers)
12-
* [4 Expression examples](#Expression-examples)
13-
* [4.1 Basic IStructuredSelection](#Basic-IStructuredSelection)
14-
* [4.2 Package Explorer IStructuredSelection](#Package-Explorer-IStructuredSelection)
15-
* [4.3 Active editor type](#Active-editor-type)
16-
* [4.4 Complex nested boolean expressions](#Complex-nested-boolean-expressions)
17-
* [5 New Core Expressions in 3.3](#New-Core-Expressions-in-33)
18-
* [5.1 count and iterate](#count-and-iterate)
19-
* [5.2 definitions](#definitions)
206

217
Expressions and the Command Framework
228
=====================================
239

24-
The [Platform Command Framework](https://github.com/eclipse-platform/eclipse.platform.ui/blob/master/docs/PlatformCommandFramework.md) uses [core expressions](https://github.com/eclipse-platform/eclipse.platform.ui/blob/master/docs/Platform_Expression_Framework.md) for enabledWhen and activeWhen for handlers, programmatic activation of contexts, and for visibleWhen for menu contributions.
10+
The [Platform Command Framework](PlatformCommandFramework.md) uses [core expressions](Platform_Expression_Framework.md) for enabledWhen and activeWhen for handlers, programmatic activation of contexts, and for visibleWhen for menu contributions.
2511
The command framework provides the IEvaluationContext that command core expressions are evaluate against.
2612

2713
The IEvaluationContext provides a default variable for evaluations, and a number of named variables.

docs/Eclipse4_RCP_Contexts.md

+3-23
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,10 @@ Eclipse4/RCP/Contexts
22
=====================
33

44
The Eclipse 4 Application Platform manages state and services using a set of _contexts_; this information is used for injection.
5-
Contexts are used as the sources for [Dependency Injection](https://github.com/eclipse-platform/eclipse.platform.ui/blob/master/docs/Eclipse4_RCP_Dependency_Injection.md).
5+
Contexts are used as the sources for [Dependency Injection](Eclipse4_RCP_Dependency_Injection.md).
66
In this respect, they are somewhat analogous to _modules_ in Guice.
77
Normally code should not have to use or know about the context.
88

9-
10-
11-
Contents
12-
--------
13-
14-
* [1 What is a Context?](#What-is-a-Context)
15-
* [2 The Use of Contexts in Eclipse 4](#The-Use-of-Contexts-in-Eclipse-4)
16-
* [3 Context Variables](#Context-Variables)
17-
* [4 Context Chains and the Active Context](#Context-Chains-and-the-Active-Context)
18-
* [5 Context Functions](#Context-Functions)
19-
* [6 Run And Tracks](#Run-And-Tracks)
20-
* [7 Exposing Services and State on an Eclipse Context](#Exposing-Services-and-State-on-an-Eclipse-Context)
21-
* [7.1 Context Functions](#context-functions-1)
22-
* [7.2 OSGi Services](#OSGi-Services)
23-
* [7.3 Context Functions Exposed As OSGi Declarative Services](#Context-Functions-Exposed-As-OSGi-Declarative-Services)
24-
* [8 Creating New Contexts](#Creating-New-Contexts)
25-
* [9 Advanced Topics](#Advanced-Topics)
26-
* [9.1 How do I access the current context?](#How-do-I-access-the-current-context)
27-
* [9.2 @Active vs ACTIVE_*](#active-vs-active_)
28-
* [10 References](#References)
299

3010
What is a Context?
3111
------------------
@@ -36,7 +16,7 @@ A context (a IEclipseContext) is a hierarchical key-value map. The keys are stri
3616
The Use of Contexts in Eclipse 4
3717
--------------------------------
3818

39-
![300px-Ui-context-hierarchy.png](https://raw.githubusercontent.com/eclipse-platform/eclipse.platform.ui/master/docs/images/300px-Ui-context-hierarchy.png)
19+
![300px-Ui-context-hierarchy.png](images/300px-Ui-context-hierarchy.png)
4020

4121

4222
Eclipse 4 associates contexts to the container elements in the UI
@@ -85,7 +65,7 @@ By declaring a context variable for the master server, if we later decide that w
8565
Context Chains and the Active Context
8666
-------------------------------------
8767

88-
![300px-Ui-contexts-active.png](https://raw.githubusercontent.com/eclipse-platform/eclipse.platform.ui/master/docs/images/300px-Ui-contexts-active.png)
68+
![300px-Ui-contexts-active.png](images/300px-Ui-contexts-active.png)
8969

9070
The editor is the active leaf
9171

docs/Eclipse4_RCP_Dependency_Injection.md

+3-32
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,6 @@ Eclipse4/RCP/Dependency Injection
22
=================================
33

44

5-
Contents
6-
--------
7-
8-
* [1 Overview](#Overview)
9-
* [2 Standard Annotations and Classes](#Standard-Annotations-and-Classes)
10-
* [2.1 @Inject (jakarta.inject)](#inject-jakartainject)
11-
* [2.2 @Named (jakarta.inject)](#named-jakartainject)
12-
* [2.3 @Singleton (jakarta.inject)](#singleton-jakartainject)
13-
* [2.4 Provider (javax.inject)](#provider-javaxinject)
14-
* [2.5 @PostConstruct (jakarta.annotation), @PreDestroy(jakarta.annotation)](#postconstruct-jakartaannotation-predestroyjakartaannotation)
15-
* [3 E4AP-specific Annotations](#e4ap-specific-annotations)
16-
* [3.1 @Optional (org.eclipse.e4.core.di.annotations)](#optional-orgeclipsee4corediannotations)
17-
* [3.2 @Active (org.eclipse.e4.core.contexts)](#active-orgeclipsee4corecontexts)
18-
* [3.3 @Preference (org.eclipse.e4.core.di.extensions)](#preference-orgeclipsee4corediextensions)
19-
* [3.4 @Creatable (org.eclipse.e4.core.di.annotations)](#creatable-orgeclipsee4corediannotations)
20-
* [3.5 @CanExecute, @Execute (org.eclipse.e4.core.di.annotations)](#.canexecute-execute-orgeclipsee4corediannotations)
21-
* [3.6 @Focus (org.eclipse.e4.ui.di)](#focus-orgeclipsee4uidi)
22-
* [3.7 @AboutToShow, @AboutToHide (org.eclipse.e4.ui.di)](#abouttoshow-abouttohide-orgeclipsee4uidi)
23-
* [3.8 @GroupUpdates (org.eclipse.e4.core.di.annotations)](#groupupdates-orgeclipsee4corediannotations)
24-
* [3.9 @EventTopic (org.eclipse.e4.core.di.extensions), @UIEventTopic (org.eclipse.e4.ui.di)](#eventtopic-orgeclipsee4corediextensions-uieventtopic-orgeclipsee4uidi)
25-
* [4 Advanced Topics](#Advanced-Topics)
26-
* [4.1 Injection Order](#Injection-Order)
27-
* [4.2 Extending the DI Framework](#Extending-the-DI-Framework)
28-
* [4.3 Configuring Bindings](#Configuring-Bindings)
29-
* [5 Debugging](#Debugging)
30-
* [6 Considerations](#Considerations)
31-
* [7 Current Caveats](#Current-Caveats)
32-
* [8 Design Decisions](#Design-Decisions)
33-
345
Overview
356
========
367

@@ -131,7 +102,7 @@ However, if this annotation is specified, then:
131102
@Active (org.eclipse.e4.core.contexts)
132103
--------------------------------------
133104

134-
@Active serves a similar purpose to @Named, indicating the the value should be resolved from the [active context](https://github.com/eclipse-platform/eclipse.platform.ui/blob/master/docs/Eclipse4_RCP_Contexts.md).
105+
@Active serves a similar purpose to @Named, indicating the the value should be resolved from the [active context](Eclipse4_RCP_Contexts.md).
135106

136107
For example, a handler could obtain the active part with:
137108

@@ -286,7 +257,7 @@ The setInfo() method will be triggered by a call to IEclipseContext#processWaiti
286257

287258
The @EventTopic and @UIEventTopic annotations tag methods and fields that should be notified on event changes.
288259
The @UIEventTopic ensures the event notification is performed in the UI thread. Both the event's DATA object and the actual OSGi Event object (org.osgi.service.event.Event) is available.
289-
See the [Events](https://github.com/eclipse-platform/eclipse.platform.ui/blob/master/docs/Event_Model.md) section for more details about events.
260+
See the [Events](Event_Model.md) section for more details about events.
290261

291262
@Inject
292263
public void setSelection(@EventTopic(REFRESH_EVENT) Object data) {
@@ -296,7 +267,7 @@ See the [Events](https://github.com/eclipse-platform/eclipse.platform.ui/blob/ma
296267
Advanced Topics
297268
===============
298269

299-
Injection is performed using the active [context](https://github.com/eclipse-platform/eclipse.platform.ui/blob/master/docs/Eclipse4_RCP_Contexts.md).
270+
Injection is performed using the active [context](Eclipse4_RCP_Contexts.md).
300271
Changes to values in the context will trigger re-injection.
301272

302273
* * Adding, setting, or modifying variables

docs/Eclipse4_RCP_EAS_List_of_All_Provided_Services.md

+2-30
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,8 @@
11
Eclipse4/RCP/EAS/List of All Provided Services
22
==============================================
33

4-
This page provides a listing of the services and other data values that can be injected or obtained from a [context](https://github.com/eclipse-platform/eclipse.platform.ui/blob/master/docs/Eclipse4_RCP_Contexts.md).
5-
6-
Contents
7-
--------
8-
9-
* [1 Application Context](#Application-Context)
10-
* [1.1 Application Parameters](#Application-Parameters)
11-
* [1.2 Services](#Services)
12-
* [1.3 Runtime Data](#Runtime-Data)
13-
* [2 Top Level Window Context](#Top-Level-Window-Context)
14-
* [2.1 Model Info](#Model-Info)
15-
* [2.2 Services](#Services-2)
16-
* [2.3 Runtime Data](#Runtime-Data-2)
17-
* [3 Part Context](#Part-Context)
18-
* [3.1 Model Info](#Model-Info-2)
19-
* [3.2 Services](#Services-3)
20-
* [4 Handler Execution](#Handler-Execution)
21-
* [5 Eclipse 3.x Compatibility Layer](#Eclipse-3x-Compatibility-Layer)
22-
* [5.1 Application Context](#Application-Context-2)
23-
* [5.1.1 Application Parameters](#Application-Parameters-2)
24-
* [5.1.2 Model Info](#Model-Info-3)
25-
* [5.1.3 Services](#Services-4)
26-
* [5.1.4 Runtime Data](#Runtime-Data-3)
27-
* [5.2 Top Level Window Context](#Top-Level-Window-Context-2)
28-
* [5.2.1 Model Info](#Model-Info-4)
29-
* [5.2.2 Services](#Services-5)
30-
* [5.2.3 Runtime Data](#Runtime-Data-4)
31-
* [5.3 Part Context](#Part-Context-2)
32-
* [5.3.1 Model Info](#Model-Info-5)
33-
* [5.3.2 Services](#Services-6)
4+
This page provides a listing of the services and other data values that can be injected or obtained from a [context](Eclipse4_RCP_Contexts.md).
5+
346

357
Application Context
368
-------------------

docs/Eclipse4_RCP_FAQ.md

+1-48
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,6 @@
11
Eclipse4/RCP/FAQ
22
================
33

4-
Contents
5-
--------
6-
7-
* [1 Adopting the Eclipse 4 Application Platform](#Adopting-the-Eclipse-4-Application-Platform)
8-
* [1.1 How do the Eclipse 3.x and 4.x programming models differ?](#how-do-the-eclipse-3x-and-4x-programming-models-differ)
9-
* [1.1.1 Handlers](#Handlers)
10-
* [1.1.2 Parts](#Parts)
11-
* [1.1.3 Lazy Instantiantion](#Lazy-Instantiantion)
12-
* [1.2 How would I accomplish X in Eclipse 4?](#How-would-I-accomplish-X-in-Eclipse-4)
13-
* [1.2.1 Accessing the status line](#Accessing-the-status-line)
14-
* [1.2.2 Associating help context with a control](#Associating-help-context-with-a-control)
15-
* [1.2.3 Handling errors and exceptions](#Handling-errors-and-exceptions)
16-
* [1.2.4 Accessing preference values](#Accessing-preference-values)
17-
* [1.2.5 How to I find ressource leaks in plug-ins](#How-to-find-resource-leaks)
18-
* [2 The E4 Model](#The-E4-Model)
19-
* [2.1 What is an _xmi:id_? How is it different from the _elementId_?](#what-is-an-xmiid-how-is-it-different-from-the-elementid)
20-
* [2.2 How do I reference an object defined in another .e4xmi?](#how-do-i-reference-an-object-defined-in-another-e4xmi)
21-
* [2.3 Are identifiers (elementId) supposed to be unique?](#are-identifiers-elementid-supposed-to-be-unique)
22-
* [2.4 How do I use MPlaceholders?](#How-do-I-use-MPlaceholders)
23-
* [2.5 How do I create an MPart from an MPartDescriptor?](#How-do-I-create-an-MPart-from-an-MPartDescriptor)
24-
* [3 Problems on Configuration, Start-Up, and Shutdown](#Problems-on-Configuration.2C-Start-Up.2C-and-Shutdown)
25-
* [3.1 Why won't my application start?](#Why-won.27t-my-application-start)
26-
* [3.2 I modified my App.e4xmi/fragment.e4xmi but the changes aren't being loaded. Why?](#i-modified-my-appe4xmifragmente4xmi-but-the-changes-arent-being-loaded-why)
27-
* [3.3 How can I prevent my workbench model from being saved on exit?](#How-can-I-prevent-my-workbench-model-from-being-saved-on-exit)
28-
* [4 Dependency Injection & Contexts](#dependency-injection--contexts)
29-
* [4.1 Why aren't my @Inject-able/@PostConstruct methods being injected?](#why-arent-my-inject-ablepostconstruct-methods-being-injected)
30-
* [4.1.1 Cause #1: Mismatched Annotations](#cause-1-mismatched-annotations)
31-
* [4.1.2 Cause #2: Unresolvable Injections](#cause-2-unresolvable-injections)
32-
* [4.2 What services are available for injection?](#What-services-are-available-for-injection)
33-
* [4.3 How can I override a provided object?](#How-can-I-override-a-provided-object)
34-
* [4.4 How do I provide singleton objects?](#How-do-I-provide-singleton-objects)
35-
* [4.5 Why am I getting a new instance of an object?](#Why-am-I-getting-a-new-instance-of-an-object)
36-
* [4.6 Why is my widget/part not displaying? Why am I getting a new Shell?](#Why-is-my-widget.2Fpart-not-displaying-Why-am-I-getting-a-new-Shell)
37-
* [4.7 Why am I being injected with _null_?](#Why-am-I-being-injected-with-null)
38-
* [4.8 Why aren't my parts being injected with my value set from my bundle activator?](#Why-aren.27t-my-parts-being-injected-with-my-value-set-from-my-bundle-activator)
39-
* [4.9 What is the difference between IEclipseContext#set and IEclipseContext#modify?](#what-is-the-difference-between-ieclipsecontextset-and-ieclipsecontextmodify)
40-
* [4.10 Why aren't my _@EventTopic_ or _@UIEventTopic_ methods being called?](#why-arent-my-eventtopic-or-uieventtopic-methods-being-called)
41-
* [5 Commands and Handlers](#Commands-and-Handlers)
42-
* [5.1 Why aren't my handler fields being re-injected?](#why-arent-my-handler-fields-being-re-injected)
43-
* [5.2 Why is my parameterized handler not triggered?](#Why-is-my-parameterized-handler-not-triggered)
44-
* [5.3 Why does org.eclipse.core.commands.Command's isEnabled() and getHandler() not work?](#why-does-orgeclipsecorecommandscommands-isenabled-and-gethandler-not-work)
45-
* [6 UI](#UI)
46-
* [6.1 How do I enable Drag N Drop (DND) of parts?](#how-do-i-enable-drag-n-drop-dnd-of-parts)
47-
* [6.2 Why are my CSS theming not taking effect?](#Why-are-my-CSS-theming-not-taking-effect)
48-
* [6.3 Why is my part's selection never set as the active selection?](#why-is-my-parts-selection-never-set-as-the-active-selection)
49-
* [7 Customizing and Controlling the Platform](#Customizing-and-Controlling-the-Platform)
50-
* [7.1 How do I provide my own prompt-to-save when closing a part?](#How-do-I-provide-my-own-prompt-to-save-when-closing-a-part)
514

525
Adopting the Eclipse 4 Application Platform
536
-------------------------------------------
@@ -233,7 +186,7 @@ Two approaches to help diagnose such problems:
233186

234187
### What services are available for injection?
235188

236-
See the [list of provided services](https://github.com/eclipse-platform/eclipse.platform.ui/blob/master/docs/Eclipse4_RCP_EAS_List_of_All_Provided_Services.md)
189+
See the [list of provided services](Eclipse4_RCP_EAS_List_of_All_Provided_Services.md)
237190

238191
### How can I override a provided object?
239192

0 commit comments

Comments
 (0)