Tag: Appendix

Categories
Fact Sheet Fusion v2

Appendix 2 – Tokens

Fact Sheet Fusion Banner

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.

Categories
Fact Sheet Fusion v2

Appendix 1 – XML File Structures

Fact Sheet Fusion Banner

Appendix 1 – XML File Structures

When exporting your project to HTML or PDF Fact Sheet Fusion first creates an XML representation of the information. This XML document is then transformed to the preferred format (HTML or PDF) using the selected template. For a template to work it must “know” about the structure and data types of these XML documents. Below is an outline of the XML structures for an Entity Fact Sheet, Index and Glossary.

Entity Fact Sheet XML

<?xml version=”1.0″ encoding=”utf-8″?>
<?xml-stylesheet type=”text/xsl” href=”fs_template/template.xsl”?>
<EntityData xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema”>
    <Entity name=”Entity Name Label” childof=”” safename=”Entity Name Label (no spaces or special characters)” exclude=”boolean (True/False)” review=”boolean (True/False)” heading=”boolean (True/False)” customstyle=””>
        <Author />
        <AuthorNotes />
        <Description />
        <Identifier />
        <GoogleAnalytics />
        <Topic ID=”1″ name=”Topic Name Label” exclude=”boolean (true/false)” excludeheading=”boolean (true/false)” color=”” customstyle=””>
            <Content>Topic HTML fragment</Content>
            <Media>
            <Item mediatype=”Image” review=”boolean (True/False)” exclude=”boolean (True/False)”>
                <file>relative path\filename</file>
                <thumb>relative path\filename</thumb>
                <caption />
                <captionalttext />
                <photographer />
                <copyright />
            </Item>
            <Item mediatype=”Image” review=”boolean (True/False)” exclude=”boolean (True/False)”>
                <file>relative path\filename</file>
                <thumb>relative path\filename</thumb>
                <caption />
                <captionalttext />
                <photographer />
                <copyright />
            </Item>
        </Media>
        </Topic>
        <Topic ID=”2″ name=”Topic Name Label” exclude=”boolean (true/false)” excludeheading=”boolean (true/false)” color=”” customstyle=””>
            <Content>Topic HTML fragment</Content>
            <Media>
            <Item mediatype=”Image” review=”boolean (True/False)” exclude=”boolean (True/False)”>
                <file>relative path\filename</file>
                <thumb>relative path\filename</thumb>
                <caption />
                <captionalttext />
                <photographer />
                <copyright />
            </Item>
            <Item mediatype=”Image” review=”boolean (True/False)” exclude=”boolean (True/False)”>
                <file>relative path\filename</file>
                <thumb>relative path\filename</thumb>
                <caption />
                <captionalttext />
                <photographer />
                <copyright />
            </Item>
        </Media>
        </Topic>
        <Media>
            <Item mediatype=”Image” review=”boolean (True/False)” exclude=”boolean (True/False)”>
                <file>relative path\filename</file>
                <thumb>relative path\filename</thumb>
                <caption />
                <captionalttext />
                <photographer />
                <copyright />
            </Item>
            <Item mediatype=”Image” review=”boolean (True/False)” exclude=”boolean (True/False)”>
                <file>relative path\filename</file>
                <thumb>relative path\filename</thumb>
                <caption />
                <captionalttext />
                <photographer />
                <copyright />
            </Item>
        </Media>
    </Entity>
</EntityData>

Index XML

<?xml version=”1.0″ encoding=”utf-8″?>
<?xml-stylesheet type=”text/xsl” href=”fs_template/index.xsl”?>
<Index xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema”>
    <AlphabetMenuLetters>
        <Letter value=”A” present=”true” />
        <Letter value=”B” present=”true” />
        <Letter value=”C” present=”false” />
        <Letter value=”D” present=”false” />
        <Letter value=”E” present=”false” />
        <Letter value=”F” present=”true” />
        <Letter value=”G” present=”false” />
        <Letter value=”H” present=”false” />
        <Letter value=”I” present=”false” />
        <Letter value=”J” present=”false” />
        <Letter value=”K” present=”false” />
        <Letter value=”L” present=”false” />
        <Letter value=”M” present=”true” />
        <Letter value=”N” present=”false” />
        <Letter value=”O” present=”false” />
        <Letter value=”P” present=”false” />
        <Letter value=”Q” present=”false” />
        <Letter value=”R” present=”false” />
        <Letter value=”S” present=”true” />
        <Letter value=”T” present=”false” />
        <Letter value=”U” present=”false” />
        <Letter value=”V” present=”false” />
        <Letter value=”W” present=”false” />
        <Letter value=”X” present=”false” />
        <Letter value=”Y” present=”false” />
        <Letter value=”Z” present=”false” />
    </AlphabetMenuLetters>
    <AlphabetMenuSymbols>
        <Letter value=”Symbol Character (e.g. *)” />
    </AlphabetMenuSymbols>
    <GoogleAnalytics />
    <Letter value=”*”>
        <EntityItem name=”* Entity Name Label” parententity=”” exclude=”boolean (true/false” review=”boolean (true/false” heading=”boolean (true/false” color=”” customstyle=”” altentity=”false”>
            <Link>Entity Filename[.htm,.pdf,.xml]</Link>
            <FormattedName></FormattedName>
            <ParentFormattedName></ParentFormattedName>
            <Author />
            <AuthorNotes />
            <Description />
            <Identifier />
            <Media>
                <Item mediatype=”Image” review=”boolean (True/False)” exclude=”boolean (True/False)”>
                    <file>relative path\filename</file>
                    <thumb>relative path\filename</thumb>
                    <caption />
                    <captionalttext />
                    <photographer />
                    <copyright />
                </Item>
                <Item mediatype=”Image” review=”boolean (True/False)” exclude=”boolean (True/False)”>
                    <file>relative path\filename</file>
                    <thumb>relative path\filename</thumb>
                    <caption />
                    <captionalttext />
                    <photographer />
                    <copyright />
                </Item>
            </Media>
            <AlternativeNames>
                <Alias Name=”Entity Alias Label” />
            </AlternativeNames>
            <ChildEntities />
        </EntityItem>
    </Letter>
    <Letter value=”A”>
        <EntityItem name=”Animal pest management” parententity=”” exclude=”boolean (true/false” review=”boolean (true/false” heading=”boolean (true/false” color=”” customstyle=”” altentity=”boolean (true/false”>
            <Link>Entity Filename[.htm,.pdf,.xml]</Link>
            <Author />
            <AuthorNotes />
            <Description />
            <Identifier />
            <Media>
                <Item mediatype=”Image” review=”boolean (True/False)” exclude=”boolean (True/False)”>
                    <file>relative path\filename</file>
                    <thumb>relative path\filename</thumb>
                    <caption />
                    <captionalttext />
                    <photographer />
                    <copyright />
                </Item>
                <Item mediatype=”Image” review=”boolean (True/False)” exclude=”boolean (True/False)”>
                    <file>relative path\filename</file>
                    <thumb>relative path\filename</thumb>
                    <caption />
                    <captionalttext />
                    <photographer />
                    <copyright />
                </Item>
            </Media>
            <AlternativeNames>
                <Alias Name=”Entity Alias Label” />
            </AlternativeNames>
            <ChildEntities />
        </EntityItem>
    </Letter>
    <Letter value=”B”>
        <EntityItem name=”Bins and boxes” parententity=”” exclude=”boolean (true/false)” review=”boolean (true/false)” heading=”boolean (true/false)” color=”” customstyle=”” altentity=”boolean (true/false)”>
            <Link>Entity Filename[.htm,.pdf,.xml]</Link>
            <Author />
            <AuthorNotes />
            <Description />
            <Identifier />
            <Media>
                <Item mediatype=”Image” review=”boolean (True/False)” exclude=”boolean (True/False)”>
                    <file>relative path\filename</file>
                    <thumb>relative path\filename</thumb>
                    <caption />
                    <captionalttext />
                    <photographer />
                    <copyright />
                </Item>
                <Item mediatype=”Image” review=”boolean (True/False)” exclude=”boolean (True/False)”>
                    <file>relative path\filename</file>
                    <thumb>relative path\filename</thumb>
                    <caption />
                    <captionalttext />
                    <photographer />
                    <copyright />
                </Item>
            </Media>
            <AlternativeNames />
            <ChildEntities />
        </EntityItem>
    </Letter>
    …
</Index>

Glossary XML

<?xml version=”1.0″ encoding=”utf-8″?>
<?xml-stylesheet type=”text/xsl” href=”fs_template/glossary.xsl”?>
<GlossaryXML xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema”>
    <GoogleAnalytics />
    <GlossarySet name=”Glossary Set Name Label” Exclude=”False”>
        <AlphabetMenuLetters>
            <Letter value=”A” present=”true” />
            <Letter value=”B” present=”false” />
            <Letter value=”C” present=”true” />
            <Letter value=”D” present=”true” />
            <Letter value=”E” present=”true” />
            <Letter value=”F” present=”true” />
            <Letter value=”G” present=”true” />
            <Letter value=”H” present=”true” />
            <Letter value=”I” present=”true” />
            <Letter value=”J” present=”false” />
            <Letter value=”K” present=”false” />
            <Letter value=”L” present=”true” />
            <Letter value=”M” present=”true” />
            <Letter value=”N” present=”true” />
            <Letter value=”O” present=”true” />
            <Letter value=”P” present=”true” />
            <Letter value=”Q” present=”false” />
            <Letter value=”R” present=”true” />
            <Letter value=”S” present=”true” />
            <Letter value=”T” present=”true” />
            <Letter value=”U” present=”false” />
            <Letter value=”V” present=”true” />
            <Letter value=”W” present=”false” />
            <Letter value=”X” present=”false” />
            <Letter value=”Y” present=”false” />
            <Letter value=”Z” present=”false” />
        </AlphabetMenuLetters>
        <AlphabetMenuSymbols>
            <Letter value=”*” />
        </AlphabetMenuSymbols>
        <Alphabet>
            <Letter value=”*”>
                <GlossaryItem Exclude=”False” Review=”False” AliasTerm=””>
                    <Term>* Symbol Character Example</Term>
                    <Definition></Definition>
                    <Media>
                        <Item mediatype=”Image” review=”boolean (True/False)” exclude=”boolean (True/False)”>
                            <file>relative path\filename</file>
                            <thumb>relative path\filename</thumb>
                            <caption />
                            <captionalttext />
                            <photographer />
                            <copyright />
                        </Item>
                        <Item mediatype=”Image” review=”boolean (True/False)” exclude=”boolean (True/False)”>
                            <file>relative path\filename</file>
                            <thumb>relative path\filename</thumb>
                            <caption />
                            <captionalttext />
                            <photographer />
                            <copyright />
                        </Item>
                    </Media>
                </GlossaryItem>
            </Letter>
            <Letter value=”A”>
                <GlossaryItem Exclude=”False” Review=”False” AliasTerm=””>
                    <Term>Term Label</Term>
                    <Definition>Definition (HTML fragment)</Definition>
                    <Media>
                        <Item mediatype=”Image” review=”boolean (True/False)” exclude=”boolean (True/False)”>
                            <file>relative path\filename</file>
                            <thumb>relative path\filename</thumb>
                            <caption />
                            <captionalttext />
                            <photographer />
                            <copyright />
                        </Item>
                        <Item mediatype=”Image” review=”boolean (True/False)” exclude=”boolean (True/False)”>
                            <file>relative path\filename</file>
                            <thumb>relative path\filename</thumb>
                            <caption />
                            <captionalttext />
                            <photographer />
                            <copyright />
                        </Item>
                    </Media>
                </GlossaryItem>
        </Alphabet>
    </GlossarySet>
    …
</GlossaryXML>

Alphabet XML

The alphabet XML document is used in conjunction with the Entity Fact Sheet XML document to help construct an alphabet menu structure that matches the entities that have been exported.

<?xml version=”1.0″ encoding=”utf-8″?>
<AlphabetMenuHelper xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema”>
    <letter value=”A” present=”true” />
    <letter value=”B” present=”true” />
    <letter value=”C” present=”false” />
    <letter value=”D” present=”false” />
    <letter value=”E” present=”false” />
    <letter value=”F” present=”true” />
    <letter value=”G” present=”false” />
    <letter value=”H” present=”false” />
    <letter value=”I” present=”false” />
    <letter value=”J” present=”false” />
    <letter value=”K” present=”false” />
    <letter value=”L” present=”false” />
    <letter value=”M” present=”true” />
    <letter value=”N” present=”false” />
    <letter value=”O” present=”false” />
    <letter value=”P” present=”false” />
    <letter value=”Q” present=”false” />
    <letter value=”R” present=”false” />
    <letter value=”S” present=”true” />
    <letter value=”T” present=”false” />
    <letter value=”U” present=”false” />
    <letter value=”V” present=”false” />
    <letter value=”W” present=”false” />
    <letter value=”X” present=”false” />
    <letter value=”Y” present=”false” />
    <letter value=”Z” present=”false” />
    <symbol value=”*” />
</AlphabetMenuHelper>