You are viewing the documentation for Blueriq 15. Documentation for other versions is available in our documentation directory.

What is it for?

Documents are used to present information from Blueriq in an downloadable file

Creating a document

A document is started by creating a Blueriq Studio Document element, or by using the RTF import wizard. The contents of a document is stored in a tree of Content item. Content items are the nodes in the tree representing the document. This means that content items can contain other content items. In addition, each content item can contain text or images.

A document is shown in two ways: as a tree of content items at the left hand side, and as text on the right hand side. Although this seems to be a preview pane, the view has no styling and in that sense doesn't look like the final result after rendering.

The two display forms are linked: when a node is selected in the tree on the left, the text is also selected at the right. In addition, the text of the child nodes of the content item is also selected.

The formatting of the text in a document is done by setting Content style and Presentation style to the content items. A content style determines the type of the content item, for example Paragraph, List, or Table. The presentation style determines the sub styling, for example RightAligned, TextEmphasis, or ListBullet (for a list).

Presentation styles can also be applied to pieces of text inside the content item.

What can I use in a document?

Please refer to Text and styling for documentation on various elements and styles that a Document can contain:

Editing a document

A document is edited by manipulating the content items of the document.

Tree view

The actions for editing the structure of the document have to be performed in the tree view. Actions can be chosen from the context menu (right mouse button), or by using the keyboard (see the list of keyboard shortcuts). The icon that represents the content item looks different depending on what is set on the content item:

: generic icon for a content item;

: a content item with a condition;

: a content item with a repetition;

: a content item on which a content style is set;

: a content item on which a presentation style is set;

: a content item on which a content and a presentation style is set;

: a content item on which a condition, a content style and a presentation style is set.

More about content items, how to create, move and edit them, is explained below in the section Content items.

Collapse or expand parts of the tree

To navigate through a (large) tree, you can choose to expand or collapse part of the tree. To do so, select a node in the tree view and either select from the shortcut menu the Open/Close> sub menu and choose Expand node, Collapse node, Expand all or Collapse all

  These options are also available in the ribbon, tab Document and section Outline tools: 

Reusable items

Content items can be made reusable. Reusable means that the content item can be used in multiple documents, or more than once in the same document. The text part of a content item can be made reusable as well, this is called a text item. Text items can be used in multiple documents, and more than once in the same document. (Reusable) content items and text items are autonomous items, and can also be created and maintained separate from a document.

Text view

The text view allows editing individual texts within the document, which includes adding fields (filled with data from the domain model) and setting a condition and/or presentation style on specific pieces of text.

You can open the text editor from the tree view by double-clicking on a node in the tree, and from the text view by double-clicking on a piece of text.

At the top of the text editor, the name of the content item is shown. With the check mark or the cancel button the changes to the content item can either be committed or discarded. Both buttons close the text editor.