Task export-docx

This task can be used to convert a portable or processed PSML document to the Word docx format according to rules defined in the Export Microsoft Word docx config usage.

For a list of the latest changes, see github .

To use this Ant extension standalone outside PageSeeder, you can download the pso-docx-ant-x.jar and pso-docx-core-x.jar files from maven central .

Task definition

Following are two examples of task definitions. 

Minimal

<export-docx src="[source]" />

Full

<export-docx src="[source]"
             dest="[destination]"
             media="[media folder]"
             working="[working-directory]"
             wordTemplate="[template.docx]"
             config="[config.xml]">
  <param name="[param name]"
         value="[param value]"/> ...
</export-docx>

Attributes

Parameters

The following @name and @value attributes are valid for <param> elements – all are optional.

As of pso-docx version 0.6.2, the following tokens can be used for the @value of any of the manual- parameters above and are substituted with the corresponding value from PageSeeder.

Usage

Invoking in Ant

This task is included by default in the PageSeeder publisher, so <taskdef/>  is only required when using it outside the publisher.

<project ... xmlns:psd="antlib:org.pageseeder.docx.ant">

  <!-- only required for standalone -->
  <taskdef uri="antlib:org.pageseeder.docx.ant" 
           resource="org/pageseeder/docx/ant/antlib.xml" 
           classpath="pso-docx-ant-0.5.9.jar"/>

  <target ... >
    <!-- Invoke Task -->
    <psd:export-docx src="test.psml" dest="result.docx">
      <param name="current-user"
             value="${ps.config.default.user.firstname}
                     ${ps.config.default.user.surname}" />
    </psd>
  </target>
</project>

Using a namespace  is not required, but it is a good mechanism to know the origin of the task. The recommended namespace is ‘psd’.

Standalone

It is designed to work as standalone. It is possible to invoke this task without being connected to PageSeeder.

Typically, this task would be used in the context of a PageSeeder export. In that case, use the Task export and Task process to download the source PSML file.

How does it work?

This Ant task does the following:

1. Loads the config and template files.
2. Transforms the PSML into docx XML files.
3. Zips up the XML files and associated images into the docx format.

Post processing

For custom formatting, it is sometimes useful to post-process the DOCX XML to add special formatting. The example ANT script code below does the following:

1. Uses the expanded=true parameter to output the unzipped DOCX files.
2. Runs an XSLT named docx-post-transform.xsl  to transform the document.xml file.
3. Zips the expanded files to create a .docx file.

...
<property name="working" value="${ps.config.default.working}" />
<property name="process" value="${working}/process" />
<property name="images" value="${working}/images" />
<property name="expanded" value="${working}/expanded" />
...

<psd:export-docx
    src="${process}/${ps.config.default.uri.filename.no.ext}.psml"
    dest="${expanded}"
    media="${images}"
    working="${working}/docx"
    config="word-export-config.xml"
    wordTemplate="word-export-template.docx">
  ...
  <param name="expanded" value="true"/>
</psd:export-docx>
<echo>DocX post-transform</echo>
<xslt
  in="${expanded}/word/document.xml"
  out="${working}/document.xml"
  style="docx-post-transform.xsl"/>
<copy
  todir="${expanded}/word"
  file="${working}/document.xml" overwrite="true"/>

<echo>Zipping</echo>
<zip
  destfile="${working}/${ps.config.default.uri.filename.no.ext}.docx"
  basedir="${expanded}"/>
...