From a2ca7336603d42b2778776ed904fd34baf68ba6e Mon Sep 17 00:00:00 2001 From: Brian de Alwis Date: Thu, 19 Nov 2015 14:32:48 -0500 Subject: Recover doc for 'execute' intro action: commit e473e78b modified the generated HTML rather than updating the source schema description. Change-Id: I4d29407856862585d682a24a1625c884457224d2 --- org.eclipse.ui.intro/schema/IntroContent.exsd | 8 +++++++- org.eclipse.ui.intro/schema/introContentFileSpec.html | 7 ++++++- 2 files changed, 13 insertions(+), 2 deletions(-) (limited to 'org.eclipse.ui.intro') diff --git a/org.eclipse.ui.intro/schema/IntroContent.exsd b/org.eclipse.ui.intro/schema/IntroContent.exsd index f6a4d2269..35b5de189 100644 --- a/org.eclipse.ui.intro/schema/IntroContent.exsd +++ b/org.eclipse.ui.intro/schema/IntroContent.exsd @@ -344,6 +344,12 @@ no parameters required<br> additional parameters - any additional parameters are passed to actions that implement <code>org.eclipse.ui.intro.config.IIntroAction</code><br> <br> +<b>execute</b> - executes the specified command. See the <code>serialize()</code> method on <code>org.eclipse.core.command.ParameterizedCommand</code> for details of the command serialization format. Since 3.2.<br> +<i>command</i> - a serialized <code>ParameterizedCommand</code><br> +<i>standby (optional) = ("true" + "false") "false"</i> - indicate whether to set the intro into standby mode after executing the action<br> +<br> + <b>setStandbyMode</b> - sets the state of the intro part<br> <i>standby = ("true" "false")</i> - true to put the intro part in its partially visible standy mode, and false to make it fully visible<br> @@ -374,7 +380,7 @@ no parameters required<br> <i>standby (optional) = ("true" "false") "false"</i> - indicate whether to set the intro into standby mode after showing the page<br><br> -If any of the parameters passed to these actions have special characters (ie: characters that are illegal in a URL), then they should be encoded using UTF-8 url encoding. To recieve these parametrs in there decoded state a special parameter, <i>decode = ("true" "false")</i> can be used to force a decode of these parameters when the Intro framework processes them.<br> +If any of the parameters passed to these actions have special characters (ie: characters that are illegal in a URL), then they should be encoded using UTF-8 url encoding. To receive these parametrs in there decoded state a special parameter, <i>decode = ("true" "false")</i> can be used to force a decode of these parameters when the Intro framework processes them.<br> For example, the following Intro url: <br><i> http://org.eclipse.ui.intro/showMessage?message=This+is+a+message</i><br> will process the message parameter as "This+is+a+message"<br> diff --git a/org.eclipse.ui.intro/schema/introContentFileSpec.html b/org.eclipse.ui.intro/schema/introContentFileSpec.html index e584aa1f4..2bcea00ee 100644 --- a/org.eclipse.ui.intro/schema/introContentFileSpec.html +++ b/org.eclipse.ui.intro/schema/introContentFileSpec.html @@ -143,6 +143,11 @@ no parameters required
additional parameters - any additional parameters are passed to actions that implement org.eclipse.ui.intro.config.IIntroAction

+execute - executes the specified command. See the serialize() method on org.eclipse.core.command.ParameterizedCommand for details of the command serialization format. Since 3.2.
+command - a serialized ParameterizedCommand
+standby (optional) = ("true" | "false") "false" - indicate whether to set the intro into standby mode after executing the command
+
+ setStandbyMode - sets the state of the intro part
standby = ("true" "false") - true to put the intro part in its partially visible standy mode, and false to make it fully visible
@@ -173,7 +178,7 @@ no parameters required
standby (optional) = ("true" "false") "false" - indicate whether to set the intro into standby mode after showing the page

-If any of the parameters passed to these actions have special characters (ie: characters that are illegal in a URL), then they should be encoded using UTF-8 url encoding. To recieve these parametrs in there decoded state a special parameter, decode = ("true" "false") can be used to force a decode of these parameters when the Intro framework processes them.
+If any of the parameters passed to these actions have special characters (ie: characters that are illegal in a URL), then they should be encoded using UTF-8 url encoding. To receive these parametrs in there decoded state a special parameter, decode = ("true" "false") can be used to force a decode of these parameters when the Intro framework processes them.
For example, the following Intro url:
http://org.eclipse.ui.intro/showMessage?message=This+is+a+message
will process the message parameter as "This+is+a+message"
-- cgit v1.2.3