Help Composer Documentation : Creating a Sample Help Project Tutorial/title> - Instantiations Inc.

Help Composer Guide > Getting Started > Creating a New Help Project

Help Composer Guide

Getting Started

Creating a New Help Project

Creating a New Help Page

Linking CSSes to Pages

Applying CSS Classes to Text Blocks

Working with TOCs

Linking Help to the Menu

Documentation generated
from the Eclipse Help
for the product

Creating a New Help Project

Here are the basic steps in creating an Eclipse-based Help project using the Help Composer:

Create a new Help project.

View the new Help project.

Create a new Help project.

Switch to the Help Composer perspective. From the menu, select Window > Open Perspective > Other > Help Composer. To generate a new Eclipse help project, choose File > New > Project from the menu. Expand Help and select Help Project from the list.
New Help project wizard: Enter a name for the project (com.instantiations.contactmanager.help in the example) in the Project name field. Choose a folder, in which the HTML content for your new project will be stored. Click Next.
Enter Plugin Details The Plugin details should be populated with default values. Edit them if necessary. Click Next.
Choose Help Details In the Title of the book field, type in the title for the new book(Contact Manager Guide in the example). Check the Primary checkbox. This ensures that your new book will be promoted to the top level of the Help. The next group of checkboxes lets you choose, which default categories will be created automatically. For example, check the Generate a 'Getting Started' category checkbox. Another group of checkboxes lets you create the default topics in the book the similar way. Example shows the the 'Tips and tricks' checkbox chosen. Click Finish.
Review generated Help Project You should now see the generated project in your workbench. The Topic Explorer view shows the generated topics and the Navigator view shows the generated files. The Help Preview, at the bottom, shows the Contact Manager Guide and all the help topics in the Eclipse help system.
View the new Help project. To view the new Help project, run the help project as an Eclipse application.
To launch project as Eclipse Application: Click on the contact manager help project. Select Run > Run As... Eclipse Application. If successfull, you should now see a runtime workspace.
View Eclipse Help Window To view the Help contents: From the launched workspace menu, select Window > Help Contents. You should now see the Contact Manager Guide. Click the Contact Manager Guide. Expand the Getting Started category.