Content XML 3.5

Note

Applies to Typefi Server and Typefi Designer 8.16 and later.

CXML is an abbreviation for Content XML. It is the data format used by Typefi to encode content.

In many Typefi deployments, CXML is completely hidden from users. Content is marked up and styled in Microsoft Word using Typefi Writer or Typefi Orion, and then converted into CXML as an intermediate format before the final Adobe InDesign document, PDF, EPUB, or other output is generated.

But sometimes, a custom conversion to CXML from another format is required. This guide is for developers who are creating these conversions.

TIP

When you create a custom conversion, it's a good idea to add a custom namespace prefix. A custom namespace prefix makes it easy to identify a document created by Typefi's native converters versus a converter written by a third party.

Workflow labels

Some CXML elements are specific to a particular Typefi workflow. Where applicable, elements are labelled as follows:

• InDesign — supported in the InDesign workflow only
• DOCX — supported in the Typefi Orion workflow only

Elements with no label are supported in all workflows.

Schema

This guide covers CXML 3.5. The schema is located at:

https://www.typefi.com/TPS/content/3_5/ContentXML.xsd

Hello, World

Here is a simple CXML document that will run through Typefi Server:

<content xmlns="http://www.typefi.com/ContentXML">
  <section type="Chapter">
    <p>Hello, World.</p>
  </section>
</content>

Although, in practice, it tends to look more like this:

<?xml version="1.0" encoding="UTF-8"?>
<tps:content xmlns:tps="http://www.typefi.com/ContentXML" 
 xmlns:xsl="http://www.w3.org/2001/XMLSchema-instance" 
 schemaVersion="3.5" 
 xsl:schemaLocation="http://www.typefi.com/ContentXML  
                                 http://www.typefi.com/TPS/content/3_5/ContentXML.xsd" 
 whiteSpaceMode="strict">
  <tps:section type="Chapter">
    <tps:p type="Body">Hello, World.</tps:p>
  </tps:section>
</tps:content>

For clarity, our CXML examples below will use the simpler form that omits the tps: namespace prefix.

While Typefi produces CXML files with the tps: namespace prefix, it is not required. CXML files are valid with or without the tps: prefix. However, you can't use the tps: prefix on some elements—it has to be all or nothing.

Requirements

• The document encoding (@encoding) MUST be UTF-8. This is the only supported encoding for CXML.
• The XML namespace (@xmlns:tps) MUST be http://www.typefi.com/ContentXML.
• The document MUST have exactly one root content (<content>) element.

What's new

Content XML 3.5 extends the list of supported @style values for ordered lists (<ol>).

Ordered list styles

CXML 3.5 adds 44 new @style values for the <ol> element and renames seven existing ones, expanding the set of numbering styles available for ordered lists. The 44 new values cover international numbering formats — Korean, Japanese, Chinese, Thai, Vietnamese, Hindi, and more — that had no previous CXML equivalent. The seven renamed values use new preferred kebab-case names; the old names remain valid but are deprecated.

The 44 new @style values are currently supported in the Typefi Orion workflows only, and require Typefi Server 8.24 or later and the Microsoft Word plug-in v27 or later. Support for InDesign, EPUB, and HTML outputs is planned for a future release.

See Lists for the full list of supported and deprecated values.

Further information

For more information about Content XML or anything in this guide, contact your Typefi Solutions Consultant, or visit the Help Centre.