Documents are rich-text artifacts that you use to
capture text-based content. They support several rich-text constructs
such as text styles, paragraph justification and indentation, bullets,
and links. Create a document and format the textual content by using
controls for paragraph and text styles, bulleted lists, paragraph
justification and indentation.
About this task
You can add links to new and existing requirements and
other artifacts. You can also mark and embed other artifact types,
comments, requirements, and images into a document. Embedded requirements
and inserted artifacts are updated as the artifacts are modified and
saved. For embedded storyboards, use the forward and back arrows in
the heading of the image to advance or go back to a specific frame.
Documents
in Rational® Requirements Composer include
a spell checker. Misspelled words are marked with a red wavy underline.
Right-click a misspelled word to select from suggested spellings or
to add it to the dictionary.
Procedure
- Click .
- In the New Document window, type a document name.
- Browse to a project and a folder for the new document.
- (Optional) Add one or more tags to the document.
- (Optional) Select a template for initial content for the
document.
- (Optional) Click Next, select attribute groups to
associate with the document.
- Click Finish.
- Type text and format the text using the rich-text controls
in the toolbar.
- Right-click in the document for more editing options, including:
What to do next
To embed images or artifacts in a document do any of the
following actions.
- To embed a copy of an image or a rendering of an artifact in the
document, right-click in the document and click Insert
Image or Insert Artifact.
- To embed an image in the document, drag the image from the Project
Explorer to the document editor.
- To embed the artifact as an image, press Ctrl and drag an artifact
from the Project Explorer to the document editor.
- To create a link to an artifact in a document, drag the artifact
to the document editor.
- Select an image in the document and drag a handlebar to resize
it.