Edit Documents

Documentation / Get Started

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 Object. 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 Objects, 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 Objects, 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 Objects, 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 Objects

You can copy objects into the application clipboard and paste them into the same or another document. Each pasted object is assigned a new ID and is placed into the tree structure of the target document.

To copy the selected objects into the application clipboard, click Edit and select Copy, click icon in the toolbar, or press CtrlC.

To paste copied objects from the application clipboard, click Edit and select Paste, click icon in the toolbar, or press CtrlV. In the Paste popup menu, select whether you want to copy the values of custom attributes, attachments, or copy object links. And specify the location of the pasted objects here:

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

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

Move Objects

You can move objects or whole sections easily. Cut them into the application clipboard and paste them into the same or another document. When you paste objects into another document, they are marked as deleted in the source document. In the target document, the objects will get new IDs.

To cut the selected objects into the application clipboard, click Edit and select Cut, click icon in the toolbar, or press CtrlX.

To paste cut objects, click Edit and select Paste, click icon in the toolbar, or press CtrlV.

You can also move a selected object in the document hierarchy. Click Edit, mouseover Move Objects, and select from the following options or use the corresponding shortcuts:

Swap UpCtrlShiftSwap object with the previous sibling
Swap DownCtrlShiftSwap object with the next sibling
PromoteCtrlShiftPromote object one level higher
DemoteCtrlShiftDemote object one level lower

Edit Document Objects

You can set for each document object its section heading or text description, which are displayed in the Description column of the Requirements Table. You can also set values of custom attributes, which are displayed in separate columns.

Edit Description

To open the Description editor, press Enter or F2 shortcut or double click on the corresponding table cell.

Edit requirement text description

In the inline rich text editor, you can use only basic rich text formatting from the toolbar:

  • bold and italic font styles
  • ordered and unordered (bullet) lists

When the Description editor is open, the application automatically choose the heading or text edit mode according to the current document object. To switch to the heading edit mode, press CtrlH. To switch to the text edit mode, press CtrlT. To open the Description editor directly in the heading edit mode, click Edit and select Edit Heading, or press CtrlH.

Edit section heading

To save the changes done in the Description editor, click anywhere outside the editor or press CtrlEnter. To discard all your changes and leave the editor, press Esc.

Edit Text in Dialog

To edit the text description or rich text attributes (with xhtml type) in a dialog, click Edit and select Edit Text or press CtrlE.

Edit requirement text description or a rich text attribute in a dialog

To resize the dialog, drag the resize handle in the bottom right corner.

Format Text

In the inline rich text editor, you can use advanced rich text formatting from the toolbar:

  • bold, italic, underline, strike-through, subscript (lower index), superscript (upper index) font styles
  • text and background colors
  • ordered and unordered (bullet) lists
  • code and indented quote paragraph styles
  • URL links
  • embedded tables
  • insert special characters

To edit an URL link, place the cursor to the linked text and choose to edit the link or unlink the text from the context toolbar.

Edit URL links in a dialog

Edit Embedded Tables

To edit an embedded table, place the cursor to table and choose an action from the context toolbar.

Edit embedded table in a dialog

Choose Spelling Languages

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 Custom Attributes

Custom attribute values are displayed in separate columns. To modify attribute values for one or more selected objects (rows) at once, press Enter or F2. ReqView chooses the right editor depending on the attribute type. Press CtrlE to edit an xhtml attribute containing a larger text in the Edit dialog, see Edit Text in Dialog.

Note: Read-only attributes (with readOnly flag set) are shown with the icon in the column heading.

Example: Inline editor for an enum attribute Status.

Editing value of the requirement status

Example: Inline editor for a date attribute Target Date.

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

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, click button in the toolbar or press CtrlShiftA shortcut, and finally select the attached file.

You can also conveniently attach files via the system clipboard. In an external application just select an image or a file, press CtrlC, then select a requirement in ReqView, and press CtrlV.

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.14.0