Creating Reusable Methods Content

 

I.                                                   Method Content Authoring Overview

Method content is represented in this tool with a schema that defines roles representing development skills and responsibilities for work products. The roles also define responsibility relationships to the work products.

image described in accompanying text

The figure above depicts typical sources for method content, as well as how the method content is represented. To learn about development methods, people research in libraries or receive training. Development methods are typically described in publications such as books, articles, training material, standards and regulations, or any other form of documentation. These sources usually document methods by providing step-by-step explanations for a particular way of achieving a specific development goal under general circumstances. Some examples are: transforming a requirements document into an analysis model; defining an architectural mechanism based on functional and non-functional requirements; creating a project plan for a development iteration; defining a quality assurance plan for functional requirements; redesigning a business organization based on a new strategic direction, and so on.

This tool takes content such as the content described above, and structures it in one specific way using a predefined schema of concepts. This schema supports the organization of large amounts of descriptions for development methods and processes. Such method content and processes do not have to be limited to software engineering, but can also cover other design and engineering disciplines such as mechanical engineering, business transformation, sales cycles, and so on.

The schema for method content is represented this tool as a construct of roles defining development skills and responsibilities for work products. These work products are produced by tasks that are performed by the roles and have the work products as inputs and outputs. The screen capture in the figure above shows how such method content elements are organized in tree browsers on the left. These tree browsers, similar to a library, provide different indexes of the available elements for rapid access. The screen capture shows on the right an example of a task presentation. This task presentation defines the task in terms of steps that need to be performed to achieve the task's purpose. You can see that the task has various relationships, such as relationships to performing roles as well as work products that serve as inputs and outputs to the task. Find more details on tasks, role, and work products in the online help. In addition to roles, tasks, and work products, this tool supports the addition of guidance elements. Guidance are supplementary free-form documentation such as white papers, concept descriptions, guidelines, templates, examples, and so on.

This tool provides various form-based editors to create new method content elements. Document your task, roles, work products, and guidance elements using intuitive rich-text editors that allow you to copy and paste text from other sources such as web pages or documents. Use simple dialogs to establish relationships between content elements. For example, make a work product the input to your task simply by selecting it in a dialog.

Using this tool, you can organize content in physical content packages that allow you to manage your content in configurable units. You can also categorize your content based on a set of predefined categories (for example, categorize your tasks into development disciplines, or your work products into domains) or create your own categorization schemes for your content with your own user-defined categories that allow you to index content in any way you want.

Related concepts

Method Content

Related tasks

Create Method Content

II.                                             Method Content

Method content provides step-by-step explanations, describing how specific development goals are achieved, independent of the placement of these steps within a development lifecycle. Processes take these method elements and relate them into semi-ordered sequences that are customized to specific types of projects.

Method content elements are:

  • Task
  • Role
  • Work Product
  • Guidance

A Process Engineer authors these elements, defines the relationships between them, and then categorizes them. Method content provides step-by-step explanations, describing how specific development goals are achieved independent of the placement of these steps within a development lifecycle. Processes take these method elements and relate them into semi-ordered sequences that are customized to specific types of projects.

For example, a software development project that develops an application from scratch performs development tasks such as "Develop Vision" or "Use Case Design" similar to a project that extends an existing software system. However, the two projects will perform the tasks at different points in time with a different emphasis, i.e., they perform the steps of these tasks at different points of time and perhaps apply individual variations and additions.

Method content elements are contained within method content packages which, in turn, are contained within a Method plug-in. In order to separate your own content from original IBM Rational content, you should always create new method content in a method plug-in that you produce. Creating method content in a method plug-in of your own also allows you to update your own library with new releases of the IBM Rational library without affecting the content that you have created in your own plug-ins.

See also:

Related concepts

Method Content Categories

Related tasks

Create Method Content

Create a Method Plug-in

III.                                        Create Method Content

Method content provides step-by-step explanations, describing how specific development goals are achieved independent of the placement of these steps within a development lifecycle. Processes take the method elements and relate them into semi-ordered sequences that are customized to specific types of projects.

Method content elements are:

  • Task
  • Role
  • Work Product
  • Guidance

Click here for more information about Method Content.

To create method content:

  1. In the Library View, expand the content package in which you want to create new method content.
  2. Right click the folder containing the type of method element you want to create, click New and then select the element that appears. The new element is created and its respective editor opens.

Note: For Work Products, choose between Artifact, Outcome, or Deliverable. For Guidance, choose from the list of guidance types.

  • Create a Role
  • Create a Task
  • Create a Work Product
  • Create Guidance
  • Variability
    Variability allows elements in one content package to influence or modify elements in other content packages without actually directly modifying the original content. Variability enables changes to the content while keeping the changes separate and optional.

Related tasks

Create a Role

Create a Task

Create a Work Product

Create Guidance

IV.                                       Create a Role

A Role defines a set of related skills, competencies, and responsibilities of an individual or individuals.

You should always create new method content in a Method Plug-in that you produce.

To create a role:

  1. Expand the content package in which you want to create the role.
  2. Right click Roles, and then select New > Role. The role editor appears with the Description tab set as the default.
  3. In the Name field, type a unique name for your role. The role name is the file name that appears in the Library view.
  4. In the Presentation name field, type a presentation name. The presentation name is the name that appears in your published content and in the Configuration View. You can also make this name appear in the Library View by toggling the Show Presentation Names button in the Library View toolbar.
  5. In the Brief Description field, type a short description of the new Role.
  6. Type a more detailed description of the new Role in the Main Description field. The main description is a more detailed version of the description you typed into the Brief Description field. There are three ways you can create text for the description:
    • Directly, by typing it manually in the editor.
    • Copy from another similar role and then modify by using the editor.
    • Copy from an HTML source such as a published RUP Web site.

Note: You can use the Rich Text Editor to edit or enter the text for any field that has a rich text editor icon rich text editor icon. Simply click the icon to access the Rich Text Editor. Click the icon again to close the Rich Text Editor. For more information see Rich Text Editor.

  1. Under Version Information, provide any pertinent version information about the role.
  2. Click the Work Products tab and then click the Add button to the right of the "Responsible for:" field. The Select Dialog for Work Products dialog opens.
  3. Select one or more work products from the list. A description of the work product you select appears in the Brief Description field at the bottom of the dialog box.

Note: The list of work products in the "Work products that are output of tasks that this role performs" field is calculated and cannot be changed with the role editor. A work product appears here if it is an output of a task that the role performs.

  1. Click OK. The dialog box closes and the "Role is responsible for:" field is populated.

Note: Selected elements in an Add/Remove section display both the element name (plug-in name) and the "path" (package name) to that element.

  1. Click the Guidance tab. This part of the editor allows you to add and remove guidance for the role. To add guidance, click the Add button, select the guidance you want to add, and then click OK. To remove guidance, select it in the Guidance field and then click Remove. When you select a guidance element, the brief description of the guidance is displayed.
  2. Click the Categories tab. A role can be included in one or more rolesets and any number of custom categories. Open the appropriate Select dialog by clicking the Add button next to the category lists. You can remove a role from a category by selecting it and then clicking the Remove button.
  3. Click the Preview tab to view the newly created role and then save by closing the tab.

Parent topic: Create Method Content

Method Content

Create a Task

Create a Work Product

Create Guidance

Variability

V.                                             Create a Task

A task is an assignable unit of work. Every task is assigned to a specific role. The granularity of a task is generally a few hours to a few days and usually affects one or only a small umber of work products.

You should always create new method content in a Method Plug-in that you produce.

To create a task:

  1. Expand the content package in which you want to create the task.
  2. Right click Tasks, and then select New > Task. The task editor appears with the Description tab set as the default.
  3. In the Name field, type a unique name for your task. the task name is the file name that appears in the Library View.
  4. In the Presentation name field, type a presentation name. The presentation name is the name that appears in your published content and in the Configuration View. You can also make this name appear in the Library view by toggling the Show Presentation Names button in the Library view toolbar.
  5. In the Brief Description field, type a short description of the new task.
  6. Type a more detailed description of the new task in the Main Description field. The main description is a more detailed version of the description you typed into the Brief Description field. There are three ways you can create text for the description:
    • Directly, by typing it manually in the editor.
    • Copy from another similar role and then modify by using the editor.
    • Copy from an HTML source such as a published RUP Web site.

Note: You can use the Rich Text Editor to edit or enter the text for any field that has a rich text editor icon rich text editor icon. Simply click the icon to access the Rich Text Editor. Click the icon again to close the Rich Text Editor. For more information see Rich Text Editor.

  1. Complete the other task specific fields in Detail Information as needed. See Variability for information on creating variability.
  2. Click the Steps tab. The Steps Editor appears.

A task can have a series of steps that detail how to perform that task. The Step Editor allows you to:

    • Create a new step
      • Click the New button.
      • Give the Task a name in the Name field.
      • Describe the Task in the Description field.
    • Remove a step
      • Select the step to remove in the Steps field.
      • Click the Delete button.
    • Move a step up the list
      • Select the step you want to move up.
      • Click the Move Up button.
    • Move a step down the list
      • Select the step you want to move down.
      • Click the Move Down button
  1. Click the Roles tab. This part of the editor allows you to define the roles that perform the task. You should select a role as the Performing Role for this task. You can also add one or more roles as Additional Performers. To add a role, click the Select or Add button as appropriate, select the role you want to add, and then click OK. To remove a role, select it in the Guidance box, and then click Clear or Remove as appropriate. When you select a role the brief description of that role is displayed.
  2. Click the Work Products tab. This part of the editor allows you to define the work products that are inputs and outputs for this task. You can select any number of work products as Mandatory Inputs, Optional Inputs, and Outputs. To add a work product, click the appropriate Add button, select the work products you want to add, and then click OK. To remove a work product, select it in the appropriate box and then click the corresponding Remove button. When you select a work product the brief description of the work product is displayed.
  3. Click the Guidance tab. This part of the editor allows you to add and remove guidance for the task. To add guidance, click the Add button, select the guidance you want to add, and then click OK. To remove guidance, select it in the Guidance box and then click Remove. When you select a guidance element the brief description of the guidance is displayed.
  4. Click the Categories tab. A task can be included in one discipline and any number of custom categories. Open the Select dialog by clicking the appropriate Select or Add button next to the category lists. Select a single discipline or any number of custom categories, and then click OK. You can remove a task from a category by selecting it and then clicking the appropriate Remove button.
  5. Click the Preview tab to view the newly created task as it will appear in a published Web page, and then save by closing the tab.

Parent topic: Create Method Content

Related concepts

Method Content

Variability

Related tasks

Create a Role

Create a Work Product

Create Guidance

VI.                                       Create a Work Product

Work product is a general term for task inputs and outputs. There are three types of work product:

  • Artifact
  • Outcome
  • Deliverable

You should always create new method content in a Method Plug-in that you produce.

To create a work product:

  1. Expand the Content Package in which you want to create the work product.
  2. Right click Work Products, and then select one of the following:
    • New > Artifact
    • New > Outcome
    • New > Deliverable

The Work Product editor for the specific type of work product you are creating appears with the Description tab set as the default.

  1. In the Name field, type a unique name for your work product. The work product name is the file name that appears in the Library View.
  2. In the Presentation name field, type a presentation name. the presentation name is the name that appears in your published content and in the Configuration View. You can also make this name appear in the library view by toggling the Show Presentation Names button in the library view toolbar.
  3. In the Brief Description field, type a short description of the new work product.
  4. Type a more detailed description of the new work product in the Main Description field. The main description is a more detailed version of the description you typed into the Brief Description field. There are three ways to create text for the description:
    • Directly, by typing it manually in the editor.
    • Copy from another similar work product and then modify using the editor.
    • Copy from an HTML source, such as a published RUP Web site.

Note: You can use the Rich Text Editor to edit or enter the text for any field that has a rich text editor icon rich text editor icon. Simply click the icon to access the Rich Text Editor. Click the icon again to close the Rich Text Editor. For more information see Rich Text Editor.

  1. Under Notation, provide any notations about the Work Product.

Note: Artifacts and Deliverables contain the Notation fields, while Outcomes do not.

  1. Under Icon you can select a node icon to appear with the work product in the Library and Configuration views 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 Web page for the work product. the Shape icon should be 32 x 32 pixels.
  2. Complete the other work product specific fields as needed. See Variability for information on adding variability to your work product.
  3. Select the Guidance tab. This part of the editor allows you to add and remove guidance for the work product. To add guidance, click the Add button, select the guidance you want to add, and then click OK. To remove guidance, select it in the Guidance field, and then click Remove. When you select a guidance element the brief description of the guidance is displayed.
  4. Select the Categories tab. A work product can be included in one domain, any number of work product types, and any number of custom categories. Open the appropriate Select dialog by clicking the Select or Add button next to the category lists. Select a single domain or any number of work product kinds or custom categories and then click OK. You can remove a work product from a category by selecting it and then clicking the appropriate Remove button.
  5. If the work product is a deliverable, you can define what the deliverable consists of on the Deliverable Parts tab. Click the Deliverable Parts tab. This part of the editor only appears for deliverables and it allows you to add other work products as part of the deliverable. To add work products, click the Add button, select the work products you want to add, and then click OK. To remove a work product, select it in the work products as deliverable parts: field, and then click Remove. When you select a work product the brief description of the work product is displayed.
  6. Select the Preview tab to view the newly created work product, and then save by closing the tab.

Parent topic: Create Method Content

Related concepts

Variability

Related tasks

Create Method Content

Create a Role

Create a Task

Create Guidance

VII.                                  Create Guidance

Guidance is a general term for additional information related to Role, Task, and Work Product. 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 Guidance.

You should always create new Method Content in a Method Plug-in that you produce.

To create Guidance:

  1. Expand the Content Package in which you want to create Guidance until you see the Method Elements (Roles, Tasks, Work Products, Guidance).
  2. Right click Guidance and then click New > "guidance type". The guidance editor for that particular guidance type opens.

The following guidance types have the same editor which includes a Description tab and a Preview tab:

    • Concept
    • Example
    • Guideline
    • Report
    • Reusable Asset
    • Roadmap
    • Supporting Material
    • Term Definition
    • Tool Mentor
    • Whitepaper
  1. 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.

Note: You can use the Rich Text Editor to edit or enter the text for any field that has a rich text editor icon rich text editor icon. Simply click the icon to access the Rich Text Editor. Click the icon again to close the Rich Text Editor. For more information see Rich Text Editor.

  1. In the Icon section, select a Node icon to appear with the work product in the Library View and Configuration View 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.
  2. Select the Preview tab to view the newly created work product and then save by closing the tab.

It is possible to change some types of guidance to a limited number of other guidance types. To change a guidance type, click the Change Type button and select an available new type.

If the type of guidance is a Practice, you can add references to other elements. If the guidance is a Template, you can attach a file to the guidance.

Parent topic: Create Method Content

Related tasks

Create Method Content

Create a Role

Create a Task

Create a Work Product

VIII.                            Variability

Variability allows elements in one content package to influence or modify elements in other content packages without actually directly modifying the original content. Variability enables changes to the content while keeping the changes separate and optional.

Variability allows you to factor your method content and processes in interrelated units and to architect method content and processes in layers that extend each other with new capabilities. Variability also allows you to extend and tailor method content and processes you do not own and cannot directly modify, and to easily upgrade to newer versions by simply reapplying your personal changes to the upgrades.

The use of variability affects two characteristics of a method element: its attributes and its relationships with other content elements. If an element allows variability, the specification is shown at the bottom of the element's description view.

For the purposes of variability, there are three groups of information for any element to be considered:

  • Attributes - pieces of data about an element such as Main Description.
  • Incoming Associations - associations to other elements where the association reference is held in the other element. In other words, the other element has references to the subject element.
  • Outgoing Associations - associations to other elements where the association reference is held in the subject element. In other words, the subject element has references to the other element.

In addition, associations can be one-to-one or one-to-many. See Variability Associations for a full list of the associations for each type of element.

IX.                                                  Variability Type

Variability type defines the nature of how one element affects another element using variability. The variability types are:

  • Not Applicable - The element is a base element and does not affect another element through variability. This is the default value of an element's variability type.
  • Contributes - A contributing element adds to the base element. Contributes provides a way for elements to contribute their properties into their base element without directly changing any of its existing properties, such as in an additive fashion. The effect, after contribution, is that the base element is logically replaced with an element that combines the attributes and associations of the contributing element with the base element.
  • Replaces - A replacing element replaces parts of the base element. Replaces provides a way for an element to replace a base element without directly changing any of the base element's existing properties. This is, in most cases, used for method plug-ins that aim to replace specific content elements such as roles, tasks, or activities with either a completely new variant or to change the fundamental relationships of these elements. The effect of this, is that the base content element is logically replaced with the new replacing element to which all incoming associations still point as before, but which has potentially new attribute values and outgoing association properties.
  • Extends - An extending element inherits characteristics of the base element. Extension allows Method Plug-ins to easily reuse elements from a base plug-in by providing a kind of inheritance for the extending element. Attribute values and association instances are inherited from the "based-on" element to the extending element. The result is that the extending element has the same properties as the "based-on" element, but might define its own additions. Extends is not used to modify content of the base plug-in, but to provide the ability for the extending plug-in to define its own content which is a variant of content already defined. For example, a special version of a generic Review Record for a specific type of review. The effect of this is that the base element and any number of extending elements can be used side by side, but refer to each other through the extends relationship. Extends also provides the key mechanism for binding capability patterns to processes: A pattern is applied by defining an extends relationship from an activity of the applying processes to the capability pattern. The activity inherits association instances from the pattern and the pattern appears to be part of the resulting process after interpretation.

Related concepts

Variability Associations

Contributes

Replaces

Extends

X.                                             Contributes

A contributing element adds to the base element. Contributes provides a way for elements to contribute their properties into their base element without directly changing any of its existing properties, such as in an additive fashion. The effect, after contribution, is that the base element is logically replaced with an element that combines the attributes and associations of the contributing element with the base element.

Use the Content Variability section on the Description tab to make an element contribute to another element. Select Contributes as the Variability type and then select the base element to which this element will contribute. The base element must be the same type of element as the contributing element.

Any information you enter in the contributing element is added to the base element. Text fields in the contributing element are added at the end of the respective text fields in the base element.

Contribution only adds attributes and associations to the base. It never overrides or replaces any information from the base. In other words, if the base is allowed an association to exactly one other element and has this one already defined, it is not being replaced by a contributor's association.

Contribution rules:

  • Attributes are appended except for identifying/naming attributes and non-string attributes such as boolean, date, etc.
  • Outgoing to-one associations of the contributor are ignored if the base already has such an association or if the base element has more than one contributing element (i.e. it cannot be decided which contribution should be chose, then none will be chosen).
  • Outgoing to-many associations are added to the base elements of a contribution.
  • Incoming associations to the contributing element with a to-one constraint on the other association end are ignored if the base already has such an incoming association or if there is more than one contribution to consider for the base element.
  • Other incoming associations to the contributing element are added to the base elements of a contribution.
  • A base element of a contribution can have more than one contributor
  • Contribution works transitively, i.e. a contribution element contributes its own contributors.

See Variability Associations to find the associations for each element type.

Related concepts

Variability

Extends

Replaces

XI.                                       Extends

An extending element inherits characteristics of the base element. Extension allows Method Plug-ins to easily reuse elements from a base plug-in by providing a kind of inheritance for the extending element. Attribute values and association instances are inherited from the "based-on" element to the extending element. The result is that the extending element has the same properties as the "based-on" element, but might define its own additions. Extends is not used to modify content of the base plug-in, but to provide the ability for the extending plug-in to define its own content which is a variant of content already defined. For example, a special version of a generic Review Record for a specific type of review. The effect of this is that the base element and any number of extending elements can be used side by side, but refer to each other through the extends relationship. Extends also provides the key mechanism for binding capability patterns to processes: A pattern is applied by defining an extends relationship from an activity of the applying processes to the capability pattern. The activity inherits association instances from the pattern and the pattern appears to be part of the resulting process after interpretation.

Use the Content Variability section on the Description tab to make an element extend another element. Select Extends as the Variability Type, and then select the base element which this element extends. The base element must be the same type of element as the extending element.

Any information you enter in the extending element is added to the base element in creating an additional element. Text fields in the extending element are added at the end of the respective text fields in the base element.

Extends only defines inheritance for the extending element. The base remains untouched. If the extending element is allowed an association to only one other element and has such an element defined itself, inheritance will not override this association.

Extends rules:

  • Attribute values of the base element are inherited to the extending element if the extending element has not defined its own values.
  • Outgoing to-many associations of the base element are inherited to the extending element.
  • Outgoing to-one associations are only inherited if the extending element does not define its own to-one association.
  • Extends works transitively, i.e. if an extending element is extended itself, the second extension inherits from its direct and indirect base elements.
  • Contribution precedes Extends, i.e. contribution is evaluated first and then extending elements inherit afterwards from the base element (including all of its contribution).
  • Replace precedes Extends, i.e. if a base element has a replace and extends relationship, the extending element inherits from the replacing element.

See Variability Associations for more information on the associations for each element type.

Related concepts

Variability

Replaces

Contributes

XII.                                  Replaces

A replacing element replaces parts of the base element. Replaces provides a way for an element to replace a base element without directly changing any of the base element's existing properties. This is, in most cases, used for method plug-ins that aim to replace specific content elements such as roles, tasks, or activities with either a completely new variant or to change the fundamental relationships of these elements. The effect of this, is that the base content element is logically replaced with the new replacing element to which all incoming associations still point as before, but which has potentially new attribute values and outgoing association properties.

Use the Content Variability section on the Description tab to make an element replace another element. Select Replaces as the variability type and select the base element that this element will replace. The base element must be the same type of element as the replacing element.

When you replace an element, all the description attributes are replaced by the replacing element. If a description attribute in the replacing element is blank, but the base element has content, the attribute will be blank in the resulting element.

Replace always replaces attributes and associations of the base element with the replacing element's attributes and associations, except for incoming associations, which are only added to the base, but do not replace the base's incoming associations.

Replaces rules:

  • Attributes of the base element are replaced with attributes of the replacing element including identifier of the base element.
  • Outgoing to-one and to-many associations of the replacing element replace any outgoing associations of the base element. If the replacing element does not have any outgoing associations, then neither will the resulting element.
  • Incoming associations with a to-many constraint on the other association end to the replaced element are preserved and augmented with incoming associations of the replacing element.
  • Incoming associations with a to-one constraint on the other association end to the replaced element are replaced with the respective incoming association of the replacing element. If the replacing element does not have such an association then the resulting element keeps the incoming association of the base element.
  • A base element of a replacement can have only one replacing element per configuration. If more than one replacing element is present, no replacement takes place.
  • Replacement works transitively, i.e. if a replacing element is replaced itself, the final replacer prevails.
  • Contribution precedes Replacement, i.e. contribution is evaluated first and then replacement performed afterward. The evaluation of contribution and replacement is performed top-down in the specialization hierarchy.

See Variability Associations for more information on the associations for each element type.

Related concepts

Variability

Extends

Contributes

XIII.                            Variability Associations

The following table lists the incoming and outgoing associations for each element type for which variability can be used. Associations also have a cardinality of to-many or to-one.

Element Type

Associated Element Type

Association

Work Product

contained artifacts

out-many

deliverable parts

out-many

guidance

out-many

container artifact

in-one

deliverable

in-one

responsible role

in-one

input and output to tasks

in-many

categories

in-many

Role

responsible for work product

out-many

guidance

out-many

performer in task

in-many

categories

in-many

Task

primary performer role

out-one

additional performer roles

out-many

input and output work products

out-many

guidance

out-many

steps

out-many

categories

in-many

discipline

in-one

Categories

Custom Category

categorized elements

out-many

other custom categories

in-many

Discipline

categorized tasks

out-many

referenced workflow activity

out-one

discipline grouping

in-one

custom categories

in-many

Discipline Grouping

categorized disciplines

out-many

custom categories

in-many

Domain

categorized work products

out-many

sub-domains

out-many

super-domains

in-one

custom categories

in-many

Work Product Type

categorized work products

out-many

custom categories

in-many

Role Set

categorized roles

out-many

role set grouping

in-one

custom categories

in-many

Role Set Grouping

categorized role sets

out-many

custom categories

in-many

Guidance

Practice

content element

out-many

Other Guidance Types

sections via content descriptions

out-many

Parent topic: Variability

Related concepts

Variability

XIV.                            Browse and Preview Method Content

You can browse method content in both the Authoring Perspective and Browsing Perspective. While authoring method content, you can see a preview of the published page for the content you are editing by selecting the Preview tab at the bottom of the content editor. Click any link in the displayed page to go to that page. Use the buttons in the editor toolbar to perform familiar browser actions such as back or refresh. While browsing method content in the browsing perspective you can see a preview of any method and process content in a method configuration as it appears in a published Web site.

To browse and preview Method Content in the Authoring Perspective:

  1. Click the Open Perspective button open perspective buttonand select Authoring. The Authoring perspective opens with the Library View and Configuration View on the left and the content view on the right. If a method element is selected, the appropriate editor is open on the right.
  2. Explore the contents in the both the Library View and Configuration View by expanding the different content packages and method plug-ins down to their method elements. Double click an element to open it in the editor.
  3. Click the Preview tab at the bottom of the content editor to preview the content of any selected element.

Note: The preview page in the content editor does not resolve content variability relationships. If you are extending, contributing to, or replacing a base content item, you can only see the result of this in the Configuration View in the Browsing Perspective. For more information see Variability.

To browse and preview Method Content

 in the Browsing Perspective:

  1. Click the Open Perspective button open perspective buttonand select Browsing. The Browsing Perspective opens with the Configuration View on the left and the Content View on the right.
  2. Select a method configuration from the configuration drop-down list in the tool bar. The content of the method configuration appears in the content view, as it will appear in a published Web site.
  3. Explore and preview the content in the Configuration View by expanding the categories and other folders down to method elements. Click a method element to open it in the content view.

Parent topic: Tool Interface

Previous topic: Library View

Next topic: Search for Method Content

Related concepts

Tool Interface