Ecrion Publisher 11.5 (Klink) Users Guide
Working with your Data Source
Because you are using the Ecrion Publisher to design a dynamic document template, the first step will be to understand how to assign and work with your data sources. This section is designed to help you get started with assigning a data source, and also familiarize you with other actions present in the Data Source Pane.
Assign a Data Source
The first step in creating your document template will be to assign your data source. The Publisher will accept four data source file types: XML Data and Schema Files (.xml, .xsd), Data Modeler Diagram Files (.edx, .dax), EOS Form Templates Files (.efd), or Spreadsheet Files (.csv, .xlsx). In any case, you are assigning a data source that represents the same structure of the data you will be using with your document template at run time to produce your documents.
Remember that assigning a data source is the essential first step. When doing so, your data source will be accessible in the Data Source Pane for quick access. You will be able to drag and drop the data points in order to include them in your document template.
To assign a data source:
- Check the
Data Sourceoption available under the View tab to access the Data Source pane. - From the Data Source Pane, select the
Browsebutton, which will launch the Windows Open Dialog. - Select the file to be used as the data source and select
Open. - The data source will now be visible in the Data Source Pane in the Publisher.
Schema vs. Content view
When working in the Data Source Pane, you will notice your data can be displayed in two ways: Schema or Content. In this section of the help documentation, you can learn about the differences between these two data source views.
Schema View
Often, the data source contains a lot of content and it gets difficult to navigate through it in order to find a particular information. The Schema View displays the structure of the data source, instead of the content of each individual element.
Simply select the Schema tab from the Data Source Pane to view the schema of your data source.
Content View
The Content View is available in the Data Source Pane to provide you with the capability to view all of the data content present in your data source. This means, for example, that you will have the capability to view individual elements part of a repeating element sequence. It is very important for purposes like testing conditional sections, where you will want to see a specific example of something that should be displayed based upon a specific value found in your data source.
Another key benefit of viewing your data in Content View is that you have the capability to edit the data source content directly in the Publisher. You can learn more about this feature in the How to Edit Your Data Source section of the help documentation.
Edit
One of the great features of the Publisher is the capability to edit your sample data source directly in the application without having to modify the XML Source File. This can be achieved in a user friendly capacity, enabling you to make quick edits all through the user interface. This can prove to be very important to you when you start including intelligent design such as conditional formatting, for example, to highlight specific items in your document based upon a test performed on your data source.
Access Options
Whether you are editing an attribute or an element, the access to the Edit Dialog is the same:
- Select the element or attribute from the Content View and the Options menu launch icon will be displayed to the right.
- Select this button and choose the
Edit Itemoption in order to display the Edit Element or Edit Attribute Dialogs.
Edit Data Points
The Edit Attribute or Edit Element Dialog will provide options to edit either the name or the value of the selected item in the data source. To change any of them you will simply need to follow these steps:
- Place your cursor in either the Name or Value text boxes provided or highlight the text to be replaced.
- Make the necessary changes.
- Select the
Savebutton.
Note: Your adjustments will not be saved in the data source unless you choose to Save the data source.
Adding Data Points
Regardless if you are choosing to add an element, text value, or attribute, use the following steps.
- Select the parent element you wish to add the item to from the Data Source Pane Content View.
- Click on the Options menu displayed to the right.
- Select the
Add New Itemoption. - Use the drop down selection menu to choose which type of element you wish to add: element, attribute or text value.
- Specify the Name of the item to add.
- Specify the Value of the item, if applicable (for Text Value and Attributes).
- Select the
Insertbutton to add the item to your data source.
Removing Data Points
To remove a data point from your data source, use the following steps:
- Select the item to be removed from the Data Source Pane Content View.
- Click on the Options menu displayed to the right.
- Select the
Remove Itemoption. - Confirm in the additional dialog that you want to perform this action.
Search
One useful feature that you may wish to utilize is the Search Box located in the Data Source Pane. You will notice that this Search feature is available to you in both the Schema and Content Views of the Data Source Pane. The behavior of the search is a bit different in each view and, in this section, you can learn more about using the Search feature for either case.
Schema View Search
By using the search feature in the Schema View, the Publisher will search through all of the element and attribute names in your data source to find the item that you are looking for. It is not actually searching through the content of the data source, but only referencing the names of the items present.
For example, use the Search Box to find the attribute "Quantity". The Schema View will automatically adjust as you type and display the parent elements related to the "Quantity" item so you can see exactly where this item is located.
Content View Search
By using the Search Box in the Content View, you will be able to search not only the element and attribute names, but also the content within the data source.
If the same search for "Quantity" is used, you can notice that all of the quantity attributes from the data source are displayed.
Split
When working with the Publisher, the templates that are being created might be used in a batch workflow in Ecrion Platform. In batch workflows, you have the option to “split” data into records, where each record is used to generate a matching document. For example, you may have a data source that holds invoices for all your clients, and your batch workflow will need to render a separate document for each one.
The Split feature in the Publisher will allow you to use XML data that matches the format expected by the batch workflow, and to configure the Publisher to split the data just like the workflow would split it. The final result is that each record’s matching document is available for export within the Publisher. In order to work with this feature follow the steps below:
- Open your data source in the Data Source Pane by checking the
Data Sourcebutton from the View Tab. - If using a XML file, select the Schema Menu. If your data source is a Data Modeler file skip to step 3.
- Select on the repeating element that encapsulates the data for a single document instance.
- From the element’s Options Menu select
Split By. You should now see a visual indication that the split has been applied.
Configuration of the ‘split’ feature is now complete. In order to generate a document for every record, you will need to use the ‘export’ feature. Note that the ‘Preview’ feature will still generate only the first document.
- From the Home Tab, select the
Export tobutton and choose where you would like to save your generated documents. - The Publisher will export a new document for each record, according to the ‘split’ configuration.
- Use the file manager on your machine to navigate to the export folder. The output files will all be there, with a suffix indicating the record index within the data file.
Other Data Source options
Changing the Data Source
- Place the cursor over the side of the Data Source Pane that displays the name of the data source and select.
- Select a new file from the Windows Open Dialog.
Open in Editor
The Open Data Source option allows you to review and edit the data in the Ecrion Source Editor application.
Delete Data Source
You can use this option if you wish to remove the currently assigned data source. An additional confirmation dialog will be displayed to ensure you want to proceed.
Save Data Source
This option offers the possibility to save the data source directly from the Publisher. This feature is important because as you learn about editing your data source directly in the Publisher, you can save a copy for later usage or even save over the existing data source. One key item that you should keep in mind is that if you edit the data source in the Publisher, its name will possess a red asterisk character next to it. This is an indication that your edits have not been saved. By selecting the option to Save Data Source, you can save and the asterisk will be removed until a later edit is made.
Reload Data Source
To reload the data source you will need to select the green Reload button. This option is available to reload the data source from its original location. Typically there are a couple of reasons why this is required. The first is if you've decided to edit the Data Source directly in the Publisher and you wish to discard them, and the second is if you have made edits directly in the source XML and wish to have those edits refreshed in the Data Source Pane.
View Options
There are several important view options to understand when working in the Publisher. All of these options are accessible by simply selecting the View Tab located in the Ribbon.
Document Views
XML View
XML View is used to review and edit the code behind your template as you design in the Design Surface.
- From the View Tab in the Ribbon, select
XML Viewbutton. - Use shortcuts,
CTRL+Page UpandCTRL+Page Downto navigate between views. - From the Status Bar located at the bottom of the design surface select the
XML Viewbutton.
The XML View will open in the Publisher and you will be able to update and edit your templates' XML as needed. Edits made here will be directly translated to the Design View when you return.
Design View
The Design View is where most users complete all of their design work. Here you can use the Design Surface to add static and dynamic content to build your document template.
- From the View Tab, select the
Design Viewbutton. - Use shortcuts,
CTRL+Page UpandCTRL+Page Downto navigate between views. - From the Status Bar select the
Design Viewbutton.
Print View
Print View is a very useful feature when you would like to get a quick preview of your output without having to launch another application like a PDF reader to preview.
- From the View Tab, select the
Print Viewbutton. - Use shortcuts,
CTRL+Page UpandCTRL+Page Downto navigate between views. - From the Status Bar select the
Print Viewbutton.
In Print View you will notice your output is produced and your fields will be populated with the data from the data source. You will also be able to preview the template in a large variety of output formats as well as options to change display settings for pages and zoom.
Web View
Web View is a very useful feature when you would like to get a quick preview of your output without having to launch a browser for preview.
- From the View Tab, select the
Web Viewbutton. - Use shortcuts,
CTRL+Page UpandCTRL+Page Downto navigate between views. - From the Status Bar select the
Web Viewbutton.
In Web View you will notice your output is produced and your fields will be populated with the data from the data source. You will also be able to preview the template in a large variety of output formats as well as options to change display settings for pages and zoom.
You will also be able to view multiple outputs at one time to quickly evaluate what the document will look like on different devices.
Document Panes
Pagination Pane
The Pagination Pane is a very useful menu, that provides you access to all the pagination features, including to your designed Layouts and Page Sets.
- To enable the Pagination Pane, choose the
Paginationbutton located in the View Tab. - In the Pagination Pane, you will see a list with all of your Layouts and Page Sets under each tab. To add a new item, simply use the
Add new layoutorAdd new page setbuttons. To edit existing Layouts and Page Sets, select the item in the Pagination Pane, then choose the Options Menu located to the right to explore more options. For more information on working with the Pagination Pane please view Pagination.
Properties Pane
The Properties Pane can be used to modify the properties of any object present in your document template.
- To enable the Properties Pane, select the
Propertiesbutton located in the View Tab in the Ribbon. Additionally, you can right click on objects in the Design Surface and select Properties, or use theALT+Entershortcut. - You can see in the Properties Pane that there are multiple menus located at the top of the pane from which you can choose. Each menu possesses properties located in Groups below, depending on the property type.
- The menu located at the bottom of the Properties Pane is called the
Navigation Bar. You can use it to select an object and modify its properties. Additionally, you can select objects in the Design Surface when the Properties Pane is enabled and it will be updated for the current element.
Data Source Pane
By default, the Data Source Pane is displayed when opening the application. In case you closed it, it can be enabled from either the Home or the View Tabs. This menu will allow you to have direct access to your data source, so you will be able to include data points in your document template or to review and search through items for reference.
Rulers
Rulers are helpful when working with items such as paragraphs, tables, or columns. They provide not only visual guidelines for the layout when designing your template, but also enable you to create new indents by dragging and dropping them. A common example of ruler usage is when changing the column width in tables.
- Enable Rulers by selecting the Rulers Check Box located under the View Tab, in the Ribbon.
- You will notice in the Design Surface that rulers are now displayed.
- You can modify the positioning of objects on the page by dragging the Ruler selectors to new positions and see how it affects your content.
Gridlines
Gridlines are visual references used for positioning objects on the page in the Design Surface. They are typically useful when referencing the different regions of the document, as well as when using tables to position content on the page with no table formatting.
To toggle Gridlines on or off, select the Gridlines check box located under the View Tab, in the Ribbon.
Navigation Pane
Navigation Pane is a very useful option when creating documents that contain repeating and conditional data. This option provides a visual reference of the dynamic data, enabling you to edit it by simply double clicking on the matching side annotation.
- To enable the Navigation Pane, select the Navigation Pane check box located under the View Tab, in the Ribbon.
- You will notice, when enabled, that Navigation Pane will be present to the left of the Design Surface, indicating all of your dynamic content. The annotations will be color coded for repeating, conditional and other dynamic content types. Additionally, relationships will be reflected with indentations to show that objects are present inside of other dynamic elements.
- Selecting the
optionsbutton next to the dynamic value in the Navigation Pane will allow you to select the appropriate editing dialog in the Publisher. - Select on the target annotation options at the top of the Navigation Pane to select the specific dynamic elements to view. You can select from Fields, Repeating Elements, Conditional Elements, Dynamic Tables, Conditional Formatting Properties, or you can view them all.
Content Library
Content Library Pane is very useful when you want to edit content fragments included in document templates, synchronized with Ecrion Platform.
- To enable the Content Library Pane, select the Content Library check box located under the View tab, in the Ribbon.
- You will notice, when enabled, that Content Library Pane will be present to the left of the Design Surface and it will contains all the content fragments available in Ecrion Platform.
- For each selected content fragment, you can click on the Options Menu located in the top right and choose to open it, insert it under your document template as inline or as paragrah, or create categories and group your content fragments,as desired, from the Properties option.
EOS Drive
Ecrion provides the EOS Drive feature so any changes done to your local templates or to other resources, will be synchronized and ready to use within Ecrion Platform. Using EOS Drive, users have the possibility to open, edit or remove existing workspace files, or add new custom folders or templates using personal data. Once a new folder or file is created in EOS Drive, it can be added to the workspace, from which the desired outputs can be generated using the Ecrion Develop API.
Working with the EOS Drive
Accessing EOS Drive
- Access the Windows Taskbar menu.
- Select the
EOS Drivetool.
Connecting to Ecrion Platform using EOS Drive
If it is the first time you access EOS Drive, you need to follow the steps below:
- Under the EOS Drive tool select the
Connectbutton. - Fill out the form using your Ecrion Account credentials. You will need to provide the URL or IP Address along with the port number of the Enterprise Home website,an username and a password, and optionally, the environment name.
- Select
Browseto choose a local path to store the files. - Check
Synchronize files automaticallyto start the synchronization when log in.
EOS Drive displays the Workspaces data hierarchically, including Content Library, and permits files to be opened directly from the list with the corresponding tool. For example, if you need to access Insurance Communication, Insurance Policy Project, Form.edx file, you double-click on it and it will open directly with EDS Publisher tool.
Managing Accounts
Here, you can configure accounts in EOS Drive, either by adding a new account or changing properties within current one.
- Click on
Optionsmenu, in the right corner of the EOS Drive toolbar. - Select
Accountsoption from the contextual menu. - Within Configure Accounts Dialog, you have the possibility to
Add Account. - You will now need to specify the connection details, including the Server URL and login credentials for the newly introduced Ecrion Account.
- Once you have filled in all the required data, click on the
Connectbutton. - If, for some reason, the connection fails to establish, we recommend you to revisit step 4 mentioned above to ensure you provided the correct details.
More EOS Drive Options
Visiting Local Folder
- Select the
Browseoption (folder icon) located in the EOS Drive Toolbar. - You will notice that the folder containing all the files and workspace available in EOS Drive will be opened in File Explorer.
Adding New Folders
If you want to quickly create a new folder directly from EOS Drive, use these steps:
- Select the
Optionsmenu from the right side of the EOS Drive toolbar. - Select the
New Folderoption. - Provide a name for the folder, then click
Create.
If you want to create a new folder in Windows File Explorer, directly from EOS Drive, use these steps:
- Click on the
Optionsmenu from the right side. - Select the
Add Folderoption.
Opening Files
- Within EOS Drive interface, use the arrows from the left side to expand and navigate to the file you want to open.
- Click on the
Optionsmenu from the right side. - Select
Openand your file will be opened with the appropiate Ecrion tool.
Synchronizing Files Manually
If the Synchronize files automatically option is not enabled, you can update your files manually by using the options from below:
Checking Out a document
- Navigate to the needed Workspace in the EOS Drive, using the down arrow on the left corner.
- Select the document to be opened and then choose
Check Out for Editoption. - In the newly checked out document, make all of the required changes and click on
Save. Then, you must click onCheck In Pending Changesin order to update the document in the Drive.
Checking In a document
- Navigate to the needed Workspace in the EOS Drive, using the down arrow on the left corner.
- Select the document you have checked out and made edits to. It should be indicated with a red check mark next to it.
- From the Contextual Menu, select the
Check In Pending Changesoption. - From the Commit Changes Dialog, add any comments needed for this new version and then select
Check Inbutton.
Get the latest server version
- Navigate to the needed Workspace in the EOS Drive, from the down arrow on the left corner.
- Click on
Get Latest Versionbutton from the Contextual Menu, next to the name of the Workspace. - Once completed, all the files
and foldersstatuses will be updated. - Select from the Contextual Menu of any file/folder or the whole Workspace itself,
Get Latest Versionoption.
Undo pending changes
If you do not want to preserve the changes you have made to the document and wish to revert these changes, follow the instructions below.
- Navigate to the needed Workspace in the EOS Drive, from the down arrow on the left corner.
- Select the document you have made the changes to, which should be indicated with a corresponding red thick Icon.
- From the contextual options select the
Undo Pending Changesoption. - If you are undoing the changes of a file you have edited, you will receive a message requesting confirmation to reload and lose the changes you have made to the file. Click on
Yesbutton to proceed with losing changes and reloading the Server Version. If you selectNo, your changes will still be present in the Publisher and stored in the Local Working Folder.
Adding an Existing Folder
- Navigate to the needed Workspace in the EOS Drive, using the down arrow on the left corner.
- Select the project folder where the folder will be added to.
- Access the Contextual Menu and select the
Add Folderoption. - Use the Browse For Folder Dialog to search for and select the folder to be added.
- The folder will be displayed in the tree with a Green Plus Sign next to it and awaits the
Check In Pending Changescommand to upload it to the Drive. - Access the contextual options for the newly added project folder, and select the
Check In Pending Changesoption. - Optionally, you can add a comment for committing changes and then click on
Check Inbutton.
Adding a document
You may be working on a document that is not present in the Drive and you must add it.
- Navigate to the needed Workspace in the EOS Drive, using the down arrow on the left corner.
- Select the project folder where the file will be added to and expand it.
- Access the Contextual Menu and select the
Add filesoption. - Use the Windows Open Dialog to browse and select the file to be added.
- The file will be displayed in the tree with a Green Plus Sign next to it and awaits the
Check In Pending Changescommand to upload the file to the Drive. - Access the contextual options for the newly added file, and select the
Check In Pending Changesoption. - Optionally, you can add a comment for committing changes and then click on
Check Inbutton.
Removing a document
- Navigate to the needed Workspace in the EOS Drive, using the down arrow on the left corner.
- Select the folder from where the file will be removed, then expand it.
- Select the file that have to be erased.
- Access the Contextual Menu (
Settingssymbol button) and select theDeleteoption. - The file will be displayed in the tree with a red 'X' next to it and awaits the
Check In Pending Changescommand to completely delete the file from the Drive. - Access the Contextual Menu for the newly deleted file, then select the
Check In Pending Changesoption.
File Tab Options
Beyond simple options for creating a new template, opening a previous template, or saving the file, you also will be able to access the Options and Account Menu. In this section, you can learn about the options available to you within these menus.
Account Menu
Here you can find the current Product Information such as the Build Date and the package to which it belongs, together with the Product Key Information.
Installing Product Keys
- Select
Accountfrom the File tab of your Ecrion Design Studio Publisher Tool. - From the Account section, select
Install Product Key. You will be prompted to enter your Ecrion Account credentials. - Starting with Ecrion Develop, you can also use your Ecrion Platform credentials. Simply choose
Sign in with EOS Accountfrom More Options. You will be prompted to enter your Ecrion Platform credentials. - If your Ecrion Platform is hosted on-premise, click the server icon to be able to choose a local server. If your Ecrion platform is deployed remotely, IP addresses can also be used. Add the Ecrion platform username and password; optionally, you can enter an environment name.
- Next, select a product key from the list provided, then click on the
Installbutton. NOTE: If there are no available product keys, click on the Contact us button to purchase a permanent license. - Your license should now be activated. In File\Account, you can now see the Name and Expiration Date information for the product key you installed.
Uninstalling Product Keys
- Select
Accountfrom the File tab of Ecrion Design Studio Publisher Tool. - Select
Uninstall Product Keyfrom your Design Studio Account, then Sign in using Ecrion Account credentials or EOS credentials. - Select the product key that you want to uninstall from the list, then click
Uninstall. - Your product key should now be uninstalled.
Installing Product Keys using Offline Installation
You can install Design Studio product keys on a computer behind a firewall or proxy (or with no Internet connection), however, you will need to access a server that has an internet connection to obtain and activate the product key.
- Log in to your Ecrion Account from a computer with Internet Connection. Navigate to Product Keys and click on the
Key IDyou want to install. - Select
Install Licenseand copy the string generated in the License key field. - Select
Accountfrom the File tab of your Ecrion Design Studio Publisher Tool. - From the Account section, select
Install Product Key. ChooseInstall using a Product Keyfrom More Options menu. - Paste the string copied from Ecrion Account under the field displayed in Design Studio, then click
Install. - To use EDS Product Keys, you need to activate them first. Select
Activateto complete the activation. - If the computer does not have an Internet connection, select
Activate Offlinefrom the More Options menu. - Copy the string generated in the
Request Codefield. - Paste the string in the Activation key box from your Ecrion Account, then select
Install. - Next, copy the string generated in the Ecrion Account box, under the Activation Key field from Design Studio. Click
Activateto finalize the installation. - Your license should now be activated. In File\Account, you can now see the Name and Expiration Date information of the product key you installed.
Uninstalling Product Keys Offline
- Select
Accountfrom the File tab of your Ecrion Design Studio Publisher Tool. - To uninstall Product Keys Offline, select
Uninstall Product Keyfrom File\Account of any Design Studio Tools and chooseUninstall Product Key Offlinefrom More Options. - Select the license that you want to uninstall from the list, then click
Uninstall. - Next, you still need to uninstall the product key from your Ecrion Account as well, to be able to use it on another machine. Start by copying the string generated in Design Studio under Uninstall Key.
- Sign in to Ecrion Account and select the Key ID of the product key that needs to be uninstalled. Select
Uninstall Licenseand paste the string copied above. ClickUninstallto finish the process. - Your product key should now be uninstalled.
Options Menu
General
Here you can make general options configurations. Here you will have the options to:
- Change the log level if needed, and open the last log file created.
- Adjust the default unit of measure.
- Select the check box for absolute paths if you wish to use absolute paths for external resources like stylesheets, images, data sources, etc...
- Select to enable sending usage statistics to Ecrion so we may better update our products.
Developer
The developer menu will present you options to access more advanced usage of the Publisher. Here you will be able to select the XSL Transformation Engine you would like to use, and set Encoding. In addition, you will also have options for:
- Enabling the Developer Tab in the Ribbon to access parameters, inline XSLT, Scripts, and Global XSLT configurations.
- Choose if you would like to have a prompt to assign a XSD schema.
- Validate the XML against a XSD schema, if available.
- Enable Serializing CSS attributes when generating a stylesheet.
- Optimize the template automatically when generating a stylesheet.
- Validate Fields automatically.
- Display XPath labels.
You have the possibility to configure external fonts, by selecting Manage External Fonts option, at the bottom of the Developer's Options.
Tables
Tables can be helpful when designing your Document Templates for either positioning information on the page, or placing content in rows to display focused formatting in individual cells. To insert a table into your document template, you have many options.
Insert a Basic Table
- In the Ribbon, click on the
Tablebutton located in the Insert Tab. - Use the quick insert option to add up to a 10X8 table.
- You will notice that your table is now inserted into the Design Surface. You can proceed with editing and adding content to your table.
Note
Using the quick insert option will not insert a header or a footer row. Use the Insert option available on right-click context menu, to add a Header on Top or Footer on Bottom of your table.
Insert a Custom Table
- In the Ribbon, click on the
Tablebutton located in the Insert Tab. - You can click on the
Insert Tablebutton and the Insert Table Dialog will be displayed. - Select a style to use for your table from the available dropdown list.
- Type the number of rows and columns you wish to have in your table, in the provided fields.
- You can select available checkboxes for adding a table header and/or footer (
Has Header/Has Footer). - When you have finished your configuration for your table, click on
Insertbutton. You will notice that your table is now inserted into the Design Surface. You can proceed with editing and adding content to your table.
Table Options
Once you have inserted a table into your Document Template, you will need to understand the available options related to modifying and working with things such as padding and borders, for example.
Borders
From the Ribbon
- In the Design Surface, select the cell you wish to apply borders to. You can select multiple in a sequence by selecting the first cell, holding down the shift key, and then selecting the last cell in the sequence. The applied borders will be added to all selected cells.
- Once your selection is made, navigate to the Design Tab in the Ribbon and locate the Borders Group.
- Select the Pen Color in which you would like your borders drawn by using the drop down menu for color selection.
- Select the Width by specifying a value and dimension you would like to use. You can use the up and down arrows to modify or manually type the value.
- Select the
Bordersmenu button and choose where you would like your borders to be applied for your selected cells. - You will notice in the Design Surface, that the borders are applied as specified.
- For more options regarding borders, select
More Bordersfrom the Borders drop-down list available when the Borders button is selected.
From the Properties Pane
- Enable the Properties Pane from the View Tab by selecting Properties.
- In the Properties Pane, select the item you wish to modify in the Navigation Bar. Here you can select an individual cell that your cursor resides in or an entire table row relative to where your cursor is. The properties you modify will be applied to your selected item.
- In the Border Group, you will need to specify a desired color to apply, the thickness of the border and the style.
- Once you have made your border specifications, you need to select the border occurrence you would like to add. You will notice the table will update in the Design Surface to reflect any changes that are made.
Background
You can apply background colors for table items such as cells, rows, or the entire table by working with the Properties Pane using the following instructions.
- Enable the Properties Pane by selecting the
Propertiesbutton in the View Tab of the Ribbon. - In the Navigation Bar, from the bottom of the Properties Pane, select the item you wish to add background color to.
- In the Background Group, you can use the menu selection for Background Color to choose the color you wish to apply or specify your own color using the
More ColorsEditor. Additionally, you also have the option to add a background image if desired by clicking on the image logo to browse for a Background Image. - In the Design Surface the background color will be applied as you have specified.
Add/Remove Rows and Columns
From the Ribbon
- Start by placing your cursor inside a cell in the row or column you wish to use as reference. The options provided will be related to where your cursor is located in the table.
- To delete a row, column, or the entire table, click on the
Deletebutton in the Layout Tab and choose from available options to delete the current row or the column or the entire table where your cursor is positioned in. - To insert rows or columns, simply select from the available buttons
Insert Above,Insert Below,Insert Left, orInsert Right. Insert Above and Below are related to adding table rows and Insert Left and Right are related to inserting columns. Once you make a selection, a row or column will be inserted relative to where your cursor was positioned in the table.
Right Click Menu
- Begin by placing your cursor in the desired reference row or column. The options provided will be related to where your cursor is located in the table.
- Right click to reveal a contextual menu. Select Insert to expose more options for adding rows, columns, and headers and footers. Select from the available options to insert a row above or below or add a column to the left or right relative to where your cursor is placed.
- To delete rows, columns, or the entire table, select Delete to expose options to delete the current row, column, or delete the entire table.
Merge cells
From the Ribbon
- First, place your cursor in the desired location in the table where you would like to merge from. Available options will merge columns the right of the current cell as well as down from the current cell.
- In the Ribbon, select the Layout Tab for the table, and locate the Merge Group.
- You can click on the
Merge Cells HorizontallyorMerge Cells Verticallybuttons to merge cells vertically and horizontally related to the currently selected cell. - To remove the merge selection, click on the
Split Cells HorizontallyorSplit Cells Vertically. When selecting these options, the cells will be merged or unmerged one cell at a time, so you will need to make this selection as many times to complete your merge needs. Split options will unmerge columns the left of the current cell as well as up from it.
Right Click Menu
- Place your cursor in the desired location within the table. Available options will be related to where your cursor is located in the table so this step is important.
- Right click to reveal contextual options related to the table. Select
Mergeto reveal options related to merging/splitting cells. - The Split options are only available when a previously merged cell is selected in the Design Surface. You will need to select this item for every cell you wish to merge, repeating the process until you are satisfied with the design.
Apply Formating
A selection of predefined designed formats are available for you to choose from after inserting a table into your Document Template. To apply an auto format, follow the instructions below.
- Place your cursor anywhere inside of the table you wish to apply formatting to.
- In the Ribbon, locate the Design Tab, and reference the Styles Group.
- Simply select the Style Format that you wish to apply to your table. You will notice in the Design Surface that the format is applied to your table.
Important Note
If you apply an auto format and notice that the formatting does not match up with the preview image, this is normally caused by a lack of header and footer being present in the table. Auto format options depend on headers and footers in many cases and will apply formatting to those objects when applied. If they are not present, you can learn more about adding them by visiting Adding Headers and Footers After Creating.
Alignment
From the Ribbon
- Place your cursor in the desired cell to apply alignment changes to. The options provided will be related to where your cursor is located in the table.
- Navigate to the Alignment Group under the Table Tools\Design Tab in the Ribbon and select any of the available alignment options. You will notice that the alignment will be adjusted in the Design Surface and the applied alignment will be highlighted in the Ribbon.
Align by Feature
- Place your cursor in the desired cell to apply alignment changes to.
- In the Table Tools\Design Tab, select the Align By Text drop down menu to choose from available characters.
- Select the option you wish to apply alignment by dot, comma or colon.
- Your alignment will now be applied and noted in the Ribbon for this table cell.
- You should preview your output to ensure the behavior is as intended.
From the Properties Pane
- Place your cursor in the desired table cell in the Design Surface.
- Enable the Properties Pane by selecting Properties located in the View Tab.
- Select the Table Cell element in the Navigation Bar at the bottom of the pane.
- From the All tab, in the Alignment & Indentation Group, select the alignment you wish to apply.
- You will notice that there are two parameters to choose from, one related to the Vertical orientation of the cell - Vertical Align and another one related to the Horizontal orientation of the content in the cell - Text Align. After the selection, your alignment choice will be applied in the Design Surface.
Cell Margins
You may wish to control the margins within any given table object. This is most often the case when you are trying to control content distance from the edge of table items. Follow the instructions provided below to adjust table margins.
How to Adjust Margins
- Place your cursor in the desired table cell to edit. Multiple cells can be selected for application by holding down the shift key and selecting the initial cell and then the last cell in a sequence.
- Click on the
Cell Marginsbutton under Alignment Group in the Table Tools\Design Tab from the Ribbon and the Properties Pane will be launched. - In the Margins Group within Layout tab, select the appropriate measurement unit from the drop down menus and manually type the desired value or use up and down arrows to apply your margins. Hit Enter to apply your adjustments.
- You will notice in the Design Surface that the margins is applied accordingly.
Resize
Using the Design Surface
- Place your mouse over a column or row border to expose a two way directional arrow.
- Click and hold to drag the selected item to resize. A preview line will indicate where the outcome upon release.
- Release the mouse button. The table row or column will be resized as indicated.
Using the Ruler
- Enable Rulers by selecting
Rulersoption in the View Tab. - Mouse over any of the gray indicators for row or column end to expose a two way directional arrow.
- Select, drag and drop to desired location.
- Release the mouse at desired location and the column or row will be resized.
From the Properties Pane
- Place your cursor in the desired table cell to edit.
- Enable the Properties Pane by selecting Properties located in the View Tab.
- Select the Table Cell, Table Row or Table element in the Navigation Bar at the bottom of the pane.
- From the Layout tab, in the SIZE Group, provide the
Row HeightandColumn Widthyou wish to apply to the before selected element. - Select the appropriate measurement unit from the drop down menus and manually type the desired value or use up and down arrows to apply your settings. Hit Enter to apply your adjustments.
Headers and Footers
If you have inserted a table into your Document Template and wish to then add a header or a footer, follow these simple instructions provided below.
- Place your cursor inside of the table you wish to add a header or a footer.
- Right click to reveal a contextual menu, select
Insertoption and choose either to add aHeader on ToporFooter on Bottomelement. - You will notice in the Design Surface after selection that your table header or footer is now added to your table.
Grids
A Grid is used to quickly and easily organize the content on a page. Grids are similar to tables but they do not have headers, footers, grouping or repeating content.
Insert a Basic Grid
- In the Ribbon, select the
Gridbutton located in the Insert Tab. - You can either use the quick insert option to insert up to a 6X6 Grid or you can select the
Insert Gridbutton and the Insert Grid Dialog will be displayed. - Select a format to use for your Grid by using the up and down arrows to the right of the preview images. To select the format, click on the preview image available.
- Type the number of rows and columns you wish to have in your Grid in the provided fields.
- When you have finished your configuration for your Grid, select Insert. You will notice that your Grid is now inserted into the Design Surface. You can proceed with editing and adding content to your Grid.
Grid Options
Once you have inserted a Grid into your Document Template, you will need to understand the available options to modifying and working with things such as margins and borders, for example.
Borders
From the Ribbon
- In the Design Surface, select the cell you wish to apply borders to. You can select multiple in a sequence by selecting the first cell, holding down the shift key, and then selecting the last cell in the sequence. The applied borders will be added to all selected cells.
- Once your selection is made, navigate to the Design Tab in the Ribbon and locate the Borders Group.
- Select the Pen Color in which you would like your borders drawn by using the drop down menu for color selection.
- Select the Width by specifying a value and dimension you would like to use. You can use the up and down arrows to modify or manually type the value.
- Select the
Bordersmenu button and select where you would like your borders applied to your selected cells in the Design Surface. - You will notice in the Design Surface, that the borders are applied as specified.
From the Properties Pane
- Enable the Properties Pane from the View Tab by selecting Properties.
- In the Properties Pane, select the item you wish to modify in the Navigation Bar. Here you can select an individual cell that your cursor resides in or an entire grid row relative to where your cursor is. The properties you modify will be applied to your selected item.
- In the Border Group, you will first need to specify a desired color to apply, select the thickness of the border,and select the style of the border.
- Once you have made your border specifications, you need to select the border application you would like to add. You will notice the grid will update in the Design Surface to reflect any changes that are made.
Background Colors
You can apply background colors for grid items such as cells, rows, or the entire grid by working with the Properties Pane using the following instructions.
- Enable the Properties Pane by selecting the
Propertiesbutton in the View Tab of the Ribbon. - In the Navigation Bar, select the item you wish to add background color to.
- In the Background Group, you can use the menu selection for Background Color to choose the color you wish to apply or specify your own color using the Editor. Additionally, you also have the option to add a background image if desired by selecting Browse to select a Background Image.
- In the Design Surface that the background color will be applied as you have specified.
Add/Remove Rows and Columns
From the Ribbon
- Start by placing your cursor inside a cell in the row or column you wish to use as reference. The options provided will be related to where your cursor is located in the grid.
- To delete a row, column, or the entire grid, select the
Deletebutton in the Layout Tab and choose from available options to delete the current row or column or entire grid your cursor is positioned in. - To insert rows or columns, simply select from the available buttons Insert Above, Insert Below, Insert Left, or Insert Right. Insert Above and Below are related to adding grid rows and Insert Left and Right are related to inserting columns. Once you make a selection, a row or column will be inserted relative to where your cursor was positioned in the grid.
Right Click Menu
- Begin by placing your cursor in the desired reference row or column. The options provided will be related to where your cursor is located in the grid.
- Right click to reveal a contextual menu. Select Insert to expose more options for adding rows, columns, and headers and footers. Select from the available options to insert a row above or below or add a column to the left or right relative to where your cursor is placed.
- To delete rows, columns, or the entire grid, select Delete and expose options to delete the current row, column, or delete the entire grid.
Merge cells
From the Ribbon
- First, place your cursor in the desired location in the grid where you would like to merge from. Available options will merge columns the right of the current cell as well as down from the current cell.
- In the Ribbon, select the Layout Tab for the grid, and locate the Merge Group.
- You can select Merge Cells Horizontally or Merge Cells Vertically to merge cells vertically and horizontally from your currently selected cell. To remove select Split Cells Horizontally or Split Cells Vertically. When selecting these options, the cells will be merged or unmerged one cell at a time, so you will need to make this selection as many times to complete your merge needs.
Right Click Menu
- Place your cursor in the desired location within the grid. Available options will be related to where your cursor is located in the grid so this step is important.
- Right click to reveal contextual options related to the grid. Select Span to reveal options related to merging cells.
- By using this menu, you can select options Increase Row Span, Increase Column Span, Decrease Row Span, and Decrease Column Span. The decrease options are only available when a previously merged cell is selected in the Design Surface. You will need to select this item for every cell you wish to merge, repeating the process until you are satisfied with the design.
Apply Formating
A selection of previously designed formats are available for you to choose from after inserting a grid into your Document Template. To apply an auto format, follow the instructions below.
- Place your cursor anywhere inside of the grid you wish to apply formatting to.
- In the Ribbon, locate the Design Tab, and reference the Auto Format Group.
- Simply select the Auto Format that you wish to apply to your grid. You will notice in the Design Surface that the format is applied to your grid.
Important Note
If you apply an auto format and notice that the formatting does not match up with the preview image, this is normally caused by a lack of header and footer being present in the grid. Auto format options depend on headers and footers in many cases and will apply formatting to those objects when applied. If they are not present, you can learn more about adding them by visiting Adding and Headers and Footers After Creating.
Alignment
From the Ribbon
- Place your cursor in the desired cell to apply alignment changes to. The options provided will be related to where your cursor is located in the grid.
- Navigate to the Alignment Group under the Layout Tab in the Ribbon and select any of the available alignment options. You will notice that the alignment will be adjusted in the Design Surface and the applied alignment will be highlighted in the Ribbon.
From the Properties Pane
- Place your cursor in the desired grid cell in the Design Surface.
- Enable the Properties Pane by selecting Properties located in the View Tab.
- Select the grid Cell element in the Navigation Bar.
- In the Cell Alignment Group, select the alignment you wish to apply.
- You will notice that the alignment selected will be highlighted in blue in the Properties Pane and your alignment choice will be applied in the Design Surface.
Align by Feature 1. In the Design Tab select the Align By drop down menu to choose from available characters. 1. Select the option you wish to apply to align by dot, comma, or colon. 1. Your alignment will now be applied and noted in the Ribbon for this grid cell. 1. You should preview your output to ensure the behavior is as intended.
Cell Margins
You may wish to control the margins within any given grid object. This is most often the case when you are trying to control content distance from the edge of grid items. Follow the instructions provided below to adjust grid margins.
How to Adjust Margins
- Place your cursor in the desired grid cell to edit. Multiple cells can be selected for application by holding down the shift key and selecting the initial cell and then the last cell in a sequence.
- Select the
Cell Marginsbutton in the Layout Tab tn the Ribbon and the Properties Pane will be launched. - In the Margins Group, select the appropriate measurement unit from the drop down menus and manually type the desired value to apply your margins. Hit enter to apply your adjustments.
- You will notice in the Design Surface that the margin is applied accordingly.
Resize
Using the Design Surface
- Place your mouse over a column or row border to expose a two way directional arrow.
- Click and hold to drag the selected item to resize. A preview line will indicate where the outcome upon release.
- Release the mouse button. The grid row or column will be resized as indicated.
Using the Ruler
- Enable Rulers by selecting
Rulersoption in the View Tab. - Mouse over any of the grey indicators indicating row or column end to expose a two way directional arrow.
- Select and drag and drop to desired location.
- Release the mouse at desired location and the column or row will be resized.
Headers and Footers
If you have inserted a grid into your Document Template and wish to then add a header or a footer, follow these simple instructions provided below.
- Place your cursor inside of the grid you wish to add a header or a footer.
- Right click to reveal a contextual menu, select Insert and choose either to add a Header on Top or Footer on Bottom.
- You will notice in the Design Surface after selection that your grid header or footer is now added to your grid.
Repeating Content
In most document templates, there is a need to have content repeated in the output document for an occurrence of a data point in the data source. Common examples include: a repeating table in an invoice that lists all the transactions over the past month, a repeating paragraph displaying each line present in a transcript, or repeating a list of available products in the same line. Whether you are trying to create a table with a repeating row or configuring a section to repeat inline or in a new paragraph, you can learn about how to accomplish these objectives and more in this section.
Repeating Tables
Repeating Tables are a great way to display repeating content in your data source in a structured table format. These are often used when needing to display multiple columns of information for a single occurrence of repeating data point. In this section you can find all information related to working with repeating tables.
Create using Drag and Drop
Perhaps the easiest method for creating a repeating table in your document template is to utilize the drag and drop functionality provided by the Data Source Pane. Use the following steps to create a repeating table using the drag and drop method. In this example, we'll demonstrate using a simple invoice to list, in table format, information for each product that was purchased in the billing period.
- Enable the Data Source Pane by clicking on the
Data Sourcebutton from the Home Tab in the Ribbon. - You will need to consider which element in your data source is the item that you want your table row to repeat for.
For example, consider the following XML:
< Invoice>
< InvoiceProperties>
< Products>
< Product>
< id>1< /id>
< name>Arthur C. Clarke< /name>
< /Product>
< Product>
< id>2< /id>
< name>Frank Herbert< /name>
< /Product>
< /Products>
< InvoiceProperties>
< /Invoice >
The Product element repeats in the data source and it is exactly what we want our table row to repeat for: repeat the table row displaying information about every product purchased.
- Once you have located the element that you wish your table row to repeat for, select the element in the Data Source Pane and, holding down the mouse button, drag and drop the element into the Design Surface.
- A pop up contextual menu will appear at the mouse release, from where you need to choose
Dynamic tableoption.
Create using the Ribbon
You can create a repeating table during the initial configuration of any table when using the Insert Table Dialog. The following steps need to be followed to achieve this objective. For our example, we will use a repeating element in a sample data source called "Product" to set up a table to display information for every product purchased in the billing cycle for an invoice.
- Click on the
Tablebutton from the Insert Tab in the Ribbon. - Select the
Insert Dynamic Tableoption and a corresponding dialog will now be displayed. - You will now be presented with the Insert Repeating Row Dialog. To begin, select the element in your data source, that you wish for your table row to repeat for. In this example, we will select the "Product" element, and click on the
Insertbutton. - Next, in the Insert Dynamic Table Dialog, choose the table styling option you wish to apply when inserting the table. You should also notice, that the Columns Group will display available choices for including columns in your table. These choices are taken directly from the information present in each "Product" element.
- When you are finished with your configurations, click on the
Insertbutton and your table will be inserted into the design surface. Here you will notice that table is inserted into the document template. By placing your cursor anywhere in the repeating table row you will notice a visual indication of which element row repeats for as well as a green background color indicating that this row is a repeating table row. - It is recommended that you preview your output at this point to ensure all of your table configurations are behaving as intended. In our example the table row repeats for every "Product" element displaying relevant information. However, the repeating content is also sorted by price from highest to lowest as well as possesses an alternating table row color as previously configured.
Create by Conversion
- To begin, first place your cursor inside of the table row that you wish to convert to a repeating row.
- Right click, and you will be presented with a contextual menu. Select the option
Convert Toand then choose Repeated Row. - You will now be presented with the Insert Repeating Row Dialog. You can now select in the Data Tree the repeating element in your data source that you wish for the row to repeat for. In our example we will navigate to and select the "Product" element. Notice that the selected item will be highlighted to give you a visual indication of your selection. For more complex expressions, you can select Create Expression to create your own XPath Expression.
- When you are finished with your configuration, select Save. You will now be returned to the Design Surface where you will notice your table row is now highlighted in green and there will be a visual indication of the element that the row repeats for.
A Common Error
You will notice in our example we have converted a previously static table row with dynamic content (fields) present previously. A common error that can occur when converting a table row that already has dynamic content in it is that your output will only repeat the same information.
It is important to understand that when the Field was originally created, it was set up to find a specific value in the data source. However, by converting this row to a repeating row we have now changed the context in which this field is evaluated. What we really want, in this example, is for the Field to pull the content that is relative to the repeated element that is currently being evaluated.
For this reason alone, we recommend that you always set your repeating rows before adding any dynamic content to avoid having to make additional modifications. There are primarily two ways that you can resolve such an issue.
Changing the Fields Using the Edit Field Dialog
- Begin by selecting the Field in the Design Surface.
- Double click on the Field to launch the Edit Field Dialog.
- In this Dialog, you will notice now that some fields outside of your repeating element are in gray. This is because the repeating context is taken into consideration.
- In the Create Expression Dialog you will need to update the XPath in the expression box. To do so, simply delete the expression that is there, and select the original field. In our example, the field was originally retrieving the "price" attribute, so we will select the "price" attribute again. This time, the Publisher will automatically take into consideration the new context and update our field appropriately.
- Click on the
Savebutton when configurations are complete. Now it is recommended to preview your output to ensure the content is displayed correctly, and this process should be repeated for every Field present in your table row that was converted.
Deleting and Replacing the fields
Deleting and replacing the Fields in your table row is a valid option if you do not have many to replace or if you have not already applied formatting to your Fields. If you have already spent valuable time applying formatting to your Fields within the table row, you should probably use the method described above to modify the Fields so you will not need to reformat them. However, if you now delete and replace these Fields with new ones, the Publisher will automatically take the repeating context into consideration.
- Select a Field in your table row and delete.
- Using the Drag and Drop method, select the same data point previously deleted in the Data Source Pane and drag into the repeating table row to create a new Field.
- The Publisher will now automatically take the repeating context into consideration.
Create Repeating Columns
You also have the option to create a repeating table that will set up a repeating column to repeat for every item in your data source. To create such a table, follow the instructions provided below.
- In order to create a table with repeating columns instead of repeating rows you will need to convert a table that you have created. Select in the row that you would like to convert.
- Navigate to the Layout Tab in the Ribbon and click on the
Convert tobutton and selectRepeating Columnoption from the Repeating Column group. - From the Insert Repeating Column Dialog select the element that you would like have your cell repeat for from the data tree or you can select the
Create Expressionbutton. When you have selected your field select Insert and the cell will be converted into a repeating column. - The new repeating column will now be shown in the design surface. Drag and drop your needed field into the new cell.
- You can now proceed to format your table and remove any additional content that you do not wish to be displayed. When previewing your output, you will notice that a column is created for every occurrence of the element that you configured the column to repeat for.
Edit Table Rows
Right Click Option
- Place your cursor anywhere inside of the repeated table row you wish to edit. Make sure you have not selected another dynamic component like a Field.
- Right click and select
Editand then click on theRepeating Rowbutton to launch the Edit Repeating Row Dialog. - In the Edit Repeating Row Dialog you can select a new element for the table row to repeat for in the Data Tree or you can select Create Expression to create a more complex XPath Expression manually.
From the Ribbon
- In the Design Surface select the Repeated Row and navigate to the Layout Tab in the Ribbon.
- From the Repeating Row group click on the
Editbutton and this will launch the Edit Repeating Row Dialog. - In the Edit Repeating Row Dialog you can select a new element for the table row to repeat for in the Data Tree or you can click on the
Create Expressionbutton to create a more complex XPath Expression manually.
Group Table Rows
Sometimes, to make a point over some information or to make the information easier to understand, the data presented in tables must be grouped considering different criteria. In the example that we will use to highlight these steps, we have a table that will repeat for all of the products that are in our data source. The rows will be grouped by the purchased quantity.
- Place the cursor anywhere in the repeating row you would like to group.
- From the contextual Layout Tab for the table, click on the
Group Bybutton. - This will display the Group By Dialog. Here you will notice that there is already content for the Group Context. This context is inherited from the repeating row that you have selected. From the Group By Dialog, click on the
Selectbutton located in the Group By section. - You will need to set the data point you wish to group your data by. You can either select the element from the data tree or click on the
Create Expressionbutton to create a more complex expression. In this example we will group the data by the quantity. After selecting the data point 'quantity' for the group, click on theInsertbutton. - Now, in the Group By Dialog, you will see the data for the point that you have selected. To edit it, you will simply need to click on the
Selectbutton. If theMerge content with first rowoption is checked, the content of the new row will be merged with the first row's content. After finishing the Group By configurations, click onSave. - In the Design Surface, the table you grouped will now show an extra row, which is the group by row. You are able to edit, format or sort this row just as you would do with a regular repeating row.
- It is recommended that you preview your output at this point to ensure all of your Group By configuration are behaving as intended. In our example the table row repeats for every "Product" element. However, the repeating content is also grouped by the quantity of the products purchased.
Repeating Paragraphs
Repeating Paragraphs are an excellent way to display repeating content from your data source when you do not want this presented in a table format. With a Repeating Paragraph, you can display large sections of repeating content that will create a new paragraph for every occurrence of an element that you specify. For example, if you are building a contract that contains several paragraphs of legal content present in repeating elements in the data source. A repeating paragraph can be used to populate all of the content creating a new paragraph for each item in the data source without having to manually type static text in your document template.
Create using Drag and Drop
You can create Repeating Paragraphs easily by utilizing the drag and drop functionality directly from the Data Source Pane. In this section, we will use an example providing a list of offered books and a description of each all obtained from the data source from a repeating element called "Product".
- Enable the Data Source Pane by clicking on the
Data Sourcebutton located in the Home Tab of the Ribbon. - You will need to determine which element in your data source you want to generate a paragraph for every occurrence of this element. For our example, the information resides in a repeating element called "Product".
- Once you have determined which element the paragraph will repeat for, select the element in the Data Source Pane and drag into the Design Surface. Release the mouse in the desired location and you will be presented with a contextual menu. Here you must select Repeating Paragraph.
- Notice in the Design Surface that a Repeating Paragraph is now inserted. You should be aware that you will have a visual indication of which element the paragraph repeats for and the paragraph will be highlighted in blue indicating that it is a Repeating Paragraph.
- Next, you will need to replace the placeholder text with the content you wish to be displayed. Here you will simply highlight and delete the placeholder text and add the relevant content you wish to display for each occurrence. In our example, we will add the product "name" attribute as well as the "description" attribute with some static text "Product Description". When inserting Fields into the Repeating Paragraph, the Publisher will automatically take into consideration the repeating context of the paragraph. Additionally, we have added an additional space to separate the content when it is repeated.
- When you have finished adding the content that you wish to be presented in each paragraph, you should preview your output to ensure that the content is retrieved from your data source and displayed properly.
Create using the Ribbon
- Click on the
Repeating Paragraphbutton from the Insert Tab in the Ribbon. - Next, in the Repeated Paragraph Dialog, you will need to simply navigate to the element you wish the paragraph to repeat for in the Data Tree and select that item then click on
Save. In our example, we want to create a repeating paragraph to display information contained within every "Product" element. You will notice that your selection will be highlighted in the Data Tree. For more complex needs, you can click on theCreate Expressionbutton to construct a customized XPath Expression. - Notice in the Design Surface that a Repeating Paragraph is now inserted. You should be aware that you will have a visual indication of which element the paragraph repeats for and the paragraph will be highlighted in blue indicating that it is a Repeating Paragraph.
- Next, you will need to replace the placeholder text with the content you wish to be displayed. Here you will simply highlight and delete the placeholder text and add the relevant content you wish to display for each occurrence. In our example, we will add the product "name" attribute as well as the "description" attribute with some static text "Product Description". When inserting Fields into the Repeating Paragraph, the Publisher will automatically take into consideration the repeating context of the paragraph. Additionally, we have added an additional space to separate the content when it is repeated.
- When you have finished adding the content that you wish to be presented in each paragraph, you should preview your output to ensure that the content is retrieved from your data source and displayed properly.
Edit Repeating Paragraph
If you need to make modifications to your Repeating Paragraph after inserting into your document template you can use the Edit Repeating Paragraph Dialog that can be accessed in a variety of ways.
Access from Right Click
- Place your cursor inside of the Repeating Paragraph and right click.
- From the resulting contextual menu, click on the
Edit Repeating Paragraphbutton and this will launch the Edit Repeating Paragraph Dialog.
Access from Contextual Tab
- Select anywhere in the Repeating Paragraph and navigate to the contextual Paragraph Tab in the Ribbon.
- Click on the
Editbutton from the Repeat group and this will launch the Edit Repeating Paragraph Dialog.
Access from Navigation Pane
- If you have the Navigation Pane enabled (View Tab - Navigation Pane), you will notice the Repeating Paragraph is highlighted in blue on the left side of the Design Surface.
- By simply clicking on the
Optionsbutton and selectingEdit Repeating Paragraphoption, the Edit Repeating Paragraph Dialog will be launched.
Repeating Text
Create using Drag and Drop
- In the Data Source Pane, locate the repeating element that you wish to have text repeat for every occurrence of this element. The "Product" repeating element will be used in this example to display a list product names in line.
- Select the repeating element in the Data Source Pane, and drag and drop into the Design Surface at desired location. Upon release of the mouse button, you will be presented with a contextual menu. Click on the
Repeating Textbutton from this menu. - A Repeating Text object is now inserted into the Design Surface with blue visual indication that the content within will be repeated for every occurrence of the element you have selected.
- Replace the placeholder text with the content that you wish to repeat for every occurrence of your selected element. In this example, the "name" attribute is added inside of the Repeating Text object by dragging and dropping from the Data Source Pane and a comma and a space is added. The result will yield each name being displayed with a comma and space occurring after.
- At this point you should preview your output to ensure your Repeating Text is creating your desired output.
Create using the Ribbon
- Place your cursor in the Design Surface where you would like to add your Repeating Text.
- Next, you will need to select the repeating element to be used by selecting in the Data Tree of the Repeated Text Dialog. We want our text to repeat for every "Product" element. For more complex expressions,like filtering your data, select
Dynamic Values. - Select
Insertwhen your selection is complete. - Now the Repeating Text object will be inserted into the Design Surface. You will notice placeholder text and a visual indication in blue to show the element that this text section will repeat for.
- Replace the placeholder text with the content that you wish to repeat for every occurrence of your selected element. In this example, the "name" attribute is added inside of the Repeating Text object by dragging and dropping from the Data Source Pane, the result will yield each name being displayed with a comma and space occurring after.
- At this point you should preview your output to ensure your Repeating Text is creating your desired output.
Quick Access Options
- Navigate to the Insert Tab in the Ribbon and click on the
Repeating Textbutton. - Select one of the two quick access options:
Comma SeparatedorCustom. It is important to note that selecting the custom condition will allow you to create your own Repeating Text section as described in Creating Repeating Text - Using the Ribbon. - Once you select the option, the Insert Repeating Text Dialog will launch. You will need to select the data point you wish to have the section repeat for.
- You will notice in the Design Surface that your condition will be added as a Text. Placeholder text will be visible giving an indication of what the condition is set up to test and by default a fallback section has been created. From here you will need to replace the placeholder text with content that you want to show based on the condition set, you can learn more about that here.
Edit Repeating Text
If you wish to modify the configuration of your Repeating Text element, you can do so using the Edit Repeating Text Dialog. Here you will be able to select a different element for the text to repeat for, change the separators used or select Dynamic Values to create a more complex XPath Expression. Use the information below to assist you in accessing this Dialog.
Access from Right Click
- Place your cursor inside of the Repeating Text object in the Design Surface.
- Right mouse click.
- Click on the
Edit Repeating Textbutton from the resulting contextual menu.
Access from the Ribbon
- Select anywhere in the Repeating Text Section and navigate to the contextual Text Tab in the Ribbon.
- Click on the
Editbutton from the Repeat group and this will launch the Edit Repeating Text Dialog.
Access from the Navigation Pane
- Toggle the Navigation Pane on, by visiting the View Tab in the Ribbon and selecting the Navigation Pane check box.
- The Navigation Pane will be displayed to the left of the Design Surface. Locate the Repeating Text object as indicated in blue.
- Click on the
Optionsbutton for the Repeating Text and select theEdit Repeating Textoption from the contextual menu to access the Edit Repeating Text Dialog.
Work with Separators
When adding Repeating Text to a template, you have the ability to add different separators,like a ','. This section will walk you though how to add or change a separator.
If you would like to add a comma between the text, view the steps in Quick Access Option and click on the Comma Separated button. This will automatically create a Repeated Text section that will have a comma separator.
- Select the Repeating Text section to work with.
- In the Ribbon Navigate to the Text contextual tab.
- From the Repeat group select a separator from the drop down list. Here you are also able to select the last separator for the repeating text as well.
Other Repeating Content Options
Filtering Repeating Content
- When inserting your repeating content, in this example a repeating table, we will need to access the Edit Repeating XXXX Dialog to adjust the expression used for the repeat. "XXXX" represents either repeating table, paragraph, or text.
- Currently the output of this table is set up to repeat for every "Product" element displaying all values.
- In the Edit Repeating Row Dialog, select Dynamic Values.
- square brackets. The square brackets are added to the node set (to the right) that will be repeated by manually typing them in. In this example, "[@price>20]" is added to the right of the repeating "Product" element. This results in "select all product elements containing the price attribute with values greater than 20". You can use the operator options and insert selected options below the Expression Dialog to add or you can manually create your expressions by typing.
- Select Save when you have completed creating your expression. It is now time to preview your output to ensure your expression was set up properly and the output reflects the desired behavior.
Sorting Repeating Content
- Select the repeating section or table row you would like to sort and navigate to the Paragraph tab in the Ribbon.
- Click on the
Sortbutton, which will launch the Edit Sort Dialog. Here click on theAdd rulebutton. - In the Add Sort Criteria Dialog you will need to select the data point you wish to base the sort criteria of, from the data tree or click on the
Create Expressionbutton to create a more complex expression. For this example we will sort our table by the price of our products. When you have selected your data point, click onInsert. -
In the Edit Sort Dialog you have the below options for your Row Sort Expression. For our example we will sort the price in ascending order.
- Sort Order
Select if you want the row data be ascending or descending. - Data Type
Select if the data from the sort expression is a text or number value. - Case Order
If the data type is text(string), you will need to select the case order. The case order refers to the order of the data if the data source has duplications in which some data points are uppercase and some are lowercase.
- Sort Order
-
At this point you can repeat steps 2-4 as many times as needed to sort the table to meet your needs. By selecting on a Sort Expression you will have the options to edit, reorder the expressions if there is more than one and to delete the expression. It is important to note that the Publisher will sort the data in the order present in the Dialog.
- It is recommended that you preview your output at this point to ensure all of your Row Sort configurations are behaving as intended.
Conditional Content
When designing your document template, you may have the need to show or hide content conditionally based upon a test on your data source. Such content is referred to as Conditional Content and can easily be set up in the Publisher. You can accomplish this objective on a paragraph level or show or hide content directly in line.
Conditional Paragraphs
Conditional Paragraphs allow you to include entire paragraphs of content both static and dynamic into your outputs entirely dependent upon your data source.
Create New Conditional Paragraph
- In the Insert Tab in the Ribbon, click on the
Conditional Paragraphbutton. -
Next, you will be presented with the Insert Conditional Paragraph Options where you will need to set your initial condition. The steps below will walk you though creating the first condition.
a. Select in the Data Tree the data value to base your condition on. In this example, the "show-discount" attribute will be used. Your selection in the Data Tree will be highlighted for visual reference.
b. Then, choose your type of condition based on available options: occurrence, numerical value, or text value. In this example, we want to test to see if this attribute contains the value "true" or "false" so we have to choose
Based on Text Value.c. Then specify the details of your condition using the drop down menu available and then add the value to test for. Here we have added "true" by typing in the value field. You can create more complex conditions manually by clicking on the
Create Expressionbutton. When you are finished configuring your condition, click onInsert. -
You will notice in the Design Surface that your first condition will be added as paragraph. Placeholder text will be visible giving an indication of what the condition is set up to test and by default a fallback section has been created.
- At this point you can simply replace the text that is present with the dynamic or static content that you wish to be displayed for condition and the fallback section. If you need to add more conditions or want to remove the fallback section you can do this from the Paragraph Pane within Conditional Tools. In this example, we are including a message for when the "show-discount" attribute is set to true and when any other value is present to display a default message.
- Lastly, you should test your results by previewing the output. You can Edit Your Data Source to modify the test value and compare to ensure the behavior is correct. By changing the "show-discount" attribute from true to false, the output reveals the desired results. Notice that only one paragraph is used for the output and no space will be consumed by the paragraphs that do not evaluate for the condition.
Quick Access Options
- Navigate to the Insert Tab in the Ribbon and click on the
Conditional Paragraphbutton. - Select one of the four quick access options:
If Exists,If Greater Than,If ContainsorCustom Condition. It is important to note that selecting the custom condition will allow you to create your own condition as described in How to Create Conditional Paragraph section. - Once you select the condition you would like, the Insert Conditional Paragraph Dialog will launch, with some configurations already made. You will need to select the data point you wish to base the condition from the data tree and select the value that will make the condition true.
- You will notice in the Design Surface that your condition will be added as a paragraph. Placeholder text will be visible giving an indication of what the condition is set up to test and by default a fallback section has been created. From here you will need to replace the placeholder text with content that you want to show, based on the condition set, you can learn more about that here.
Edit Conditional Paragraphs
Once you have inserted a Conditional Paragraph into your document template, you may wish to revisit the setup of any of your conditions, add new conditions, or remove them.
Edit a Specific Condition
Right Click Option
- Place your cursor in the desired condition you would like to modify in the Design Surface.
- Right click to reveal a contextual menu. Click on the
Edit Conditionbutton to reveal more options and chooseCondition. - The Edit Condition Dialog will be displayed. Use this Dialog to make a quick configuration change to your condition.
Using the Ribbon
- Place your cursor in the desired condition you would like to modify in the Design Surface.
- Click on the
Editbutton in the Condition group in the Paragraph contextual tab. - The Edit Condition Dialog will be displayed. Use this Dialog to make a quick configuration change to your condition.
Add, Edit, Remove Conditional Paragraphs
Right Click Option
- Right click in any of the conditions present in your Conditional Paragraph Section.
- From the contextual menu, click on the
Edit Conditionbutton to reveal more options and chooseAll Conditions. -
In the resulting Edit Conditional Paragraph Dialog, you can choose from the following options:
a. Select a present condition to change the evaluation order using the up and down arrow buttons.
b. Select a present condition to edit the condition setup in the Edit Condition Dialog.
c. Select a present condition then click on theXbutton to remove the condition entirely.
d. SelectAdd New Conditionto create a new condition to be present in your section.
e. Select to toggle on or off the fallback section.
Using the Ribbon
- Select any of the conditions present in your Conditional Paragraph Section and navigate to the Paragraph contextual tab in the Ribbon.
-
From the contextual tab you will have the following options:
a. Delete the
Active Condition(the condition you have selected) orAll Conditions. b. Insert a new condition. For more information on how to configure your condition visit How to Create a Conditional Paragraph.
c. Conditional Paragraph withinConditionsoption.
d. Toggle on or off the else section (Has Else).
e. Edit the condition you have selected.
Conditional Text
Conditional text is used to show or hide content in line depending upon a test of your data source. A common usage example is in letters where either Mr. or Mrs. should be used as salutation depending upon the gender present in the data source.
Create New Conditional Text
- In the Insert Tab in the Ribbon, select the
Conditional Textbutton. You will be presented with the Insert Conditional Text Dialog. -
Next, you will be presented with the Insert Conditional Paragraph Dialog where you will need to set your initial condition. The steps below will walk you though creating the first condition.
a. Select in the Data Tree the data value to base your condition on. In this example, the "gender" attribute will be used. Your selection in the Data Tree will be highlighted for visual reference.
b. Then, choose your type of condition based on available options for based on occurrence, numerical value, or text value. In this example, we want to show text based on the value of the gender field, so we will select Based on text value.
c. Then specify the details of your condition for contains or starts with using the drop down menu available and then add the value to test for. Here we have added "female" by typing in the value field. You can create more complex conditions manually by selecting theCreate Expressionbutton. When you are finished configuring your condition, select Insert. -
You will notice in the Design Surface that your first condition and the else section will be added as inline text objects. Placeholder text will be visible giving an indication of what the condition is set up to test.
- We will now need to insert a new condition for when the gender is male. Select here to learn how to add new conditions to your section.
- Simply replace the text that is present with the dynamic or static content that you wish to be displayed for each of your conditions. In this example, we are including a message for when the "gender" attribute is set to male, female, and when any other value is present to display a default message.
- Lastly, you should test your results by previewing the output. You can Edit Your Data Source to modify the test value and compare to ensure the behavior is correct. Notice that only one condition is used for the output and that no space will be consumed by the other inline objects that do not evaluate for the condition.
Quick Access Options
- Navigate to the Insert Tab in the Ribbon and select the bottom of the
Conditional Textbutton. - Select from one of the four quick access options; If Exists, If Greater Than, If Contains or Custom Condition. It is important to note that selecting the custom condition will allow you to create your own condition as described in How to Create Conditional Text.
- Once you select the condition you would like the Insert Conditional Text Dialog will launch, with some configurations already made. You will need to select the data point you wish to base the condition off of from the data tree and select the value that will make the condition true.
- You will notice in the Design Surface that your first condition and the else section will be added as inline text objects. Placeholder text will be visible giving an indication of what the condition is set up to test. From here you will need to replace the placeholder text with content that you want to show based on the condition set, you can learn more about that here.
Edit Conditional Text
Once you have inserted Conditional Text into your document template, you may wish to revisit the setup of any of your conditions, add new conditions, or remove them.
Edit a Specific Condition
Right Click Option
- Place your cursor in the desired condition you would like to modify in the Design Surface.
- Right click to reveal a contextual menu. Select Edit to reveal more options and choose Active Condition.
- The Edit Condition Dialog will be displayed. Use this Dialog to make a quick configuration change to your condition.
Using the Ribbon
- Place your cursor in the desired condition you would like to modify in the Design Surface.
- Select the
Editbutton in the in the Condition group in the Paragraph contextual tab. - The Edit Condition Dialog will be displayed. Use this Dialog to make a quick configuration change to your condition.
Add, Edit, Remove Conditional Text
Right Click Option
- Right click in any of the conditions present in your Conditional Text Section.
- From the contextual menu, select Edit to reveal more options and choose Section.
-
In the resulting Edit Conditional Inline Dialog, you can choose from the following options.
a. Select a present condition to change the evaluation order using the up and down arrow buttons.
b. Select a present condition to edit the condition setup in the Edit Condition Dialog.
c. Select a present condition then theXbutton to Erase the condition entirely.
d. Select Add New Condition to create a new condition to be present in your section.
e. Toggle on or off the else section.
Using the Ribbon
- Select any of the conditions present in your Conditional Text Section and navigate to the Text contextual tab in the Ribbon.
-
From the contextual tab you will have the following options:
a. Delete the
Active Condition(the condition you have selected) orAll Conditions.
b. Insert a new condition. For more information on how to configure your condition visit How to Create a Conditional Paragraph.
c. Toggle on or off the else section.
d. Edit the condition you have selected.
Dynamic Content
When designing your templates, you can think about the content in your document as being either static or dynamic. Dynamic Content is information that will be displayed in your document that will come directly from your data source and will change with the different data sources that the template is used with. Take, for example, an account number displayed for an invoice at the top of the page. For every customer invoice produced, this account number will need to come directly from the data source so each invoice is unique for each customer. Static content is information in the document that will not change. For example, your company's address and contact information.
When inserting Dynamic Content, usually you can add individual values, data in a repeating format from your data source or data based on a condition. This section will help you understand the different ways that you can accomplish these objectives.
Fields
When building your template, you will be frequently adding data values into the Design Surface. Whenever you complete this action, you will be creating what is called a Field. A Field is a placeholder in your document template that is used at run time to retrieve the information from your data source and insert into the document when rendered.
Fields will show up in the Design Surface by default with a gray background and an XPath expression (the location of the information in your data source). You can resize these elements in the Design Surface for your design needs, but in your output document the Field will be replaced with the value from your data no matter what the length is. You should keep Dynamic behaviors such as this in mind when working with Fields.
When working with fields, you will need to learn about how to add them, format the data, modify, and understand other options related to adding fields into repeating elements in your document template.
Insert a Field
Highlighted below are the two ways to insert a Field into the Design Surface.
Drag and Drop
- Ensure that the Data Source Pane is visible on the right side of the Design Surface.
- Place your cursor in the Design Surface where you would like to insert your data point to create a field.
- Select the data point you wish to insert in the Data Source Pane. Hold down the mouse upon selection.
- Drag the data point into the Design Surface to your desired location and release.
- Click on the
Fieldbutton option.
If you have selected an element from your Data Source, upon adding it to the Design Surface you will be shown a contextual menu.
Using the Ribbon
- Place your cursor in the Design Surface where you would like to create your field and navigate to the Insert Tab in the Ribbon.
- The
Fieldbutton in the Dynamic group is asplitbutton. Select the top button to launch the Insert Field Dialog. - From the Insert Field Dialog, navigate through the data tree on the left and select the field you want to add to your template. You can also click on the
Create expressionbutton to create a more complex expression. - Once you have selected the field you would like to add, click on the
Insertbutton and the new field will be inserted into the design surface.
Select the bottom part of the Field button to insert one of the following options: Current Date/Time, Current Page Number, Total Page Count, or select Custom Field option to insert a field from your data source.
Edit a Field
Access the Edit Field Dialog. There are multiple ways to do this:
- Double click on the field you want to edit.
- Right click the field and select the
Edit Fieldoption from the contextual menu. - Select the field, navigate to the Dynamic Tab in the Ribbon and click on the
Editbutton.
Creating Advanced Expressions
- When working in the Insert Field Dialog or the Edit Field Dialog, click on the
Create expressionbutton located in the Advanced section. - From the Create Expression Dialog, add an expression item by selecting from the available options located below the Expression Box. When you select an option, a menu will be displayed for you to choose from the required function. The selected function will be automatically inserted in the Expression Box.
- Select the item(s) from the data tree that you would like to use for the arguments. Upon doing so, you will be provided with two options indicated with plus signs in the expression options list:
Insert the selected path from the treeorInsert only the selected element. Depending upon what type of expression you are using, by selecting either of these options you will notice that your selected item in the Data Tree will now be inserted into the Expression Box. - Select the green check mark to the right of the Expression Box to validate the expression that you have created. If your expression is not valid, the Publisher will display an error message with details about what the problem is regarding the expression. If successful, you will receive a message stating so.
- Once your Expression is validated, click on the
Insertbutton and you will be returned to the Design Surface where your field is now inserted. - It is recommended that you preview your output to ensure that your expression is working exactly as you intended.
Example: Combining two Data Points
In this example, we aim to combine two data points from our data source using a common XPath Function called "concatenate". This function is used to combine multiple strings and, in this case, will concatenate the first name and the last name. The result will be a single full name, with the last name displayed first.
- In the Create Expression Dialog, we first want to identify the function by searching for it in the FUNCTIONS tab and choosing
concatfrom the drop-down menu. - Next, we will need to add the different string arguments that we want to combine, one at a time. Notice that we can extend the number of arguments for this function to as many as required. Here we will select an item in the Data Tree, and choose
Insert the selected path from treeto add the path for that attribute in the Expression box. We will start with the last name, so it will be displayed first. - We will now repeat this process including a string manually typed in order to add a comma and a space between the last and the first name attributes. In addition, we will add the "first-name" attribute by following the instructions from step two.
- After designing the Expression, we will need to click on the
Insertfor the Field to be added into the document template. You will notice that the field will be present in the Design Surface. It is recommended that you preview your output to ensure that the expression is evaluating as you intended it to.
Example: Finding the Sum of Multiple Data Points
In this example, we aim to calculate the sum of all attributes contained within a repeating element from the data source. This is often the case for example, such as invoices, where we might have multiple line items containing a charge in each. The sum of all line items will result in the total payment due. We will use a common numerical function called "sum" to count all of the "price" attributes for each product purchases in our invoice.
- In the Create Expression Dialog, we will first need to select the
sumfunction by searching for it in the FUNCTIONS tab. - Once the sum function is added into the Expression box, we need to replace the argument indicated as a "node-set" for a repeated item. In this case, we want to sum all of the occurrences of the "price" attribute, so we will navigate and select this item in the Data Tree. Next, click on the
Insert the selected path from treeto add the path into the expression box. We now have an expression that will sum all of the numerical values present in the "price" attribute for each product element in the data source. - After the expression is set, click on the
Insertbutton for the Field to be added into the Design Surface. It is recommended that you test your results by previewing the output.
Formatting your Fields
Once you insert a Field into your document template, you may wish to make adjustments to how this field will be displayed in your output. Typically this is broken down into two main areas of usage: basic font formatting and changing the structure of the data to be displayed.
Basic Font Formatting
Using the Ribbon
- To make formatting adjustments to any Field in your document template, begin by selecting the Field in the Design Surface.
- In the Home Tab, located in the Ribbon, select the appropriate font formatting option to be applied from the Font group.
- Notice in the Design Surface that the field will be adjusted to display the formatting that has been applied. By previewing your output you can notice that the populated data in the document will have the chosen formatting applied.
Using the Properties Pane
You can also format your fields directly in the Properties Pane. Here you will be provided with the same options in a slightly different menu.
- Turn on the Properties Pane from the View Tab or by right clicking on the field and selecting
Propertiesoption from the contextual menu. - Make sure you have selected the
Fieldeither in the Design Surface or in the Navigation Bar located at the bottom of the Properties Pane. - In the Visual Menu, you have various options to change the font properties and more related to formatting the selected Field.
Structural Formatting
It is often the case that your data will not possess the actual formatting that you want it to be displayed with in your output. A common example of this is taking a numerical price value located in the data source and adding the appropriate currency for this Field. Another being, taking a date in the XML Standard format and changing to a format of your specification. In this section we will explore exactly how you can format the structure of your data presented in the output.
Accessing the Formatting Dialog
Access from Right Click
You can access the Formatting Dialog by simply right clicking on the Field that you would like to format in the Design Surface. You will be presented with a contextual menu and here you can simply click on Format option.
Access from Dynamic Tab
You can access the Formatting Dialog for your Field in the Dynamic Tab by using the following steps.
- Select the Field you would like to format.
- In the Ribbon, select the Dynamic Tab.
- In the Formatting Group you will have quick access formatting options such as:
Currency,PercentageandFormat Date & Time. - Select the
expand- symbol button, to access the Formatting Dialog.
Access from Home Tab
You can access the Formatting Dialog for your Field in the Home Tab by using the following steps.
- Select the Field you would like to format.
- In the Ribbon select the Home Tab.
- In the Formatting Group you will have quick access formatting options such as:
Currency,PercentageandFormat Date & Time. - Select the
expand- symbol button, to access the Formatting Dialog.
Using the Formating Dialog
In the Formatting Dialog you will be able to easily change the structure of your data source values to be presented the way you intend in your output. Here you can learn about how to use the Formatting Dialog to accomplish these objectives.
- To begin, select the type of formatting you wish to apply to your Field. Available options include:
Number,Currency,Percentage,Duration,Data/Time,Phone Number,Language Specific, andCustomformatting. - Upon selecting the type of formatting to apply, options will be displayed related to the choice in the right side of the Dialog.
- For any selection, you will be given two options: to select a predefined format or to create a custom format. Predefined formats will be highlighted with the format and an example. Simply make the predefined selection of your choosing if your desired format is available.
- To create more custom formatting, first select the
Customradio button to enable these options and choose from a variety of settings related to your formatting type. In this example, we'll change the number formatting for our field to have two decimal places. You will notice in the Preview Dialog that the applied formatting will be previewed as you make adjustments. - Once you have completed your formatting specifications, click on the
Savebutton and you will be returned to your work in the Design Surface. By previewing your output, you can notice the appropriately applied formatting.
Conditional Formatting
When designing your document templates in the Publisher you can set up the content in your output to be formatted dynamically depending upon a test in your data source. Imagine a scenario in a monthly statement with repeating information for every transaction that occurred. If the transaction is over one hundred dollars, then the transaction amount should be displayed in bold red text. This is a great example of the need to apply conditional formatting to this item.
General Instructions
To apply conditional formatting for any object in your document template, use the provided instructions below. The instructions will demonstrate applying conditional formatting to a field based upon a precise condition specified.
- Select the object you wish to add conditional formatting to in the Design Surface and right click. From the resulting contextual menu, select Properties to launch the Properties Pane. Note: If you are looking to add conditional formatting to a table row or other object you cannot fully select, but you can always in the Navigation Bar of the Properties Pane after opening.
- Make sure to select the target element for object you would like to set the condition on in the Navigation Bar and select the All Menu.
- Click on the
Moresymbol button next to the Property tabs. Click on theConditional Formattingbutton and you will now be presented with the Conditional Formatting Dialog; here you will click on theAdd rulebutton. -
In the Create Condition Dialog you will need to specify a condition for which the formatting will change.
a. Select in the Data Tree the data value to base your condition on.
b. Then, choose your type of condition based on available options:Based on occurrence,Based on numerical value, orBased on text value.
c. Then specify the details of your condition, using the drop down menu available and then add the value to test for. You can create more complex conditions manually by clicking on theCreate Expressionbutton. When you are finished configuring your condition, click onInsert. -
Specify what formatting to use when the condition is true by clicking on the
Choose formattingoption. You can select a static value from the available drop down list, or even configure a dynamic value to be retrieved from the data source by selectingDynamic Value - fxbutton for the condition. Regardless of your selection, this value will be used as formatting for your property when the condition evaluates to true. In our example, we have selected red to be used for the font color property when the condition is met.
Once you have set your condition, click on the Apply button and you will be returned to the Design Surface. Now you should test your results by previewing your output. You should edit your data source changing the values to test if your configured conditional formatting is behaving as intended.
Edit Formatting After Setup
It is important to understand how to access the Conditional Formatting setup for any given object in your document template. It is important to understand that specific items in your document template can all have their own unique formatting applied, so you will need to make sure you have selected the correct item when trying to make modifications. A common example of this is looking to edit the conditional formatting on a table cell but the paragraph within the cell is actually selected. Follow the general instructions below to access your Conditional Formatting for editing after creation.
- Open the Properties Pane by selecting Properties from the View Tab in the Ribbon.
- Make sure you select the object that you wish to apply formatting to in the Navigation Bar of the resulting Properties Pane. The Navigation Bar is located at the bottom of the pane, and you can horizontally scroll through the objects in your template to select the exact item you wish to modify properties of.
- Next, at the top of the Properties Pane, select the All Menu. Navigate through the format groups to locate the format you wish to conditionally modify and select the
Dynamic Valuesbutton. - When you select the
Dynamic Valuesbutton the Dynamic Property Dialog will be displayed. Here you will have the capability to make several adjustments. You can modify previously added conditional formatting just as you initially configured in General Application Instructions, including setting a new default value, selecting a new value to use when your condition is true, switching to a dynamic value for any condition, or adding a new condition for that specific property. - If you would like to edit the configuration of a previously created condition, such as changing the "price" attribute test; to test for values greater than 10, then you will need to select that configured condition and adjust the condition as needed just as initially configured in General Application Instructions.
- You can add conditional formatting based on an entirely new property by selecting Add rule. For more information on this process, be sure to read General Application Instructions for Conditional Formatting.
Common Examples
Conditional Formatting is a very common need when producing documents of any kind. Because of this reason, we've added several common examples in the documentation for your reference.
Show or Hide Table Row
There are a couple of different ways to conditionally collapse a table row based upon a test on your data source. We have highlighted the steps for the different ways below.
Before you begin you will need to understand your data and your current table and its output. In this example, we have a simple table repeating for every "Product" element in the data source.You will need to determine what condition you would like to hide content for. In this example, we will conditionally hide any books in our product list that have a price value greater than fifty. Now you can use either the Quick Access Option or the Properties Pane Option.
- Open the Properties Pane by selecting Properties in the View Tab, located in the Ribbon.
- Select the item to apply Conditional Formatting to in the Navigation Bar. For this example, we will select the Repeated Row.
- Select the All Menu located at the top of the pane and click on the
Moresymbol button to accessConditional Formattingoption. - In the Conditional Formatting Dialog click on the
Add Rulebutton. -
In the Create Condition Dialog, you will need to specify your condition for when the table row will not be shown.
a. Select in the Data Tree the data value to base your condition on.
b. Then, choose your type of condition based on available options.
c. Then specify the details of your condition, using the drop down menu available and then add the value to test for. You can create more complex conditions manually by clicking on theCreate Expressionbutton. When you are finished configuring your condition, click onInsert. -
You are returned to the Dynamic Property Dialog where you will need to specify the value to use when the condition is met. Here we will use the static value drop down menu to select which value we wish to apply to this property when the condition is met. In this example, we want the visibility property to be set to "collapse" when our condition is met. You should be aware you can change this value to be dynamic from your data source by selecting the
Dynamic Valuebutton. - It is now time to preview your output to test the behavior of your conditional formatting. Notice that the table is displayed for every "Product" element, but when the price value is greater than fifty, the table row repeat is collapsed and not displayed. This is noted as you will see that ID number two is missing. This is also a good example of keeping identifying columns in mind when conditionally showing or hiding content such as this.
Conditionally Changing the Background Color of a Row
To conditionally change the background color of a table cell based upon a test on your data source, use the following instructions.
Before you begin understand your data and your current table and its output. In this example, we have a simple table repeating for every "Product" element in the data source.
- Open the Properties Pane by selecting Properties in the View Tab, located in the Ribbon.
- Select the item to apply Conditional Formatting to in the Navigation Bar. For this example, we will select the Table Cell.
- Select the All Menu located at the top of the pane and select the
Dynamic Valuebutton next to the background color. - In the Dynamic Property Dialog select the
Add Rulebutton. -
In the Create Condition Dialog, you will need to specify your condition for when the table row will not be shown.
a. Select in the Data Tree the data value to base your condition on.
b. Then, choose your type of condition based on available options for based on occurrence, numerical value, or text value.
c. Then specify the details of your condition for contains or starts with using the drop down menu available and then add the value to test for. You can create more complex conditions manually by selecting theCreate Expressionbutton. When you are finished configuring your condition, select Save. -
You are returned to the Conditional Formatting Dialog where you will need to specify the value to use when the condition is met by selecting
Choose formattingoption. Here we will use the static value drop down menu to select which value you wish to apply to this property when the condition is met. In this example, we want to highlight our table cell with a background color of red when our condition is met. You should be aware you can change this value to be dynamic from your data source by selecting theDynamic Value - fxbutton. - It is now time to preview your output to test the behavior of your conditional formatting. Notice that the table is displayed for every "Product" element, but when the price value is greater than fifty, the background color of that specific table cell is changed to red.
Images
One of the key components to designing a powerful piece of communication is having the capability to integrate images in your documents. One of the most common uses of this need is the utilization of a company logo, for example. The Publisher allows you to not only select static images from a location of your choosing, but also perform more powerful configurations such as selecting the image path to come from your data source or conditionally testing your data source and then applying the appropriate image. In this section of the help documentation, you can find all of the necessary information on working with images in your document template design.
Insert a Static Image
A static image is one that you select as a constant image to be displayed in your document. This image will not vary with your data source but will remain the same for every output that your document template produces. Typically, you will simply browse to a location that the data source resides and select the image when inserting. At run time, the image will be referenced by the template and inserted into the document. The steps highlighted here indicate how to insert a static image into your document template.
- Click on the
Imagebutton from the Insert Tab in the Ribbon and the Insert Image Dialog will launch. - click on the
Browsebutton and use the Windows Open Dialog to navigate to the appropriate local or network directory and select the image you wish to insert. A preview of your image will now be displayed in the Insert Image Dialog. - Select if the image should be embedded in the document. This feature is used if you wish to have the publisher convert your image to base64 encoding and embed in the template. If the image is embedded at run time, the server will not need to navigate a file system or network to retrieve the image to be inserted as it will already be embedded.
- Once you have made all of the necessary configurations, you will simply need to click on the
Insertbutton located at the bottom of the Insert Image Dialog. Your image should now be inserted into the document.
Working with Dynamic Images
A Dynamic Image is an image that is dependent upon your data source in some capacity. Dynamic images are commonly used when designing intelligent document templates. Here are a couple of examples of using dynamic images:
- You have an attribute in your data source that contains a specific image url pointing to an image to be retrieved at runtime. In this case, depending upon the customer the data is pulled for, a specific image is also specified in the data source and used when that data source is rendered with the template.
- You are producing statements for ten clients each with their own logos. You wish to use the same template to produce them so you do not need to design ten different templates. You can set up the conditional test on the data source to determine which client document is being produced and insert the appropriate image.
Using an Image from a Data Source
There are two primary ways in which images are specified in a data source: passing the image file path and using an embedded image in the data source. In this section of the help documentation, you can learn about each of these methods to accomplish your objectives.
Path in your data source
You can have your data field possess an external url, a relative file path, or point to a network location. Remember that the image needs to be present in the location specified, and of course, the path needs to be correct.
- You will first need to click on the
Imagebutton from the Insert Tab in the Ribbon. - From the Insert Image Dialog select the
Dynamic Value - fxbutton. - Confirm assigning a data source, by selecting
Yesoption. - In the Default Value field section click on the
Dynamic Value - fxbutton. - In the Edit Dynamic Value Dialog navigate through your data tree to find the attribute with the path to the image you want to have inserted and click on
Save. - You will now notice in the Dynamic Property Dialog that the value for the Default image has changed to represent that a dynamic field has been selected.
- Click on the
Applybutton in the Dynamic Property Dialog.
Results and Testing
At this point, the image will be inserted into the design surface.
Notice in the Design Surface that your image is marked with a placeholder. This is because the Publisher does not yet know what image is to be used until the document is generated and the XML Data Source is evaluated to obtain the image. It is recommended at this point that you test the configuration of this dynamically driven image by previewing your output. If the path in your data is correct and the configuration was successful, your image should be present in your output.
Embedded image in your data source
Often images are included directly in the data source. If an image is encoded into a base64 string and is present in the data source, the Publisher can also take this image directly from your data source and insert into your document.
Most users that work with their data will know if this option is available in their data source. Below, is a common example of what this base64 string might look like in an input XML source. This will be our starting point for this example. Our goal is to use this string located in the "logo-image" attribute to dynamically pull the image from the data source.
- You will need to click on the
Imagebutton from the Insert Tab in the Ribbon. - From the Insert Image Dialog, click on the
Dynamic Values - fxbutton. - At this point, you will be presented with the Dynamic Property Dialog. Here you will see the image you selected to be used. Click on the
Dynamic Value - fxbutton for the value of the default image. - Using a base64 encoded string requires a specific syntax beyond just selecting from the data source, so you will need to click on the
Create Expressionbutton located in the Advanced Section of the Dialog to the right. - Next, select FUNCTIONS tab and from the drop down menu select Concat. This function is used to concatenate strings and data points. The Concat() function will automatically be inserted into the Expression Dialog.
- Now you will need to combine some specific syntax with the field of your choosing. To complete this, you will need to highlight the first string and replace with the correct syntax. The standard declaration of source image requires: "data:image/imagetype;base64,imagestring". The image string we will obtain directly from our data source, so the first string we need to replace with the preceding syntax. Our image is a PNG image so we will use: concat("data:image/png;base64,",...). Notice how we included the comma at the end.
- Next, highlight the second string in expression to replace. Select the Data Field in the Data Tree on the left side of the Dialog and double click. You will notice that the XPath Expression is automatically added into your function.
- Delete any remaining strings as we only need two arguments in this function; the preceding syntax and the actual string from the data source.
- When you are satisfied, click on
Saveoption and you will return to the Insert Image Dialog.
Conditionally Choosing an Image
Often times, you might want to intelligently insert an image into your document depending upon your data source. Imagine producing a statement for two companies and each company has its own logo. You can use, for example, a data point called "company-name" to test this and apply the image conditionally. So when this data point contains "Company A", company A's logo will be inserted, and when the data point contains "Company B", company B's logo will be inserted. This is typically called selecting an image on a conditional field. In this section, you will learn how to set up conditions to test your data source and insert the image that you wish to specify when the condition is met.
- To begin, you will need to identify an attribute or text value in your data source that you wish to test in your conditions.
- You will need to select the
Imagebutton from the Insert Tab in the Ribbon. - From the Insert Image Dialog Select the
Dynamic Valuebutton. - At this point, you will be presented with the Dynamic Property Dialog. Here you can set a default image if you wish; to either be static by selecting browse or dynamic by selecting the
Dynamic Valuebutton. - To configure a condition for your image, select Add rule. This will launch the Create Condition Dialog.
- In the Create Condition Dialog you will need to create the configure the condition you to show the image you would like.
-
In the Create Condition Dialog you will need to specify a condition for which the formatting will change.
a. Select in the Data Tree the data value to base your condition on.
b. Then, choose your type of condition based on available options for based on occurrence, numerical value, or text value.
c. Then specify the details of your condition for contains or starts with using the drop down menu available and then add the value to test for. You can create more complex conditions manually by selecting theCreate Expressionbutton. When you are finished configuring your condition, select Save. -
When you have completed all of the configurations select Insert and you will be brought back to the Dynamic Property Dialog. From here you will need to select an image that you would like to show when the condition is met. This can be a static value or you can select the
Dynamic Valuebutton to select an image from your data source. - You can now repeat this process to add as many conditions as you would like. Once you have set up all of your conditions, select Apply from the Dynamic Property Dialog, then select Insert from the Insert Image Dialog and you will be returned to the Design View where you will see a place holder image is set.
Image Properties
When you insert any image into your document template, you will have specific properties that you can modify. In the Properties Pane, you can select from four categories of properties related to your image.
Visual
Visual properties that you can modify include:
- Specifying a default image.
- Specifying alternate text.
- Embedding image bytes.
- Selecting a background color.
- Adding borders to your images.
Layout
In this menu you have the ability to modify the image dimensions and specify whether or not you would like to Preserve the aspect ratio of the image.
All
In this menu, you will see all available properties related to the image in list format. Here you can view each property modified and the value that the property is set to. Here is where you will be able to make modifications to your dynamic image configurations. The Source of the image has a dynamic value and we can modify this by clicking on the Edit Image button in the Content Group of the Format - Image Tools tab, in the Ribbon. You can learn more about these options in Working With Dynamic Images. In addition, you can also add extra properties as you see fit.
Image Options
Resize Manually
To resize an image manually simply select the image in the Design Surface. You will notice that the image is marked as selected and dragging markers will be present. Use your mouse to select any of these corner points to drag and resize your image. Note: If you have the Preserve Aspect Ratio option enabled in the Image Properties, then the resizing will adjust based upon this specification.
Move Images anywhere in the Design Surface
In the event you want to position the image manually on the page, you can use what is called Absolute Positioning.
- Right click on the image.
- From the resulting menu, select
Absolute Positioningoption. - Place your mouse over the image until you see the four way directional arrows.
- Press left mouse button, hold & drag image to desired location on the page and then release the mouse.
Change an Image
By clicking on the Edit Image button, either by right-clicking on the image and select the corresponding option, or from Format - Image Tools tab. You will launch the Edit Image Dialog so you can change the image to be used.
Reset the Image Size
Click on the Reset Image button to reset the image to its original dimensions, from the Format - Image Tools tab in the Ribbon.
Modify the Image Dimensions
In the Format Tab for the image, you can manually type the image dimensions, specify your desired measurement unit, or use the up and down arrows to adjust the image dimensions as you see fit. You will also have the option here to select Preserve Aspect Ratio. This feature is used to control the behavioral relationship between height and width when resizing your images.
Barcodes
A barcode can be a very valuable addition to any document. A barcode is a graphic defined by a specific barcode type and composed of either static or dynamic information. A machine capable of reading this graphic can interpret the contained content and act accordingly.
In some scenarios, barcodes are used to provide a variable graphic that other machines can read to determine print orders, packaging, and other post delivery operations. In other scenarios, barcodes are used so anyone can point their mobile device at their statement and instantly the barcode reader will direct them to your website to access more information or access promotional options.
Insert Static Barcodes
- You will need to click on the
Barcodebutton located in the Objects Group in the Insert Tab. You will then notice the Insert Barcode Dialog will be displayed. - Select the needed barcode type from the drop down list. In this example we will select the QR Barcode type.
- Specify the static value to use for the barcode. In this example, we have typed "www.ecrion.com".
- When your configurations are complete, click on
Insertto add the barcode into your document template.
Results and Testing
When you have completed the configuration and inserted your barcode into your document template, you will notice that the barcode will be present in the Design Surface. It is recommend at this point that you do perform a test with your barcode to ensure that the barcode is properly configured and works. There are numerous ways that you can test your barcode including:
- Use a mobile device directed at your computer screen and see if the barcode reads as you have specified.
- There are several online resources for obtaining free software to validate barcodes on-screen. A simple internet search can reveal some of these options.
- If you are inserting a barcode that will drive other operations like printing, then you will want to generate an output that can be used for testing your device.
If your barcode is appropriately read, then you can continue with your design. If the barcode fails, you should revisit the barcode properties by accessing the Properties Pane from the View Tab and check your configurations.
Insert Dynamic Barcodes
Dynamic Barcodes are barcodes which contain encoded values obtained directly from the data source or values that are applied conditionally. For example, a company may want to generate invoices that are to be delivered by mail in two separate geographic regions. One region accepts a specific type of barcode for mass mailing and another region accepts a different barcode. In the Publisher, you can easily set up your barcodes to either test the region to be delivered to and apply a specific value, or simply include this value in your data source to directly be encoded in the barcode. In this section we'll cover a couple of different examples to highlight this type of usage.
Using a Field from Data Source
- From the Insert tab in the Ribbon click on the
Barcodebutton. - In the Insert Barcode Dialog, you will notice a
Dynamic Values - fxbutton. Upon selecting this button, click on theDynamic Value - fxbutton in the Default Value section. - In the resulting Edit Dynamic Value Dialog, select the data field that you wish to use to obtain the value from the Data Tree. You will notice that your selection will be highlighted in the Data Tree. It is important to note that in this step, you can also click on the
Create Expressionbutton to merge multiple data fields together or use a more complex function to drive the value of your barcode. - When you are finished with this configuration step, click on
Savebutton. Then click onApplybutton and you will be returned to the Insert Barcode Dialog. Notice that your dynamic configuration will be displayed to you giving you valuable information about where the value of the barcode will be obtained from. - When you are satisfied with your barcode type and other configurations, click on the
Insertbutton to add the barcode into your document template. - It is recommended, at this point that you test your configuration by modifying the data field in the Publisher and previewing your outputs. Here you will be able to see that the barcode is obtaining the correct value from the data source when rendered to an output.
Conditionally add a Value
- From the Insert tab in the Ribbon click on the
Barcodebutton. - In the Insert Barcode Dialog, you will notice a
Dynamic Values - fxbutton. Upon clicking on this button, you can configure a default value to be used. This default can be a static value you can type or you can select theDynamic Value - fxbutton to configure a default value to come from your data source. - To add a condition click on the
Add rulebutton, from the Dynamic Property Dialog. -
In the Create Condition Dialog, you will now need to follow a few steps to configure it in a proper manner:
a. Select in the Data Tree the data value to base your condition on.
b. Then, choose your type of condition based on available options for based on occurrence, numerical value, or text value.
c. Then specify the details of your condition using the drop down menu available and then add the value to test for. You can create more complex conditions manually by clicking on theCreate Expressionbutton. When you are finished configuring your condition, click onInsertbutton. -
You will be returned to the Dynamic Property Dialog. You can now add a static value manually or you can select the
Dynamic Value - fxbutton to choose a value to be obtained from the data source when the condition is met. For our example, we want to apply the value '1234' when the region equals 'USA' so we will add this value dynamically. - You should repeat this process to set up the conditions that you would like to have evaluated based upon your data source. Remember that, when no condition evaluates to true, your default value will be used.
- When you are satisfied with your condition setup, click on the
Applyand thenInsertbuttons and the barcode will be inserted into your document template. - It is recommended to test the conditional application of your barcode value, by changing the fields in your data source. In our example, we will change the region attribute to test the outputs based upon our conditions.
Barcode Options
Type
Selecting an option from the drop down menu within Edit Barcode Dialog.
The following barcodes are available for you to choose from in the Publisher;
- UPC-E
- UPC-A
- EAN-8
- EAN-13
- Data Matrix
- PDF417
- 2 of 5
- 3 of 9
- Postnet
- Planet
- 128
- 128 Raw
- 128 UCC
- OMR
- Aztec
- Maxicode
- QR Barcode
- Intelligent Mail.
Value
If you are only inserting a static value to be used as your barcode, you will simply need to type your value to be used in the Value field available. You can view an example of using a simple static barcode in the How to Insert a Simple Static Barcode section. In addition, if you are going to make your barcode dynamic, you can leave blank and learn more in the How to Insert a Dynamic Barcode section.
If you are typing a value to be used in your barcode, you will need to ensure that it qualifies as an acceptable value as specified in the Valid Value description.
Advanced Options
The advanced options that you will have from the Insert Barcode Dialog are to adjust the rotation of the barcode, as well as select from the following options that are available depending on the barcode type selected:
- Draw Text
- Use Extended Character Set
- Include checksum
- UTF8 Encoding
Regardless if you are inserting a static or dynamic barcode, you will first need to understand the options available to you when inserting any barcode. In this section of the documentation, you can learn about these options in detail.
Properties Tab Options
From the Properties Tab you will have the following options to change after your barcode has been inserted.
Properties
Depending upon the barcode type you inserted, the Properties section will display available Properties that you can check to include or not.
- Select
Draw Textcheckbox to include the value along with your barcode in the output. - Select
Extendedcheckbox to have 3 of 9 barcodes accept full ASCII character set. Note: This option is only available for 3 of 9. - Select
Hex valuecheckbox to specify whether the barcode in hexadecimal for PDF417 barcode type. - Select
Include Checksumcheckbox to manually specify if you wish to include the checksum or not.
Rotation
You can choose to rotate your barcode after its inserted into your document template. Simply select the rotation that you would like to apply to it.
Resize the Barcode from the Design Surface
- In the Design Surface, select your barcode.
- Drag and drop any of the selection points to resize your barcode to desired size.
- Release mouse.
Resize the Barcode from the Properties Pane
- Right click on the barcode in the Design Surface and select
Propertiesfrom the resulting contextual menu. - Select the
Layoutmenu at the top of the pane. - Specify your desired unit measurement to the right using the drop down menu.
- Specify your desired dimensions for
WidthandHeight.
Stylesheets
Using Stylesheets during your document template design is a great way to improve efficiency and consistency across your organization's documents and their design. Whether you create your own or use the Publisher's default stylesheet, you can single click to apply formatting to content in a fast and consistent manner.
Creating a New Stylesheet
Saving the stylesheet from the Ribbon
- In the Ribbon, click on the bottom part of the
Manage Stylesbutton located in the Home Tab. - From the contextual menu, select
Create New Stylesheetoption. - The Windows Open Dialog will be displayed, and you need to navigate to where you would like to save the new file. You must, as well, give the file a name.
- Click on the upper part of the
Manage Stylesbutton in the Ribbon and from the Styles Pane use the down arrow to navigate to the newly added Stylesheet.
Saving the stylesheet from the Styles Pane
- In the Ribbon, click on the
Manage Stylesbutton located in the Home Tab. The Styles Pane will now be displayed. - Click on the
Optionssymbol button to reveal a contextual menu and selectCreate Stylesheetoption. - You will need to specify the location where the new stylesheet will be saved. Use the Windows Open Dialog to browse and give your new stylesheet a name.
Creating Styles
- Click on the
Add new stylebutton to create a Style. -
Next, the New Style Dialog is displayed.
a. Select what type of elements this style can be applied to. Use the drop down menu to select the element type. Select
Otheroption from the list to choose a more specific element type if needed.
b. Provide an appropriateStyle Namefor this new style. If a Name is not given, the style will be applied to all instances of the selected element. -
Using the formatting options, begin modifying the properties that will change when you apply this style. In this example, we will change the font size when this style is applied. You will notice that the preview image will modify to show you what the application of your style will look like.
- When you are finished with your selection, click on the
Applybutton. - You should now repeat steps 1 - 4 to add all of the styles you require.
- You will now be returned to the Styles Pane. Your newly created style is now listed and you can apply this style to your content using any of the methods listed in the Applying Your Styles to Content section. In addition, you can repeat steps 3 through 5, above mentioned, to create another style for your stylesheet. Lastly, you will now notice that your created styles are also available in the Home Tab of the Ribbon for single click application within Style Group.
Working with Stylesheets
Applying Styles to Content
Using the Ribbon
- In the Home Tab of the Ribbon, locate the Style Group. Notice how you have a selection of available styles to apply to content in your document template.
- Place your cursor in the paragraph or select or highlight the object you wish to apply the formatting to in the Design Surface. If you have a style that is designed for a table cell, then the table cell should be selected.
- Single click on the desired style in the Ribbon. You will notice that the formatting is automatically applied.
- Preview your output to view the results.
Using the Styles Pane
- In the Home Tab of the Ribbon, locate the Style Group and click on the
Manage Stylesbutton. From the contextual menu select theManage Stylesoption, that will launch the Styles Pane. - In the Styles Pane, you will notice the available Styles to apply. You will see the name of the style is present as well as a preview of the formatting that is associated with this style.
- To apply a style to your content, place your cursor in or select the desired content to format in the Design Surface. Then, simply select the Style to apply in the Styles Pane. You will notice that the formatting associated with the Style is automatically applied to the content in the Design Surface.
Clear Styles from Content
Using the Ribbon
- In the Design Surface, select the object that you have applied the Style to, or place your cursor inside of that object.
- In the Ribbon, you will notice that the applied Style is highlighted in the Style Group.
- Single click on the Style to deselect it. You will notice that the formatting is removed from the content.
- An alternative is to also use the
Clear Formattingbutton located in the Font Group. By selecting this button, the formatting will be removed from the content selected.
Using the Styles Pane
- In Home Tab of the Ribbon, select
Manage Stylesoption, after clicking on theManage Stylesbutton to launch the Styles Pane. - You will notice in the Styles Pane the applied style to your selected content will be noted.
- Single click on the Style in the Styles Pane to remove the application to the object in the Design Surface. You will notice the formatting will be removed in the Design Surface and the selection will be removed in the Styles Pane.
Edit Styles
If you have created a stylesheet, you can make modifications to your Styles directly in the Publisher as needed. To do so, follow the instructions provided below.
- Click on the
Manage Stylesbutton in the Home Tab of the Ribbon to launch the Styles Pane. - Right click the style you would like to edit and you will have the option to either
Removethe Style orEdit. To make modifications to the formatting associated with this Style, select Edit. - In the Edit Style Dialog, you can follow the instructions provided in Creating a New Stylesheet to modify your already existing style.
- When you have finished with your adjustments, click on
Applybutton to return to the original Styles Pane.
Assign a Stylesheet
Using the Ribbon
- From the Home tab, click on the
Manage Stylesbutton, then select theAdd existing Stylesheetoption. - From the Windows Open Dialog, select the file you would like to assign.
Using the Styles Pane
- From the Home tab, click on the
Manage Stylesbutton and select theManage Stylesoption. - From the Styles Pane, select the
Optionssymbol bottom. - Select the
Add existing Stylesheetoption. - From the Windows Open Dialog, select the file you would like to assign.
Dynamically Assign a Stylesheet
Using the Ribbon
- From the Home tab, click on the
Manage Stylesbottom button, then theAdd Dynamic Stylesheetoption. - From the Dynamic stylesheet Dialog, click on the
Dynamic Value - fxbutton. - Navigate through the data tree to select the attribute which holds the stylesheet file and click on
Savebutton.
Using the Styles Pane
- From the Home tab, click on the
Manage Stylesbutton, then theManage Stylesoption. - From the Styles Pane, select the Options Menu.
- Select the
Add Dynamic Stylesheetoption from the drop down menu. - From the Dynamic stylesheet Dialog, click on the
Dynamic Value - fxbutton. - Navigate through the data tree to select the attribute which holds the stylesheet file and click on
Save.
Add Stylesheets for different Devices
- Click on the
Manage Stylesbutton located under the Home tab, in the Ribbon. - You will either start with the default stylesheet as the stylesheet to be used for PDF/ Print documents, or you can assign / create your own. Once you have the base stylesheet assigned select the
Add new stylebutton under Styles Pane. - From the New Style Dialog select the device you would like to add a style for, phone, tablet, laptop or TV.
- You will receive a notice that there is no stylesheet attached for that device. Select Yes to create a new stylesheet for that device.
- Browse and save the stylesheet in the folder needed.
- Give the style a name and adjust the properties as needed, then click on
Apply. - The newly added style will appear as a single click option in the Styles Pane and in the Home Tab. Apply the styles the same as you would for a PDF output.
Important Notes:
-
I created a new style for a different device, and when I apply it the Design Surface shows the wrong formats.
If this happens it is most likely because you have a corresponding style in your base stylesheet for a PDF and this is what is showing in the Design Surface. View your document by going to the Web View, and select the correct device to see if the correct style has been applied.
For example: In your base stylesheet you have a style Heading1, then you create a stylesheet for the phone device also with a Heading1 style. The style from the base stylesheet will appear in the Design Surface but the style from the phone stylesheet should show in the Web Preview. -
I created a new style for a different device, and when I apply it nothing changes in the Design Surface.
This is similar to the above. This happens because there is no corresponding style in the base stylesheet. Like above, use the Web View to preview your document to make sure it has been applied correctly. For example: In your base stylesheet you have a style Heading1, then you create a stylesheet for the phone device and add a style Heading_1. When you apply Heading_1 it will appear as if nothing has happened because there is no corresponding Heading_1 style in the base stylesheet.
**Viewing the Different Outputs **
Navigate to the View tab and click on the Web View button. This will allow you to view the document with the stylesheet changes.
Other Stylesheet Options
Opening Your Stylesheet in Text Editor
- Click on
Manage Stylesbutton from the Home Tab in the Ribbon. - In the Styles Pane, click on the
Optionssymbol button to view more options then selectOpen in Editor. - The Ecrion Source Editor will be displayed and you can now view the CSS code behind your stylesheet.
Open in Editor option is enabled only for Stylesheets that take as data source a .css file format, otherwise this option cannot be accessed from the Default Stylesheets.
Removing an Assigned Stylesheet
- Click on the
Manage Stylesbutton located in the Home Tab, under the Ribbon. - In the Styles Pane, click on the
Optionssymbol button to view more options, then select theRemove Stylesheetoption. - The default stylesheet provided by the Publisher will now be displayed for use.
Reload a Stylesheet
This option is used to obtain the latest version of the stylesheet as it resides in the source location. Use this option if the stylesheet has been modified manually or in the Publisher and you want to obtain the latest saved version.
- Click on the
Manage Stylesbutton located in the Home Tab, under the Ribbon. - In the Styles Pane, click on the green Reload Stylesheet button.
Embed Stylesheet Content
Use the Embed Stylesheet option to embed the stylesheet directly into the document template. This means that at run time, the rendering server does not need to access an external resource CSS to obtain the style, but the information will be inserted in the template.
- Click on the
Manage Stylesbutton located in the Home Tab, under the Ribbon. - In the Styles Pane, click on the
Optionssymbol button to view more options, then selectEmbed Stylesheet.
Reset Default Stylesheet
Users now have the option to reset the stylesheet to the one that comes with the Ecrion Design Studio Publisher.
- Click on the
Manage Stylesbutton located in the Home Tab, under the Ribbon. - In the Styles Pane, click on the
Optionsbutton to view more options, then selectReset Default Stylesheet.
Pagination
Unlike designing a document in a normal text editor, the Publisher is set up to allow you to create complex documents in a professional publishing tool. This includes creating documents with varied headers and footers applied to different pages, showing entire sections of the document depending upon the data source, dynamically changing the orientation from landscape to portrait, and much more.
Pagination addresses the concepts of breaking down your document into many sections (or Page Sets) and creating different layouts with side region content and formatting to create complex variations in outputs.
You will need to understand first how to create different Layouts to control the way your content is presented in the output, and then learn how to apply those layouts to different page sets which can even be dynamic in nature. It is our recommendation to visually break down your desired output considering differences in headers and footers, left and right side regions, varied content, and more to determine how many layouts and page sets you will need before you even begin adding content.
Pagination is an important first step consideration when beginning your document design, and you can learn much more about its usage in the Publisher in this section of the documentation.
Layouts
A Page Layout is an important component of your design that involves arranging content on the page in the output. While most of your design will reside in the Body Region of the document, a Page Layout is used to specify overall layout concepts like:
- How large will the header be?
- What page dimensions will the output document posses?
- Will the page orientation be portrait or landscape?
- How do I add content in the header, footer, left, or right regions?
- And much more...
You can think of layouts as controlling the overall structure of the content that you are creating, and furthermore, layouts can actually be dynamically applied to some Page Sets so you can, for example, have a header on the first page and an entirely different header present for the rest of your document. In this section, you will learn all of the important information about working with Layouts when designing your document templates.
Creating a New Layout
From the Page Layout Tab
- In the Ribbon, locate the Page Layout Tab.
- In the Layouts Group, click on the
Add Page Layoutbutton.
From the Pagination Pane
- In the Ribbon, locate the View Tab and click on the
Paginationbutton. - In the Pagination Pane, under Layouts tab, click on the
Add new layoutbutton. You will now have access to the New Layout Dialog to begin your setup of your layout.
Set Page Properties
- In the Pagination Pane click on the
Add new layoutbutton. -
In the Page Layout section of the New Layout dialog:
a. Select a format using the drop down list of predefined page sizes, or you can specify your own
WidthandHeightvalues by clicking onCustom.
b. Give your layout an applicable name by manually typing the name in the provided box.
c. Select theAuto Adjust Regionscheckbox option to fit larger content in the page regions (region-after, region-start, region-end, region-before) without overlapping their extent over the region-body. By default, this selection is not checked and typically is not used for most layouts unless needed.
d. Specify Page Margins, if applicable while creating your layout. Page Margins are unprintable space between the edge of the page and where the side regions (header, footer, left, and right) will begin. You can manually specify both the value and the measurement unit to use for Left, Right, Top, and Bottom page margins. -
You can configure different printing options for your Layout as needed, by selecting
Set printing propertiesoption from the New Layout Dialog. All of these values can be added as static content by manually typing in the boxes provided, or you can select the arrow to the right of any of the fields to set this dynamically from your data source.
Printing Options
-
Copy Count: specifies the number of copies that should be printed. The default value is "1". -
Input Tray: specifies the index of the input tray that will be used. The default value is "0". For PS and AFP format files, the input-tray is a numerical value. Any non-numerical value will have no effect and a warning will be issued. For the Direct Printing format, the attribute, the attribute's value can either be numerical or non-numerical. When a non-numerical value is specified, the server detects it automatically from the tray name. -
Output Tray: specifies the index of the output tray that will be used. The default value is "0". The values for this attribute depend on the output file format. For AFP format files, the attribute is a numerical value. Any non-numerical value will have no effect and a warning will be issued. For PS format files, the attribute must have a string value. For Direct Printing format, values for this attribute are not supported. -
Media Color: specifies the color to use for printing. The default value is "none". -
Printing Mode: specifies whether the page sequence should be printed in simple or duplex mode. -
Color Mode: specifies whether the page sequence should be printed color or monochrome. -
Orientation: specifies whether the page sequence should be printed as landscape or portrait.
Set Body Region Properties
Select the Regions Layout section from the New Layout Dialog and select the body region in the Select Region drop down menu. Below you will find the options that are available to adjust.
Margins
You should consider both Margins and Padding for your region. Margins are the distance from the edge of the page (or page margin end if applied) to where your body region will start. By default you will notice that the Body Margins are all set to .7in.
Padding
Padding is the actual distance from the start of your region and where the content will start. For adjustments to both Margins and Padding, you will simply need to type your value and measurement unit in the provided boxes as desired.
Columns
You can change the number of columns for multi-column outputs by manually entering the column count. In addition, you can also specify the desired gap between columns on the page.
Content
Next, you can modify content properties including changing the content orientation to rotate content as it appears on the page. Additionally, you can change the Vertical Alignment by using the drop down menu to select from Top, Center, Bottom or Justify alignment.
Writing Mode
Select the writing mode from the available drop down list, which includes: Auto, Left to right, Right to left.
Borders and Background
To apply Borders to your selected region, click on the Borders and Background button. From the Borders and Background Dialog select the Borders tab menu. The following options are able to be adjusted to meet your needs:
- The Style of border
- The Width of the border
- The Color the border should be
- Where the border of the selected Region should be applied to.
You should notice that the preview image adjusts to match the settings that have been made.
Now, should focus on adjusting any properties for your region background. From the Borders and Background Dialog select the Background tab menu. The following options are able to be adjusted to meet your needs:
- The color of the background.
- The ability to add and adjust an image for the background:
Image Repeat Mode,Image Offset X,Image Offset Y. - The shadow properties for the background of the selected Region:
Shadow Color,Offset X,Offset Y.
Header and Footer Region Options
To begin configuring either the Header or Footer Region, select one of these options from the drop menu at the top of the Regions Menu.
Visibility
You have the option to select the Visible check box to make the Header or Footer visible or hidden in the output.
Margins
Specify an Extent by manually adding the value and measurement unit in the provided box. The Extent is the measurement for how far your Header or Footer will extend from the edge of the page or from where your Page Margin ends if applied. By default, the extent is set to .7 inches.
For Headers and Footers, you have the option to check the box for Precedence. This option will enable the Header or Footer to overlap consuming space over the left and right side regions.
Padding
You should consider Padding for your region. Padding is the actual distance from the start of your region and where the content will start within. For adjustments to Padding, you will simply need to type your value and measurement unit in the provided boxes as desired.
Content
Make modifications related to the way your content will be displayed in the Header or Footer by using the Content Properties Group. You can modify the content Orientation or change the Vertical Alignment by selecting the options present in the drop down menu.
Borders and Background
To apply Borders to your selected region, select the Borders and Background button. From the borders and Background Dialog select the borders menu. The following options are able to be adjusted to meet your needs:
- The Style of border
- The Width of the border
- The Color the border should be
- Where the border of the selected Region should be applied
You should notice that the preview image adjusts to match the sections that have been made.
Now, should focus on adjusting any properties for your region background. From the Borders and Background Dialog select the Background menu. The following options are able to be adjusted to meet your needs:
- The color of the background
- The ability to add and adjust an image for the background.
- The shadow properties for the background of the selected Region
Left and Right Region Options
To begin configuring either the Left or Right Region, select one of these options from the drop menu at the top of the Regions Menu.
Visibility
You have the option to check the Visible check box to make the Left or Right side region visible or hidden in the output.
Margins
Specify an Extent by manually adding the value and measurement unit in the provided box. The Extent is the measurement for how far your Left or Right side region will extend from the edge of the page or from where your Page Margin ends if applied. By default, the extent is set to .7 inches.
Padding
You should consider Padding for your region. Padding is the actual distance from the start of your region and where the content will start within. For adjustments to Padding, you will simply need to type your value and measurement unit in the provided boxes as desired.
Content
Make modifications related to the way your content will be displayed in the Left or Right side region by using the Content Properties Group. You can modify the content Orientation or change the Vertical Alignment by selecting the options present in the drop down menu.
Borders and Background
To apply Borders to your selected region, select the Borders and Background button. From the borders and Background Dialog select the borders menu. The following options are able to be adjusted to meet your needs:
- The Style of border
- The Width of the border
- The Color the border should be
- Where the border of the selected Region should be applied
You should notice that the preview image adjusts to match the sections that have been made.
Now, should focus on adjusting any properties for your region background. From the Borders and Background Dialog select the Background menu. The following options are able to be adjusted to meet your needs:
- The color of the background
- The ability to add and adjust an image for the background.
- The shadow properties for the background of the selected Region
Editing an Existing Layout
It is normally true that you will need to make adjustments to a layout during your design. A common example of this is realizing that the Header Extent needs to be increased to provide a bit more room for your header content. In this section, you can learn more about how to access the Edit Layout Dialog and use the Ribbon to make quick layout modifications. Use the topics below to learn more about specific layout adjustments available.
Accessing the Edit Layout Dialog
- You can access the Pagination Pane in two ways. First, you can click on the
Expandbutton located at the bottom right corner of the Layouts Group in the Page Layout Tab. Additionally, you can click on thePaginationbutton located in the View Tab. Both of these options will always lead you to the Pagination Pane. - Select the Layout you wish to adjust and notice that an Options Menu is present to the right of it.
- Click on the
Options Menubutton to reveal more options related to this Layout. You will want to selectEdit Propertiesto modify the Layout Properties. This option will launch the Edit Layout Dialog. - In the Edit Layout Dialog, you can make all necessary adjustments to your layout including changing region dimensions, margins, padding, background coloring, orientation, and much more. You can learn more about these options in the Set Up Page Properties and Set Region Properties sections. Remember to click on
Savebutton to apply any changes you have made.
Changing Layout Margins
- In the Page Layout Tab of the Ribbon, click on
Marginsbutton. You can select from four available default options: Normal, Narrow, Moderate and Wide. These options will automatically adjust the layout properties for you. - If you would like to customize your Margins, select
Custom. This will launch the Edit Layout Pane. - If you wish to change the Page Margins, use the Page Layout Menu to specify margins in the provided boxes for left, right, top, and bottom.
- If you wish to modify the extent of side regions, select the Regions Layout Menu at the top of the Dialog. You can learn more about modifying these options in the Set Region Properties section.
Changing Layout Orientation
- In the Page Layout Tab in the Ribbon, click on the
Orientationbutton to expose options. You can select from the two available options here to change the layout orientation from Portrait to Landscape. - Additionally, you can access more detailed options in the Edit Layout Pane. click on the
Expandbutton located at the bottom right corner of the Layouts Group in the Page Layout Tab. This will now launch the Pagination Pane. - In the Pagination Pane, select Layout you wish to modify and you will notice an
Options Menuto the right of your selection. - Click on the
Options Menuto reveal more options. Next, selectEdit Properties. - The Edit Layout Dialog will now be launched. Here you can use the Format selection menu to select a predefined format to change your orientation, or you can create your own custom format by selecting Custom.
Adjusting Page Size
- In the Page Layout Tab of the Ribbon, click on the
Sizebutton to reveal a list of standard options. You can select from available default options to apply, or you can selectCustomto define your custom page size dimensions. This will launch the Edit Layout Dialog. - Select
Customoption from the Format selection drop down menu. - Define your custom dimensions by manually adding value and measurement unit in the provided boxes for Width and Height. Notice that the preview image will update as you specify your dimensions.
- When you are satisfied with your adjustments, click on the
Savebutton to apply your changes to the Layout.
Changing the Column Count
- In the Page Layout Tab of the Ribbon, click on the
Columnsbutton. You can select from One, Two, or Three columns to apply. You will now notice your selection will be applied and in the Design Surface the columns will be present. - If you would like to specify a different number of columns other than the available options, click on the
Expandbutton located at the bottom right corner of the Layouts Group in the Page Layout Tab. This will launch the Pagination Pane. - In the Pagination Pane, select the Layout you wish to modify and you will notice an
Options Menuto the right of your selection. - Click on the
Options Menuto reveal more options. Next, selectEdit Properties. - Next, click on the
Regions LayoutMenu located at the top of the Edit Layout Dialog. - Choose
Bodyin the Select Regions menu. - In the Columns Group, specify the number of columns you wish to have present in your document as well as the column gap if applicable.
- When you are finished with your configurations, click on
Savebutton to apply your changes to your Layout.
Rotate Page Content
- In the Page Layout Tab of the Ribbon, locate the Arrange Group and click on the
Rotatebutton. You will be presented with two options to rotate left or right. - Select
Rotate to leftorRotate to rightoptions to rotate the content on the page accordingly. You will notice that when applied, the Design Surface will update to display your selected content rotation. - Additionally, you can also rotate the content of the Body Region, or other regions if desired, by accessing the Edit Layout Dialog. Begin by selecting the
Expandbutton located at the bottom right corner of the Layouts Group in the Page Layout Tab. This will launch the Pagination Pane. - In the Pagination Pane, select the Layout you wish to modify and you will notice an Options Menu to the right of your selection.
- Click on the
Options Menubutton to reveal more options. Next, selectEdit Properties. - Next, select the
Regions LayoutMenu located at the top of the Edit Layout Pane. - Choose
Bodyin the Select Regions menu. - In the Content Properties Group, select from a list of rotation options in the Orientation Menu. Click on
Savebutton to apply your changes and view the results in the Design Surface.
Adding Content to Side Regions
To add content into any of your Side Regions (header, footer, left, or right), simply follow the instructions provided below. When adding content into these regions (which are called static regions), remember that this content will show up on every page of the output for which this Layout is applied to. For this reason, when adding content to any side region, the Publisher will launch into a mode called Edit Page Layout where you must either apply or cancel the changes you have made in order to return to normal editing.
Access Edit Page Layout by Double Clicking
The easiest way to access Edit Page Layout, is simply double click in any of the Side Regions. For example, double clicking in the Header will provide access to add content into the header. Notice that when doing so, the Edit Page Layout Tab is now present in ribbon, your cursor is now placed in the header, and a message will appear in the body region telling you which layout you are editing.
Access Edit Page Layout from the Ribbon
In the Page Layout Tab of the Ribbon, click on the Edit Page Layout button and choose the Layout you wish to adjust.
Access Edit Page Layout from the Pagination Pane
Launch the Pagination Pane, by selecting Pagination in the View Tab. Here select the Layout you wish to modify, click on the Options Menu button to the right of your selection, and choose Edit Headers & Footers.
Adding Content
- Once you have access to add content in the Side Regions, simply add your content as you would in the body of the document including writing static text, adding dynamic content, images, and more.
- When you are satisfied with your design, you can either click on the
Applybutton in the Edit Page Layout Tab orCancelbutton to drop all your changes to the Layout, or you can double click in the body region. For either choice, you must specify if you wish to apply and save these adjustments before returning to the normal editing mode. - You will now be returned to normal editing of the Body Region in the Design Surface and your side region content will be presented in gray.
Page Sets
You can think of Page Sets as a segmentation of your overall document output. You can imagine a scenario where an invoice document produced will have a cover page including account information and payment return, a series of pages that will be all related to recent purchases listed, and a last page with terms and conditions. Instead of creating one continuous document, you can create multiple Page Sets to accommodate the different sections of your final document. This allows flexibility in applying different layouts and even accessing features such as conditionally including or removing an entire set of pages depending upon a test of your data source.
Creating a New Static Page Set
- In the Page Layout Tab of the Ribbon, under Pages section, click on the
Add Page Setbutton. From these options provided, chooseAdd Page Set. - The New Page Set Dialog will now be displayed. First, you will need to specify which layout(s) will be applied to this page set and exactly how they will be applied. You can click on
Add Layoutbutton to combine multiple layout applications to a single Page Set. You can learn more about working with multiple layouts in the How to Apply Multiple Layouts section. - You have options to move the layout up or down in application order with the up and down buttons found in the
Options Menubutton next toRemove. In addition, you can remove the layout application for this Page Set. - Next configure the occurrence. This tells the Publisher how you would like this layout applied to your page set. For example, by selecting
Conditionaloption, you can specify this layout to only be applied to the first page or other options. - Continue selecting and modifying your layout applications for all available layouts, and click on
Insertbutton when this is complete. You will need to ensure that all possible pages are accounted for logically, otherwise you will receive a notification from the Publisher that not all pages are accounted for. - In the New Page Set Dialog, you can toggle the option to make this a Dynamic Page Set on or off. For a Static Page Set, leave this option off.
- Lastly, you can configure different printing options for your Page Set as needed by clicking on the
Set printing propertieson the left bottom corner of the Dialog. All of these values can be added as static content by manually typing in the boxes provided, or you can select the arrow to the right of any of the fields to set this dynamically from your data source. - Click on the
Savebutton when complete. You will now be returned to the Design Surface where you will notice you can scroll to access your newly added page set. - Next, access the Pagination Pane by clicking on
Paginationbutton from the View Tab. - Here you will notice your new Page Set is presented. Select the Page Set and click on the
Options Menubutton to the right of your selection to reveal options. - You should rename your Page Set to something relevant related to the content that it possesses. Click on the
Renamebutton from this available menu.
Creating a New Dynamic Page Set
A Dynamic Page Set can be used to set up a Page Set that can create a new page for a repeating element in your data source or even show or hide the entire Page Set based on a conditional test of your data.
Creation and Layout Configuration
- In the Page Layout Tab of the Ribbon, click on the
Add Page Setbutton to reveal more options. You will need to chooseAdd Page Set. - From the New Page Set Dialog select the Dynamic Page Set menu and toggle on the
Is Dynamicoption. Notice that now theIs Dynamictoggle button is turned on providing options to configure both conditional and repeating behavior. Visit the Configuring Conditional Behavior and Configuring Repeating Behavior sections to learn more about each of these dynamic options. - Select the Pages menu and specify which layouts will be applied to this page set and exactly how they will be applied. You can click on
Add Layoutto combine multiple layout applications to a single Page Set. You can learn more about working with multiple layouts in the How to Apply Multiple Layouts section. - Notice you have options to move the layout up or down in application order with the up and down buttons located in the
Options Menubutton, next toRemove. - Next, select an available Layout and configure the occurrence. This tells the Publisher how you would like this layout applied to your page set. For example, by selecting
Conditionaloption, you can specify this layout to only be applied to the first page. - Continue selecting and modifying your layout applications for all available layouts, and click on the
Insertbutton when this is complete. You will need to ensure that all possible pages are accounted for logically, otherwise you will receive a notification from the Publisher that not all pages are accounted for.
Configuring Conditional Behavior
- In the Pagination Pane select the Page Set that should be conditional. From the
Options Menu, select thePropertiesoption. - Navigate to the Dynamic Page Set section in the Edit Page Set Dialog.
- Click on the
Select Valuebutton to the right of the Condition field. This option will only be present if the Dynamic Page Set option is enabled. - The Create Condition Dialog will be displayed. Use this Dialog to select a data point to test in the Data Tree, choose a condition type, and then specify the criteria of your condition using the drop down menu and adding the value you wish to test for. When you are satisfied with your condition setup, click on
Insertbutton. - You are now returned to the Edit Page Set Dialog. Notice that your conditional configuration is presented here. You can click on the
Select Value- fx button to make adjustments to your repeating configuration or you can click on theXbutton to remove this repeating set up for your page set. - You can
Configure Repeating Behavior, or click onSavebutton to finish your creation of your Dynamic Page Set.
Configuring Repeating Behavior
- In the Pagination Pane select the Page Set that should be conditional. From the
Options Menu, select thePropertiesoption. - Navigate to the Dynamic Page Set section in the Edit Page Set Dialog.
- Click on the
Select Value- fx button to the right of theRepeatfield. This option will only be present if the Dynamic Page Set option is enabled. - The Dynamic Value Dialog will now be displayed. You will need to select the repeating element in your data source that you wish to have a new page created for. Notice that your selection will be highlighted in the Data Tree. Alternatively, you can choose
Create Expressionto create a more complex expression manually. When you are finished, click onInsertbutton. - You are now returned to the Edit Page Set Dialog. Notice that your repeating configuration is presented here. You can click on the
Select Value- fx button to make adjustments to your repeating configuration or you can click on theXto remove this repeating set up for your page set.
Configuring Sorting Behavior
- In the Pagination Pane select the Page Set that should be conditional. From the
Options Menu, select thePropertiesoption. - Navigate to the Dynamic Page Set section in the Edit Page Set Dialog.
- Click on the
Select Value- fx button to the right of theSortfield. This option will only be present if the Dynamic Page Set option is enabled. - In the Edit Sort Dialog click on the
Add rulebutton. - The Add Sort Criteria Dialog is now displayed. You will need to select from the available options in the Data Tree which value to sort by. Your selection will be highlighted in the Data Tree. When finished, click on
Insertbutton and you will be returned to the Edit Sort Dialog. - You will now notice the expression is set for the Sort Criteria. Now select the data type of this value, the order in which to sort, and case order if applicable to alphabetical sorting. You can continue to add multiple sorting rules by selecting the
Add rulebutton. - When you are satisfied with your setup of your Dynamic Page Set, click on
Applybutton thenSave.
Editing and Existing Page Set
- Turn on the Pagination Pane, by clicking on
Paginationin the View Tab. - In the Pagination Pane, select the Page Set you wish to modify to reveal the
Options Menu, chooseProperties. - In the Edit Page Set Dialog, you can now proceed to make modifications to the Layout that is applied, turn on Dynamic Page Set Features, or set up and change Printing Properties.
Converting a Static Page Set to Dynamic
- In the Pagination Pane, select the Page Set you wish to convert to a Dynamic Page Set to reveal the Options Menu, select
Convert to Dynamic Page Set. - The Edit Page Set Dialog is displayed. Notice that the
Dynamic Page Settoggle button will now be set to on, as the Publisher has automatically set this to be a dynamic Page Set. - Next, you can continue to configure both conditional and repeating behavior for this Page Set as described in the Configuring Conditional Behavior and Configuring Repeating Behavior sections.
- When you are satisfied with your conversion to a Dynamic Page Set, click on the
Savebutton to apply your changes.
How to Apply Multiple Layouts
When setting up either a Static Page Set or a Dynamic Page Set, you will have the option to configure the Layouts that will be applied to your page set. This option allows you to accomplish such objectives as having different headers and footers from page to page, having a landscape layout applied to the first page and portrait applied to the rest, and much more. To demonstrate the usage of this feature, we will use a simple example with two layouts: one for the cover page, and another for all remaining pages.
- If you are creating a new Page Set, the following will be applied in the New Page Set Dialog. If you are editing a previously created Page Set, the following will be applied in the Edit Page Set Dialog. All of the functionality will be exactly the same as you apply your layouts.
- Click on
Add Layoutbutton in the New Page Set or Edit Page Set Dialog. Select the Page Layout to add from the list of the available Page Layouts. - Once selected choose from different appearance options. In this example, we have selected to add the Cover Layout and specified we want this applied conditionally to the First Page Only. Use the selection menu to choose from available conditions. Here you should also ensure that all other Page Layouts are correctly applied.
- Click on
Insertbutton and you will be returned to the design surface. You have now set up two layouts to be applied to the Page Set. One will be applied to only the first page while the other will be applied to all other pages.
Other Page Set Options in the Pagination Pane
- Notice in the Pagination Pane, that if your page set is dynamic, it will be represented with an icon with multiple pages.
- Notice in the Pagination Pane, that if your page set contains multiple layouts, multiple icons will be displayed. The layout name applied will be present below the Page Set name. If multiple are used, a name of "ComplexMaster" will be placed to indicate multiple layouts are used.
-
Select the Page Set you wish to modify to reveal the
Options Menu. Click on this button to choose from available options.- You can move Page Sets up or down in order by selecting
Move UporMove Down. This will change the order in which they occur in the Design Surface and in your output document. - Click on
Renamebutton to manually type the text to rename your Page Set. - Click on
Deletebutton to remove the entire Page Set from the document. - Click on
Go to Page Setbutton to navigate the cursor to that Page Set in the Design Surface. - Click on
Propertiesbutton to adjust the settings related to the Page Set.
- You can move Page Sets up or down in order by selecting
Content Fragments
Content Fragments are a powerful way to improve efficiency and consistency across your document templates. For any of your designed content, you can preserve your work in a content fragment. By doing so, you can then insert it into other templates. This means that you do not have to recreate the section of content that you had already created, but perhaps more importantly, when you need to change something within that section of content you will only need to change in one location and consequentially all of your templates using this content fragment are updated.
Create a Content Fragment
In the Publisher, you will be able to create a Content Fragment using the Ribbon or the Properties Pane. The steps below highlight the best practices for creating Content Fragments.
From the Ribbon
- Select the section that you would like to turn into a Content Fragment. i.e. Repeating or Conditional Section, Repeating or Conditional Text, or a table.
- Navigate to the Layout section in the Ribbon. For example, if you select a table, you need to access Table Tools\Layout tab; if you select a repeating paragraph, you need to access the Repeating Tools\Layout tab.
- Select the
Create Content Fragmentbutton. - Next, in the resulting dialog, you will need to use the
Browsebutton to select the location where you would like to save your Content Fragment as well as give it an identifying name. - From the drop down list, select how you would like to view the content fragment in the main template:
Inline, as aParagraphorGlobal. - You can use Context parameter for assigning a data source and create an complex expression for the content fragment.
- The Preview Section will automatically updates in real-time, according to your modifications of content fragment’s parameters.
- After the dialog is completed with the needed parameters, click Insert and the element can be found in Content Fragments Pane and can be easily reutilizes anywhere in your main template. If you are not able to see the Content Fragments Pane, just tick the Content Fragment option from the View tab. For later insertions of the Content Fragment, right-click on it under Content Fragments Pane and select Insert option.
Using Properties Pane
- Open the Properties Pane by checking
Properties Paneunder the View tab from the Ribbon. - Select the section that you would like to turn into a Content Fragment. i.e. Repeating or Conditional Section, Repeating or Conditional Text, or a table.
- Select the
Optionsmenu from the right of the Properties Pane. - Select
Create Content Fragmentoption. - Next, in the resulting dialog, you will need to use the
Browsebutton to select the location where you would like to save your Content Fragment as well as give it an identifying name. - From the drop down list, select how you would like to view the content fragment in the main template:
Inline, as aParagraphorGlobal. - You can use Context parameter for assigning a data source and create an complex expression for the content fragment.
- The Preview Section will automatically updates in real-time, according to your modifications of content fragment’s parameters.
- After the dialog is completed with the needed parameters, click Insert and the element can be found in Content Fragments Pane and can be easily reutilizes anywhere in your main template. If you are not able to see the Content Fragments Pane, just tick the Content Fragment option from the View tab. For later insertions of the Content Fragment, right-click on it under Content Fragments Pane and select Insert option.
Insert a Content Fragment
To insert a previously designed Content Fragment into your document template, follow the instructions provided below.
- Place your cursor in the Design Surface where you would like to add the Content Fragment.
- In the Insert Tab in the Ribbon, select the
Content Fragmentbutton. - The Windows Open Dialog will launch and you will need to search for and select the Content Fragment you would like to include. The allowed extensions that can be selected are either .epb or .xfc files. The Insert Content Fragment Dialog will now be displayed. You will notice that your Content Fragment content will be displayed in the preview window. You will have options to configure parameters as well as making this a global template. For more information, visit the Global Templates section of the documentation.
- When you are finished, click on
Insertbutton. Your Content Fragment is now placed in the Design Surface. Remember that you will not be able to edit this content directly in the Design Surface. However, to learn more about your available options, visit the the Working with Content Fragments section of the documentation.
Working with Content Fragments
Once you have created or inserted a Content Fragment into your document template, you will want to know about the different options available to you.
Open Fragment
- In the Design Surface, select the Content Fragment you wish to edit.
- Right click to reveal a contextual menu. Click on
Open. - When this option is selected, the Content Fragment will be opened in an entirely different Dialog. You can now proceed to make modifications just as you would a normal document template. Remember to save your changes before navigating back to your template.
Edit Fragment
- To begin, you can access the Edit Content Fragment Dialog by double clicking on your fragment. Additionally, you can right click to reveal a contextual menu and select
Edit Fragment. - In the Edit Content Fragments Dialog, select Browse to navigate to assign a different Content Fragments. You will notice your preview image will be updated when a new Content Fragments is added.
- You can also manage the way that you insert it by selecting from the values of drop down list :
Inline,ParagraphorGlobal Template. - From the Edit Content Fragment Dialog you can also manage the parameters or the context.
- When you are finished with your configurations, select
Save.
Parameters
- Access the Parameters dialog by selecting
Manage Parametersfrom the Developer tab under the Ribbon. If you are not able to see the Developer tab in your template, just tick theShow Developer tabfrom the File\Options\Developer menu. - From the Parameters Dialog, click on the
Add New Parameterbutton. - A menu will now be displayed. Specify the name of the parameter. You can now specify the default value of the parameter that will be passed to the Content Fragment.
- Next, ensure that your Content Fragment is set up to accept the parameter. Open the Content Fragment for editing in another window. Select the Developer Tab in the Ribbon and click on
Manage Parametersbutton. The Developer Tab is an option that you can enable from the File Tab. - Click on the
Add New Parameterbutton. Add the same name previously configured and a default value as desired. Click onInsertbutton when you are finished. - Now, you can use this parameter in your Content Fragment. Click on
Fieldbutton from the Insert Tab. - In the Insert Field Dialog, click on
Create expressionbutton from the Advanced Group. - In the Create Expression Dialog, click on
Add a Parameterbutton. - Select your parameter from the list of available parameters. Then click on
Insertto insert your parameter. - The parameter will now be displayed in the Design Surface as a field. Save your work in the Content Fragment and return to the document template.
- It is now time to preview your output to ensure your parameter is behaving as intended. For example, if the parameter value defined in the template is "Hune 20th, 2016", it will now be passed to the Content Fragment and will overwrite the parameter defined in the Content Fragments. The result of the output should show this value populated.
Global Templates
Global Templates are used when you would like to insert a Content Fragment dynamically based upon the occurrence of a dynamic element in your document template. This feature will automatically replace a Field found in your template with the contents of the Content Fragment you have specified.
- In the Edit Content Fragment Dialog, you will see an option to make the Content Fragment a Global Template. Select
Globaloption under Display parameter to reveal additional options. - Next, you must specify an Expression indicating which XPath Expression will be replaced with the Content Fragment content when found in your document template. Click on the
Select Value- fx button. - In the Create Expression Dialog, select the element you wish to replace in the Data Tree, or select Create Expression to create your own XPath Expression. Click on the
Insertbutton when complete. - You will now notice the match expression is displayed. The Content Fragments content will be applied whenever this expression is validated in the document template.
- Once you select Save the field will be created for you in the Design Surface.
- Preview your output to ensure your Global Template is functioning properly. Because this Field possesses the same match expression, it will be replaced with the Content Fragments content.
Widgets
If you are utilizing the Ecrion BI Server to power Business Intelligence Dashboards, you also have the capability to link those dashboards to your templates in the Publisher to include the interactive widgets from your dashboards directly into a report of your design. These reports can then be synced with the dashboard and generated on the fly from the dashboard to produce on demand reporting of the widgets in their current state. To insert a Widget into your document template, follow the instructions provided below.
- In the Insert Tab of the Ribbon, click on the
Widgetsbutton. - The Manage Widgets Dialog will now be displayed. You will first need to add a Dashboard so you can access the available Widgets that reside within. Click on
Add New Dashboardbutton. - You will now need to navigate to the dashboard you would like to assign and select it. There are sample dashboards available in the Sample directory provided with the Ecrion Design Studio installation. The dashboard file will have an extension of ".bid". Once you make your selection, the Manage Widgets Dialog will be updated to display the available Widgets from your uploaded dashboard.
- You can repeat this process to add multiple Dashboards or use the two available options located to the right of your Dashboard in order to
Openor toErasethe Dashboard. - To insert a specific Widget, select from the available Widgets and click on the
Insertbutton. It is important to note that you can make multiple selections to insert and the selections will be noted with a check mark in the top right corner. - Once inserted, the Widget will appear in the Design Surface. You may wish to resize the Widget to meet your needs by dragging and dropping any of the selection points on the Widget perimeter.
Options
Selecting any inserted widget will access the Analytics contextual tab in the Ribbon. Through this tab you will be able to access the options highlighted below.
Delete
The Delete option will permanently erase the widget from the Design Surface of the EDS Publisher.
Refresh
The Refresh option will allow you to update the widget if any changes have been made to the widget in the BI Architect.
Filter
The filter option will allow you to easily update or create filters for the data of the widget directly in the Publisher.
-
Click on the
Add filterbutton. -
Select the filtering element to use from the drop down list.
-
Select the dynamic value from the attached data source to filter the element by.
Open
Clicking on the Open button will launch the dashboard where the widget is located. This will allow you to make any design edits that may be needed to the widget.
Size Section
You can adjust the size of the widget by dragging one of the corners, however if you need the widget to be at a specific size, you can specify the exact dimensions in the Ribbon.
Charts
In the Publisher, you have the capability to include powerful charts directly into your document templates. These charts can be entirely dynamic displaying information directly from your data source and can be a great way to improve the communications you produce.
General Usage of the Insert Chart Dialog
- Click on the
Chartbutton located in the Insert Tab in the Ribbon. Select the Chart Type and Style you would like to work with from the drop down menu. -
Once you have made your selections for Type and Style, you will now need to proceed with your Series Configuration. Depending upon the type of chart you have selected, this menu can change.
-
Pie charts, for example, are based on one series, where bar charts can accept multiple series. The general process involves using the
Selectbuttons to choose your data points parent element, category access, and value access.- The Data Points selection is asking you to specify exactly where your data points will be located in your data.
- The Category refers to the label associated with each data point.
- The Value represents the actual value used to drive the chart.
You can learn more about configuring charts with one or more series by visiting the Creating a Chart With One Series and Creating a Chart With Multiple Series sections of the documentation.
-
When you choose the
Selectbutton for each configuration point, the Dynamic Value Dialog will be launched. You will need to use the Data Tree to select your desired data point for each or select Create Expression to create a more complex XPath Expression manually. - When you have completed the steps above to define the chart, click on
Insertbutton and the chart will be added into the Design Surface. You will also notice that a contextual tab for the chart is now present in the Ribbon. You can learn more about available options by visiting the Chart Options section.
Create a Chart with One Series
- The first thing you should do is review your data source to determine where your data resides. In our example, there is a repeating series each containing investment data for three months. For this chart, we only want to present the data for one of these series, the month of "April".
- Click on the
Chartbutton from the Inset Tab in the Ribbon and select the Pie Chart, then choose the Style of your preference. - Choose the
Selectbutton for data points to configure where the data points reside. This will launch the Dynamic Value Dialog. You can simply select the element in the Data Tree to specify where the data points reside, or you can click onCreate Expressionto create your own XPath Expression. For our example, we need to use a filter to get the data from the series with the attribute value "April", so we will click on 'Create Expression' button. - Click on the
Savebutton to return to the Edit Pie Chart Dialog. You will notice that your selection is now displayed. You can chooseClearto remove, located on the right of every data point or theSelectbutton to return and make edits to your expression. - Repeat steps 3 and 4 for both the Category and Value Series values. When you have completed this process of selection, each data point will be presented to you in the Edit Pie Chart Dialog.
- When you are satisfied with your specifications, click on
Insertbutton and the chart will be inserted into the Design Surface. Notice how the captions that are retrieved are displayed outside of each pie slice as well as in a legend by default. - You can learn more about additional chart options by visiting the Chart Options section of the documentation.
Create a Chart with Multiple Series
- For this example you will need to configure the multiple series that you wish to have present in your chart. You will first need to understand where your data points reside. In this example, the data resides in three series with a defining attribute of "month" for each series. We will need to set up a series for each of these months as follows.
- CLick on the
Chartbutton, located in the Insert Tab of the Ribbon and select the Line Chart from the Type Menu. - You will need to configure the first series. To begin, click on the
Selectbutton to launch the Dynamic Value Dialog. Here you can choose a value directly from the Data Tree or click onCreate Expressionbutton to manually create your own XPath Expression. For this example, we will use a predicate to filter the series' element to only select the occurrence when the "month" attribute is equal to "April". Click onSavebutton when your configurations are completed. - Repeat this process to select the data point to be used for the category axis (X axis) and the value axis (Y axis). When you are finished, all selected data points will be visible for this series. You can click on the
Editbutton for the series to provide a more applicable name or move up and down accordingly using the arrow buttons. - Click on
Add New Seriebutton to configure a new series. In our example, we will repeat steps 3 and 4 above being sure to change the filter for Data Points to pull the data from the months February and March accordingly. After this process, all three series should be present. - When you are satisfied with all of your series configurations, click on
Insertbutton. The chart will now be inserted into the Design Surface. You will notice that each series is represented as a different colored line as well as a contextual Format Tab is available in the Ribbon when the chart is selected. - You can learn more about additional chart options by visiting the Chart Options section of the documentation.
Chart Options
Once you have inserted a chart into your document template, there are a large amount of additional configurations you can make after this step.
Resize Chart
- You can resize your chart simply by dragging and dropping in the design surface. Begin by selecting the chart in the Design Surface.
- Drag and drop any of the corner or side selection points to achieve a new desired size. Release the mouse when you are content with the new size outline.
- To apply more specific chart dimensions, click on the chart in the Design Surface to launch the Properties Pane.
- In the Properties Pane, select the Layout Menu at the top. Then choose the area you would like to resize. You can resize individual areas such as the legend, plot area, or the entire chart as you see fit. Begin by selecting the measurement unit and then manually typing in the value of the Width and Height for the object you wish to modify. Upon applying, you will notice your adjustments being reflected in the Design Surface.
Show or Hide Captions
- Double click on your chart in the Design Surface to launch the Properties Pane.
- Select the Layout Menu at the top of the pane. In the Labels Group, inside Plot Area you can toggle the
Show Captionsoption on or off by selecting it. - In the Design Surface, your chart will update to reflect this adjustment removing the captions or adding accordingly.
Legend Display and Placement
- Double click on your chart in the Design Surface to launch the Properties Pane.
- Select the Layout Menu at the top of the pane.
- Select Legend Area from available area selections.
- You can enable the legend to be shown by selecting the Placement Menu and choosing where your legend will be located.
- To remove the legend, simply select None.
- Additionally, you can place your legend in a custom location by selecting
Customand specifying values for Left and Top displacement to adjust your legend to the correct location. - Your adjustments to the legend will be reflected in the Design Surface.
Background Color and Outline
- Double click on your chart in the Design Surface to launch the Properties Pane.
- In the Visual Menu, locate the Appearance Group.
- Select the area from the area selection menu that you would like to apply appearance changes to.
- Use the drop down menus to apply a standard or custom designed color for both
Shape FillandShape Outlineto the area object selected as you see fit. Your modifications will be updated in the chart located in the Design Surface.
Modify Axis
- Double click on your chart in the Design Surface to launch the Properties Pane.
- Select the Layout Menu at the top of the pane.
- Navigate to and select either the Category Axis(X) or Value Axis(Y) axis in the area selection menu.
-
In the Axis Group you can configure the following options:
- Select
Display Axischeckbox to show or hide the entire axis selected. - Provide a
Titleby manually typing in your text. The title will be displayed in the chart. - Select from Orientation menu,
VerticalorHorizontaloptions to change the orientation of the chart. - Select an Intersection Value of
Auto,Min, orMaxfor axis placement. - Select a Color for axis grid lines display.
- Select
-
In the Appearance Group you can control formatting for the labels of the axis including:
- Select Display Labels checkbox to toggle axis labels on or off.
- Choose Placement Value using the drop down menu to
Center, placeBetween, or set toAuto. - Specify an
Axis offsetfor labels to start that distance from axis. - Specify a Color for axis labels by selecting the color menu.
-
In the Gridlines and Tickmarks Groups you can modify options including:
- Selecting
Display Gridlinesto enable or disable this option. - Choose a color for the gridlines using the Color selection menu.
- For axis tickmarks, choose a Style provided from available Options Menu.
- For axis tickmarks, select a color for your tickmarks using the Color selection menu.
- Selecting
Use Provided Color Schemes and Layouts
- In the Design Surface, select your chart. This will enable the contextual Format Tab in the Ribbon for your chart.
- To apply an available color scheme, use the Format Tab to navigate through available color schemes and simply select to apply. You will notice that your chart's colors are updated in the Design Surface and the applied color scheme will be highlighted in the Ribbon for visual reference.
- You can also choose from provided layouts to automatically adjust your chart. Browse through the provided layouts in the Format Tab and simply select the layout you would like to apply by clicking on the preview image. You will notice the layout will be applied in the Design Surface.
Edit Charts Data Configuration
- In the Design Surface, select your chart to reveal the contextual Format Tab in the Ribbon.
- In the Format Tab, click on the
Edit Seriesbutton. This will launch the Edit Chart Dialog focusing just on the Series Group. - In this Dialog, you will be able to revisit your series configurations by using the
Selectbuttons for data points, category and value configurations depending on the type of chart you are configuring. - When you have finished making adjustments to your chart series, you will need to click on
Insertbutton to apply your changes to your chart.
Change Chart Type or Style
- In the Design Surface, select your chart to reveal the contextual Format Tab in the Ribbon and click on the
Change Chart Typebutton. - Navigate the drop down list to select a new Chart Type and Style.
- Once you have selected your new Type and Style your chart will up updated in the Design Surface.
Change Chart Fonts
- Double click on your chart in the Design Surface to launch the Properties Pane.
- In the Visual Menu, choose the desired area to make font changes to. Theses areas include changing fonts for the entire chart, the plot area, the legend, individual axis, and more.
- In the Font Group, select modifications to your font including font family, size, formatting such as bold and italic, and more. Simply use the available buttons and menus to apply your font formatting to the selected area. You will notice in the Design Surface that your modifications to the font are applied to your selected area.
Forms
In the Publisher you can create interactive two-way communications allowing your document audience to interact with the form and submit information back to you.
Starting a Form
- In the Insert Tab of the Ribbon, click on the
Formbutton. - You will now notice an empty Form element is present in the Design Surface. In this area, you can now proceed to add your form controls and merge with other static and dynamic content.
Inserting Form Controls
- In the Insert Tab of the Ribbon, locate the Forms Group. Here you will have access to the different Form Controls that you can insert into your form including Edit Boxes, Check Boxes, Radio buttons, Buttons, and Submit buttons.
- To insert a Form Control, simply place your cursor in the desired location in the Design Surface and selected the Form Control you would like to insert.
- The form control you select will be added into the Design Surface.
Options
Once you have inserted a Form Control into your document template, there are many options available to you to personalize this element.
Borders and Backgrounds
- Right click on the Form Control in the Design Surface and select
Propertiesto launch the Properties Pane. - In the Properties Pane, select the Visual Menu.
- To specify a background color, choose from the provided Background Color drop down menu or create your own custom color.
- To apply borders, select the color, thickness, style and then single click in the border application menu in the region you wish to apply the border.
- It is recommended you preview your output to ensure your adjustments are behaving as anticipated.
Make a Form Control not Editable
- Right click on the Form Control in the Design Surface and select
Propertiesto launch the Properties Pane. - Select the Visual Menu from the top of the pane. Notice in the Appearance Group the
Editableoption. Check or uncheck this option to determine if this Form Control will be editable in the output. - You can test the results of this option by previewing your output and notice that you will not be able to interact with the Form Control if this option is not selected.
Resize
Design Surface
- Select the Form Control you wish to resize in the Design Surface.
- To resize, simply drag and drop any of the selection points available on the Form Control perimeter.
Properties Pane
- Right click on the Form Control in the Design Surface and select
Propertiesto launch the Properties Pane. - Select the Layout Menu from the top of the pane.
- Specify the measurement unit then type the value for padding parameters, the width and height of your Form Control as you see fit.
Dynamically Populate and Edit Box
- Right click on a Form Control - Edit Box in the Design Surface and select
Propertiesto launch the Properties Pane. - Select the All Menu at the top of the pane.
- Select the
Dynamic Value - fxbutton next to theValuefield in the Form-Control Group. - In the Dynamic Properties Dialog, select the
Dynamic Value - fxbutton to the right of the Default Value field. - From the Edit Dynamic Value Dialog select the field to be used to populate the form control and click on
Savebutton. In this example we will select the 'first' field. - You will be returned to the Dynamic Property Dialog, click on
Applybutton. - You should now preview your output. The output should reveal that the value in the data source will be pulled and populated in the Edit Box.
Dynamically Mark Check Boxes
- Right click on a Form Control - Check Box in the Design Surface and select
Properties. The Properties Pane will now be displayed. - Select the All Menu from the top of the pane and click on the
Dynamic Value - fxbutton to the right of theCheckedfield within Form-Control Group. - From the Dynamic Property Dialog select the Select Property button.
- Click on the
Add rulebutton to create a condition. -
In the Create Condition Dialog:
- Select in the Data Tree the data value to base your condition on.
- Then, choose your type of condition based on available options for based on occurrence, numerical value, or text value.
- Then specify the details of your condition for contains or starts with using the drop down menu available and then add the value to test for. You can create more complex conditions manually by clicking on the
Create Expressionbutton. When you are finished configuring your condition, click onInsertbutton.
-
You will be returned to the Dynamic Property Dialog. Here you must specify to use a static value by using the drop down menu, or select
Dynamic Value - fxbutton to obtain the property value from your data source. For this example, when the gender is set to "male" we will want the check box "checked" property to be set to true. - Next, preview your output to test the behavior of your condition. You can modify the data source to different values to test and ensure the condition evaluates properly.
Configure a Submit Button
- Double click on the
Submitbutton in the Design Surface to launch the Edit Form Control. - You can specify a name if desired or use the default assigned name.
- Use the http-url field to manually enter in the address of the service that will consume the submitted information.
- Select from
PostorGetmethods from the Method drop down menu.
Important Note
Note that PDF files supports only POST submits.
Document Translations
In the Publisher, you can set up multiple language translations for your document template. This means that during the rendering process, a specific translation can be applied and all of the static text in your document will be replaced using the translation that you set up in the Publisher.
Create a New Language
- Select the
Manage Languagesbutton under the Review tab from the Ribbon. - In the Languages Dialog, select
Add new language - In the Add New Language Dialog you must specify the language for your translation using the drop down menu, then click on the
Insertbutton. The new inserted language will be used as the initial display that you will use to provide translations for.
Edit a Translation File
- Select the Review Tab in the Ribbon, then click on
Manage Languagebutton. This will launch the Language Pane. - Notice in the Language Pane, your active translation is teh currently applied language. In the Languages Group, select the language you wish to modify to reveal other options located to the right (
Optionsbutton). - Click on the
Optionsbutton and select theEditoption from the contextual menu. This will launch the text file editor so you can edit the translations. - The language file is a text file and you must click on
Browsewithin Language File Field, from the Language Properties to choose where you would like to save this file. - You can now simply replace the original text with the translated text as you see fit, then click on
Savebutton to approve the translation file and return back to your template.
Document Protection and Editing Restrictions
With the Publisher you will be able to restrict / protect 3 different aspects of the template or document.
Document Editing
You are able to restrict the editing of the document template (.epr) file itself.
- Navigate to the Review Tab in the Ribbon.
- Click on the
Restrict Editingbutton from the Document Group. - In the Protection Pane, toggle on the option for
Document Editing. - You have the option to add a password. Optionally, add a password manually and check the
Remember Passwordoption, if needed. - Click on the
Applybutton to successfully complete the Protection process.
Adding a password will allow edits only when the password is entered. If you do no add a password, no edits will be able to be made unless the Allow users to edit this element option is selected.
Selecting the Allow users to edit this element option will allow users to edit the content within the selected paragraph.
PDF Document
You will be able to configure that options that a user will have when viewing the PDF output of the rendered document.
- Navigate to the Review Tab in the Ribbon.
- Click on the
Restrict Editingbutton from the Document Group. - In the Protection Pane, toggle on the option for
PDF Document. - Click on the
Configureto set up the protection options and add an optional password. Manually add a password or select theDynamic Value - fxbutton to select a value from the data source. - Click on the
Applybutton to successfully complete the Protection process.
There are two types of passwords, that can be set: * User password - restricts access to the document, if set. * Owner password - controls available permissions, such as editing, if set.
Any modifications to the protection configuration made when rendering will overwrite any made at the template level.
Word Document
- Navigate to the Review Tab in the Ribbon.
- Click on the
Restrict Editingbutton from the Document Group. - In the Protection Pane, toggle on the option for
Word Document. - Click on the
Configureto enable modification of the document and add an optional password for the Owner. Manually add a password or select theDynamic Value - fxbutton to select a value from the data source. - Click on the
Applybutton to successfully complete the Protection process.
To allow users to only modify chosen sections
- Select the section of the template to be modified.
- Toggle on the
Allow users to edit this elementoption.
Document Guided Tour
When creating a Smart Document output, you can add a Guided Tour to assist your customers to easily understand what specific sections mean or giving necessary information.
Configure Guided Tour
You are able to use the Configure Guided Tour button to add new steps, as well as configure additional information. The steps below will highlight how to configure the additional information.
- Click on the
Configure Guided Tourbutton from Review tab in the Ribbon. - Give the Tour a title.
- Add a description for the tour. This will be shown in the rendered document when the tour icon is selected.
- You can adjust the order of the steps that have been added by selecting the up or down arrows. You can also remove individual steps, or all of them.
- Once you have made all necessary configuration, click on
Apply.
Add Individual Steps
- Select the template element you would like to add a description to. You may need to use the navigation bar in the Properties Pane to select the specific target element.
- Click on the
Add Tour Stepbutton from the Review tab in the Ribbon. - From the Configure Guided Tour dialog add the description you would like for the selected element.
- Once you have completed the description, click on
Applybutton.
Previewing the Document
After you have added the steps to the guided tour you may want to preview the document to ensure that the steps have been set up correctly.
- Navigate to the Home tab in the Ribbon.
- In the Export group, click on the bottom button of the
Previewand select theHTML5 Smart Documentoption. - A browser window will launch with the rendered document.
- Select the Tour icon to start the tour and ensure the steps are in the correct place and order.
Responsive Documents
With the Ecrion Design Studio you are able to adjust sections in your templates to be responsive depending on the device that it will be viewed on. Below is a list of options available, along with the steps needed to configure them. For each of the different device output options, Phone, Tablet, Computer, we have assigned a different stylesheet in order to better help distinguish between them.
Tables
- Select anywhere in the table you which to make responsive.
- In the Ribbon, navigate to the Home tab.
- From the Style group select the
Responsive Designbutton. - In the Responsive Design dialog select the device type to adjust the settings for; Phone, Tablet, Laptop, or TV.
- Select one of the available Responsive Table Behaviors; Not Visible, Transpose Columns or Selective Columns.
Paragraphs
- Select in Paragraph to be made Responsive.
- In the Ribbon navigate to the Home tab.
- From the Style group select the
Responsive Designbutton. - In the Responsive Design dialog select the device type to adjust the settings for; Phone, Tablet, Laptop, or TV.
- Select one of the available Responsive Table Behaviors; Not Visible or Show Summary.
Grids
- Select anywhere in the Grid you which to make responsive.
- In the Ribbon, navigate to the Home tab.
- From the Style group select the
Responsive Designbutton. - In the Responsive Design dialog select the device type to adjust the settings for; Phone, Tablet, Laptop, or TV.
- Select one of the available Responsive Grid Behaviors; Not Visible, Drop Column or Selective Columns.
Preview the Output
- Navigate to the Home tab and select the Preview as
HTML5option from the Export group. - This will launch a new tab in your default browser. The view will change depending on the size of the browser window. In order to view what your output will look like on different devices, you will need to resize the browser window.
Options
Transpose Columns
The Transpose Columns option will shift the content of the table so that the columns and rows are interchanged. With Transposed Columns you will also have the option to set the column width ratio.
- Follow the steps to make the document Responsive here.
- Modify the Columns Size ratio for the columns that are available. By default this will be, 50% - 50%.
Preview the Output
- Navigate to the Home tab and select the
Preview as HTML5option from the Export group. - This will display a new tab in your default browser. The view will change depending on the size of the browser window. In order to view what your output will look like on different devices, you will need to resize the browser window.
Drop Columns
The Drop Columns option will take the text from the columns and stack them.
- Follow the steps to make the document Responsive here.
- Set the cell width for each and adjust the order as well if needed.
Preview the Output
- Navigate to the Home tab and select the
Preview as HTMLoption from the Export group. - This will display a new tab in your default browser. The view will change depending on the size of the browser window. In order to view what your output will look like on different devices, you will need to resize the browser window.
Selective Columns
- Follow the steps to make the document Responsive here.
- In the table or grid, select the column(s) you would like to not be visible and toggle off the Column Visible option in the Responsive Layout.
Preview the Output
- Navigate to the Home tab and select the
Preview as HTMLoption from the Export group. - This will display a new tab in your default browser. The view will change depending on the size of the browser window. In order to view what your output will look like on different devices, you will need to resize the browser window.
Show Summary
- Follow the steps to make the document Responsive here.
- Adjust the Summary title. By default the Publisher add Show More, however you may wish to have text like "details" or "Read on".
- The
Show Collapsedoption will either show the test in the paragraph as collapsed by default or not. If you toggle this option on, when viewing this section in the selected device, all that will be visible is the Summary text. However, if you toggle this option off, the text will be shown, and the end user will have the ability to hide the text.
Preview the Output
- Navigate to the Home tab and select the
Preview as HTML5option from the Export group. - This will launch a new tab in your default browser. The view will change depending on the size of the browser window. In order to view what your output will look like on different devices, you will need to resize the browser window.
Authoring Projects
With EOS you are able to create interactive forms to use with templates that users can fill out to generate personalized documents.
The steps below highlight how to create and work with Layout Templates in the Publisher for Interactive Documents.
In the Publisher, you will create the Layout template for an Interactive Document the same way you would any other document. The only difference is what will be used for the data source. In order to create the Layout Template in the Publisher please follow the steps below.
- Create a new Form in EOS, for more information visit Creating Forms section.
- Once saved, download the Form (this will be an .efd file) from Ecrion Platform.
- In the Publisher assign the .edf file as the data source.
- Create the Template as normal, using the fields from the Form data source as the dynamic values.
- Once you have completed the Template, upload it to Ecrion Platform in the same folder where the workflow will go. You can do this by uploading the file directly to Ecrion Platform or using the Ecrion Platform tab in the Publisher.
- Once you have uploaded the Template you will need to create a workflow for the Interactive Document.
Appendix
Set up the Design Studio
System Requirements
| Minimum Requirements | Optimal Requirements |
|---|---|
| Hardware | |
| Processor: Intel Core i5 @2GHZ | Processor: Intel Core i7 @ 3GHZ |
| Memory: 4GB of RAM | Memory: 8GB of RAM |
| Hard Disk: 10 GB disk space | Hard Disk: 10 GB of disk space |
| Operating System | |
| Windows Vita SP2 | Windows 8 x64 and up |
| Prerequisites | |
| Net Framework 4.5 or later | Net Framework 4.5 or later |
Installing
Ecrion Data Modeler is available to you in an executable (.exe) installer which contains several applications called the Ecrion Design Studio. This allows you to simply double click on the installer file and follow the on screen instructions provided to you by the Setup Wizard. Below are some helpful points to assist you along the way with the installation.
- The installer will open with the welcome screen that indicates the setup wizard is ready to begin and guide you through the installation. When you are ready to begin, click on
Nextbutton. - Accept the end-user licensing agreement by checking the box and selecting
Next. - Specify the directory you wish to install Ecrion Design Studio in. Ecrion recommends using the default installation folder *C:\Program Files\Ecrion\Ecrion Design Studio 2018(64 bit)*, and then select
Next. - Now, you will need to decide which product to install. Ecrion Design Studio provides a suite of products which can be chosen during this step of the installation. Each tool is provided with a short description on its functionality. By default, all products are selected. You can decline the installation of a feature by de-selecting the associated check-box. Not selecting an option will render the user unable to finish the installation.
- Next, the Setup Wizard will now perform the necessary installation and provide a progress window for your information.
- When the setup is successfully completed, the Setup Wizard will provide a notification of completion. You can uncheck the
Launch Publisheroption if you do not wish to launch the Publisher after installation finishes. When you are ready to complete the installation, selectFinish.
Updating your Build
When updating your build using either the production links from our website or the evaluation builds provided by our support team, the steps to update are the same.
- The first step to follow when updating your Ecrion Studio build is to unistall the old build from the machine. Otherwise, the installer will open and you will see a note saying that there is another version installed.
- Use the link provided to download the correct version that you need.
- Follow the on-screen instructions. These will be the same as the ones highlighted on the Installing page.
- Once the build is updated, you can continue to create and design your templates as before.
Trial Limitations
Below is a full list of the Trial limitations for the Publisher. If you have any questions you can reach out to support@ecrion.com or directly to your account manager.
General Limitations
When downloading a trial version from the Ecrion Website, all the applications from the Ecrion Design Studio suite will have a 14 day trial. This download will include the three products that Ecrion Design Studio consists of: the Publisher, Data Modeler, and BI Architect. If you are looking for an extension of the trial please reach out directly to your account manager.
Preview
When you are previewing your document from the Publisher using the Preview as button from the Home Tab the following restrictions are in place:
- The Ecrion Logo is displayed on every page.
- The even pages above 10 will not be displayed.
Export
When you are using the Export to button located in the Home Tab, the following restrictions are in place:
- The Ecrion Logo is displayed on every page.
- The even pages above 10 will not be displayed.
- Exporting to FO is not available in trial mode.
Terminology
Template
Before you can fully understand the usage of the Publisher, you must first understand what a template is used for. The process of data driven communications is driven by two main components. One component is a well structured and refined data source, and the other is a template that will use the data to populate the template at runtime. Let's take an example to further demonstrate.
Imagine that you have two customers: John and Jane.
When you want to generate your invoices to send for payment collection, you can produce two invoices, one for John and one for Jane. However, we will have one template that will be used with each data source and will produce two entirely different invoices.
A template contains both static content and dynamic content. Dynamic content is in the form of placeholders known as fields located in your template. At production time, these fields are replaced by the actual data. The Publisher allows you to not only include these placeholders with a few simple steps, but also to apply complex formatting options and much more in order to create stunning outputs. Here is an example of a template and its associated output. Notice that, in the template that there are fields which indicate where specific data will be inserted.
Layout
When designing your templates, you should think about the construction of your document in terms of layouts and page sets. A Page Layout is part of the designing process and consists of the arrangement of content in a page. Layouts are used to control pagination features like: page margins, headers, footers, left and right side regions, and more. A Layout will define the extent of the side regions, specify the page margins, and control the overall orientation and dimensions of the template before you start adding content.
It is extremely important to take your layout into consideration prior to managing the content in your template. These layouts can be assigned to multiple page sets, applied conditionally, and much more. You can read much more about this functionality in the Pagination section.
Page Set
A Page Set (or Page Sequence) is a sequence of multiple Page Layouts that apply when the page's number meets certain conditions (is first, is last, or when a condition from the XML is met). Your template may end up being composed of many page sets, and this can be very useful because you may want to assign different layouts to change design properties such as orientation, page size, and much more specifically for that range of pages. Additionally, you can choose to conditionally display an entire page set based upon your data source or specify to create a page for a set of repeating content in your data.
You can learn more about the design and usage of Layouts and Page Sets by visiting our help section on Pagination.
Dashboard
A Dashboard is a useful collection of Widgets that provide a visualization of enterprise data with the purpose of analyzing key information. A Dashboard can consolidate data, portray trends through graphics, and allow viewers to use filtering options, all on a single screen. Although these dashboards are created by using the BI Architect, the widgets that provide these valuable analysis tools can be used in your templates.
Widget
Widgets are interface elements which present data and interact with a Dashboard. Widgets are designed in the BI Architect, used in your dashboards and ultimately can be included in your reports templates in the Publisher.
Ribbon
The Ribbon is used to access all necessary functionalities needed to design your document templates. Select from different Tabs and access the different Groups within the Ribbon to find the features you would like to explore.
Design Surface
The Design Surface is the dedicated region in the Publisher that you will use to add and remove content, adjust alignment and formatting, and perform all of your template design needs. This is the largest region on the screen and will display what your template will look like as you design it.
The Design Surface has the same layout as a page of your document, and you can scroll as you continue to add page sets or additional content.
Status Bar
The Status Bar is located under the Design Surface and allows you to access important viewing and navigation options when working with templates. It is useful for zooming on specific sections of your template design, viewing your design in two pages side by side, or even switching Views to Preview your document populated with data.
The Status Bar will also display important messages to you where applicable and let you know which page your are currently working on. If there is an error at any point you can find more information in the status bar.
Switching Views
You can easily switch back and forth through the available views in the Publisher, using the Status Bar. You will notice at the right side of the Status Bar quick access options for the different views. By simply selecting these options, you will be able to switch between the three Document Views: the Design View, the XML View and the Print View.
Document Zoom
On the far right side of the Status Bar, you can select from a variety of zoom options. These options include a slide bar for specific zooming, such as One page, Two Pages, and Fit to screen. Each of these options is highlighted below.
One - Zoom the document so that the entire page fits in the window. Two - Zoom the document so that two pages fit in the window. Fit - Zoom the document so that the document's width matches the window's width.
You can use the zoom slide bar to adjust the zoom percentage as needed.
Navigation Bar
The Navigation Bar is an important component of the Properties Pane, allowing you to select specific elements in order to modify their attributes accordingly.
When selecting the Properties option from the View Tab, you will notice the Navigation Bar displayed at the bottom of the Properties Pane.
Best Practices
Get to know your Data
The best place to get started when designing your Document Templates is to begin with understanding your data that will be populating your resulting document. You will need to know where certain values are located within your data, which elements are repeated,and where specific flag elements might be located in order to display Conditional Paragraphs and Texts.
A great place to accomplish this is by displaying the Data Source Pane. You can read more about assigning your data source and viewing the Data Representation Tree in the Assigning a Data Source section of the help documentation. You should first assign your data source and then navigate through it in order to inspect what elements and attributes are available to you.
Remember that your Document Templates may often consist of elements such as Conditional and Repeating Paragraphs that are used to dynamically build the content that will be displayed. You should first familiarize yourself with the data in order to understand where you will need to find the elements and attributes required to drive the construction of your Document Template.
Think about Pagination
After you have a good understanding of your data source, it is recommended to start building the pagination requirements before you even begin to add content into your Document Template. Pagination is highlighted, in detail, in the Pagination section of the documentation. However, you should know why we recommend that you consider this as one of your first steps.
Before you begin your design, we recommend using pencil and paper to draw out what your document will consist of. Questions such as the following should be presented when thinking about the pagination of the resulting document:
- Does my document contain headers and footers? If yes, do these change from page to page?
- Does my document contain content or formatting in the left or right side regions?
- What are the page dimensions that I need for my document? Do these dimensions change at all?
- What orientation should my document output be? Does this change from a page to the next one?
- Do I want certain pages of my document to be repeated or displayed based upon my data source?
By asking yourself questions of this nature, you will begin to build your document before actually designing it in the Publisher. Perhaps you may even want to sketch pages and mark the dimensions, or the headers and footers. This will provide a great reference for you as you work with the Pagination feature to create different layouts and page sets accordingly.
You can read more about layouts and page sets in the Terminology section of the help documentation. We encourage this practice of thinking about pagination as a mean to assisting you in designing the layouts and structure before even adding content to your Document Template.
Consider Dynamic Behavior
At this point, you may have structured your Document Template using Layouts and Page Sets. It is now recommended to take into account the content you would like to populate your template with. It is important to think of elements in your document as one of two types: static or dynamic.
Static content is added into the Design Surface and will appear in your output as you have added it in your template.
Dynamic content can vary depending on the data source used. It can either display data directly from the source, conditionally show static and dynamic elements, or even repeat for every element present in your data source. When your document is rendered, your data source will be used to display your dynamic content accordingly, making an entirely unique output.
As a best practice, we recommend to first think about what content in your template will be static and what will be dynamic. Questions such as the following may help you create a concept for your template before even beginning to design the content:
- Does my document have paragraph sections that will need to be displayed only if certain conditions are met in the data?
- Do I have a need to generate a repeating paragraph for a particular item in my data?
- What information on each page will be obtained from the data source, and what content will always be the same no matter what the data source is?
- As my template is used with many different data sources, do items like formatting and image usage need to change?
With the answers to these questions in mind, you can begin using the Design Guide to build your Document Template with static, as well as Dynamic Content.
FAQs
How is this product licensed?
The Publisher is licensed per computer and licenses are installed locally using a guided on-screen installation tool.
Where do I start once I've installed the software?
The best place to begin is by reviewing the Terminology associated with this application. After this, we recommend reviewing our section on Best Practices. Once you have familiarized yourself with these items, you can move forward to Creating a New Document Template and using the Design Guide to insert specific elements into your Document Template.
Where do I learn about the different components in the software?
The best place to learn about the different functions available to you is to visit the Publisher Terminology section.
What hardware and software requirements are needed to run the software?
You can visit the help page on System Requirements to find this information.
Keyboard Shortcuts
The Ecrion Design Studio Publisher does accept the traditional keyboard shortcuts as well as other that apply for all Ecrion's products. Please find a full list of the keyboard shortcuts for the Publisher below.
Design View
| Shortcut | Action |
|---|---|
| Ctrl + Page Up | Switch between Views |
| Ctrl + Page Down | Switch between Views |
| F5 | Preview |
| F1 | Help |
| Ctrl + C | Copy |
| Ctrl + X | Cut |
| Ctrl + V | Paste |
| Ctrl + O | Open document |
| Ctrl + A | Select all |
| Ctrl + Z | Undo |
| Ctrl + Y | Redo |
| Ctrl + S | Save |
| Ctrl + '+' | Zoom in |
| Ctrl + '-' | Zoom out |
| Ctrl + B | Bold |
| Ctrl + I | Italic |
| Ctrl + U | Underline |
| Ctrl + P | |
| Ctrl + N | New document |
| Ctrl + L | Align Left |
| Ctrl + E | Align Center |
| Ctrl + R | Align Right |
| Ctrl + J | Justify |
| Ctrl + W | Close document |
| Ctrl + T | Strikethrough |
| Ctrl + Alt + 0 | Zoom document to 100% |
| Alt + Enter | Access Properties |
| Delete | Delete |
| Escape | Exit any Dialog |
| F12 | Display the "Save As" Dialog box |
| CTRL + SHIFT + > | Increase the font size |
| CTRL + SHIFT + < | Decrease the font size |
| CTRL + F9 | Open the "Insert Field" Dialog |
| ALT + SHIFT + D | Insert a "Date" field |
| CTRL + SHIFT + K | Format letters as small capitals (Small Caps) |
| CTRL + M | Indent a paragraph from the left |
| CTRL + SHIFT + M | Remove a paragraph indent from the left |
| CTRL + K | Display the "Insert Hyperlink" Dialog |
| CTRL + F10 | Maximize or restore a selected window |
| CTRL + F1 | Expand or collapse the Ribbon |
Text View
| Shortcut | Action |
|---|---|
| Ctrl + F | Find |
| Ctrl + H | Replace |
| Ctrl + G | Go To.. |
| F8 | Auto Format |
| F7 | Check Syntax |
| Ctrl + Shift + Alt + C | Comment |
| Ctrl + Shift + Alt + U | Uncomment |
| Ctrl + D | Duplicate |
| Ctrl + M | New line |
| Ctrl + Home | Navigate to the beginning of the document |
| Ctrl + End | Navigate to the end of the document |