Documentation Example

pdx:replaceVariableByExternalFile

Replaces an array of variables by external files.

Description

Element definition

<pdx:templateVariables>                                            
    <pdx:replaceVariableByExternalFile pdx:firstMatch="" pdx:matchSource="">
        <pdx:variable pdx:variableName="" >
            <pdx:data pdx:dataId="" pdx:dataType="text">path to external file</pdx:data>
        </pdx:variable>
    </pdx:replaceVariableByExternalFile>
</pdx:templateVariables>

With the help of this element one may replace a single placeholder variable by a whole external document.

This element accepts the following document formats: DOCX, RTF, HTML and MHT.

This element is not compatible with the xmldocx PDF conversion plugin.

Attributes and sub-elements

variableName

The placeholder variable and the path to the corresponding external document as value.

options

key	Description
firstMatch	If the variable appears more than once within the Word document and firstMatch is set to true, xmldocx will only replace the first ocurrence of the variable within the Word document.
matchSource	If true (default value) tries to preserve as much as possible the formatting of the inserted document.

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/TemplateExternalFile.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:replaceVariableByExternalFile pdx:matchSource="true">
            <pdx:variable pdx:variableName="EXTERNAL">
                <pdx:data pdx:dataId="" pdx:dataType="text">/var/www/xmldocx/samples/files/External.docx</pdx:data>
            </pdx:variable>
        </pdx:replaceVariableByExternalFile>
    </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: