User Interface
The add-in interface has two parts:
- A top ribbon
- A side panel
Top Ribbon
The ribbon only contains a button to open the side panel. Once the side panel is opened, the top ribbon can be collapsed.
Side panel
The side panel is the place where the add-in is displayed.
The panel layout consists in four main tabs to quickly switch between different interfaces.
- Home
- List the available actions to add dynamic content tags
- Explorer
- Allow the user to navigate through the hierarchy of tags
- Validation Center
- Display notifications if errors are made in the template.
- Settings
- Allow to load a Data Source Model and update template-level settings.
HOME TAB
This tab provides access to all the actions to insert dynamic information in the document:
- Tags
Ability to insert a field from the quote at any given point of the document - even in the footer and header of the document.
- Images
Ability to insert dynamic images referencing a field or a column from the quote.
- Tables
Ability to insert dynamic tables referencing quote grids.
- Sections
Ability to create block of content and manage their display depending on the quote content. Section are also used for the content-locking capability.
- Iterations
Ability to create iterative content based on quote grids.
- Sub-templates
Ability to insert appended documents at a given point of the document.
- Merge Document
Ability to merge external document at a given point of the document (PDF merge only).
- Attach Document
Ability to attach external files at a given point of the document.
These actions will be described in more details in specific help topics.
EXPLORER TAB
VALIDATION CENTER TAB
The errors that the validation will catch are:
- Invalid tag structure
- Tag overlap
- Incomplete tags
- Tag duplicates
- Missing data source model reference
For more details on the Validation Center, review the Template Validation section
SETTINGS TAB
The Settings tab allows you to set-up the template's global parameters. In this tab, the user is able to:
- Set or replace the Data Source Model by selecting a JSON file.
- Choose the default display format for each type of data.
For more information read Getting Started
- Activate the lock on the final document by setting up the lock password.
CONTEXT TAB
The Context tab is only displayed when the cursor is placed on a tag in the Word document. It's contextual to the type of tag.
This is where the user will be able to view tags properties and edit tags
| WHEN CURSOR POSITIONED ON: | IMAGE |
|---|---|
| Field tag | |
| Image tag | |
| Table tag | |
| Column tag | |
| Section tag | |
| Iteration tag | |
| Sub-template tag | |
| Merge tag | |
| Attach tag |
NAVIGATION
