### Eclipse Workspace Patch 1.0 #P org.eclipse.platform Index: cheatsheets/CVS_1.xml =================================================================== RCS file: /home/eclipse/org.eclipse.platform/cheatsheets/CVS_1.xml,v retrieving revision 1.4 diff -u -r1.4 CVS_1.xml --- cheatsheets/CVS_1.xml 14 Jul 2004 21:26:08 -0000 1.4 +++ cheatsheets/CVS_1.xml 9 Dec 2005 20:16:49 -0000 @@ -18,7 +18,8 @@ + title="Load the Destination into your Workspace" + dialog="true"> Select the project and choose Replace With > Another Branch or Version from the context menu. Then select the branch to replace with. In this step you must ensure that the destination is loaded into your workspace. This is a manual task, you will need to perform the work and click the "Click to complete" button to move to the next step. @@ -26,7 +27,8 @@ + title="Merge Details" + dialog="true"> Select the project, choose Team > Merge and complete the wizard as required. This step specifies the details of the merge. This is a manual task, you will need to perform the work and click the "Click to complete" button to move to the next step. #P org.eclipse.ui.cheatsheets Index: src/org/eclipse/ui/internal/cheatsheets/data/Item.java =================================================================== RCS file: /home/eclipse/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/Item.java,v retrieving revision 1.6 diff -u -r1.6 Item.java --- src/org/eclipse/ui/internal/cheatsheets/data/Item.java 1 Mar 2005 20:45:46 -0000 1.6 +++ src/org/eclipse/ui/internal/cheatsheets/data/Item.java 9 Dec 2005 20:16:49 -0000 @@ -15,6 +15,7 @@ public class Item extends Intro implements IActionItem, IPerformWhenItem, ISubItemItem { private String title; private boolean skip; + private boolean dialog; private ArrayList itemExtensions; private Action action; @@ -29,10 +30,11 @@ super(); } - public Item(String title, String description, String href, String contextId, boolean skip) { + public Item(String title, String description, String href, String contextId, boolean skip, boolean dialog) { super(description, href, contextId); this.title = title; this.skip = skip; + this.dialog = dialog; } /** @@ -59,6 +61,14 @@ } /** + * Returns whether or not this item requires opening a dialog. + * @return whether the item requires opening a dialog + */ + public boolean isDialog() { + return this.dialog; + } + + /** * Returns the skip. * @return boolean */ @@ -67,6 +77,14 @@ } /** + * Sets whether or not this item requires opening a dialog. + * @param dialog whether the item requires opening a dialog + */ + public void setDialog(boolean dialog) { + this.dialog = dialog; + } + + /** * @param skip The skip to set. */ public void setSkip(boolean skip) { Index: src/org/eclipse/ui/internal/cheatsheets/data/IParserTags.java =================================================================== RCS file: /home/eclipse/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/IParserTags.java,v retrieving revision 1.9 diff -u -r1.9 IParserTags.java --- src/org/eclipse/ui/internal/cheatsheets/data/IParserTags.java 1 Mar 2005 20:45:46 -0000 1.9 +++ src/org/eclipse/ui/internal/cheatsheets/data/IParserTags.java 9 Dec 2005 20:16:49 -0000 @@ -55,12 +55,14 @@ * * */ public static final String ITEM = "item"; //$NON-NLS-1$ + public static final String DIALOG = "dialog"; //$NON-NLS-1$ public static final String SKIP = "skip"; //$NON-NLS-1$ /* Index: src/org/eclipse/ui/internal/cheatsheets/data/CheatSheetParser.java =================================================================== RCS file: /home/eclipse/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/CheatSheetParser.java,v retrieving revision 1.15 diff -u -r1.15 CheatSheetParser.java --- src/org/eclipse/ui/internal/cheatsheets/data/CheatSheetParser.java 8 May 2005 06:23:05 -0000 1.15 +++ src/org/eclipse/ui/internal/cheatsheets/data/CheatSheetParser.java 9 Dec 2005 20:16:49 -0000 @@ -505,6 +505,8 @@ item.setHref(attribute.getNodeValue()); } else if (attributeName.equals(IParserTags.SKIP)) { item.setSkip(attribute.getNodeValue().equals(TRUE_STRING)); + } else if (attributeName.equals(IParserTags.DIALOG)) { + item.setDialog(attribute.getNodeValue().equals(TRUE_STRING)); } else { AbstractItemExtensionElement[] ie = handleUnknownItemAttribute(attribute, itemNode); if (ie != null) Index: src/org/eclipse/ui/cheatsheets/CheatSheetViewerFactory.java =================================================================== RCS file: /home/eclipse/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/cheatsheets/CheatSheetViewerFactory.java,v retrieving revision 1.4 diff -u -r1.4 CheatSheetViewerFactory.java --- src/org/eclipse/ui/cheatsheets/CheatSheetViewerFactory.java 1 Mar 2005 20:45:46 -0000 1.4 +++ src/org/eclipse/ui/cheatsheets/CheatSheetViewerFactory.java 9 Dec 2005 20:16:49 -0000 @@ -37,6 +37,6 @@ * @return a new cheat sheet viewer */ public static ICheatSheetViewer createCheatSheetView() { - return new CheatSheetViewer(); + return new CheatSheetViewer(false); } } Index: schema/cheatSheetContentFileSpec.html =================================================================== RCS file: /home/eclipse/org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.html,v retrieving revision 1.14 diff -u -r1.14 cheatSheetContentFileSpec.html --- schema/cheatSheetContentFileSpec.html 1 Mar 2005 20:45:46 -0000 1.14 +++ schema/cheatSheetContentFileSpec.html 9 Dec 2005 20:16:49 -0000 @@ -11,7 +11,7 @@

Cheat Sheet Content File XML Format

-

Version 3.0

+

Version 3.2

This document describes the cheat sheet content file structure as a series of DTD fragments (machine readable XML schema).

cheatsheet

@@ -70,6 +70,7 @@ 
<!ELEMENT item (description ([action|perform-when] | (subitem|repeated-subitem|conditional-subitem)*))> 
 <!ATTLIST item 
   title               CDATA #REQUIRED
+  dialog              ("true" | "false") "false"
   skip                ("true" | "false") "false"
   contextId           CDATA #IMPLIED 
   href                CDATA #IMPLIED
@@ -79,6 +80,9 @@
 follows:

 
    
   
  • title - The title of the cheat sheet item.
+  
  • dialog - dialog="true" means this step involves opening
+    a modal dialog. This is a hint to the system that it should allow the user
+    to continue using the cheat sheet while in the modal dialog.
    • 
   
  • skip - skip="true" means that the whole step can be
     skipped; the UI generally shows a button that the user can press to indicate
     that they are skipping this step
    • 
@@ -322,8 +326,8 @@
   <intro>
     <description>Example cheat sheet with two steps.</description>
   </intro>
-  <item title="Step 1">
-     <description>This is a step with an action.</description>
+  <item title="Step 1" dialog="true">
+     <description>This is a step with an action that involves opening a modal dialog.</description>
      <action class="com.xyz.myaction" pluginId="com.xyz"/>
   </item>
   <item title="Step 2">
@@ -333,7 +337,7 @@