Document Structure
A composite document, or document roll-up is an ordered list of files comprised of multiple subdocuments, each maintained in their own right. Calyx RIM is specifically designed to compile and publish these documents as single, seamless entities that are a complete package ready for printing, distributing or saving as separate documents.
You can publish electronically, retaining the original structure of the document list. You can also define a complete folder hierarchy for this, which is independent of the original document locations.
The composite document can be thought of as having three key parts:
- The cover page comprises previously prepared sheets that are usually placed at the front of the document, for example, title and copyright information. Cover pages can be added anywhere in an assembly.
- The table of contents (TOC) is prepared from a TOC definition template that defines the layout of the TOC pages, and is compiled from a combination of assembly elements and document extracts or bookmarks held in the constituent documents. The TOC may have up to 20 levels and has no limit on the number of entries. All TOC entries can be automatically numbered. Calyx RIM can also automatically enter the page numbers and a series of roughly fifty page-counting variables associated with TOC entries. Several TOCs can appear in a single publication, each with its own scope of pages. Tables of equations, figures and tables can also be defined separately.
- The document, sometimes called body matter, comprises constituent documents or specified page ranges from within constituent documents. Documents may be in any format supported by rendering, but must be in a repository Calyx RIM can access. The resulting output is a new document, eCTD XML structure, set of volumes for printing, or set of electronic files in a folder hierarchy defined as part of the publish process. Page ranges are useful for dividing a single document into multiple pieces, and for omitting or replacing pages in a source document that do not apply. In the case of dividing a single document into multiple parts, all links between pages are maintained during publishing. When copying placeholders between assemblies, these page ranges are maintained. A complex document may consist of several volumes, each with its own TOC and with an overall master TOC. Any page in the output document can be overlaid by a previously designed overlay template. This provides for the addition to the document of custom headers and footers, watermarks and other information. Different templates can be applied to the cover page, TOC and individual major divisions, minor divisions, volumes, folders, leafs elements, documents, and pages.
Keep in mind that any document that has security or requires a password will fail to render, and may cause a long delay as rendering attempts to complete.
Warning: While you can create documents that are children of other documents within the assembly, this is for viewing only and may cause issues during publish. To roll up documents under a leaf, simply include all documents in the proper order as children of the leaf.
Related concepts