Edit Documents

After you create a new project or open a Project File, you can modify any of the project documents by changing the document structure, updating attributes of objects, commenting on objects, or linking objects.

When you open a Project Folder, all project documents are opened in read-only mode. To edit a document, click Document and select Start Editing Document, or press CtrlShiftE. When you finish changing the document click Document and select Finish Editing Document, or press CtrlShiftE. This feature allows multiple editors to work independently on different documents simultaneously, see Edit Documents Exclusively.

Tip: You can edit documents of a project in multiple project windows.

Note: If you are using the FREE plan, then you cannot edit projects with more than 150 objects or more documents, see Compare Plans.

Create New Objects

Add a new document object before, after, or as a child of the selected document object. To create new objects, select Edit, and mouseover Add New. Select one of the following options:

Add a new document object dialog with before, after, as child options

Alternatively, use the shortcuts as shown above. Press CtrlEnter to insert a new object after, press CtrlShiftEnter to insert a new object before, or press CtrlAltEnter to insert a new object as a child of the currently selected object.

The new document object gets automatically a unique ID in the current document. You can edit its heading or text description in a rich text editor.

Delete Objects

To delete the selected object (including the whole subtree containing all its children), click Edit and select Delete, or press CtrlDelete. You can also click the toolbar icon. Note: Deleted objects are not removed from the document, but are rather marked as deleted. All edit operations are disabled for deleted objects.

You can choose whether to display the deleted objects with full details or to display only the first line of text. Click Edit and select Preferences. In the Preferences dialog select Show details of deleted objects. The following image shows deleted objects without details:

Objects marked as deleted in ReqView software requirements specification document

Undelete Objects

To undelete a selected deleted object from the project (including the whole subtree containing all its children and all deleted parents on the path to the document root), click Edit and select Delete, or press CtrlDelete. You can also click the toolbar button.

Permanently Remove Objects

To permanently remove (purge) selected deleted objects (including their deleted subtrees) press Edit, mouseover Purge, and select Purge Selected, or press CtrlShiftDel. Note: Purging a deleted object also removes all deleted children, but does not work on non-deleted objects.

To purge all deleted objects in the current document, select Purge All from the Purge drop-down.

Copy and Paste Objects

You can cut or copy selected objects into the application clipboard. Click Edit and select Copy or Edit and select Cut, or press the standard shortcuts CtrlC or CtrlX.

Cut or copied objects can be pasted into the current project by clicking Edit and selecting Paste, or pressing CtrlV. In the Paste popup menu select if you want to copy value of custom attributes, attachments, or copy object links and specify the location of the pasted objects:

Paste object popup menu with values to copy: position, attributes, attachments, links

Select the Link to Origin option to link the new copy to its origin. To display the links from a copy to the origin links and all links inherited from the origin, click Edit and select Preferences. From the dialog, select Show origin and inherited links. For more information, see Inherited Links.

Pasting works similarly as adding new requirements by respecting the tree document structure. When you paste, each pasted (new) object is assigned a new ID. When you Cut and Paste within the same document, the entire source subtree is moved in the document to its new position and all the IDs of the objects are preserved. When you Cut and Paste to a different document, all copied objects are marked as deleted in the source document and pasted as new objects with new IDs in the target document.

Move Objects

Move a selected object in the document hierarchy by swapping with its previous or next sibling, promoting to the parent level or demoting to the child level. Click Edit and mouseover Move. Select from the following options or use the corresponding shortcuts:

Move object menu with options: up, down, promote, demote

Edit Document Objects

Each document object has a section heading and text description, which are displayed in the combined Description column of the Requirements Table.

Edit Description

To edit the text of a selected object, click Edit and select Edit Text or double click on it. In the inline rich text editor, you can change font style to bold, italic, use numbered or bulleted lists:

Edit requirement text window

To open the Description editor directly in the heading edit mode, click Edit and select Edit Heading, or press CtrlH.

Edit requirement heading window

To open the Description editor, press Enter or F2 and let the application automatically choose the heading or text edit mode.

While the Description editor is open, you can switch to the heading edit mode by pressing CtrlH, and to the text edit mode by pressing CtrlT.

To save the changes, click anywhere outside the editor or press CtrlEnter.

Note: Pressing Esc leaves the editor and discards all your changes.

Edit Text Dialog

You can press CtrlE to edit xhtml attributes with larger texts in the Edit dialog. The dialog can be resized by dragging the resize handle in the bottom right corner.

Edit text dialog for software requirement

The Edit dialog enables editing of URL links and embedded tables, which are unavailable in inline editors.

Edit URL Link:

Editing URL Link in requirement text editor

Edit Embedded Table:

Editing table in requirement text editor

Spelling Language:

To choose spelling languages, right-click in the rich text editor, select Spelling languages context menu item and choose one or more languages for the spell checker.

Edit Attributes

The values of custom attributes are displayed in separate columns. If the focused attribute column is editable, you can modify its value for all selected objects (rows) at once by pressing Enter or F2. ReqView chooses the right editor depending on attribute type.

The following shows the editor for enumeration custom attribute Status:

Editing value of the requirement status

The following shows the editor for date attribute Deadline:

Custom attribute with calendar view to set deadline when mitigating project risks

You can press CtrlE to edit larger text of xhtml attributes in the Edit dialog.

Attributes that cannot be edited (they have the readOnly flag set) are shown with the icon in the column heading.

Comment Requirements

To add a new comment to the selected requirement, click Edit and select New Comment. You can also press CtrlD or click the toolbar icon.

To edit a comment, open the Discussion pane and click above the selected comment:

Discussion pane

To delete a comment, click Delete button in the Edit Comment dialog:

Edit Comment dialog

Attach Files

You can enhance requirements description by attaching image or document files. The application assigns each attachment a unique ID and stores it with the project data.

To attach an image or document file to the selected requirement, click Edit and select New Attachment, or press CtrlShiftA. You can also click the toolbar icon.

There are no restrictions on the attachment file type, however, only image attachments are displayed in the Description column:

Flowchart image attachment displayed in the Description column

If you click on an attachment link then image attachments are opened in the Image Preview dialog. Other types of attachments are copied to a local temporary directory and opened by the OS-defined way when using the native application for Windows, Linux or Mac. When using the online web application, attachments are only saved to the browser download folder.

Note: The changes you make in the attachment files will not be saved to ReqView, the attachments have to be updated manually. First, save the edited attachment to the specific folder with your project files. Second, right-click on the attachment in ReqView, click Update Attachment option, and select the file you have edited and saved in your previous step.

To show, hide or preview an image, open, save, update or delete an attachment, right-click on the attachment displayed in the Description column and select the appropriate action from the menu:

Context menu for image attachments

To show or hide all image attachments in a document, click View, mouseover Image Attachments, and select Show All Images or Hide All Images. To show images after opening a project automatically, click Edit, select Preferences, and tick Show images.

Tip: Hiding image attachments in large documents or documents with a large number of attachments can significantly improve application performance.

Edit Document Name

Change the name of the document by clicking on the document name at the top of the page or from the Document Properties dialog. To open the Document Properties dialog, click on the document ID on the left of document name, or click Document and select Document Properties.

Updated for version 2.11.0