Doc Builder Tips and Tricks
Table of Contents
Video Tutorial - Adding a ToC
Adding a Table of Contents
To add a Table of Contents to your document, you will need to insert the Table of Contents widget from the widget menu. This widget will automatically populate based on the section and subsection headers added to your document. For the Table of Contents widget to render correctly, the correct text format (e.g., Header 1, Header 2, Header 3, Header 4) must be used for each section and subsection name. Page numbers in the Table of Contents will be rendered upon exporting the QbDVision document.
Key Concepts
Moving, Copying & Pasting Content within a Doc Builder Document
Copying and pasting content in Doc Builder can be done similarly to other document editors. The formatting of the copied content will be retained when pasted, including smart content. When saving the Doc Builder draft, smart content will render data from the Project and/or Process that is set in the document record. To move smart content and widgets within a Doc Builder Document, users can highlight the content and then click and drag the selection to the desired location.
There are different shortcuts available depending on the content you want to move, copy, and paste. Each shortcut is detailed in the table below:
Action | Shortcut | Instructions |
---|---|---|
Moving a Single Smart Content Field | Click, drag & drop |
|
Moving Widgets | Triple click or highlight, then drag & drop Note: Highlight to move multiple separate widgets |
|
Copying & Pasting Widgets | Triple click or highlight, then copy & paste
Note: Highlight to copy & paste multiple separate widgets |
|
Copying & Pasting Standard Text/Tables (no Smart Content) | Highlight, copy & paste |
|
Moving a Combination of Smart Content, Widgets, and Standard Text/Tables | Highlight, drag & drop |
|
Copying & Pasting a Combination of Smart Content, Widgets, and Standard Text/Tables | Highlight, copy & paste |
|
Moving Images | Click, drag & drop |
|
Filtering Smart Content
Filters can be applied to smart content to refine further the data presented. For example, filters can be applied to smart content in widgets by clicking the Add Filter button in the Add Widget screen.
Filter attributes are available based on the widget's selected model (e.g., material-related fields will be displayed for Materials). Add a filter by selecting the attribute, operator, and value. Then click Add.
Filtered widgets can be identified by the Filter parameter while in Edit mode.
Nesting Widgets to Add Record Sub-Section Data
To reference information located in a subsection of a record, users must set up nested widgets so that the smart content renders correctly. Examples of information that users may want to add from sub-sections include information about Source Documents and Risk Links. These are considered sub-sections because they may appear multiple times in different sections within the same record.
Nested widgets are created when a widget is added within another widget. When nesting widgets, it is essential to select the appropriate model and sub-model for each widget. Additionally, the order of the nested widgets may affect how information renders (e.g. table headers appearing per row). For the first widget, users should select the model that matches the type of record from which the information is being referenced. For example, to reference specific information about the Source Documents uploaded to a Project record, users should first select “Project” as the widget model. For this widget, no sub-model should be specified. Next, users should add another widget within the first widget. For the second widget, users should select the same model as the first widget, and then select the sub-model that matches the sub-section from which the information is being referenced. For example, to reference specific information about the Source Documents uploaded to a Project record, users should select “Project” as the widget model and “Project: Source Documents” as the sub-model for the second widget. After adding these nested widgets to the document, users can add the corresponding fields from the smart content menu. It is important to note that the fields available under the main header (e.g., “Project”) will only render when added in the first widget, while the fields available under the sub-header (e.g., “Project: Supporting Documents) will only render when added to the second widget.
Below is an example of how widgets can be nested to reference information about Project Supporting Documents.
Frequently Asked Questions
How can I add a filter to an existing widget?
Adding filters to existing widgets is not currently supported. The recommended workaround is to add a new widget for the same data with the filter applied and remove the old widget.
Why does some smart content render blank and not show in my QbDVision Doc?
There are several reasons why smart content may render blank and not display any information after a QbDVision Doc is saved. The first reason is that the fields that the smart content are referencing are blank in the record and do not contain any information. Once the user completes these fields, the smart content will update automatically with the information once the QbDVision Doc is loaded. The second reason that smart content will not render correctly is due to the setup of the Repeater and Table Widgets used. Instructions for how to correctly add smart content and use Widgets are detailed in the Doc Builder Confluence Page in the Doc Builder | Smart Content and Doc Builder | Widgets sections, respectively. Please submit a ticket through the Support Portal if you require further assistance.
Why is the table formatting not appearing in my exported Word file?
If the table border formatting in the exported Word file does not match the formatting in Doc Builder, we recommend updating the column width settings to “auto” for the affected tables.
Why does my exported Word file contain red “X” icons?
The red “X” icons (see below) may appear in your exported Word file when images or tables inserted in Doc Builder are not entirely deleted. To avoid these icons in the export, we recommend including the lines above and below the image or table when deleting it. This will ensure that the icons do not appear in the file during the export process.