pdx:setTemplateSymbol Sets the character used to identify placeholder variables within a given template

pdx:setTemplateSymbol

Sets the character used to identify placeholder variables within a given template.

Description

Element definition

<pdx:templateVariables pdx:preprocessedTemplate="">
    <pdx:setTemplateSymbol pdx:symbolValue="" pdx:symbolValueEnd="" />
</pdx:templateVariables>

By default the xmldocx template variables have to be wrapped by $'s (dollar symbol).

You chan change that symbol by any other you wish with the help of this method. It is, of course, convenient to use a symbol reasonably distinguishable from standard text characters.

Make sure that all variables in your template are surrounded by the symbol you have chosen.

Attributes and sub-elements

symbolValue

The symbol we want to use for identifying placeholder variables within templates.

Code samples

#Example 1

config.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:config>
        <pdx:template pdx:path="/var/www/xmldocx/samples/files/TemplatePipeSymbol.docx" />
        <pdx:output pdx:name="output" pdx:type="docx" />
    </pdx:config>
</pdx:document>

content.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:templateVariables pdx:preprocessedTemplate="">
        <pdx:setTemplateSymbol pdx:symbolValue="|" />
        <pdx:replaceVariableByText pdx:parseLineBreaks="true">
            <pdx:variable pdx:variableName="FIRST">
                <pdx:data pdx:dataId="" pdx:dataType="text">Hello World!</pdx:data>
            </pdx:variable>
        </pdx:replaceVariableByText>
    </pdx:templateVariables>
</pdx:document>

settings.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:settings>
    </pdx:settings>
</pdx:document>

import os as os
import sys as sys
sys.path.append(os.path.abspath("wrappers/python/XmlDocx"))
import XmlDocx as XmlDocx
document = XmlDocx.XmlDocx("config.xml")
document.setDocumentProperties("settings.xml")
document.addContent("content.xml")
document.setXmlDocxPath("xmldocx path")
document.render()

The resulting Word document looks like: