Token Filler Suffixes

Navigation:  Tokens > Token Suffixes >

Token Filler Suffixes

Previous pageReturn to chapter overviewNext page

Token fillers allow you to specify, in the GridTemplate, if you want some text to be appended to the left and/or right of the result of a token, if that result is non-blank. This is useful, for example if you have a combination of tokens in a text box, where one of the tokens may often be blank.

 

To use filler tokens :

 

At the end of any token, but before the closing brace, add a pair of filler delimiters. These can either be \/ (backslash and front slash) or _- (underscore and hyphen).

Between the 2 delimiters, place the text that is to appear to the left of the token if its result is not blank. To the right of the 2 delimiters, place the text that is to appear to the right of the token if its result is not blank.

Which delimiters you use does not matter as long as the text you place to the left and right does not contain one of these delimiters. So, for example, if you want to separate the 2 tokens with a hyphen (-), then you should use the slashes \/ as delimiters.

Make sure that you specify the delimiters you use in the GridOptions.

Important: If you use token fillers inside a macro token, then you should be aware that token fillers will be inserted differently, depending if the result of the macro contains other tokens or not. If the result of the macro contains tokens, then it is assumed that the filler should be inserted into each of the result's tokens. However, if the result of the macro is text that does not contain any tokens, then the filler is applied to the macro token as a whole, in a manner similar to the way filler tokens behave normally.

 

Some guidelines to help you decide if you should place the filler to the left or to the right, and in which token. Suppose you have the 2 tokens [1fa][1mp] (this is valid for any combination of tokens) :

 

If both tokens are to be on the same line and the text is aligned left, then place fillers to the right of the first token : [1fa\/ ][1mp].

If both tokens are to be on the same line and the text is aligned right, then place fillers to the left of the second token : [1fa][1mp\ /].

If the 2 tokens are to be on separate lines and the text is top aligned, then place fillers to the right of the first token : [1fa\/&s][1mp].

If both tokens are to be on separate lines and the text is bottom aligned, then place fillers to the left of the second token : [1fa][1mp\&s/].

 

One common example is a holiday token followed by a moon phase token. If you separate the 2 tokens with a space, then you have an extra space to the left of the moon phase when there is no holidays :

 

           

 

The solution is to use filler tokens and write [fa\/ ][mp] to have a space to the right of the holidays, only if there is a holiday.

 

           

 

Another common use of filler tokens is to have holidays on separate lines, when there may be a holiday on the 1st line, or not, and likewise for the bottom line.

 

You can have tokens in the text to be placed to the left or right, but in that case, as was the case for zap and conditional tokens, the braces must be replaced by underscores. For example :

 

 [1fa\/_d_ _dddd_]

 

By default the delimiters for the left and right fillers are \ and /, but if you need to use these characters in the filler text itself, you can use the GridOptions property to select another one of the other combinations of filler delimiters, such as _ and -.

 

See also: separator tokens.


Topic 154800 updated on 13-May-2016.
Topic URL: http://www.qppstudio.net/webhelp/index.html?fillertokens.htm