Skip to content

review cheat sheets in eclipse

Ian Mayo edited this page Jun 18, 2015 · 4 revisions

Here are the steps to take to review cheat sheets in the Computer Based Training mode, from within Debrief.

Loading the whole Debrief project

  1. Ensure you have Java installed on your machine. (a 32bit Jre is a recommended, it performs fastest)
  2. Download Eclipse (Eclipse for RCP and RAP Developers, from here
  3. Clone the Debrief repo to your machine using your Git client (note: take note of where it gets stored)
  4. Open Eclipse.
  5. From the "Welcome" screen, select "Workbench" welcome_screen
  6. You're now in the workbench view: Workbench view
  7. Now right-click in Package Explorer, and select Import
  8. From the popup dialog, select Git then Projects from Git Import from git
  9. Now select Existing local repository Existing repository
  10. Now click on Add and browse to the folder containing all of your git repos, then press Finish.
  11. Select the folder containing the cloned Debrief repo, then Next
  12. Indicate that you wish to Import existing projects Existing projects
  13. Lastly, check all of the projects are selected (see screenshot below), then press Finish All projects

Navigate to the cheat sheets

  1. In the left hand side, you'll see all of the projects loaded. They're in alphabetical order.
  2. Expand the project titled org.mwc.debrief.help
  3. The cheat sheets are in there, in a folder titled cheat_sheets Cheat sheets
  4. Now expand a folder, to view the cheat sheets inside
  5. There is a custom editor for cheat sheets, or Eclipse's normal XML editor may be used.
  6. Right-click on a cheat sheet, and select Open with: Open with menu
  7. For a plain cheat sheet, you will be offered a Simple cheat sheet editor.
  8. But, for a composite cheat sheet (one that collates a collection of cheat sheets) you will be offered the Composite cheat sheet editor (as in the above screenshot). Here is the editor: Composite editor
  9. There's Internet guidance on how to use this editor, but the crux is that from the composite editor you can click on Preview and the cheat sheet will open in a view within the editor: Preview pane