MarkLogic Server 11.0 Product Documentation

xdmp.wordConvert

xdmp.wordConvert(
   doc as Node,
   filename as String,
   [options as Object?]
) as Sequence

Summary

Converts a Microsoft Word document to XHTML. Returns several nodes, including a parts node, the converted document xml node, and any other document parts (for example, css files and images). The first node is the parts node, which contains a manifest of all of the parts generated as result of the conversion. Does not convert Microsoft Office 2007 and later documents.

Usage Notes

This function is part of a separate package which may generate temporary files. These temporary files are not supported by encryption at rest.

This function requires separate converter installation package starting with release 9.0-4, see MarkLogic Converters Installation Changes Starting at Release 9.0-4 in the Installation Guide for All Platforms.

This function supports the following file formats: Microsoft Word 97/98 (Mac)/2000/2001 (Mac)/XP/2003 (Native format).

The convert functions return several nodes. The first node is a manifest containing the various parts of the conversion. Typically there will be an xml part, a css part, and some image parts. Each part is returned as a separate node in the order shown in the manifest.

Therefore, given the following manifest:

<parts>
  <part>myFile_doc.xhtml</part>
  <part>myFile_doc_parts/conv.css</part>
  <part>myFile_doc_parts/toc.xml</part>
</parts>

the first node of the returned query is the manifest, the second is the "myFile_doc.xhtml" node, the third is the "myFile_doc_parts/conv.css" node, and the fourth is the myFile_doc_parts/toc.xml node.

Example

const results = xdmp.wordConvert(
                  fn.head(xdmp.documentGet('myFile.doc')),
                  'myFile.doc');
const it = results[Symbol.iterator]();
const manifest= it.next().value;
const wordAsXHTML = it.next().value;
wordAsXHTML;

// The word document converted as xhtml.  The results variable
// is a Sequence, where the first item is the manifest, and the 
// remaining items are the converted nodes.

Example

// Including an mix of xdmp.wordConvert options ('tidy') and 
// xdmp.tidy options ('clean') in a conversion call.

const results = Array.from(
  xdmp.wordConvert(
    fn.head(xdmp.documentGet('myFile.doc')),
    'myFile.doc',
    {tidy: true, clean: 'yes'}
 ));

const manifest = results[0];
const parts = results.slice(1);
parts[0];