The Encodian population engine supports dynamic hyperlink and bookmark generation.
Insert a Hyperlink
Example Document: Encodian - Template Syntax - Links.docx
Example JSON Data:
{
"companyName": "Encodian",
"linkUrl": "https://www.encodian.com",
"linkDisplay": "Encodian Website"
}
The link token requires two parameters, the URL and display text, see below:
<<link[linkUrl][linkDisplay]>>
This generates the following output:
Insert a bookmark
Example Document: Encodian - Template Syntax - Bookmarks.docx
Example JSON data
{
"bookmark_expression": "Bookmark",
"bookmarkDisplay": "My Bookmark"
}
The bookmark token requires one parameter; the bookmark_expression.
<<bookmark [bookmark_expression]>>
I need to easily find this piece of text later
<</bookmark>>
This generates the following output
The link token can be paired with the bookmark token to create a visible link in the document to the bookmark. It requires two parameters the bookmark expression (this links it with the bookmark token) and the display text:
<<link [bookmark_expression][bookmarkDisplay]>>
This generates the following output
Notes:
- The words within the square brackets [] are just text and can be changed (provided your JSON is also changed) this will be required if you are going to create more than one bookmark within the same document. i.e instead of [bookmark_expression] you have [expression1], [expression2] etc
- Everything from the opening bookmark tag to the closing bookmark tag must either be on the same line or only separated by line breaks (in most cases this will be shift+enter). Any paragraph breaks (enter) will cause the bookmark to not create as expected (it will not error).
The one on the left will work the one of the right will not (this markup can be seen by turning on paragraph marks in word)
The above also applies to the link tag. Everything within the tag must either be on the same line or only separated by line breaks,
14 Comments