Home NIVOMAX Builder User Guide General
My Group: This user has no roles.
My Distribution ID: Please log in to see your distribution ID.
Open TOC
 

Building the XML for ATA100 Manuals TOC

Disclaimer

SYNAXIOM does not distribute NIVOMAX Viewer setup files directly to end users. To obtain the necessary setup files, users must download a copy directly from the Technical Publications Supplier's NIVOMAX Self Serve portal, subsequent to agreeing to the terms and conditions stipulated therein. The Technical Publication Supplier, possessing a valid Distribution ID for their copy of the NIVOMAX Applications, is the sole distributor. Access to and use of the NIVOMAX Viewer is contingent upon the purchase of a Data License for a digital product from the Technical Publications Supplier. The digital product downloaded will function exclusively with the viewer provided by the respective Supplier. Users are advised that the distribution of NIVOMAX Viewer setup files may be governed by applicable export control regulations depending on their region.

Licensing

It is not necessary for end-users to purchase a separate NIVOMAX license. The Technical Publications Supplier from whom you have acquired your Data License has already procured the requisite licenses from SYNAXIOM. By extending an invitation, they include you within their authorized user pool, as permitted under their NIVOMAX license agreement. You are authorized to use the NIVOMAX software provided the Technical Publications Supplier maintains a valid NIVOMAX software license.

Confidentiality

This document (“Document”) contains confidential and proprietary information owned by SYNAXIOM Inc. (“SYNAXIOM”). No part of this Document may be reproduced, copied, or distributed in any form or by any means without the prior written permission of SYNAXIOM Inc. Unauthorized use, disclosure, or reproduction of this Document is strictly prohibited. Any third-party intellectual property mentioned herein is the property of their respective owners, and such mention is for informational purposes only and does not imply any association with or endorsement by the owners.

This page must not be removed before distributing the document. It must remain present in all shared copies to ensure proper communication and compliance.

Building the XML for ATA100 Manuals TOC

Last Updated on July 17, 2024 | 2 min read

  1. The TOC Item icon in the NIVOMAX Viewer application changes to a Folder icon if a level has an attribute TYPE with the value TAXONOMY.
  2. Below is the structure of the index XML format that is accepted by the Publisher (Builder) application.
  3. The INDEX process is the only process that uses this XML read as a structure level by level.

Index XML Format

<?xml version="1.0" encoding="UTF-8"?>
<LEVEL3 TYPE="FOLDERMAN" KEY="{PUBLICATION_FOLDER_NAME}">
  <TSN>{TSN_VALUE}</TSN>
  <REVDATE>{DATE}</REVDATE>
  <MFMATR TYPE="FOLDERCPT" KEY="{FOLDER_NAME}">
    <MFITEM TYPE="FILE" KEY="{FILE_NAME}" CHG="{OPTIONAL_TAG}">
      <TITLE>{FILE_TITLE}</TITLE>
    </MFITEM>
  </MFMATR>
  <LEVEL4 TYPE="FOLDERCPT" KEY="{FOLDER_NAME}">
    <TITLE>{TITLE}</TITLE>
    <CFMATR>
      <CFITEM TYPE="FILE" KEY="{FILE_NAME}" CHG="{OPTIONAL_TAG}">
        <TITLE>{TITLE}</TITLE>
      </CFITEM>
    </CFMATR>
    <LEVEL5 TYPE="{TYPE}" KEY="{KEY_VALUE}" CHG="{OPTIONAL_TAG}">
      <TITLE>{TITLE}</TITLE>
      <LEVEL6 TYPE="{TYPE}" KEY="{KEY_VALUE}" CHG="{OPTIONAL_TAG}">
        <TITLE>{TITLE}</TITLE>
        <LEVEL7 TYPE="{TYPE}" KEY="{FILE_NAME}" CHG="{OPTIONAL_TAG}">
          <TITLE>{TITLE}</TITLE>
        </LEVEL7>
      </LEVEL6>
    </LEVEL5>
  </LEVEL4>
</LEVEL3>

XML Elements and Attributes

ELEMENT ATTRIBUTE ATTRIBUTE VALUE PARENT COMMENT
?xml version 1.0 – Use XML version 1.0
encoding UTF-8 – Only UTF-8 encoding type should be used
LEVEL3 TYPE FOLDERCPT LEVEL3 Indicates a folder where the manual is located
KEY PUBLICATION_FOLDER_NAME LEVEL3 Must be the folder name; no special characters or spaces
TSN – TSN_VALUE LEVEL3 TSN must be a string value
REVDATE – DATE LEVEL3 Must be an integer in the format YYYYMMDD
MFMATR TYPE FOLDERCPT LEVEL3 Indicates a folder where the manual front matter is located
KEY FOLDER_NAME LEVEL3 Must be a folder name; no special characters or spaces
MFITEM TYPE FILE MFMATR Indicates file type
KEY FILE_NAME MFMATR Must be a file; no special characters or spaces
CHG OPTIONAL_TAG MFMATR Optional: N (new), R (revised), U (unchanged)
TITLE – – MFITEM TITLE must be wrapped in CDATA
LEVEL4 TYPE FOLDERCPT LEVEL3 Indicates a folder where the chapter is located
KEY FOLDER_NAME LEVEL3 Must be a folder name; no special characters or spaces
TITLE – LEVEL4 TITLE must be wrapped in CDATA
CFMATR – – LEVEL4 Optional element
CFITEM TYPE FILE CFMATR Indicates file type
KEY FILE_NAME CFMATR Must be a file; no special characters or spaces
CHG OPTIONAL_TAG CFMATR Optional: N (new), R (revised), U (unchanged)
TITLE – CFITEM TITLE must be wrapped in CDATA
LEVEL5 TYPE TYPE LEVEL4 Accepted values: FOLDER, FILE, TAXONOMY
KEY KEY_VALUE LEVEL4 Depending on TYPE value; must exist for TYPE TAXONOMY
CHG OPTIONAL_TAG LEVEL4 Optional: N (new), R (revised), U (unchanged)
TITLE – LEVEL5 TITLE must be wrapped in CDATA
LEVEL6 TYPE TYPE LEVEL5 Accepted values: FOLDER, FILE, TAXONOMY, TARGET
KEY KEY_VALUE LEVEL5 Depending on TYPE value; must exist for TYPE TAXONOMY
CHG OPTIONAL_TAG LEVEL5 Optional: N (new), R (revised), U (unchanged)
TITLE – LEVEL6 TITLE must be wrapped in CDATA
LEVEL7 TYPE TYPE LEVEL6 Accepted values: FILE, TARGET
KEY FILE_NAME LEVEL6 Depending on TYPE value; must exist for TYPE TAXONOMY
CHG OPTIONAL_TAG LEVEL6 Optional: N (new), R (revised), U (unchanged)
TITLE – LEVEL7 TITLE must be wrapped in CDATA

For the latest documentation on this and other important topics, please refer to the NIVOMAX Help Center. The NIVOMAX Help Center is your primary resource for up-to-date information, guidelines, and self-serve support for NIVOMAX.

This document also has an online version which may be more up-to-date.
 

Guides

NIVOMAX © 2017-2025 All rights reserved SYNAXIOM INC.
© 2005 – 2025 SYNAXIOM Inc.
Usage of this site constitutes acceptance of our Intellectual Property Policy; please ensure you have read it thoroughly.

CONFIDENTIAL

This document is the property of SYNAXIOM Inc.

NIVOMAX © 2017-2025 All rights reserved SYNAXIOM INC. © 2005 – 2025 SYNAXIOM Inc.
Usage of this document constitutes acceptance of our Intellectual Property Policy; please ensure you have read it thoroughly.

Uncontrolled copy generated on: 2025-05-14 10:36:35