Format XML

The Format XML is an XML file where you have to incorporate the elements according to a pre-defined XML schema (XSD). Using this XML, you can pick the elements that you have specified in ZSPEC and customize how the document should be arranged on the help document. In addition to the details configured in the ZSPEC, you can also add custom content to the help documentation.

Overview of ZEST Specification Format

• Document required
  • Product required
    • Content
    • Version required
      • Custom recurrent
      • Authentication recurrent
      • Operation recurrent
      • Server recurrent
      • Resource recurrent
      • Tag recurrent

In the ZEST document layout, the header plays a pivotal role, where the product name itself acts as a clickable button and displays the detailed information about the product. Additionally, the version acts as a convenient select component, allowing users to access documents of different versions effortlessly.

Moreover, in the menu if the parent page has content, then it will behave like a button otherwise the content of its first child page will be displayed. This intuitive design enhances the overall user experience.