DocFlex/XML - XMLDoc - XML File Documentor

• Overview
• Examples
• RTF demo
• Plain HTML demo
• Framed HTML demo

Overview

It may also serve as an example of a very simple and, at the same time, practically useful application of DocFlex/XML. See Templates to learn how it works.

The set includes two main templates (i.e. those to be specified directly in the generator dialog or on the command line with -template option):

1. XMLDoc.tpl template can be used to generate single file documentation in any output format supported by DocFlex. See RTF demo and Plain HTML demo.
2. XMLDocFrames.tpl template is a variant of the same but designed to generate a framed HTML documentation. See Framed HTML demo.

Besides those main templates, there are few sub-templates, which are called internally from the both main ones. See Templates for more details.

Examples

The following XML file demo documentation has been generated from three XSL files (XSL is a subset of XML that encodes XSLT scripts) found in Apache Ant software package.

We have chosen those files simply because we use Apache Ant itself (without learning much what those XSLT scripts do).

RTF demo

The following pages are from an RTF document generated with XMLDoc.tpl template (click on the screenshot to see the real size page preview):

Plain HTML demo

This is actually the same document as RTF above generated with XMLDoc.tpl template, however, now it is in HTML format (click on the screenshot to see the real HTML):

Framed HTML demo

The following is a framed HTML variant generated with XMLDocFrames.tpl template (click on the screenshot to see the real HTML):