Document Structure XML

Introduction

XMPie uCreate provides a feature to export from Adobe InDesign an XML meta-file that describes the structure of the InDesign document including both the static and dynamic objects and properties of the document.

This meta-file is created and used automatically by the system for various purposes, but it is also available to the user: In the XMPie Dynamic Content menu, select Advanced and then Save Document Structure XML.

This XML representation exposes only the structural portions of the document without the data. For example, resources, swatches, styles, layers, used ADORs and used fonts at document, spread, page and text story levels.

Such representation enables any application to access the structural information of an InDesign document without the need to directly open an InDesign application on either a desktop or a server and call the plan interpreter to calculate such properties and attributes.

This document describes the XMPie XML meta-file.

Special XML characters encoding

Special XML characters are encoded using the escape sequence encoding of the form: &#<decimal-character-code> e.g.: &#32 for a white space and so forth.

Please note that for the sake of readability, actual escape sequences encodings were left out from the examples in this document.

Document level XML skeleton

The document level is at the top of the XML hierarchy. Under the document level the XML skeleton looks as follows:

<DOCUMENT document-attributes>
    <USED_ADORS> list of used ADORs </USED_ADORS>
    <FONTS> list of used FONTS </FONTS>
    <LAYERS> list of LAYERS </LAYERS>
    <SWATCHES> list of SWATCHES </SWATCHES>
    <RESOURCES> list of RESOURCES </RESOURCES>
    <CHARACTER_STYLE> list of STYLES </CHARACTER_STYLE> 
    <PARAGRAPH_STYLE> list of STYLES </PARAGRAPH_STYLE> 
    <OBJECT_STYLE> list of STYLES </OBJECT_STYLE> 
    <CELL_STYLE> list of STYLES </CELL_STYLE> 
    <TABLE_STYLE> list of STYLES </TABLE_STYLE> 
    <MASTER_SPREADS> SPREADS list </MASTER_SPREADS>    
    <SPREADS> list of SPREADS </SPREADS>
    <STORIES> list of STORIES </STORIES>
</DOCUMENT>

Document attributes

Describes the attributes of an InDesign document. The measurement units for values in the document are always given in points.

Usage:

Any application, such as a preflight check, may consult document attributes without the need to open the InDesign document or app.

Format:

<DOCUMENT List of document-attributes>

Attributes:

• Version – The current version of the document, e.g.: 1.0.

• NumberOfPages – Number of pages in the document.

• FacingPages – In a double-page spread, if "1", left and right pages will face each other, otherwise "0".

• PageSize – Describes standard print page sizes. Possible values : Letter, Legal, Tabloid, Letter Half, Legal Half, A3, A4, A5, B5, US Business Card, Compact Disc or Custom if customized page size.

• Width and Height – The size of the document.

• Orientation – Specify the page orientation for the document: Portrait or Landscape.

• Margins – Specify the margins for each side of the document (top, left, bottom, right).

• Bleeds – Specify the bleeds along each side of the document (top, left, bottom, right).

• AppVersion – InDesign or Photoshop application version, e.g.: 15.1.

• AppType – Application that created the document: InDesign or Photoshop.

• XMPiePluginVersion – The XMPie uCreate plugin version and build used to create the XML meta-file, e.g.: 9.9.0.12418.

• FileName – The file name, e.g.: TestLayersSelection.indd

• Type – The type of the XML document, possible values: INDD, XLIM ,PSD.

Example:

<DOCUMENT 
    Version="1.0"
    NumberOfPages="5"
    FacingPages="0"
    PageSize="A4 "
    Height="841.8897637776" 
    Width="595.2755905512"
    Orientation="Landscape"
    MarginTop="3"
    MarginLeft="3"
    MarginBottom="3"
    MarginRight="3"
    BleedTop="0"
    BleedLeft="0"
    BleedBottom="0"
    BleedRight="0"
    AppVersion="17.0.1" 
    AppType="InDesign "
    XMPiePluginVersion=" 11.1.0.13420" 
    FileName="TestLayersSelection.indd" 
    Type="INDD"
    >

Used ADORs

Describes the list of used ADORs in the document and their attributes.

Usage:

During production, uProduce server may consult the list of used ADORs without the need to call the plan interpreter to calculate the list of used ADORs at document level.

Format:

<USED_ADORS> list of used ADORs </USED_ADORS>

Entry of used ADOR item:

<ADOR 
    Name="name-of-ADOR"
    Type="Text|TextWithStyle|TextFile|Graphic|Visibility|
         Style|Link|Table"
    Style="name-of-style"
/>

Attributes:

• Name – Name of the dynamic ADOR, e.g.: Address.

• Type – The type of the dynamic ADOR.
  Possible values: Text, TextWithStyle, TextFile, Graphic, Visibility, Style, Link, Table.

• Style – Name of the character style in case of a TextWithStyle ADOR.

Example:

<USED_ADORS>
    <ADOR Name="Address" Type="Text" />
    <ADOR Name="Scores" Type="Table" />
    <ADOR Name="BirthdayCake" Type="Graphic" />
    <ADOR Name="OldStyleFirst" Type="TextWithStyle"
        Style="InitialCapitalLetter" />
</USED_ADORS>

Fonts

Describes the list of used fonts in the document and their attributes.

Usage:

Any application, such as a preflight check, may consult the list of used fonts in the document and report any missing fonts, before starting production on the campaign.

Format:

<FONTS> list of used FONTS </FONTS>

Entry of used font item:

<FONT
    Name="font-name"
    Family="font-family"
    Style="font-style" 
    Filename="font-filename"
/>

Attributes:

• Name – The font name (as PostScript name), e.g.: MinionPro-Regular.

• Family – The font family, e.g.: Minion Pro.

• Style – The font style, e.g.: Regular.

• Filename – The filename, e.g.: MinionPro-Regular.otf.

Example:

<FONTS>
    <FONT Name="MyriadPro-Light" 
          Filename="MinionPro-Regular.otf" Family="Myriad Pro"
          Style="Light" />
    <FONT Name="Consolas-Bold"
          Filename="Consolas-Bold.otf" Family="Consolas"
          Style="Bold" />
    <FONT Name="Magneto-Bold" 
          Filename="Magneto-Bold.otf" Family="Magneto"
          Style="Bold" />
</FONTS>

Layers

Describes the list of layers in the document and their attributes.

Usage:

Any application, such as a packaging preflight check, may consult the list of layers in the document and report any user defined or packaging expected missing layers, such as dyelines, before starting production on the campaign.

Format:

<LAYERS> list of LAYERS </LAYERS>

Entry of layer item:

<LAYER 
    Name="layer-name" 
    Visible="1|0" 
    Locked="1|0"  
    Printable="1|0"
    VisibilityAdor="name-of-visibilty-ADOR"
/>

Attributes:

• Name - The layer name, e.g: Layer 1.

• Visible – "1" for a visible layer.

• Locked – "1" for a locked for editing layer.

• Printable – "1" for a printable layer.

• VisibilityAdor - Name of visibility ADOR if present, e.g.: First25Pages.

Example:

<LAYERS>
    <LAYER Locked="0" Name="schoolcolor" 
        Printable="1" Visible="1"/>
    <LAYER Locked="0" Name="uImage"
        Printable="1" Visible="1"/>
    <LAYER Locked="0" Name="SchoolImage" 
        Printable="1" Visible="1"/>
    <LAYER Locked="0" Name="Scholarship" 
        Printable="1" VisibilityAdor="ShowScholarship"
        Visible="1"/>
    <LAYER Locked="0" Name="ChartTitle" 
        Printable="1" VisibilityAdor="ChartTitle" 
        Visible="1"/>
    <LAYER Locked="0" Name="ChartReplacement"
        Printable="1" VisibilityAdor="ChartReplacement"
        Visible="1"/>
    <LAYER Locked="0" Name="Chart" Printable="1"
        VisibilityAdor="Chart" Visible="1"/>
</LAYERS> 

Swatches

Describes the list of swatches in the document and their attributes.

The list of swatches should include both CMYK and RGB values, as converted by InDesign, also for spot colors, RGB values are for web emulation/proof.

Usage:

Any application, such as a printing ink calculator, may consult the list of swatches in the document to determine, for instance if this is a color, gray or black & white document. It may report some form of ink usage estimation or provide for instance, a color list of spot colors.

Format:

<SWATCHES> list of SWATCHES </SWATCHES>

Entry of swatch item:

<SWATCH 
Name="name-of-swatch" 
Type=" Registration|Process|Spot"
Mode="CMYK|RGB|Lab|HSB" 
<COMPONENTS list-of-components-values /> 
/>

Attributes:

• Name – The swatch name, e.g.: Paper.

• Type – The color model: Registration, Process, Spot.

• Mode – The color space: CMYK, RGB, Lab, HSB.

• Components – The list of components values, e.g: C,M,Y,K or R,G,B or L,a,b or H, S, B.

  For CMYK mode:

  C – The cyan color component percentage.

  M – The magenta color component percentage.

  Y – The yellow color component percentage.

  K – The black color component percentage.

  For RGB mode:

  R – The red color component percentage.

  G – The green color component percentage.

  B – The blue color component percentage.

  For Lab mode:

  L – The lightness component.

  a – The a chromaticity component.

  b – The b chromaticity component.

  For HSB mode:

  H – The hue component degree.

  S – The saturation component percentage.

  B – The brightness component percentage.

Example:

<SWATCHES>
    <SWATCH Mode="CMYK" 
        Name="Paper" Type="Process">
        <COMPONENTS C="0" K="0" M="0" Y="0"/>
    </SWATCH>
    <SWATCH Mode="CMYK" 
        Name="Black" Type="Process">
    <COMPONENTS C="0" K="1" M="0" Y="0"/>
    </SWATCH>
    <SWATCH Mode="CMYK" 
        Name="C=100 M=0 Y=0 K=0" Type="Process">
        <COMPONENTS C="1" K="0" M="0" Y="0"/>
    </SWATCH>
    </SWATCH>
    <SWATCH Mode="RGB" 
        Name="R=137 G=135 B=184" Type="Process">
    <COMPONENTS B="0.72" G="0.53" R="0.54"/>
    </SWATCH>
    <SWATCH Mode="CMYK" 
        Name="HKS 03 N" Type="Process">
        <COMPONENTS C="0" K="0" M="0" Y="1"/>
    </SWATCH>
    <SWATCH Mode="Lab" 
        Name="ANPA 72-8 AdPro" Type="Spot">
        <COMPONENTS L="69.02" a="48" b="-7"/>
    </SWATCH>
    <SWATCH Mode="HSB" 
        Name="Fun HSB" Type="Spot">
        <COMPONENTS B="0.85" H="0.91" S="0.4"/>
    </SWATCH>
    <SWATCH Mode="Lab" 
        Name="PANTONE Orange 021 C" Type="Spot">
        <COMPONENTS L="60.78" a="66" b="85"/>
</SWATCHES>

Resources

Describes the list of resources in the document and their attributes.

It describes the list of static linked files in the document, it does not include assets and use URLs (Universal Resource Locators) and not URIs (Universal Resource Identifiers).

Usage:

Any application, such as a preflight check, may consult the list of resources in the document and report any missing resources, before starting production on the campaign.

Format:

<RESOURCES> list of RESOURCES </RESOURCES>

Entry of resource item:

<RESOURCE 
    URL="full-or-relative-path-to-resource" 
/>

Attributes:

• URL - The full or relative path to resource, e.g.:
  file://E/WIP/PDFs/calendar1.pdf.

Example:

<RESOURCES>
    <RESOURCE
        URL="Resources/StudentsFront.jpg" />
    <RESOURCE
        URL="Resources/StudentsBack.jpg" />
    <RESOURCE
        URL="Resources/XMPieLogo.eps"/>
</RESOURCES>

Styles

Describes the list of styles in the document.

The list may include up to five types of styles: character styles, paragraph styles, object styles, table and cell styles as used in the document.

Usage:

Any application, such as a preflight check, may consult the list of styles in the document and report it.

Format:

<CHARACTER_STYLE> list of STYLES </CHARACTER_STYLE> 
<PARAGRAPH_STYLE> list of STYLES </PARAGRAPH_STYLE> 
<OBJECT_STYLE> list of STYLES </OBJECT_STYLE> 
<CELL_STYLE> list of STYLES </CELL_STYLE> 
<TABLE_STYLE> list of STYLES </TABLE_STYLE> 

Entry of a character style item:

<STYLE
    Name="name-of-character-style"  
/>

Attributes of a character style:

• Name - The name of the character style, e.g.: PostalCode.

Entry of a paragraph style item:

<STYLE 
    Name="name-of-paragraph-style" 
/>

Attributes of a paragraph style:

• Name – The name of the paragraph style, e.g.: TwoColumnsLarge.

Entry of an object style item:

<STYLE
    Name="name-of-object-style"
/>

Attributes of an object style:

• Name – The name of the object style, e.g.: Medicine.

Entry of a cell style item:

<STYLE 
    Name="name-of-cell-style"
/>

Attributes of a cell style:

• Name – The name of cell style, e.g.: [None].

  Note: if a style name is wrapped within square brackets, it denotes a default InDesign system style.

Entry of a table style item:

<STYLE 
    Name="name-of-table-style" 
/>

Attributes of a table style:

• Name – The name of the table style, e.g.: TableStyle1.

Example:

<CHARACTER_STYLE>
    <STYLE Name="PostalCode" />
    <STYLE Name="Initial Capital Letter" />
</CHARACTER_STYLE>
<PARAGRAPH_STYLE>
    <STYLE Name="TwoColumns" />
</PARAGRAPH_STYLE>
<OBJECT_STYLE>
    <STYLE Name="ObjectStyle1" />
</OBJECT_STYLE>
<CELL_STYLE>
    <STYLE Name="CellStyle1" />
</CELL_STYLE>
<TABLE_STYLE>
    <STYLE Name="TableStyle1" />
</TABLE_STYLE>

Master spreads

Describes the list of master spreads in the document and their attributes.

The list of master spreads and for each master spread the list of its master pages and their items list for this document.

Usage:

Any application, such as a preflight check, may consult the list of master spreads in the document and report it.

Format:

<MASTER_SPREADS>
    list of SPREADS
</MASTER_SPREADS>

Entry of master spread item:

See entry of spread item, as it shares identical attributes.

Attributes:

See entry of spread item, as it shares identical attributes.

Spreads

Describes the list of spreads in the document and their attributes.

The list of spreads and for each spread the list of its pages and their items list for this document.

Usage:

Any application, such as a preflight check, may consult the list of spreads in the document and report it.

Format:

<SPREADS> list of SPREADS </SPREADS>

Entry of spread item:

<SPREAD 
    NumberOfPages="1" 
    VisibilityAdor="First25Pages" >
    <MEDIA_SELECTION> 
        List of media type attributes
    </MEDIA_SELECTION>
    List of pages
    <PAGE>
    </PAGE>
</SPREAD>

Attributes:

• NumberOfPages – The number of pages in the spread, e.g.: 2.

• VisibilityAdor – The name of the visibility ADOR, e.g.: First25Pages.

Examples:

<MASTER_SPREADS>
    <SPREAD Name="A-Master" NumberOfPages="1" >
        List of pages
    </SPREAD>
</MASTER_SPREADS>
<SPREADS>
    <SPREAD NumberOfPages="1" 
        VisibilityAdor="First25Pages" >
        <MEDIA_SELECTION>
            List of media type attributes
        <MEDIA_SELECTION>
        List of pages
    </SPREAD>
</SPREADS>

Media selection

For every spread in the document, a dynamic media selection can be assigned based on the template defined in MediaTypesAttributes.xml under /plugins/xmpie, which can be further customized. Normally it will contain either dynamic or static attributes such as: media type, media color and media weight.

The media selection describes the list of media type attributes in the spread.

Usage:

Any application, such as a preflight check, may consult the list of spreads in the document and their media selection assignments and report it.

Format:

<MEDIA_SELECTION>
    List-of-media-type-attributes
</MEDIA_SELECTION>

Entry of media type attribute item:

<MEDIA_TYPE_ATTRIBUTE
    Name="name-of-media-type-attribute" 
    Value="static-string-value-or-ADOR-name-of-media-type-attribute" 
    IsAdor="1|0" 
/>

Attributes:

• Name - The name of the media type attribute, e.g.: Weight.

• Value – A static string value or an ADOR name of the media type attribute, e.g.: MediaWeight.

• IsAdor – True for an ADOR, e.g.: "1".

Example:

<MEDIA_SELECTION> 
    <MEDIA_TYPE_ATTRIBUTE 
        Name="Color" Value="PANTONE 10103 C" IsAdor="0" />
    <MEDIA_TYPE_ATTRIBUTE 
        Name="Weight" Value="MediaWeight" IsAdor="1" />
</MEDIA_SELECTION>

Pages

Describes the list of pages in the spread and their attributes.

Usage:

Any application, such as a preflight check, may consult the list of spreads in the document and report it.

Format:

 List of pages

Entry of single page item:

<PAGE 
    Master="name-of-master-spread"
    Thumbnail="name-of-page-thumbnail" 
    PageSize="page-size"
    PageSide="Left|Right|Single"
    Height="page-height" 
    Width="page-width" 
    Orientation="Portrait|Landscape" >
    <USED_ADORS> 
        List-of-used-ADORS-in-page
    </USED_ADORS>
    <ITEMS> list-of-page-items </ITEMS>
</PAGE> 

Attributes:

• Master – The name of the inherited master, e.g.: A-Master.

• Thumbnail - The name of the page thumbnail, e.g.: Thumbnail_001.jpg.

• PageSize – The page size, e.g.: A4.

• PageSide=The page side, e.g.: Single.

• Height - The page height in points, e.g.: 841.89.

• Width - The page width in points, e.g.: 595.27.

• Orientation - The page orientation, e.g.: Portrait.

Example:

<PAGE 
    Master="A-Master"
    Thumbnail="Thumbnail_001.jpg" 
    PageSize="A4" Height="841.8897637776" 
    PageSide="Single"
    Width="595.2755905512" 
    Orientation="Portrait" >
    <USED_ADORS> 
        List of used ADORs in page
    </USED_ADORS>
    <ITEMS> 
        List of ITEMS in page
    </ITEMS>
</PAGE>

Page used ADORs

Describes the list of used ADORs in the page and their attributes.

An ADOR may appear more than once, hence it will also have attributes to describe the location in the page. if the page item describes a table item, then it will describe only the table portion that falls within the page.

Usage:

Any application, such as a preflight check, may consult the list of used ADORs in the page and their location and report it.

Format:

<USED_ADORS> 
    List of used ADORs in page
</USED_ADORS>

Entry of a used ADOR item:

<ADOR 
    Name="name-of-ADOR" >
    List-of-bounding-box-instances
    <INSTANCE>
    </INSTANCE>
</ADOR>

Attributes:

• Name - Name of the dynamic ADOR, e.g.: Address2.

Entry of an INSTANCE item:

• <INSTANCE BoundingBox="[left,top,right,bottom]"/>

• BoundingBox – The ADOR bounding box, e.g.: [179.71,409.04,179.71,596.13].

Example:

<PAGE 
    Master="A-Master"
    Thumbnail="Thumbnail_001.jpg" PageSize="A4" 
    Height="841.89" Width="595.27" 
    Orientation="Portrait">
    <USED_ADORS>
        <ADOR Name="Address">
            <INSTANCE
                BoundingBox=
                    "[179.7,409.0,179.7,596.1]" />
            <INSTANCE
                BoundingBox=
                    "[190.4,409.0,190.4,467.8]" />
        </ADOR>
    <USED_ADORS> 
</PAGE>

Page items

Describes the list of page items in the page and their attributes.

The list of page items may include three kinds of objects: PATH, GRAPHIC and TEXT. Each page item also includes its location in the page.

Usage:

Any application, such as a preflight check, may consult the list of page items in the page, their location and layer and report it.

Format:

<ITEMS>
    List of ITEMS in page
</ITEMS

Entry of a PATH page item:

<PATH 
    Shape=
    "Line|Rectangle|Ellipse|Poly|Path|CompoundPath|Unknown" 
    BoundingBox="[left,top,right,bottom]" 
    Layer="layer-name" 
/>

Attributes of a PATH page item:

• Shape – The path shape type, possible values: Line, Rectangle, Ellipse, Poly, Path, CompoundPath, Unknown.

• BoundingBox - The path shape bounding box, e.g.: [179.71,409.04,179.71,596.13].

• Layer – The layer name the path shape item belongs to, e.g.: Layer 1.

Entry of a GRAPHIC page item:

<GRAPHIC
    Shape=
    "Line|Rectangle|Ellipse|Poly|Path|CompoundPath|Unknown" 
    BoundingBox="[left,top,right,bottom]"
    GraphicAdor="BirthdayCake"
    Layer="Layer 1"
    FitAndTransForm="FitContentToFrame|
    FitFrameToContent|CenterInFrame|FitContentProportionally|
    FitProportionallyAndCenter|FillProportionally|
    FillProportionallyAndCenter|MaintainTransformation"
    AlignFrom="TopLeft|TopCenter|TopRight|CenterLeft|Center|
    CenterRight|BottomLeft|BottomCenter|BottomRight"
    CashElementLocally="1|0"
    PDFCropOption="BoundingBoxOnlyVisibleLayers|
    BoundingBoxAllLayers|Art|Crop|Trim|Bleed|Media"
/>

Attributes of a GRAPHIC page item:

• Shape – The graphic shape type, possible values:  Line, Rectangle, Ellipse, Poly, Path, CompoundPath, Unknown.

• BoundingBox - The graphic bounding box, e.g.: [179.71,409.04,179.71,596.13].

• GraphicAdor – The name of the graphic ADOR assigned to the graphic page item, e.g.: BirthdayCake.

• Layer - The layer name the graphic item belongs to, e.g.: Layer 2.

The remaining attributes describe the values of the dynamic graphic properties:

• FitAndTransForm – The dynamic graphic fitting option. It can have one of the possible values: FitContentToFrame, FitFrameToContent, CenterInFrame, FitContentProportionally, FitProportionallyAndCenter, FillProportionally, FillProportionallyAndCenter, MaintainTransformation, e.g.: MaintainTransformation.

• AlignFrom – The dynamic alignment of the graphic item within the graphic box. Possible values: TopLeft, TopCenter, TopRight, CenterLeft, Center, CenterRight, BottomLeft, BottomCenter, BottomRight, e.g.: TopLeft.

• CashElementLocally – True, if caching of VI streams locally was selected during production run , e.g.: "1".

• PDFCropOption – The dynamic PDF crop option when placing a PDF asset, possible values: BoundingBoxOnlyVisibleLayers, BoundingBoxAllLayers, Art, Crop, Trim, Bleed, Media.

Entry of a TEXT page item:

<TEXT 
    Shape=
    "Line|Rectangle|Ellipse|Poly|Path|CompoundPath|Unknown" 
    StoryID="story-id" 
    BoundingBox="[left,top,right,bottom]" 
    Layer="layer-name" 
/>

Attributes of a TEXT page item:

• Shape – The text shape type, possible values:  Line, Rectangle, Ellipse, Poly, Path, CompoundPath, Unknown.

• StoryID – The story id of the text item, e.g.: 1000001.

• BoundingBox – The bounding box of the text, e.g.: [179.71,409.04,179.71,596.13].

• Layer – The layer name the text item belongs to, e.g.: Layer 3.

Example:

<PAGE Master="A-Master" Thumbnail="Thumbnail_001.jpg"
PageSize="A4" Height="841.8897637776" 
Width="595.2755905512" Orientation="Portrait" >
    <USED_ADORS> 
        <ADOR Name="Address2" 
            BoundingBox="[left,top,right,bottom]" />
        <ADOR Name="City" 
            BoundingBox="[left,top,right,bottom]" />
        <ADOR Name="Scores"
            BoundingBox="[left,top,right,bottom]" />
    </USED_ADORS>

    <ITEMS>
        <PATH Shape="Rectangle"
            BoundingBox="[top left bottom right]" 
            Layer="Layer 1" />
        <GRAPHIC
            Shape="Rectangle"
            BoundingBox="[left,top,right,bottom]" 
            GraphicAdor="BirthdayCake" 
            Layer="Layer 1" 
            FitAndTransForm="MaintainTransformation"
            AlignFrom="TopLeft"
            CashElementLocally="0"
            PDFCropOption="BoundingBoxAllLayers" />
        <TEXT Shape="Rectangle"
            StoryID="1000001" 
            BoundingBox="[left,top,right,bottom]" 
            Layer="Layer 2" />
    </ITEMS>
</PAGE>

Stories

Describes the list of stories in the document and their attributes.

A story in InDesign may describe a collection of one or more text frames or boxes that are threaded or connected to each other creating a text flow. XMPie adds many dynamic features to such story. It may add dynamic story length handling attributes such as: autoflow and copyfit or suppress trailing spaces on empty content.

Usage:

Any application, such as a preflight check, may consult the list of stories in a text box of a page and report any associated attributes.

Format:

<STORIES> list of STORIES </STORIES>

Entry of story item:

<STORY ID="story-id" >
    <SUPPRESS attributes /> 
    <AUTOFLOW attributes /> 
    <COPYFIT attributes /> 
    <FONTS> list of used FONTS </FONTS>
    <CHARACTER_STYLE> list of STYLES </CHARACTER_STYLE> 
    <PARAGRAPH_STYLE> list of STYLES </PARAGRAPH_STYLE> 
    <OBJECT_STYLE> list of STYLES </OBJECT_STYLE> 
    <CELL_STYLE> list of STYLES </CELL_STYLE> 
    <TABLE_STYLE> list of STYLES </TABLE_STYLE> 
    <USED_ADORS> list of used ADORs </USED_ADORS>
    <ITEMS> list of STORY ITEMS </ITEMS>
    <TABLES> list of TABLES </TABLES>
</STORY>

Attributes:

• ID – The story id, e.g.: 1000001.

Story suppress on empty content

Describes the dynamic suppressing on empty content attributes of a story in a page.

Usage:

Any application, such as a preflight check, may consult the list of text items in a page and their associated story and report any associated attributes.

Format:

<SUPPRESS attributes />

Entry of suppress on empty content item:

<SUPPRESS 
    TrailingSpaces="1|0" 
    InTableCells="1|0" 
    EmptyTables="1|0"

Attribute of suppress on empty content:

• TrailingSpaces – True, if suppress trailing spaces on empty content, e.g.: "1".

• InTableCells – True, if suppress trailing spaces on empty content within table cells, e.g.: "1".

• EmptyTables – True, if suppress tables when empty, e.g.: "1".

Example:

<STORIES>
    <STORY ID="1000001" >
        <SUPPRESS
        TrailingSpaces="1" 
        InTableCells="0" 
        EmptyTables="1" /> 
    </STORY>
</STORIES>

Story autoflow

Describes the dynamic story length handling autoflow attributes of a story in a page.

Usage:

Any application, such as a preflight check, may consult the list of text items in a page and their associated story and report any associated attributes.

Format:

<AUTOFLOW attributes /> 

Entry of autoflow item:

<AUTOFLOW 
MoldSpread="the-mold-spread" 
GenerateAtLeastOneMoldSpread="1|0"
MoldSpreadsToGenerateAtMost="#-of-mold-spreads-to-generate"
/>

Attributes:

• MoldSpread – The mold spread, e.g.: 3.

• GenerateAtLeastOneMoldSpread – True, if generating at least one spread, e.g.: "1"

• MoldSpreadsToGenerateAtMost – The maximum # of mold spreads to generate, e.g.: 10.

Example:

<STORIES>
    <STORY ID="1000001" >
        <AUTOFLOW 
            MoldSpread="3" 
            GenerateAtLeastOneMoldSpread="1" 
            MoldSpreadsToGenerateAtMost="10" />
    </STORY>
</STORIES>

Story copyfit

Describes the dynamic story length handling copyfit attributes of a story in a page.

Usage:

Any application, such as a preflight check, may consult the list of text items in a page and their associated story and report any associated attributes.

Format:

<COPYFIT attributes >
    // list of algorithms and their attributes    
    <FONT_SIZE attributes />
    <HORIZONTAL_SCALE attributes />    
    <LEADING attributes />
</COPYFIT >

Entry of copyfit item:

<COPYFIT     
    Mode="Underflow|Overflow|UnderflowAndOverflow" 
    ApplyInTableCells="1|0" 
>

Attributes of copyfit item:

• Mode – The copyfit mode. Possible values: Underflow, Overflow, UnderflowAndOverflow.

• ApplyInTableCells – True, if apply copyfitting in table cells.

Entry of font size algorithm item:

<FONT_SIZE 
    Minimum="min-percentage-to-reduce-font-size" 
    Maximum="max-percentage-to-increase-font-size"
    Step="interval-between-iterations" 
/>

Attributes of font size algorithm item:

• Minimum - The minimal percentage to reduce font size, e.g.: 75.

• Maximum – The maximal percentage to increase font size, e.g.: 125.

• Step - The interval between iterations, e.g.: 1.

Entry of horizontal scale algorithm item:

<HORIZONTAL_SCALE
    Minimum="min-percentage-to-scale-horizontally" 
    Maximum="max-percentage-to-scale-horizontally"
    Step="interval-between-iterations" 
/>

Attributes of horizontal scale algorithm item:

• Minimum - The minimal percentage to scale horizontally, e.g.: 75.

• Maximum – The maximal percentage to scale horizontally, e.g.: 125.

• Step - The interval between iterations, e.g.: 1.

Entry of auto leading algorithm item:

<LEADING 
    Minimum="min-percentage-to-auto-leading" 
    Maximum="max-percentage-to-auto-leading"
    Step="interval-between-iterations" 
/>

Attributes of auto leading algorithm item:

• Minimum - The minimal percentage to auto leading, e.g.: 75.

• Maximum – The maximal percentage to auto leading, e.g.: 125.

• Step - The interval between iterations, e.g.: 1.

Example:

<STORIES>
    <STORY ID="1000001" >
        <COPYFIT 
            Mode="UnderflowAndOverflow"
            ApplyInTableCells="0" >
                <FONT_SIZE 
                    Minimum="75" Maximum="125" Step="1" />
                <HORIZONTAL_SCALE 
                    Minimum="75" Maximum="125" Step="1" />
                <LEADING 
                    Minimum="75" Maximum="125" Step="1" />
        </COPYFIT>    
    </STORY>
</STORIES>

Story fonts

Describes the list of used fonts in the story.

Usage:

Any application, such as a preflight check, may consult the list of used fonts in the story and report any missing fonts, before starting production on the campaign.

Format:

<FONTS> list of used FONTS in story </FONTS>

Entry of used font item:

<FONT
    Name="font-name"
/>

Attributes:

• Name – The font name, e.g.: MinionPro-Regular.

Example:

<STORIES>
    <STORY ID="1000001" >
        <FONTS>
            <FONT Name="MinionPro-Regular" />
            <FONT Name="MyriadPro-Light" /> 
            <FONT Name="Consolas-Bold" />
        </FONTS>
</STORY>
</STORIES>

Story styles

Describes the list of used styles in the story.

The list may include up to five types of styles: character styles, paragraph styles, object styles, table and cell styles as used in the document.

Usage:

Any application, such as a preflight check, may consult the list of styles in the document and report it.

Format:

<CHARACTER_STYLE> list of STYLES </CHARACTER_STYLE> 
<PARAGRAPH_STYLE> list of STYLES </PARAGRAPH_STYLE> 
<OBJECT_STYLE> list of STYLES </OBJECT_STYLE> 
<CELL_STYLE> list of STYLES </CELL_STYLE> 
<TABLE_STYLE> list of STYLES </TABLE_STYLE> 

Entry of a character style item:

<STYLE 
    Name="name-of-character-style" 
/>

Attributes of a character style:

• Name - The name of the character style, e.g.: PostalCode.

Entry of a paragraph style item:

<STYLE 
    Name="name-of-paragraph-style" 
/>

Attributes of a paragraph style:

• Name – The name of the paragraph style, e.g.: TwoColumnsLarge.

Entry of an object style item:

<STYLE
    Name="name-of-object-style"
/>

Attributes of an object style:

• Name – The name of the object style, e.g.: Medicine.

Entry of a cell style item:

<STYLE 
    Name="name-of-cell-style"
/>

Attributes of a cell style:

• Name – The name of cell style, e.g.: [None].

Note: if a style name is wrapped within square brackets, it denotes a default InDesign system style.

Entry of a table style item:

<STYLE 
    Name="name-of-table-style" 
/>

Attributes of a table style:

• Name – The name of the table style, e.g.: TableStyle1.

Example:

<STORIES>
    <STORY ID="1000001" >
        <CHARACTER_STYLE>
            <STYLE Name="PostalCode" />
        </CHARACTER_STYLE>
            <PARAGRAPH_STYLE>
            <STYLE Name="TwoColumns" />
        </PARAGRAPH_STYLE>
        <OBJECT_STYLE>
            <STYLE Name="ObjectStyle1" />
        </OBJECT_STYLE>
        <TABLE_STYLE>
            <STYLE Name="TableStyle1" />
        </TABLE_STYLE>
    </STORY>
</STORIES>

Story used ADORs

Describes the list of used ADORs in the story.

Usage:

The list of used ADORs, at story level, can be calculated without the need to call the plan interpreter to calculate it.

Format:

<USED_ADORS> list of used ADORs </USED_ADORS>

Entry of used ADOR item:

<ADOR 
    Name="name-of-ADOR"
/>

Attributes:

• Name – Name of the dynamic ADOR, e.g.: Address.

Example:

<STORIES>
    <STORY ID="1000001" >
        <USED_ADORS>
            <ADOR Name="ean128-bc"/>
            <ADOR Name="Index"/>
            <ADOR Name="dynTab1"/>
            <ADOR Name="first name"/>
        </USED_ADORS>
    </STORY>
</STORIES>

Story tables

Describes the list of tables in a story and their attributes.

The list of tables includes only dynamic tables.

Usage:

Any application, such as a preflight check, may consult the list of tables in a story and report it.

Format:

<TABLES> list of TABLES in story </TABLES>

Story dynamic table

Describes a dynamic table in a story and its dynamic attributes.

Format:

<TABLE 
    HeaderRows="number-of-header-rows" 
    FooterRows="number-of-footer-rows" 
    Columns="number-of-columns"    
    TableAdor="name-of-table-ADOR"
    Design="Single|Multiple" 
    NumberOfDesignRows="number-of-design-rows"
    ShowTableHeading="1|0" 
    LimitNumberOfTableADORRecords="records-per-recipient" 
> 
    list of used ADORs
</TABLE>

Attributes:

• HeaderRows – The number of header rows, e.g.: 0.

• FooterRows - The number of footer rows, e.g.: 0.

• Columns - The number of columns, e.g.: 3.

• TableAdor – The name of the associated table ADOR, e.g.: Scores.

• Design - The design mode of the table, possible values: Single or Multiple.

• NumberOfDesignRows – The number of design rows, e.g.: 3.

• ShowTableHeading – True, if showing table header rows, e.g.: "1".

• LimitNumberOfTableADORRecords – The limit of records per recipient, e.g.: 5.

Example:

<STORIES>
    <STORY ID="1000001" >
        <TABLES>
            <TABLE
                HeaderRows="0"
                FooterRows="0" 
                Columns="3" 
                TableAdor="Scores" 
                Design="Multiple" 
                NumberOfDesignRows="3"
                ShowTableHeading="0" 
                LimitNumberOfTableADORRecords="5" >
                <USED_ADORS> 
                    list of used ADORs in table
                </USED_ADORS>
            </TABLE>
        </TABLES>
    </STORY>
</STORIES>

Story table used ADORs

Describes the list of used ADORs in the table.

Usage:

The list of used ADORs in the table can be calculated without the need to call the plan interpreter to calculate it.

Format:

<USED_ADORS> list of used ADORs </USED_ADORS>

Entry of used ADOR item:

<ADOR 
    Name="name-of-ADOR"
/>

Attributes:

• Name – Name of the dynamic ADOR, e.g.: Address.

Example:

<STORIES>
    <STORY ID="1000001" >
        <TABLES>
            <TABLE 
                HeaderRows="0" 
                FooterRows="0" 
                Columns="3" 
                TableAdor="Scores" 
                Design="Multiple" 
                NumberOfDesignRows="3"
                ShowTableHeading="0" 
                LimitNumberOfTableADORRecords="5" >
                <USED_ADORS>
                    <ADOR Name="NickName" />
                    <ADOR Name="Address" />
                    <ADOR Name="BirthdayCake" />
                </USED_ADORS>
            </TABLE>
        </TABLES>
    </STORY>
</STORIES>

Appendix

1. XML Meta-file Name and Location

   The name of the XML metafile is DocInfo.xml.

It is part of the XMPie campaign and data packages.

2. XML Meta-file Floating Point Precision

It is possible to control the floating-point precision of numbers in the XML. The default value is 4 decimal points.

To change it, add the registry key named XMLMetafilePrecision to XMPie\Common\1.00.000 and set it to reflect the desired precision.

Note: XMLMetafilePrecision registry key should be defined on both Desktop (uCreate) and Server (uProduce) machines, in case it's not a SOLO configuration and reside on separate machines.