{"id":1858,"date":"2017-06-20T10:34:49","date_gmt":"2017-06-20T09:34:49","guid":{"rendered":"https:\/\/www.threesl.com\/blog\/?p=1858"},"modified":"2022-08-24T16:31:31","modified_gmt":"2022-08-24T15:31:31","slug":"use-user-variables-document-publisher","status":"publish","type":"post","link":"https:\/\/www.threesl.com\/blog\/use-user-variables-document-publisher\/","title":{"rendered":"How to Make Use of User Variables in Document Publisher"},"content":{"rendered":"

Where can Variables be Placed<\/h2>\n

All User Variables<\/em> in Document Publisher<\/em> can be used throughout the template. You can use the variables within Headers<\/em>, Footers,<\/em> boilerplate<\/em> text and document titles<\/em>.<\/p>\n

What are Variables?<\/h2>\n

The Variables<\/em> store bits of data to be used in tags<\/em> that allow the use of either a variation of data or static data.<\/p>\n

For example the variable $UserName<\/samp> is static will only output the currently Logged in Users Name<\/em> within the document. The User Name<\/em> will also be output if the template is being generated through the Phase sidebar<\/a><\/em> in WorkBench<\/em>.<\/p>\n

Some variables<\/em> can be used to hold items identities in a static list like $IDList<\/samp><\/a> or lists of item identities collected from Hierarchy Tables like $ItemList<\/samp><\/a>. The lists for $ItemList<\/samp> can change depending on cross references and\/or if the template uses parameters<\/a>.<\/p>\n

Creating User Variables<\/em> is easy. Read How to Create a Variable<\/a> to find out.<\/p>\n

User Variables in Headers and Footers<\/h2>\n

The variable tags<\/em> can be used within a Header<\/em> and\/or Footer<\/em> in conjunction with Microsoft\u00ae Word’s own data fields.<\/p>\n

In the Word<\/em> tab, select the Header<\/em> or Footer<\/em> option. Then select the Edit Header\/Footer<\/em> option. Once the Header\/Footer<\/em> is open, select the User Variable<\/em> button and the variable you wish to use.<\/p>\n

Several variable tags can be placed to output within the Header\/Footer<\/em> so you get the output required. These tags can also be formatted.<\/p>\n

When editing the Header<\/em> or Footer<\/em> the View<\/em> will change to Print View<\/em> as they don\u2019t show in Draft view<\/em>.<\/p>\n

\"Doc
Using variables in a Word Header.<\/figcaption><\/figure>\n
\"Doc
Using variables and Word fields in a Footer.<\/figcaption><\/figure>\n

The final output looks like this:<\/p>\n

\"user<\/p>\n

\"Footer<\/p>\n

User Variables in Boilerplate<\/h2>\n

The variable tags<\/em> can be placed within any boilerplate<\/em> text. This allows for changes in data like the date or user publishing the document.<\/p>\n

\"Boilerplate
Boilerplate text with User Variables.<\/figcaption><\/figure>\n
\"Two
The User Name and Todays date within the Boilplate text.<\/figcaption><\/figure>\n

User Variables in Title Text<\/h2>\n

A User Variable<\/em> or a Paragraph Group<\/em> tag can be used to set the Document Title<\/em>. A variable is quicker but does not allow for parameters are used in a field tags.<\/p>\n

\"Title
$TemplateName<\/samp> User Variable<\/figcaption><\/figure>\n

So the output looks like this:<\/p>\n

\"Title<\/p>\n

Or you can have the Title<\/em> only output when you are generating a Formal Document<\/em>. Use any of the $FormalDoc<\/samp> variables and they are only generated during a Formal Publish<\/em>. In this example I have used $FormalDocTitle:<\/samp><\/p>\n

\"Title<\/p>\n

Using $FormalDocTitle<\/samp> means the title will output as to the same as the User entered in the Title in the Publish Formal Document<\/a> UI.<\/p>\n

\"Publish
Publish Formal Document User Interface<\/figcaption><\/figure>\n
\"Title
Document Title set by the words entered by a User during a Formal Publish.<\/figcaption><\/figure>\n