• FlexDoc/XML
• Documentation

FlexDoc/XML - Documentation

Installation / Configuration Files

1. Installation
2. Configuration Files
   • flexdoc.config
   • flexdoc.license
   • designer.config
   • generator.config
   • catalog.xml

Generator

• Launching Generator from Command Line
  • Java Command Line
  • Command Line Options
    • Template Options
    • Output Options
    • Processing Options
    • Configuration Options
  • Command Line Argument Files
• Generator Settings & GUI
  • Settings Categories
  • Generator Configuration File
  • Generator GUI
  • Specifying Template
    • Setting Template Parameters
  • Specifying Input XML File(s)
  • Selecting Output Format
    • Setting Format Options
  • Specifying Output Location
  • Starting Generation
    • Generation Phases
  • Switching Between Generator Configurations
  • How To Suppress Generator GUI?
• Template Parameters
  • What are Template Parameters?
  • Template Parameter Inspector
    • Finding All Specified Parameters
    • Profile Parameter
  • Multi-valued (List) Parameters
    • Specifying List Value in Parameter Inspector
    • Using Escapes
    • Specifying List Parameter on Command Line
• Output Formats
  • What are Output Format Options?
  • HTML Output
    • HTML Options
    • Custom Style Sheet
  • RTF Output
    • RTF Options
    • Updating RTF fields in MS Word
    • Including generated RTF in larger Word document
    • Including static Word document into generated RTF
    • Generating RTF for non-Word applications
  • Plain-Text (TXT) Output
    • TXT Options
    • Using plain-text output to generate auxiliary files
• Input XML
  • Specifying Input XML File(s)
  • XML File Pathname with Spaces
  • Using File Pathname Patterns
  • XML Catalogs
    • What is XML Catalog?
    • How FlexDoc/XML uses XML Catalogs
    • Assigning XML Catalog(s)
• Error Reporting
  • Finding Error Location in Template
• Running with Apache Ant
• Apache Maven Plugin
  • Installation
  • Installation with DiagramKit
  • Usage
    • Memory Heap Size
  • Examples
    • Site Report 1
    • Site Report 2
    • No Site
• Running in Docker
  • Example Goal
  • Building Docker Image
  • Running Docker Image

Designing Templates

1. How to Create a Template?
2. Defining XML Type
   • XML Type Configuration File
   • Assigning DTD
     • dtd.file
     • dtd.systemID
     • dtd.publicID
   • Assigning XML Schemas
     • xsd.files
     • xsd.catalogs
     • xsd.includeAbstractTypes
     • Local Element Types
   • Declaring Namespaces
     • ns.<n>.uri
     • ns.<n>.prefix
     • ns.<n>.default
     • Example
   • Pseudo-elements
     • pseudo-elements.all
     • pseudo-elements.<NAME>
     • defaultRootElement
     • #CDATA
     • #COMMENT
     • #CUSTOM
     • #DOCTYPE
     • #DOCUMENT
     • #DOCUMENTS
     • #NAMESPACE
     • #PI
     • #TEXT
   • Element Image Provider
   • Using Macros
3. Running Template Designer
   • Command Line Options
   • Creating a New Template
   • Invoking Generator from Template Designer