CHILI Package file format

Concept

A CHILI Package is a standalone file format, which can be used to represent a CHILI Document for import (in the same or another environment, or even on another server).

Internally, the CHILI Package is a zip file, containing several files describing the layout and content of the document.

General structure

A CHILI Package contains (in the root of the zip file):

Asset_Previews: Optional directory containing low-res previews of any assets contained in the package. Underneath the "Asset_Previews" folder, the same directory structure as "Assets" should be present. Previews will be included with the same file name as the original asset, but with a ".png" extension
Assets: Folder structure containing the high res (original) files used in Image Frames, including the directory structure under which the assets will (by default, although this can be overriden during import of the package) be placed within the CHILI server
Fonts: a similar folder structure, containing the font files used within the document (.otf or .ttf)
Document_Previews: Optional directory containing a "preview.pdf" file containing a first (initial) preview file for the CHILI document
assets.xml (see lower)
fonts.xml (see lower)
document.xml (see lower)

assets.xml contains a description of all of the images/assets to be used in the CHILI document. It contains the following structure:

<assets defaultLocation="Exported\ExtensionTest\Untitled-1">
   <item id="99ACED82-4BBE-1E9E-A5AC-7A8FFA4EDBA0" file="Assets\Exported\ExtensionTest\Untitled-1\boober1.jpg" relativePath="Exported\ExtensionTest\Untitled-1\boober1.jpg" name="boober1.jpg"/>
</assets>

Where:

assets/@defaultLocation contains the "default" path of new assets inside CHILI, when the package is being uploaded using ?Webservice Functions - DocumentCreateFromChiliPackage
item/@id contains the ID of the asset, as it is refered to inside the document.xml file
item/@file contains the path of the source file, starting from the root of the package's zip file
item/@relativePath contains the default path of the asset once uploaded to CHILI
item/@name contains the file name of the underlying image

fonts.xml contains a description of all of the fonts to be used inside the CHILI document. It contains the following structure:

<fonts defaultLocation="General\FromInDesign">
   <item file="\Fonts\General\FromInDesign\MinionPro-Regular.otf" id="F4AEE409-A892-6070-498E-7A8FF0113D03"/>
</fonts>

where:

fonts/@defaultLocation contains the "default" path of new fonts inside CHILI, when the package is uploaded
item/@id contains a unique ID, which is used inside document.xml to reference to the font
item/@file contains the font's underlying file path, relative from the root of the package's zip file

document.xml is a valid CHILI XML document (following the normal XML guidelines and rules), with the following exceptions:

Any reference to an asset in the imageframe's "externalID" attribute points to an ID used in assets.xml
ImageFrames do not require metadata about the placed asset (realWidthPixels, realHeightPixels, metadata, ...). This information will be populated by CHILI when importing the Package on the server
Any reference to a font should use the ID used in fonts.xml
Any reference to a font inside a textFlow or format (see ?TextFrame XML and ?TextFlow and ITextLayoutFormat XML) should be made using "FONTID_name", rather than "family_style"