From f549088fc40fc43df101ac800323b213f8dd0b75 Mon Sep 17 00:00:00 2001 From: Ivan Furnadjiev Date: Tue, 4 Jun 2013 13:46:43 +0300 Subject: Update the documentation inside exsd files --- .../org.eclipse.rap.ui/schema/rap/branding.exsd | 29 +++++----- .../org.eclipse.rap.ui/schema/rap/entrypoint.exsd | 10 ++-- bundles/org.eclipse.rap.ui/schema/rap/layouts.exsd | 66 +++++++++++----------- .../schema/rap/phaselistener.exsd | 20 +++---- .../org.eclipse.rap.ui/schema/rap/resources.exsd | 15 +++-- .../schema/rap/serviceHandler.exsd | 29 +++++----- .../schema/rap/settingstores.exsd | 44 +++++++-------- .../schema/rap/stackPresentations.exsd | 30 +++++----- .../schema/rap/themeableWidgets.exsd | 28 +++++---- bundles/org.eclipse.rap.ui/schema/rap/themes.exsd | 32 +++++------ 10 files changed, 146 insertions(+), 157 deletions(-) diff --git a/bundles/org.eclipse.rap.ui/schema/rap/branding.exsd b/bundles/org.eclipse.rap.ui/schema/rap/branding.exsd index b019c1bf97..cfa8f802cd 100644 --- a/bundles/org.eclipse.rap.ui/schema/rap/branding.exsd +++ b/bundles/org.eclipse.rap.ui/schema/rap/branding.exsd @@ -6,7 +6,7 @@ - A branding adds customizations and styling to the UI of a RAP application. It can be used to set the title and icon displayed in the browser, or to apply a custom theme and styling. A branding is associated with a name and can be activated by using this name as the servlet name in the URL. + A branding adds customizations and styling to the UI of a RAP application. It can be used to set the title and icon displayed in the browser, or to apply a custom theme and styling. The branding is associated with <code>EntryPoint</code> or <code>IApplication</code> implementation. <p> Brandings can reside in a separate bundle, i.e. it is possible to brand applications without modifying their containing bundles. </p> @@ -26,21 +26,21 @@ Brandings can reside in a separate bundle, i.e. it is possible to brand applicat - + - + - + @@ -308,19 +308,16 @@ The icon should be in the .ico format for compatibility with all browsers. - <pre> +<pre> <extension - point="org.eclipse.rap.ui.branding"> - <branding - id="org.example.tea.teabranding" - servletName="tea" - defaultEntrypointId="org.example.tea.application" - themeId="org.example.tea.teatheme" - title="Tea Portal" - favicon="icons/favicon.ico" - body="body.html" - exitConfirmationClass="org.example.tea.ExitConfirmation"> - </branding> + point="org.eclipse.rap.ui.branding"> + <branding + id="org.example.tea.teabranding" + themeId="org.example.tea.teatheme" + title="Tea Portal" + favicon="icons/favicon.ico" + body="body.html" + </branding> </extension> </pre> diff --git a/bundles/org.eclipse.rap.ui/schema/rap/entrypoint.exsd b/bundles/org.eclipse.rap.ui/schema/rap/entrypoint.exsd index 11acb038b0..fdb45bdb77 100644 --- a/bundles/org.eclipse.rap.ui/schema/rap/entrypoint.exsd +++ b/bundles/org.eclipse.rap.ui/schema/rap/entrypoint.exsd @@ -29,21 +29,21 @@ As an alternative to registering an entrypoint, Eclipse applications can also us - + - + - + @@ -77,7 +77,7 @@ As an alternative to registering an entrypoint, Eclipse applications can also us - An implementation of <code>IEntryPoint</code> which starts the application. Either this attribute or applicationId must be specified. + An implementation of <code>EntryPoint</code> which starts the application. Either this attribute or applicationId must be specified. @@ -150,7 +150,7 @@ public class MyEntryPoint implements EntryPoint { - <pre> +<pre> <extension id="org.eclipse.rap.demo.demoentrypoint" point="org.eclipse.rap.ui.entrypoint"> diff --git a/bundles/org.eclipse.rap.ui/schema/rap/layouts.exsd b/bundles/org.eclipse.rap.ui/schema/rap/layouts.exsd index 832139215b..0821b932ac 100644 --- a/bundles/org.eclipse.rap.ui/schema/rap/layouts.exsd +++ b/bundles/org.eclipse.rap.ui/schema/rap/layouts.exsd @@ -26,21 +26,21 @@ The default Layout can be defined by contributing to the <code>org.eclipse - + - + - + @@ -97,14 +97,14 @@ The default Layout can be defined by contributing to the <code>org.eclipse - + The unique identifier for a Layout. - + This optional attribute is just to give the Layout a readable name. @@ -125,36 +125,36 @@ The default Layout can be defined by contributing to the <code>org.eclipse - The following is an example of a Layout with three LayoutSets: -<p> + The following is an example of a Layout with three LayoutSets: <pre> <extension - id="org.eclipse.presentation.example.layout" - name="Example Layout" - point="org.eclipse.ui.presentations.Layouts"> - <LayoutSet - class="org.eclipse.rap.ui.interactiondesign.example.layoutset.HeaderLayoutSet2" - id="header.layoutset" - name="Header2"> - </LayoutSet> - <LayoutSet - class="org.eclipse.rap.ui.interactiondesign.example.layoutset.MacBarLayoutSet2" - id="macBar.layoutset" - name="MacBar 2"> - </LayoutSet> - <LayoutSet - class="org.eclipse.rap.ui.interactiondesign.example.layoutset.FooterLayoutSet2" - id="footer.layoutset" - name="Footer"> - </LayoutSet> - <LayoutSet - class="org.eclipse.rap.ui.interactiondesign.example.layoutset.NavigationPaneLayoutSet2" - id="navigationpane.layoutset" - name="NavigationPane"> - </LayoutSet> - </extension> - </pre> - </p> + point="org.eclipse.rap.ui.layouts"> + <layout + id="org.eclipse.presentation.example.layout" + name="Example Layout"> + <layoutSet + class="org.eclipse.rap.ui.interactiondesign.example.layoutset.HeaderLayoutSet2" + id="header.layoutset" + name="Header2"> + </layoutSet> + <layoutSet + class="org.eclipse.rap.ui.interactiondesign.example.layoutset.MacBarLayoutSet2" + id="macBar.layoutset" + name="MacBar 2"> + </layoutSet> + <layoutSet + class="org.eclipse.rap.ui.interactiondesign.example.layoutset.FooterLayoutSet2" + id="footer.layoutset" + name="Footer"> + </layoutSet> + <layoutSet + class="org.eclipse.rap.ui.interactiondesign.example.layoutset.NavigationPaneLayoutSet2" + id="navigationpane.layoutset" + name="NavigationPane"> + </layoutSet> + </layout> +</extension> +</pre> diff --git a/bundles/org.eclipse.rap.ui/schema/rap/phaselistener.exsd b/bundles/org.eclipse.rap.ui/schema/rap/phaselistener.exsd index 806c49d027..37af416161 100644 --- a/bundles/org.eclipse.rap.ui/schema/rap/phaselistener.exsd +++ b/bundles/org.eclipse.rap.ui/schema/rap/phaselistener.exsd @@ -6,7 +6,7 @@ - The extension point is used to register a <code>PhaseListener</code> implementation. PhaseListeners are objects that are registered to be notified at the beginning and ending of each phase of the request processing lifecycle (see <code>ILifeCycle</code>). Extensions should provide a class that implements <code>org.eclipse.rap.rwt.lifecycle.PhaseListener</code>. + The extension point is used to register a <code>PhaseListener</code> implementation. PhaseListeners are objects that are registered to be notified at the beginning and ending of each phase of the request processing lifecycle (see <code>LifeCycle</code>). Extensions should provide a class that implements <code>org.eclipse.rap.rwt.lifecycle.PhaseListener</code>. @@ -23,21 +23,21 @@ - + - + - + @@ -52,7 +52,7 @@ - + @@ -76,14 +76,14 @@ - <pre> +<pre> <extension id="org.eclipse.rap.demo.phaselistenerextension" point="org.eclipse.rap.ui.phaselistener"> <entrypoint - id="org.eclipse.rap.demo.phaselistener" - class="org.eclipse.rap.demo.DemoPhaseListener" /> - </extension> + id="org.eclipse.rap.demo.phaselistener" + class="org.eclipse.rap.demo.DemoPhaseListener" /> +</extension> </pre> @@ -101,7 +101,7 @@ import org.eclipse.rap.rwt.lifecycle.*; public class DemoPhaseListener implements PhaseListener { - public void beforePhase( final PhaseEvent event ) { + public void beforePhase( PhaseEvent event ) { // ... RWT.getLifeCycle().removePhaseListener( this ); } diff --git a/bundles/org.eclipse.rap.ui/schema/rap/resources.exsd b/bundles/org.eclipse.rap.ui/schema/rap/resources.exsd index 84044af17f..4e05fd6a01 100644 --- a/bundles/org.eclipse.rap.ui/schema/rap/resources.exsd +++ b/bundles/org.eclipse.rap.ui/schema/rap/resources.exsd @@ -23,21 +23,21 @@ - + - + - + @@ -106,14 +106,13 @@ - <pre> +<pre> <extension - id="example.customwidget.customjs" - point="org.eclipse.rap.ui.resources"> - <resource class="example.customwidget.CustomJavaScriptResource"/> + id="example.customwidget.customjs" + point="org.eclipse.rap.ui.resources"> + <resource class="example.customwidget.CustomJavaScriptResource"/> </extension> </pre> - diff --git a/bundles/org.eclipse.rap.ui/schema/rap/serviceHandler.exsd b/bundles/org.eclipse.rap.ui/schema/rap/serviceHandler.exsd index 5c72041b12..92eebce7a5 100644 --- a/bundles/org.eclipse.rap.ui/schema/rap/serviceHandler.exsd +++ b/bundles/org.eclipse.rap.ui/schema/rap/serviceHandler.exsd @@ -26,21 +26,21 @@ A service handler can be accessed by a URL with a specific parameter. This URL c - + - + - + @@ -55,7 +55,7 @@ A service handler can be accessed by a URL with a specific parameter. This URL c - A unique ID for this service manager. This ID is used to obtain the URL to access the service manager. + A unique ID for this service handler. This ID is used to obtain the URL to access the service handler. @@ -88,18 +88,17 @@ A service handler can be accessed by a URL with a specific parameter. This URL c Here's an example of an extension that registers two service handlers: <pre> - <extension point="org.eclipse.rap.ui.serviceHandler"> - <serviceHandler - class="org.eclipse.rap.ui.impl.ServiceHandler1" - id="myHandler1"> - </serviceHandler> - <serviceHandler - class="org.eclipse.rap.ui.ServiceHandler2" - id="myHandler2"> - </serviceHandler> - </extension> +<extension point="org.eclipse.rap.ui.serviceHandler"> + <serviceHandler + class="org.eclipse.rap.ui.impl.ServiceHandler1" + id="myHandler1"> + </serviceHandler> + <serviceHandler + class="org.eclipse.rap.ui.ServiceHandler2" + id="myHandler2"> + </serviceHandler> +</extension> </pre> - diff --git a/bundles/org.eclipse.rap.ui/schema/rap/settingstores.exsd b/bundles/org.eclipse.rap.ui/schema/rap/settingstores.exsd index c4e8beb7d4..d52866510c 100644 --- a/bundles/org.eclipse.rap.ui/schema/rap/settingstores.exsd +++ b/bundles/org.eclipse.rap.ui/schema/rap/settingstores.exsd @@ -6,13 +6,13 @@ - This extension point allows developers to contribute additional <code>ISettingStore</code> instances. + This extension point allows developers to contribute additional <code>SettingStore</code> instances. <p> -An <code>ISettingStore</code> provides persistent storage for settings (key value pairs of Strings), which are then available beyond the scope of a single session. An <code>ISettingStoreFactory</code> is responsible for creating a particular kind of <code>ISettingStore</code>. +An <code>SettingStore</code> provides persistent storage for settings (key value pairs of Strings), which are then available beyond the scope of a single session. An <code>SettingStoreFactory</code> is responsible for creating a particular kind of <code>SettingStore</code>. <p> Developers that want to implement their own setting store must provide a setting store factory and register it with the framework using this extension point. <p> -Note that at runtime only <b>one</b> (out of all available) factories will be used to create new <code>ISettingStore</code> instances. Which factory is used can be controlled in two ways: +Note that at runtime only <b>one</b> (out of all available) factories will be used to create new <code>SettingStore</code> instances. Which factory is used can be controlled in two ways: <ul> <li>In a normal RAP deployment you can specify the factory to be used by placing the following property in the OSGi config.ini file: <code>org.eclipse.rap.rwt.settingStoreFactory=<i>id</i></code> where <i>id</i> identifies a particular factory element. Example: <pre> @@ -21,12 +21,12 @@ org.eclipse.rap.rwt.settingStoreFactory=file </li> <li>In an RWT-only deployment you can specify the factory to be used by placing the following snippet in the web.xml file:<br> <pre> -&lt;init-param&gt; - &lt;param-name&gt;org.eclipse.rap.rwt.settingStoreFactory&lt;/param-name&gt; - &lt;param-value&gt;org.eclipse.rap.rwt.service.FileSettingStoreFactory&lt;/param-value&gt; -&lt;/init-param&gt; +<init-param> + <param-name>org.eclipse.rap.rwt.settingStoreFactory</param-name> + <param-value>org.eclipse.rap.rwt.service.FileSettingStoreFactory</param-value> +</init-param> </pre> -<li>If nothing is specified, the class <code>WorkbenchFileSettingStoreFactory</code> will be used in a regular RAP deployment. In an RWT only deployment the class <code>RWTFileSettingStoreFactory</code> will be used instead.</li> +<li>If nothing is specified, the class <code>WorkbenchFileSettingStoreFactory</code> will be used in a regular RAP deployment. In an RWT only deployment the class <code>FileSettingStoreFactory</code> will be used instead.</li> </ul> @@ -112,18 +112,18 @@ org.eclipse.rap.rwt.settingStoreFactory=file - <pre> - <extension - point="org.eclipse.rap.ui.settingstores"> - <factory - class="org.eclipse.rap.ui.internal.preferences.WorkbenchFileSettingStoreFactory" - id="file"> - </factory> - <factory - class="org.eclipse.rap.rwt.service.FileSettingStoreFactory" - id="rwtfile"> - </factory> - </extension> +<pre> +<extension + point="org.eclipse.rap.ui.settingstores"> + <factory + class="org.eclipse.rap.ui.internal.preferences.WorkbenchFileSettingStoreFactory" + id="file"> + </factory> + <factory + class="org.eclipse.rap.rwt.service.FileSettingStoreFactory" + id="rwtfile"> + </factory> +</extension> </pre> @@ -135,7 +135,7 @@ org.eclipse.rap.rwt.settingStoreFactory=file To obtain a setting store use <code>RWT.getSettingStore()</code>. This will use the configured <code>org.eclipse.rap.rwt.service.SettingStoreFactory</code> to generate and return an appropriate <code>org.eclipse.rap.rwt.service.SettingStore</code> instance for this session. <p> -Developers wishing to provide their own setting store must implement <code>ISettingStore</code> and <code>ISettingStoreFactory</code> and contribute their factory using this extension point. +Developers wishing to provide their own setting store must implement <code>SettingStore</code> and <code>SettingStoreFactory</code> and contribute their factory using this extension point. @@ -146,7 +146,7 @@ Developers wishing to provide their own setting store must implement <code> RAP provides the following default implementations: <ul> -<li><code>WorkbenchFileSettingStoreFactory</code>, <code>RWTFileSettingStoreFactory</code> and <code>FileSettingStore</code> +<li><code>WorkbenchFileSettingStoreFactory</code>, <code>FileSettingStoreFactory</code> and <code>FileSettingStore</code> </li> </ul> diff --git a/bundles/org.eclipse.rap.ui/schema/rap/stackPresentations.exsd b/bundles/org.eclipse.rap.ui/schema/rap/stackPresentations.exsd index 65ad143651..6439770a50 100644 --- a/bundles/org.eclipse.rap.ui/schema/rap/stackPresentations.exsd +++ b/bundles/org.eclipse.rap.ui/schema/rap/stackPresentations.exsd @@ -25,21 +25,21 @@ You can define default StackPresentations for a part using the <code>org.e - + - + - + @@ -140,19 +140,19 @@ With this action you can implement configuration bahaviour e.g. this action can - <pre> +<pre> <extension - point="org.eclipse.ui.presentations.StackPresentations"> - <stackPresentation - actionClass="org.eclipse.rap.ui.interactiondesign.example.configaction.ExampleConfigAction" - actionIcon="icons/configure.png" - class="org.eclipse.rap.ui.interactiondesign.example.stacks.NavigationPaneStackPresentation" - id="org.eclipse.rap.ui.interactiondesign.navigationPaneStackPresentation" - menuIcon="icons/menuIcon.gif" - name="Navigation Pane" - type="view"> - </stackPresentation> -</extension> + point="org.eclipse.ui.presentations.StackPresentations"> + <stackPresentation + actionClass="org.eclipse.rap.ui.interactiondesign.example.configaction.ExampleConfigAction" + actionIcon="icons/configure.png" + class="org.eclipse.rap.ui.interactiondesign.example.stacks.NavigationPaneStackPresentation" + id="org.eclipse.rap.ui.interactiondesign.navigationPaneStackPresentation" + menuIcon="icons/menuIcon.gif" + name="Navigation Pane" + type="view"> + </stackPresentation> +</extension> </pre> diff --git a/bundles/org.eclipse.rap.ui/schema/rap/themeableWidgets.exsd b/bundles/org.eclipse.rap.ui/schema/rap/themeableWidgets.exsd index 09654d876b..35d73e3a28 100644 --- a/bundles/org.eclipse.rap.ui/schema/rap/themeableWidgets.exsd +++ b/bundles/org.eclipse.rap.ui/schema/rap/themeableWidgets.exsd @@ -29,21 +29,21 @@ None of these files are mandatory, files which are found are respected, but file - + - + - + @@ -101,18 +101,16 @@ None of these files are mandatory, files which are found are respected, but file - The following is an example of a themeable widget extension definition: -<p> + The following is an example of a themeable widget extension definition: <pre> - <extension - point="org.eclipse.rap.ui.themeableWidgets"> - <widget - id="my.custom.datepicker" - class="my.custom.controls.DatePicker"> - </widget> - </extension> +<extension + point="org.eclipse.rap.ui.themeableWidgets"> + <widget + id="my.custom.datepicker" + class="my.custom.controls.DatePicker"> + </widget> +</extension> </pre> -</p> @@ -121,7 +119,7 @@ None of these files are mandatory, files which are found are respected, but file - + @@ -130,7 +128,7 @@ None of these files are mandatory, files which are found are respected, but file - + diff --git a/bundles/org.eclipse.rap.ui/schema/rap/themes.exsd b/bundles/org.eclipse.rap.ui/schema/rap/themes.exsd index b00817d23a..b3814f67b6 100644 --- a/bundles/org.eclipse.rap.ui/schema/rap/themes.exsd +++ b/bundles/org.eclipse.rap.ui/schema/rap/themes.exsd @@ -7,7 +7,7 @@ This extension point is used to register custom RWT themes. -An RWT theme is used to customize the look and feel of applications built with the Rich Ajax Platform. To create a custom theme, a CSS file must be provided. With this file the styling of one ore more widgets can be customized. A list of themeable widgets and properties can be found in the "RAP Theming Reference". +An RWT theme is used to customize the look and feel of applications built with the Remote Application Platform. To create a custom theme, a CSS file must be provided. With this file the styling of one ore more widgets can be customized. A list of themeable widgets and properties can be found in the "RAP Theming Reference". It is also possible to register contributions to existing RWT themes. A theme contribution contains CSS rules that are appended to an existing theme. If more than one contributions are registered for the same theme, the order in which these contributions are appended is undefined. The user of this extension point must ensure that the rules specified in a theme contribution can not interfere with the rules in other theme contributions. Ideally, theme contributions contain only rules for custom variants. @@ -138,28 +138,24 @@ A theme contribution contains CSS rules that are appended to an existing theme. - The following is an example of a theme extension with a new theme: -<p> + The following is an example of a theme extension with a new theme: <pre> - <extension point="org.eclipse.rap.ui.themes"> - <theme - id="my.application.aquablue" - name="Aqua Blue Theme" - file="aqua-blue.css" /> - </extension> +<extension point="org.eclipse.rap.ui.themes"> + <theme + id="my.application.aquablue" + name="Aqua Blue Theme" + file="aqua-blue.css" /> +</extension> </pre> -</p> The following is an example of a theme extension that defines a contribution to an existing theme: -<p> <pre> - <extension point="org.eclipse.rap.ui.themes"> - <themeContribution - themeId="my.application.aquablue" - file="aqua-blue-additions.css" /> - </extension> +<extension point="org.eclipse.rap.ui.themes"> + <themeContribution + themeId="my.application.aquablue" + file="aqua-blue-additions.css" /> +</extension> </pre> -</p> @@ -169,7 +165,7 @@ The following is an example of a theme extension that defines a contribution to - The RAP demo plugin <code>org.eclipse.rap.demo</code> contains an example of a theme extension. + The RAP demo plugin <code>org.eclipse.rap.design.example</code> contains an example of a theme extension. -- cgit v1.2.1