| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| <title>Register Cheat Sheet Wizard</title> |
| <link rel="STYLESHEET" href="../../../../book.css" type="text/css"> |
| <link rel="STYLESHEET" href="../../../tweak.css" type="text/css"> |
| <script language="JavaScript" type="text/javascript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script> |
| </head> |
| <body> |
| <h2>Register Cheat Sheet Wizard</h2> |
| |
| <h3>About This Wizard</h3> |
| |
| <p> |
| This wizard allows you to register a simple or |
| composite cheat sheet with the Eclipse workbench |
| to make it accessible through the <strong>Help</strong> menu. |
| </p> |
| |
| <p> |
| The underlying operation performed by this wizard involves generating |
| the XML-related mark-up for the <strong>Cheat Sheet Content</strong> |
| extension point (<strong>org.eclipse.ui.cheatsheets.cheatSheetContent</strong>) |
| and adding it to the plugin.xml file belonging to the plug-in project |
| the cheat sheet being registered is contained within. |
| </p> |
| |
| <p> |
| A brief description and problem domain category may be |
| specified for the cheat sheet during registration. |
| This wizard will only register the cheat sheet once. |
| Subsequent uses of this wizard allow the user to update the |
| cheat sheet description and category values of the original registration. |
| </p> |
| |
| <p> |
| To register the current cheat sheet being edited, click the |
| <strong>Register this cheat sheet</strong> |
| hyperlink in the title area of the <em>Simple Cheat Sheet Editor</em> or |
| <em>Composite Cheat Sheet Editor</em>. |
| </p> |
| |
| <img src="../../../images/simple_cs_editor/page_cheat-sheet_header.png" alt="Cheat Sheet Page Header"> |
| |
| <h3>Wizard Fields</h3> |
| |
| <p> |
| This wizard contains the following fields: |
| </p> |
| |
| <table cellspacing="0"> |
| <tr> |
| <td class="header"> |
| Label |
| </td> |
| <td class="header"> |
| Type |
| </td> |
| <td class="header"> |
| Name |
| </td> |
| <td class="header"> |
| Description |
| </td> |
| <td class="header"> |
| Required |
| </td> |
| </tr> |
| <tr> |
| <td class="body"> |
| <strong>Category</strong> |
| </td> |
| <td class="body"> |
| Combo Box |
| </td> |
| <td class="body"> |
| Problem Domain Category |
| </td> |
| <td class="body"> |
| To categorize the cheat sheet being registered using an |
| existing problem domain category, select a value from this |
| field. |
| <br> |
| <br> |
| If an existing problem domain category is selected, the |
| registered cheat sheet will be placed as a node under that category |
| in the <strong>Cheat Sheet Selection</strong> dialog's tree |
| viewer. |
| <br> |
| <br> |
| If <strong><none></strong> is selected, the |
| registered cheat sheet will be placed as a node under the |
| <strong>Other</strong> category |
| in the <strong>Cheat Sheet Selection</strong> dialog's tree |
| viewer. |
| </td> |
| <td class="body"> |
| No |
| </td> |
| </tr> |
| <tr> |
| <td class="body"> |
| <strong>Description</strong> |
| </td> |
| <td class="body"> |
| Text |
| </td> |
| <td class="body"> |
| Brief Cheat Sheet Description |
| </td> |
| <td class="body"> |
| Edit this field to specify a brief description for the |
| cheat sheet being registered. |
| <br> |
| <br> |
| If a description is specified, it will appear as a label under the |
| <strong>Cheat Sheet Selection</strong> dialog's tree |
| viewer when the registered cheat sheet node is selected. |
| </td> |
| <td class="body"> |
| No |
| </td> |
| </tr> |
| </table> |
| |
| <img src="../../../images/simple_cs_editor/wizard_register_cheat-sheet.png" alt="Register Cheat Sheet Wizard Main"> |
| |
| <h3>Wizard Actions</h3> |
| |
| <p> |
| This wizard provides the following actions: |
| </p> |
| |
| <table cellspacing="0"> |
| <tr> |
| <td class="header"> |
| Label |
| </td> |
| <td class="header"> |
| Type |
| </td> |
| <td class="header"> |
| Name |
| </td> |
| <td class="header"> |
| Description |
| </td> |
| </tr> |
| <tr> |
| <td class="body"> |
| <strong>New...</strong> |
| </td> |
| <td class="body"> |
| Button |
| </td> |
| <td class="body"> |
| Create New Category |
| </td> |
| <td class="body"> |
| Click this button to create a new problem domain category. |
| <br> |
| <br> |
| In the resulting <strong>Create New Category</strong> dialog, |
| enter a category name in the <strong>Name</strong> field to |
| specify the problem domain the cheat sheet being registered |
| belongs to. |
| <br> |
| <br> |
| The new category will be added to the <strong>Category</strong> |
| combo box. |
| </td> |
| </tr> |
| </table> |
| |
| <img src="../../../images/simple_cs_editor/wizard_register_category.png" alt="Register Cheat Sheet Wizard Category"> |
| |
| <h3>How To Access A Registered Cheat Sheet</h3> |
| |
| <p> |
| To access a registered cheat sheet within the Eclipse workbench, |
| perform the following steps: |
| </p> |
| |
| <ol> |
| <li> |
| Launch a new runtime Eclipse workbench<span class="reference">*</span>. |
| </li> |
| <li> |
| In the runtime Eclipse workbench, click |
| <strong>Help > Cheat Sheets...</strong> to open the |
| <strong>Cheat Sheet Selection</strong> dialog. |
| </li> |
| <li> |
| Within the dialog, select the following option: |
| <strong>Select a cheat sheet from the list</strong> |
| </li> |
| <li> |
| In the tree viewer, expand the problem domain category used |
| to categorize the registered cheat sheet. If one was not |
| specified, expand the <strong>Other</strong> category. |
| </li> |
| <li> |
| Select the registered cheat sheet |
| </li> |
| <li> |
| Click <strong>OK</strong> and the cheat sheet will be |
| opened in the <strong>Cheat Sheet</strong> view. |
| </li> |
| </ol> |
| |
| <p> |
| Note<span class="reference">*</span>: A registered cheat sheet is not |
| accessible through the <strong>Help</strong> menu in the (host) Eclipse |
| workbench being used to edit it. |
| </p> |
| |
| <img src="../../../images/simple_cs_editor/wizard_register_selection.png" alt="Cheat Sheet Selection Dialog"> |
| |
| <h3>Relevant Links</h3> |
| |
| <ul> |
| <li> |
| <a href="editor.htm">Simple Cheat Sheet Editor</a> |
| </li> |
| <li> |
| <a href="../composite_cs_editor/editor.htm">Composite Cheat Sheet Editor</a> |
| </li> |
| </ul> |
| |
| </body> |
| </html> |
