Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjeem2004-06-03 18:20:46 +0000
committerjeem2004-06-03 18:20:46 +0000
commitbbb66468a5897617eb7eb0daa778d6ce871f9665 (patch)
treebf570824fd772587b67f251013559e49daf19270 /org.eclipse.ui.cheatsheets/schema
parent2ef2855771508d90666bbfcc9d23c685dcfad0c2 (diff)
downloadeclipse.platform.ua-bbb66468a5897617eb7eb0daa778d6ce871f9665.tar.gz
eclipse.platform.ua-bbb66468a5897617eb7eb0daa778d6ce871f9665.tar.xz
eclipse.platform.ua-bbb66468a5897617eb7eb0daa778d6ce871f9665.zip
Improve ext pt schema doc
Diffstat (limited to 'org.eclipse.ui.cheatsheets/schema')
-rw-r--r--org.eclipse.ui.cheatsheets/schema/org.eclipse.ui.cheatsheets.cheatSheetContent.exsd61
-rw-r--r--org.eclipse.ui.cheatsheets/schema/org.eclipse.ui.cheatsheets.cheatSheetItemExtension.exsd46
2 files changed, 34 insertions, 73 deletions
diff --git a/org.eclipse.ui.cheatsheets/schema/org.eclipse.ui.cheatsheets.cheatSheetContent.exsd b/org.eclipse.ui.cheatsheets/schema/org.eclipse.ui.cheatsheets.cheatSheetContent.exsd
index 364c7aa58..8afc0e96a 100644
--- a/org.eclipse.ui.cheatsheets/schema/org.eclipse.ui.cheatsheets.cheatSheetContent.exsd
+++ b/org.eclipse.ui.cheatsheets/schema/org.eclipse.ui.cheatsheets.cheatSheetContent.exsd
@@ -3,7 +3,7 @@
<schema targetNamespace="org.eclipse.ui.cheatsheets">
<annotation>
<appInfo>
- <meta.schema plugin="org.eclipse.ui.cheatsheets" id="cheatSheetContent" name="CheatSheetContent"/>
+ <meta.schema plugin="org.eclipse.ui.cheatsheets" id="cheatSheetContent" name="Cheat Sheet Content"/>
</appInfo>
<documentation>
This extension point is used to register cheat sheet content contributions. Cheat sheets appear as choices from the &quot;Help&quot; menu or from within the cheat sheet view, and are typically used to aid a user through a series of comlex tasks to accomplish an overall goal.
@@ -161,26 +161,26 @@ The content file is parsed at run time by the cheat sheet framework. Based on th
<meta.section type="examples"/>
</appInfo>
<documentation>
- Here is a sample usage of the cheatsheetContent extension point.
-
+ Here is a sample usage of the cheatSheetContent extension point:
+&lt;p&gt;
+&lt;pre&gt;
&lt;extension point=&quot;org.eclipse.ui.cheatsheets.cheatSheetContent&quot;&gt;
- &lt;!-- this is a sample category. the id can be referenced in the cheatsheet element --&gt;
- &lt;!-- the name is displayed in the selection dialog and should be translatable --&gt;
&lt;category
- name=&quot;XYZ category&quot;
- id=&quot;com.org.xyz.category&quot;&gt;
- &lt;/category&gt;
- &lt;!-- this is a sample cheat sheet. the content file describes the cheat sheet steps and is loaded by the framework. --&gt;
- &lt;cheatsheet
- name=&quot;XYZ cheat sheet&quot;
- category=&quot;com.org.xyz.category&quot;
- id=&quot;com.org.xyz.cheatSheet&quot;
- contentFile=&quot;XYZCheatSheet.xml&quot;&gt;
+ name=&quot;Example category&quot;
+ id=&quot;com.example.category&quot;&gt;
+ &lt;/category&gt;
+ &lt;cheatsheet
+ name=&quot;Example cheat sheet&quot;
+ category=&quot;com.example.category&quot;
+ id=&quot;com.example.cheatSheet&quot;
+ contentFile=&quot;ExampleCheatSheet.xml&quot;&gt;
&lt;description&gt;
This is a descriptive bit of text for my cheat sheet description.
&lt;/description&gt;
- &lt;/cheatsheet&gt;
+ &lt;/cheatsheet&gt;
&lt;/extension&gt;
+&lt;/pre&gt;
+&lt;/p&gt;
</documentation>
</annotation>
@@ -189,24 +189,7 @@ The content file is parsed at run time by the cheat sheet framework. Based on th
<meta.section type="apiInfo"/>
</appInfo>
<documentation>
- See the cheat sheet Javadoc specs for full API information.
-
-The main API&apos;s available are:
-
- - Action to open a cheat sheet with an id, or a content file URL.
- - Live help action to open a cheat sheet with an id from a live help link in a help book.
-
- - Interfaces for:
- -Actions: ICheatsheetAction
- Allows for parameters to be passed to actions when they are run in a cheat sheet.
- Parameters can be set in the cheat sheet content file or passed in at run time.
-
- -ICheatsheetManager:
- Implementation passed to actions implementing ICheatsheetAction and also passed in events
- fired to cheat sheet listeners. Allows for data to be stored and retrieved for a particular cheat sheet.
-
- - Other interfaces:
- All other interfaces relate to cheat sheet listeners and events.
+ For further details see the spec for the org.eclipse.ui.cheatsheets API package.
</documentation>
</annotation>
@@ -224,16 +207,8 @@ The main API&apos;s available are:
<meta.section type="copyright"/>
</appInfo>
<documentation>
- /************************************************************************
- * Copyright (c) 2004 IBM Corporation and others.
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Common Public License v1.0
- * which accompanies this distribution, and is available at
- * http://www.eclipse.org/legal/cpl-v10.html
- *
- * Contributors:
- * IBM Corporation - Initial API and implementation
- *************************************************************************/
+ Copyright (c) 2004 IBM Corporation and others.
+All rights reserved. This program and the accompanying materials are made available under the terms of the Common Public License v1.0 which accompanies this distribution, and is available at &lt;a href=&quot;http://www.eclipse.org/legal/cpl-v10.html&quot;&gt;http://www.eclipse.org/legal/cpl-v10.html&lt;/a&gt;
</documentation>
</annotation>
diff --git a/org.eclipse.ui.cheatsheets/schema/org.eclipse.ui.cheatsheets.cheatSheetItemExtension.exsd b/org.eclipse.ui.cheatsheets/schema/org.eclipse.ui.cheatsheets.cheatSheetItemExtension.exsd
index 38b6b1d7e..9f5333e0c 100644
--- a/org.eclipse.ui.cheatsheets/schema/org.eclipse.ui.cheatsheets.cheatSheetItemExtension.exsd
+++ b/org.eclipse.ui.cheatsheets/schema/org.eclipse.ui.cheatsheets.cheatSheetItemExtension.exsd
@@ -3,7 +3,7 @@
<schema targetNamespace="org.eclipse.ui.cheatsheets">
<annotation>
<appInfo>
- <meta.schema plugin="org.eclipse.ui.cheatsheets" id="cheatSheetItemExtension" name="cheatSheetItemExtension"/>
+ <meta.schema plugin="org.eclipse.ui.cheatsheets" id="cheatSheetItemExtension" name="Cheat Sheet Item Extension"/>
</appInfo>
<documentation>
This extension point should be used when an extra button needs to be added to a step in the cheat sheet.
@@ -91,32 +91,26 @@ You specify the name of an attribute that you will put into the cheat sheet item
</appInfo>
<documentation>
Here is an example implementation of this extension point:
-
+&lt;p&gt;
+&lt;pre&gt;
&lt;extension point=&quot;org.eclipse.ui.cheatsheets.cheatSheetItemExtension&quot;&gt;
&lt;itemExtension
itemAttribute=&quot;xyzButton&quot;
- class=&quot;com.org.xyz.HandleParsingAndAddButton&quot;&gt;
+ class=&quot;com.example.HandleParsingAndAddButton&quot;&gt;
&lt;/itemExtension&gt;
&lt;/extension&gt;
-
-
---------------------------------------------------------------------------------------
-
-And here is the item attribute for that extension :
-
-&lt;item
- id = &quot;0&quot;
- title=&quot;XYZ Title&quot;
- xyzButton=&quot;/icon/button.gif&quot;
- actionphrase=&quot;0,1&quot;
- class=&quot;com.org.xyz.XYZAction&quot;
- pluignId=&quot;com.org.xyz.plugin&quot;&gt;
-&lt;/item&gt;
-
-Note that the value of the attribute in the item tag can be ANYTHING. It can be anything because
+&lt;/pre&gt;
+&lt;/p&gt;
+And here is the item attribute for that extension:
+&lt;p&gt;
+&lt;pre&gt;
+&lt;item title=&quot;XYZ Title&quot; xyzButton=&quot;/icon/button.gif&quot;&gt;
+&lt;/pre&gt;
+&lt;/p&gt;
+Note that the value of the attribute in the item tag can be ANYTHING. It can be anything because
the class that parses that attribute is the class HandleParsingAndAddButton, which in this example parses
a string /icon/button.gif from the attribute. It later will use that info to load the gif and use it as the icon
-for a new button (currently located beside the help icon for the step in the cheat sheet with id &quot;0&quot;).
+for a new button.
</documentation>
</annotation>
@@ -143,16 +137,8 @@ for a new button (currently located beside the help icon for the step in the che
<meta.section type="copyright"/>
</appInfo>
<documentation>
- /************************************************************************
- * Copyright (c) 2004 IBM Corporation and others.
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Common Public License v1.0
- * which accompanies this distribution, and is available at
- * http://www.eclipse.org/legal/cpl-v10.html
- *
- * Contributors:
- * IBM Corporation - Initial API and implementation
- *************************************************************************/
+ Copyright (c) 2004 IBM Corporation and others.
+All rights reserved. This program and the accompanying materials are made available under the terms of the Common Public License v1.0 which accompanies this distribution, and is available at &lt;a href=&quot;http://www.eclipse.org/legal/cpl-v10.html&quot;&gt;http://www.eclipse.org/legal/cpl-v10.html&lt;/a&gt;
</documentation>
</annotation>

Back to the top