Community
Participate
Working Groups
Plan Item: Update and extend documentation and FAQs
Since bug 285539 is fixed, the hint "For Max OS X systems, please add -Djava.awt.headless=true to your VM arguments." in the launch help should be removed.
From bug 250265: The CVS location of the custom widget example (GMaps widget) should be mentioned prominently at the beginning of the "Custom widget" help page
On the front-page of the CSS reference, put a description of the syntax of the more complex properties (e.g. animation, gradient). The one for animations goes here: Animation-Syntax reference -------------------------------- The syntax to define one animation is as follows: "animation-name animation-duration animation-timing-function". "animation-name": References an effect the widget supports: [List (and explanation?) of effects this specific widget supports]. "animation-duration": The duration of the effect in seconds ("s") or millisconds ("ms"). "animation-timing-function": Describes how the animation progresses over time. Valid values are "ease", "linear", "ease-in", "ease-out" and "ease-in-out". Any number of animations can be set at once, seperated by commas. To disables all animatons, set only "none".
The FAQ section "Exported WAR file does not work" [1] should be added to the "WAR Deployment" tutorial. It could be added as a paragraph of its own, entitled "Troubleshooting" or similar. [1] http://wiki.eclipse.org/RAP/FAQ#Exported_WAR_file_does_not_work
The following additions to our FAQ has been suggested in http://www.eclipse.org/forums/index.php?t=tree&th=42619&#page_top There are 2 things that I would include in the http://wiki.eclipse.org/RAP/FAQ#How_to_integrate_the_Eclipse_Help_System_in_a_RAP_application.3F, my suggestions are: The help system customization The help system customization (like help window title or home page) in a RAP application is simply done by using the org.eclipse.core.runtime.products extension. Even if this extension is not (yet?) fully supported by RAP, it is necessary to customize the help system. So: 1) add the following in the plugin.xml: <!-- Used only for customization of the help system --> <!-- "eclipse.product=my.plugin.help_id" must be set in config.ini --> <extension point="org.eclipse.core.runtime.products" id="help_id"> <product application="dummy" description="Integration With Eclipse Help System" name="%application.name"> <property name="preferenceCustomization" value="product_customization.ini"> </property> </product> </extension> 2) create the product_customization.ini file in the root folder of my.plugin and add the needed configuration as specified by the http://help.eclipse.org/help33/index.jsp?topic=/org.eclipse.platform.doc.isv/guide/ua_help_setup_preferences.htm. For example it could contain:# Toc ordering. Ordered list of help TOC's (books) as they would appear # on the bookshelf. All the other TOCS will be following these books. org.eclipse.help/baseTOCS=\ /my.plugin.ui.doc/toc.xml # help system home page org.eclipse.help.base/help_home=/my.plugin/doc/help_home.html 3) add the following VM argument to the launch configuration: -Declipse.product=my.plugin.help_id Building and deploying as web application In order to make the help system available when building and deploying the RAP application as a web application, the following setting must be added to the WEB-INF\web.xml:<init-param> <param-name>other.info</param-name> <param-value>org.eclipse.help</param-value> </init-param>(analogue to setting the -Dorg.eclipse.equinox.http.jetty.other.info=org.eclipse.help in the launch configuration) In order to add the help system customization when building and deploying the RAP application as a web application, the following setting must be added to the config.ini:eclipse.product=my.plugin.help_id(analogue to the -Declipse.product=my.plugin.help_id in the launch configuration.
Added instructions from comment 5 to FAQ, where they will be more useful than here.
