pdx:addFooter Inserts footers into the Word document

pdx:addFooter

Inserts footers into the Word document.

Description

Element definition

<pdx:content>
    <pdx:addFooter>
        <pdx:default pdx:wordFragmentName="" />
        <pdx:even pdx:wordFragmentName="" />
        <pdx:first pdx:wordFragmentName="" />
    </pdx:addFooter>
</pdx:content>

It is possible to include different footers for:

the first page or title page,
even pages and
odd pages (this one is the default footer for the whole document if no different footers are defined for the first or even pages).

The contents of the different footers are defined via the use of WordFragments. These footer WordFragments allow the insertion of:

text paragraphs,
current date and/or hour,
images,
links,
lists,
page numbers,
shapes,
tables
and HTML content.

You may also import the footers of an existing docx document via the ImportHeadersAndFooters element.

Attributes and sub-elements

footers

key	Description
default	The WordML fragment object containing the contents for the default (odd pages) header
even	The WordML fragment object containing the contents for the even pages header
first	The WordML fragment object containing the contents for the first (title) page header

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: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:content>
        <pdx:wordFragments>
            <pdx:wordFragment pdx:wordFragmentName="imgFragment" pdx:target="defaultFooter">
                <pdx:content>
                     <pdx:addImage pdx:dpi="300">
                        <pdx:data pdx:dataId="" pdx:dataType="text">/var/www/xmldocx/samples/files/img/image.png</pdx:data>
                    </pdx:addImage>
                </pdx:content>
            </pdx:wordFragment>
        </pdx:wordFragments>
        <pdx:addFooter>
            <pdx:default pdx:wordFragmentName="imgFragment" />
        </pdx:addFooter>
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">This document has a footer with just one image.</pdx:data>
                <pdx:textRunStyle>
                </pdx:textRunStyle>
            </pdx:textRun>
        </pdx:addText>
    </pdx:content>
</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: