Categories
Fact Sheet Fusion v2

Appendix 2 – Tokens

Fact Sheet Fusion supports the concept of Token replacement. Tokens are special text statements that are replaced during the export process with another value.

For example, when entering text for an entity topic it is often the case you would want to use the entity name within the text. The problem with this comes when the entity name is changed. You would then need to search back through all the topic text to find the old name and replace it with the new name. Potentially a slow process, assuming you remember to do this. Though Fact Sheet Fusion has a powerful set of find and replace functions.

Using a token for the entity name avoids this problem. Instead of using the entity name directly in the text you could use the ‘[EntityName]’ token. This would be replace when the fact sheet is exported, using the current entity name.

Available Tokens

[EntityName]: replaced with the entity name label. Can be used in topic text, media captions, Entity Properties (Description, Authors, Author notes), and export default description field.

Note: If used within media captions ensure it’s not used for media items associated with the Glossary. If a glossary media item contains [EntityName] no token replacement will occur on it.

[EntityName:scientific]: replaced with the entity name associated with the topic or media caption, formatted with scientific name formatting conventions.

Note: If used within media captions ensure it’s not used for media items associated with the Glossary. If a glossary media item contains [EntityName] no token replacement will occur on it.

[Topic:topic name]: The Topic replacement token can be used within the Author, Author Notes, and Description property fields of the entity. The ‘topic name’ element of the token is the topic label you want to use as the source the topic text.

      Token format: [Topic:<topic name>]

The topic text used in the token replacement is the plain text version of the HTML topic content. The Topic replacement token can be used in conjunction with other standard replacement tokens. For example, to create a description of the page we could do the following, assuming we had a common name topic.

      [EntityName] ([Topic:Common name]) fact sheet.

This could produce:

      Musca domestica (housefly) fact sheet

[Year]: Is replaced with the current year the export occurs. Can be used in topic text, media captions, Entity Properties (Description, Authors, Author notes), and export default description field.

[Authors]: Is replaced with the entity Authors property field. Can be used in topic text, media captions, Entity Properties (Description, Authors, Author notes), and export default description field.

[Identifier]: Is replaced with the entity Identifier field. Can be used in topic text, media captions, Entity Properties (Description, Authors, Author notes), and export default description field.