# Tutorial: << Tutorial Name>>

Version: <version number> | Date: <date>

## Contents

· Overview

· References

· Introduction

· Step One

· Step X

· Example

· Summary

## [Developers Guide Tutorials provide a step-wise example of a feature of GMF. These tutorials follow the basic flow of Eclipse articles. In your tutorial, provide the basics for getting the reader familiar with the steps required to use a platform feature, using UI pictures and code snippets. The idea is that the reader will be able understand the steps required to use the GMF feature for their own purposes. Be sure to include links to any Examples/Samples.

##

## Overview

[back to top]

Provide the objectives of your tutorial. For example, “This tutorial provides the reader with the steps to use extension point… This extension point provides… You may want to use this when… etc.”

## References

[back to top]

Provide references to any other tutorials that may supplement to your tutorial. You are also encouraged to refer the reader to a specific example in the Example section of the Developers Guide.

## Introduction

[back to top]

Describe the approach (including the steps required) that is used in your tutorial to achieve the objects of your tutorial. For example, “In this tutorial we will create a WidgetService and WidgetProviders to demonstrate GMF’s Service infrastructure.” Also, include any recommended background knowledge the tutorial assumes on behalf of the reader. If the read does not possess the required background knowledge refer them to the appropriate links.

## First Step

[back to top]

Rename the section titles to something more meaningful - for example, “Creating the WidgetService”.

Using text, code snippets and pictures to describe the steps in your tutorial.

Important notices, warnings, or "gotchas" can be highlighted via the "notabene" paragraph style:

Note: Put some important information in here.

Got a question to pose to reviewers? The "question" style provides a consistent look-and-feel:

Question: Put a question to the reviewers in here.

## Steps X

[back to top]

Keep the number of steps in your tutorial to a reasonable number. (<10?)

Keep the length of a particular step reasonable as well - the read may get lost in the details and lose sight of the objective.

The "snippet" style on a `<pre>` block provides a nice option for displaying code snippets:

    public void run(IAction action) {

           CreateTechnicalNoteWizard wizard = new CreateTechnicalNoteWizard();

           wizard.init(workbench, selection);

           new WizardDialog(window.getShell(), wizard).open();

           IFile resultFile = wizard.getResultFile();

           if (resultFile != null && resultFile.exists()) {

                   openEditor(resultFile);

           }

    }

HTML tables are an alternative that supports captions, but require manual control of the formatting and colour inside the table cell:

Example action delegate run( ) method

    public void run(IAction action) {

        CreateTechnicalNoteWizard wizard = new CreateTechnicalNoteWizard();

        wizard.init(workbench, selection);

        new WizardDialog(window.getShell(), wizard).open();

        IFile resultFile = wizard.getResultFile();

        if (resultFile != null && resultFile.exists()) {

               openEditor(resultFile);

        }

    }

## Example

[back to top]

Provide links to source files that referenced in the tutorial steps.

## Summary

[back to top]

Review the steps in your tutorial against the objects set-out in the overview. Point the reader to examples/samples or further recommended reading.

Copyright (c) 2000,2005 IBM Corporation and others. All Rights Reserved.