Skip to content

Commit

Permalink
Correct formating issues in markdown documentation
Browse files Browse the repository at this point in the history 
Command_Core_Expressions, CSS, Eclipse4_RCP_Dependency_Injection,
Eclipse4_RCP_EAS_List_of_All_Provided_Services, Eclipse_Corner,
EclipsePluginDevelopmentFAQ, Event_Processing and JFace
  • Loading branch information
@jnerlich @vogella
jnerlich authored and vogella committed Mar 8, 2024
1 parent 287d23a commit 26f3f3f
Show file tree
Hide file tree
Showing 8 changed files with 58 additions and 60 deletions.
3 changes: 1 addition & 2 deletions docs/CSS.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ Contents
* [3.5 Widget: CTabItem](#Widget-CTabItem)
* [3.6 Widget: CTabFolder with e4Renderer](#Widget-CTabFolder-with-e4Renderer)
* [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)
* [3 Customize](#Customize)
* [4 Using CSS in Eclipse 3.x releases](#Using-CSS-in-Eclipse-3.6)
* [3 Using CSS in Eclipse 3.6](#Using-CSS-in-Eclipse-36)

Overview
--------
Expand Down
2 changes: 1 addition & 1 deletion docs/Command_Core_Expressions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Contents
* [4.2 Package Explorer IStructuredSelection](#Package-Explorer-IStructuredSelection)
* [4.3 Active editor type](#Active-editor-type)
* [4.4 Complex nested boolean expressions](#Complex-nested-boolean-expressions)
* [5 New Core Expressions in 3.3](#New-Core-Expressions-in-3.3)
* [5 New Core Expressions in 3.3](#New-Core-Expressions-in-33)
* [5.1 count and iterate](#count-and-iterate)
* [5.2 definitions](#definitions)

Expand Down
11 changes: 5 additions & 6 deletions docs/Eclipse4_RCP_Dependency_Injection.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ Contents

* [1 Overview](#Overview)
* [2 Standard Annotations and Classes](#Standard-Annotations-and-Classes)
* [2.1 @Inject (javax.inject)](#inject-javaxinject)
* [2.2 @Named (javax.inject)](#named-javaxinject)
* [2.3 @Singleton (javax.inject)](#singleton-javaxinject)
* [2.4 Provider<T> (javax.inject)](#provider-javaxinject)
* [2.5 @PostConstruct, @PreDestroy (javax.annotation)](#postconstruct-predestroy-javaxannotation)
* [2.1 @Inject (jakarta.inject)](#inject-jakartainject)
* [2.2 @Named (jakarta.inject)](#named-jakartainject)
* [2.3 @Singleton (jakarta.inject)](#singleton-jakartainject)
* [2.4 Provider (javax.inject)](#provider-javaxinject)
* [2.5 @PostConstruct (jakarta.annotation), @PreDestroy(jakarta.annotation)](#postconstruct-jakartaannotation-predestroyjakartaannotation)
* [3 E4AP-specific Annotations](#e4ap-specific-annotations)
* [3.1 @Optional (org.eclipse.e4.core.di.annotations)](#optional-orgeclipsee4corediannotations)
* [3.2 @Active (org.eclipse.e4.core.contexts)](#active-orgeclipsee4corecontexts)
Expand All @@ -30,7 +30,6 @@ Contents
* [6 Considerations](#Considerations)
* [7 Current Caveats](#Current-Caveats)
* [8 Design Decisions](#Design-Decisions)
* [8 References](#References)

Overview
========
Expand Down
2 changes: 1 addition & 1 deletion docs/Eclipse4_RCP_EAS_List_of_All_Provided_Services.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Contents
* [3.1 Model Info](#Model-Info-2)
* [3.2 Services](#Services-3)
* [4 Handler Execution](#Handler-Execution)
* [5 Eclipse 3.x Compatibility Layer](#Eclipse-3.x-Compatibility-Layer)
* [5 Eclipse 3.x Compatibility Layer](#Eclipse-3x-Compatibility-Layer)
* [5.1 Application Context](#Application-Context-2)
* [5.1.1 Application Parameters](#Application-Parameters-2)
* [5.1.2 Model Info](#Model-Info-3)
Expand Down
90 changes: 45 additions & 45 deletions docs/EclipsePluginDevelopmentFAQ.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,56 +11,56 @@ Contents
--------

* [1 General Development](#General-Development)
* [1.1 How do I find a class from Eclipse?](#How-do-I-find-a-class-from-Eclipse.3F)
* [1.2 I see these $NON-NLS-1$ tags all over the place when I'm browsing Eclipse's source code? What do they mean?](#I-see-these-.24NON-NLS-1.24-tags-all-over-the-place-when-I.27m-browsing-Eclipse.27s-source-code.3F-What-do-they-mean.3F)
* [1.3 I need help debugging my plug-in...](#I-need-help-debugging-my-plug-in...)
* [1.4 I'm using third party jar files and my plug-in is not working](#I.27m-using-third-party-jar-files-and-my-plug-in-is-not-working)
* [1.5 What is the IAdaptable interface?](#What-is-the-IAdaptable-interface.3F)
* [1.6 How do I read from a file that I've included in my bundle/plug-in?](#How-do-I-read-from-a-file-that-I.27ve-included-in-my-bundle.2Fplug-in.3F)
* [1.7 Where do I find the javadoc for the Eclipse API locally? I don't always want to load stuff up in a browser.](#Where-do-I-find-the-javadoc-for-the-Eclipse-API-locally.3F-I-don.27t-always-want-to-load-stuff-up-in-a-browser.)
* [1.8 A plug-in in my 'Eclipse Application' launch configuration is listed as being "out of sync", what should I do?](#A-plug-in-in-my-.27Eclipse-Application.27-launch-configuration-is-listed-as-being-.22out-of-sync.22.2C-what-should-I-do.3F)
* [1.9 How do I include native libraries in my bundle?](#How-do-I-include-native-libraries-in-my-bundle.3F)
* [1.1 How do I find a class from Eclipse?](#How-do-I-find-a-class-from-Eclipse)
* [1.2 I see these $NON-NLS-1$ tags all over the place when I'm browsing Eclipse's source code? What do they mean?](#i-see-these-non-nls-1-tags-all-over-the-place-when-im-browsing-eclipses-source-code-what-do-they-mean)
* [1.3 I need help debugging my plug-in...](#I-need-help-debugging-my-plug-in)
* [1.4 I'm using third party jar files and my plug-in is not working](#Im-using-third-party-jar-files-and-my-plug-in-is-not-working)
* [1.5 What is the IAdaptable interface?](#What-is-the-IAdaptable-interface)
* [1.6 How do I read from a file that I've included in my bundle/plug-in?](#How-do-I-read-from-a-file-that-Ive-included-in-my-bundleplug-in)
* [1.7 Where do I find the javadoc for the Eclipse API locally? I don't always want to load stuff up in a browser.](#Where-do-I-find-the-javadoc-for-the-Eclipse-API-locally-I-dont-always-want-to-load-stuff-up-in-a-browser)
* [1.8 A plug-in in my 'Eclipse Application' launch configuration is listed as being "out of sync", what should I do?](#a-plug-in-in-my-eclipse-application-launch-configuration-is-listed-as-being-out-of-sync-what-should-i-do)
* [1.9 How do I include native libraries in my bundle?](#How-do-I-include-native-libraries-in-my-bundle)
* [2 User Interface](#User-Interface)
* [2.1 There's a view / editor that I want to model. How do I find out what its source looks like and how it was designed?](#There.27s-a-view-.2F-editor-that-I-want-to-model.-How-do-I-find-out-what-its-source-looks-like-and-how-it-was-designed.3F)
* [2.2 There's a preference / property page that I want to model. How do I find out what its source looks like and how it was designed?](#There.27s-a-preference-.2F-property-page-that-I-want-to-model.-How-do-I-find-out-what-its-source-looks-like-and-how-it-was-designed.3F)
* [2.3 There's a window / dialog / popup that I want to model. How do I find out what its source looks like and how it was designed?](#There.27s-a-window-.2F-dialog-.2F-popup-that-I-want-to-model.-How-do-I-find-out-what-its-source-looks-like-and-how-it-was-designed.3F)
* [2.4 There's a wizard page that I want to model. How do I find out what its source looks like and how it was designed?](#There.27s-a-wizard-page-that-I-want-to-model.-How-do-I-find-out-what-its-source-looks-like-and-how-it-was-designed.3F)
* [2.5 How can I leverage the 'Outline' view?](#How-can-I-leverage-the-.27Outline.27-view.3F)
* [2.6 How can I show the perspective bar in my RCP application?](#How-can-I-show-the-perspective-bar-in-my-RCP-application.3F)
* [2.7 How do I get the perspective bar to show on the top right corner?](#How-do-I-get-the-perspective-bar-to-show-on-the-top-right-corner.3F)
* [2.8 How do I warn the user that a workbench part that is not currently visible has changed?](#How-do-I-warn-the-user-that-a-workbench-part-that-is-not-currently-visible-has-changed.3F)
* [2.9 How can I make use of the workbench's browser capabilities?](#How-can-I-make-use-of-the-workbench.27s-browser-capabilities.3F)
* [2.10 How do I retrieve the id of a preference page?](#How-do-I-retrieve-the-id-of-a-preference-page.3F)
* [2.11 How do I ask my decorator to decorate items?](#How-do-I-ask-my-decorator-to-decorate-items.3F)
* [2.12 How do I get the icon associated with a file or content type?](#How-do-I-get-the-icon-associated-with-a-file-or-content-type.3F)
* [2.13 How do I set the selection of an editor or view?](#How-do-I-set-the-selection-of-an-editor-or-view.3F)
* [2.14 How do I get the selection of an editor or view?](#How-do-I-get-the-selection-of-an-editor-or-view.3F)
* [2.15 How do I get progress feedback in the status bar in my RCP application?](#How-do-I-get-progress-feedback-in-the-status-bar-in-my-RCP-application.3F)
* [2.16 How do I make a New / Import / Export Wizard appear in the context menu of the Project Explorer?](#How-do-I-make-a-New-.2F-Import-.2F-Export-Wizard-appear-in-the-context-menu-of-the-Project-Explorer.3F)
* [2.17 How do I show a message dialogue for exceptions and log them?](#How-do-I-show-a-message-dialogue-for-exceptions-and-log-them.3F)
* [2.1 There's a view / editor that I want to model. How do I find out what its source looks like and how it was designed?](#theres-a-view--editor-that-i-want-to-model-how-do-i-find-out-what-its-source-looks-like-and-how-it-was-designed)
* [2.2 There's a preference / property page that I want to model. How do I find out what its source looks like and how it was designed?](#theres-a-preference--property-page-that-i-want-to-model-how-do-i-find-out-what-its-source-looks-like-and-how-it-was-designed)
* [2.3 There's a window / dialog / popup that I want to model. How do I find out what its source looks like and how it was designed?](#theres-a-window--dialog--popup-that-i-want-to-model-how-do-i-find-out-what-its-source-looks-like-and-how-it-was-designed)
* [2.4 There's a wizard page that I want to model. How do I find out what its source looks like and how it was designed?](#Theres-a-wizard-page-that-I-want-to-model-How-do-I-find-out-what-its-source-looks-like-and-how-it-was-designed)
* [2.5 How can I leverage the 'Outline' view?](#how-can-i-leverage-the-outline-view)
* [2.6 How can I show the perspective bar in my RCP application?](#How-can-I-show-the-perspective-bar-in-my-RCP-application)
* [2.7 How do I get the perspective bar to show on the top right corner?](#How-do-I-get-the-perspective-bar-to-show-on-the-top-right-corner)
* [2.8 How do I warn the user that a workbench part that is not currently visible has changed?](#How-do-I-warn-the-user-that-a-workbench-part-that-is-not-currently-visible-has-changed)
* [2.9 How can I make use of the workbench's browser capabilities?](#How-can-I-make-use-of-the-workbenchs-browser-capabilities)
* [2.10 How do I retrieve the id of a preference page?](#How-do-I-retrieve-the-id-of-a-preference-page)
* [2.11 How do I ask my decorator to decorate items?](#How-do-I-ask-my-decorator-to-decorate-items)
* [2.12 How do I get the icon associated with a file or content type?](#How-do-I-get-the-icon-associated-with-a-file-or-content-type)
* [2.13 How do I set the selection of an editor or view?](#How-do-I-set-the-selection-of-an-editor-or-view)
* [2.14 How do I get the selection of an editor or view?](#How-do-I-get-the-selection-of-an-editor-or-view)
* [2.15 How do I get progress feedback in the status bar in my RCP application?](#How-do-I-get-progress-feedback-in-the-status-bar-in-my-RCP-application)
* [2.16 How do I make a New / Import / Export Wizard appear in the context menu of the Project Explorer?](#how-do-i-make-a-new--import--export-wizard-appear-in-the-context-menu-of-the-project-explorer)
* [2.17 How do I show a message dialogue for exceptions and log them?](#How-do-I-show-a-message-dialogue-for-exceptions-and-log-them)
* [2.18 How do I launch a dialogue from a non-ui thread and get a return value](#How-do-I-launch-a-dialogue-from-a-non-ui-thread-and-get-a-return-value)
* [2.19 How do I make a title area dialogue with radio buttons?](#How-do-I-make-a-title-area-dialogue-with-radio-buttons.3F)
* [2.19 How do I make a title area dialogue with radio buttons?](#How-do-I-make-a-title-area-dialogue-with-radio-buttons)
* [3 Editors](#Editors)
* [3.1 How do I add those rectangles in my source editor like what JDT does for parameter names during code completion?](#How-do-I-add-those-rectangles-in-my-source-editor-like-what-JDT-does-for-parameter-names-during-code-completion.3F)
* [3.2 How do I implement a 'Quick Outline' for my editor?](#How-do-I-implement-a-.27Quick-Outline.27-for-my-editor.3F)
* [3.3 How do I get an editor's StyledText widget?](#How-do-I-get-an-editor.27s-StyledText-widget.3F)
* [3.4 How can I get the IDocument from an editor?](#How-can-I-get-the-IDocument-from-an-editor.3F)
* [3.5 How do I get an IFile given an IEditorPart or IEditorInput?](#How-do-I-get-an-IFile-given-an-IEditorPart-or-IEditorInput.3F)
* [3.6 How do I hide the tabs of a MultiPageEditorPart if it only has one page?](#How-do-I-hide-the-tabs-of-a-MultiPageEditorPart-if-it-only-has-one-page.3F)
* [3.7 How do I change the editor that is being opened when a marker has been opened?](#How-do-I-change-the-editor-that-is-being-opened-when-a-marker-has-been-opened.3F)
* [3.8 How can I make my editor respond to a user opening a marker?](#How-can-I-make-my-editor-respond-to-a-user-opening-a-marker.3F)
* [3.9 Why does the workbench keep opening a new editor every time I open a marker?](#Why-does-the-workbench-keep-opening-a-new-editor-every-time-I-open-a-marker.3F)
* [3.10 How should I let my editor know that its syntax colours have changed?](#How-should-I-let-my-editor-know-that-its-syntax-colours-have-changed.3F)
* [3.11 How do I close one/all of my editors upon workbench shutdown so that it won't appear upon workbench restart?](#How-do-I-close-one.2Fall-of-my-editors-upon-workbench-shutdown-so-that-it-won.27t-appear-upon-workbench-restart.3F)
* [3.12 How do I prevent a particular editor from being restored on the next workbench startup?](#How-do-I-prevent-a-particular-editor-from-being-restored-on-the-next-workbench-startup.3F)
* [3.1 How do I add those rectangles in my source editor like what JDT does for parameter names during code completion?](#How-do-I-add-those-rectangles-in-my-source-editor-like-what-JDT-does-for-parameter-names-during-code-completion)
* [3.2 How do I implement a 'Quick Outline' for my editor?](#How-do-I-implement-a-Quick-Outline-for-my-editor)
* [3.3 How do I get an editor's StyledText widget?](#How-do-I-get-an-editors-StyledText-widget)
* [3.4 How can I get the IDocument from an editor?](#How-can-I-get-the-IDocument-from-an-editor)
* [3.5 How do I get an IFile given an IEditorPart or IEditorInput?](#How-do-I-get-an-IFile-given-an-IEditorPart-or-IEditorInput)
* [3.6 How do I hide the tabs of a MultiPageEditorPart if it only has one page?](#How-do-I-hide-the-tabs-of-a-MultiPageEditorPart-if-it-only-has-one-page)
* [3.7 How do I change the editor that is being opened when a marker has been opened?](#How-do-I-change-the-editor-that-is-being-opened-when-a-marker-has-been-opened)
* [3.8 How can I make my editor respond to a user opening a marker?](#How-can-I-make-my-editor-respond-to-a-user-opening-a-marker)
* [3.9 Why does the workbench keep opening a new editor every time I open a marker?](#Why-does-the-workbench-keep-opening-a-new-editor-every-time-I-open-a-marker)
* [3.10 How should I let my editor know that its syntax colours have changed?](#How-should-I-let-my-editor-know-that-its-syntax-colours-have-changed)
* [3.11 How do I close one/all of my editors upon workbench shutdown so that it won't appear upon workbench restart?](#How-do-I-close-oneall-of-my-editors-upon-workbench-shutdown-so-that-it-wont-appear-upon-workbench-restart)
* [3.12 How do I prevent a particular editor from being restored on the next workbench startup?](#How-do-I-prevent-a-particular-editor-from-being-restored-on-the-next-workbench-startup)
* [4 Debug](#Debug)
* [4.1 How do I invoke a process and have its output managed by the 'Console' view?](#How-do-I-invoke-a-process-and-have-its-output-managed-by-the-.27Console.27-view.3F)
* [4.2 How do I associate my executed process with its command line counterpart?](#How-do-I-associate-my-executed-process-with-its-command-line-counterpart.3F)
* [4.3 How do I capture the output of my launched application like the 'Console' view?](#How-do-I-capture-the-output-of-my-launched-application-like-the-.27Console.27-view.3F)
* [4.4 How do I run Eclipse launch configurations programmatically?](#How-do-I-run-Eclipse-launch-configurations-programmatically.3F)
* [4.1 How do I invoke a process and have its output managed by the 'Console' view?](#How-do-I-invoke-a-process-and-have-its-output-managed-by-the-Console-view)
* [4.2 How do I associate my executed process with its command line counterpart?](#How-do-I-associate-my-executed-process-with-its-command-line-counterpart)
* [4.3 How do I capture the output of my launched application like the 'Console' view?](#How-do-I-capture-the-output-of-my-launched-application-like-the-Console-view)
* [4.4 How do I run Eclipse launch configurations programmatically?](#How-do-I-run-Eclipse-launch-configurations-programmatically)
* [5 Release](#Release)
* [5.1 How do I make a p2 repository?](#How-do-I-make-a-p2-repository.3F)
* [5.2 How do I add files to the root of the installation directory?](#How-do-I-add-files-to-the-root-of-the-installation-directory.3F)
* [5.1 How do I make a p2 repository?](#How-do-I-make-a-p2-repository)
* [5.2 How do I add files to the root of the installation directory?](#How-do-I-add-files-to-the-root-of-the-installation-directory)

General Development
-------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/Eclipse_Corner.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Contents
* [24 Build and Test Automation for plug-ins and features](#Build-and-Test-Automation-for-plug-ins-and-features)
* [25 Using OpenGL with SWT](#Using-OpenGL-with-SWT)
* [26 Folding in Eclipse Text Editors](#Folding-in-Eclipse-Text-Editors)
* [27 Eclipse User Interface Guidelines: Version 2.1](#Eclipse-User-Interface-Guidelines-Version-2.1)
* [27 Eclipse User Interface Guidelines: Version 2.1](#Eclipse-User-Interface-Guidelines-Version-21)
* [28 Modeling Rule-Based Systems with EMF](#Modeling-Rule-Based-Systems-with-EMF)
* [29 Building Administrative Applications in Eclipse](#Building-Administrative-Applications-in-Eclipse)
* [30 EMF goes RCP](#EMF-goes-RCP)
Expand Down
2 changes: 1 addition & 1 deletion docs/Event_Processing.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Contents
--------

* [1 Event Notifications in E4](#Event-Notifications-in-Eclipse)
* [2 What is the Problem with the observer pattern?](#What-is-the-Problem-the-observer-pattern)
* [2 What is the Problem with the observer pattern?](#what-is-the-problem-with-the-observer-pattern)
* [3 Using publish and subscribe](#Using-publish-and-subscribe)
* [4 Eclipse-specific design parameters](#Eclipse-specific-design-parameters)
* [5 EventAdmin: pros and cons](#EventAdmin-pros-and-cons)
Expand Down
6 changes: 3 additions & 3 deletions docs/JFace.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ Contents
* [2 Using JFace outside the Eclipse platform](#Using-JFace-outside-the-Eclipse-platform)
* [2.1 Setting Up an Eclipse Project to use SWT and JFace](#Setting-Up-an-Eclipse-Project-to-use-SWT-and-JFace)
* [2.2 Identify the Required External JAR Files for SWT and JFace](#Identify-the-Required-External-JAR-Files-for-SWT-and-JFace)
* [2.3 Create the Eclipse SWT/JFace Project](#Create-the-Eclipse-SWT.2FJFace-Project)
* [2.4 Add the org.eclipse.swt Project to Your Java Project](#Add-the-org.eclipse.swt-Project-to-Your-Java-Project)
* [2.5 Test Your org.eclipse.swt Project](#Test-Your-org.eclipse.swt-Project)
* [2.3 Create the Eclipse SWT/JFace Project](#Create-the-Eclipse-SWTJFace-Project)
* [2.4 Add the org.eclipse.swt Project to Your Java Project](#Add-the-orgeclipseswt-Project-to-Your-Java-Project)
* [2.5 Test Your org.eclipse.swt Project](#Test-Your-orgeclipseswt-Project)
* [2.6 Deploying a Java Program That Uses SWT and JFace](#Deploying-a-Java-Program-That-Uses-SWT-and-JFace)
* [2.6.1 Step by Step Instructions](#Step-by-Step-Instructions)
* [2.6.2 Troubleshooting Errors](#Troubleshooting-Errors)
Expand Down

0 comments on commit 26f3f3f

Please sign in to comment.