blob: e9f330816a30c1869d5522b6eb67ee15c7eceb33 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="copyright" content="(C) Copyright Eclipse contributors 2005, 2006" />
<meta name="DC.rights.owner" content="(C) Copyright Eclipse contributors 2005, 2006" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta name="DC.Type" content="task" />
<meta name="DC.Title" content="Create Guidance" />
<meta name="DC.Relation" scheme="URI" content="createmethodcontent.html#createmethodcontent" />
<meta name="DC.Relation" scheme="URI" content="createarole.html" />
<meta name="DC.Relation" scheme="URI" content="createatask.html" />
<meta name="DC.Relation" scheme="URI" content="createaworkproduct.html#createaworkproduct" />
<meta name="DC.Relation" scheme="URI" content="createmethodcontent.html" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="createguidance" />
<meta name="DC.Language" content="en-us" />
<!--
Copyright (c) 2005, 2006 IBM Corporation and others.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html
Contributors:
IBM Corporation - initial implementation
-->
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
<title>Create Guidance</title>
</head>
<body id="createguidance"><a name="createguidance"><!-- --></a>
<h1 class="topictitle1">Create Guidance</h1>
<div><div class="p"><p>Guidance is a general term for additional information related to <a href="role.html#role">Role</a>, <a href="task.html#task">Task</a>, and <a href="workproduct.html">Work Product</a>. Guidance
provides information on how to perform your role, how to create a work product,
how to perform your task, and so on. For more information see <a href="guidance.html#guidance">Guidance</a>.</p>
<p>You should always create new <a href="methodcontent.html#creatingreusablemethodcontents">Method Content</a> in a <a href="methodplugin.html#methodplugin">Method Plug-in</a> that
you produce.</p>
</div>
<div class="section"><p>To create<strong>Guidance</strong>:</p>
</div>
<ol><li class="stepexpand"><span>Expand the Content Package in which you want to create Guidance
until you see the Method Elements (Roles, Tasks, Work Products, Guidance).</span></li>
<li class="stepexpand"><span>Right click <strong>Guidance</strong> and then click <strong>New &gt; "guidance type"</strong>.
The guidance editor for that particular guidance type opens. </span> <div class="p">The
following guidance types have the same editor which includes a Description
tab and a Preview tab:<ul><li><a href="concept.html#concept">Concept</a></li>
<li><a href="example.html#example">Example</a></li>
<li><a href="guideline.html#guideline">Guideline</a></li>
<li><a href="report.html#report">Report</a></li>
<li><a href="reusableasset.html#reusableasset">Reusable Asset</a></li>
<li><a href="roadmap.html#roadmap">Roadmap</a></li>
<li><a href="supportingmaterial.html">Supporting Material</a></li>
<li><a href="termdefinition.html#termdefinition">Term Definition</a></li>
<li><a href="toolmentor.html#toolmentor">Tool Mentor</a></li>
<li><a href="whitepaper.html#whitepaper">Whitepaper</a></li>
</ul>
</div>
</li>
<li class="stepexpand"><span>Use the fields in the content element editor to specify the guidance
details. Start by assigning a unique name to the guidance element along with
a presentation name that is used as the external visible name when other elements
refer to this element, or when the element is published. Every guidance type
has specific content fields in the content editor that are distributed over
two or more stacked tabs. Use the content fields to describe your guidance
type.</span> <div class="note"><span class="notetitle">Note:</span> You can use the Rich Text Editor to edit or enter
the text for any field that has a twisty symbol <img src="collapsed.gif" alt="" />. Simply click the symbol to access the Rich Text Editor.
Click the symbol again to close the Rich Text Editor. For more information
see <a href="richtexteditor.html#richtexteditor">Rich Text Editor</a>.</div>
</li>
<li class="stepexpand"><span>In the Icon section, select a Node icon to appear with the work
product in the <a href="libraryview.html#libraryview">Library View</a> and <a href="configurationview.html#configurationview">Configuration View</a> and
in the tree browser in a published Web site. The node icon should be 16 x
16 pixels. You can also select a Shape icon to appear at the top of the published
page for the work product. The shape icon should be 32 x 32 pixels.</span></li>
<li class="stepexpand"><span>Select the <strong>Preview</strong> tab to view the newly created work product
and then save by closing the tab.</span></li>
</ol>
<div class="section">It is possible to change the types of some types of guidance to a
limited number of other guidance types. To change a guidance type, click the <strong>Change
Type</strong> button and select an available new type.<p>If the type of guidance
is a <a href="practice.html#practice">Practice</a>, you can add
references to other elements. If the guidance is a <a href="template.html">Template</a>,
you can attach a file to the guidance.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="createmethodcontent.html">Create Method Content</a></div>
</div>
<div class="reltasks"><strong>Related tasks</strong><br />
<div><a href="createmethodcontent.html#createmethodcontent">Create Method Content</a></div>
<div><a href="createarole.html">Create a Role</a></div>
<div><a href="createatask.html">Create a Task</a></div>
<div><a href="createaworkproduct.html#createaworkproduct">Create a Work Product</a></div>
</div>
</div>
</body>
</html>