• FlexDoc/XML
• XSDDoc

FlexDoc/XML - XSDDoc (XML Schema Documentation Generator)

Overview

1. What is FlexDoc/XML XSDDoc?
2. What you can generate with it
   • Framed HTML Documentation
   • Single-File Documentation (HTML, RTF, PDF)
3. What is processed/documented
   • Any number of input XSD files
   • All referenced XSD files
   • Any XML schema design patterns
   • Joint documenting of conflicting XML schemas
   • XHTML tags in your annotations
   • Support of XML Catalogs
4. Documentation Features
   • Highly navigable framed HTML documentation
   • Dense layouts: more information in less space
   • Abundance of cross-links
   • Documenting of local elements
     • What are local elements?
     • Global and local documenting of local elements
     • Adding extensions to local element names
     • Unifying local elements by type
   • List of containing elements
   • Documenting of redefinitions
   • Documenting of substitution groups
   • Documenting of complex content
     • Component Diagram
     • XML Representation Summary
   • Documenting of XML source
5. Possibility of unlimited customizations
   • Template parameters
   • Generator options
   • Using custom CSS styles
   • Modifying templates with Template Designer
6. Getting Started
   • How to run XSDDoc?
   • How to include diagrams?
   • How to integrate with Ant/Maven?
7. Licensing
   • Demo Mode
   • Trial License
   • Full Licenses
     • Which Licenses You Need - Use Cases

Templates

1. Overview
2. XML Type
3. Main Templates
   • FramedDoc.tpl
   • SingleDoc.tpl
4. Template Parameters
5. Subtemplates

Frequently Asked Questions

• Running XSDDoc
  • How to run XSDDoc?
    • On Windows
    • On Linux
    • On macOS
  • How to generate HTML documentation?
    • Framed HTML
    • Single File HTML
  • How to generate RTF documentation?
  • How to include diagrams?
  • How to integrate with Ant/Maven?
• Generator Settings
  • What is Generator GUI?
    • What is generator.config?
    • How to suppress Generator GUI?
  • What are Template Parameters?
  • What are Output Format Options?
    • HTML Options
    • RTF Options
  • How to specify a schema file pathname with spaces?
  • How to specify multiple input XML schemas?
    • I have too many input schemas. How to specify all of them?
  • How to switch between different generator configurations?
• Working with annotations
  • How to add annotations to my XML schema?
  • Which annotations get into generated documentation?
  • How to enable/disable interpreting line breaks in my annotations?
• Formatting annotations with XHTML
  • What is XHTML?
  • How to use XHTML in annotations?
  • How to make my XHTML formatting work?
    • Related Template Parameters
    • Related HTML/RTF Options
  • What XHTML tags can I use?
    • In case of HTML output
    • In case of RTF output
    • Demo of XHTML use
  • How to insert images using XHTML?
  • What settings control the processing of XHTML and images?
  • How is XHTML processed?
• Troubleshooting
  • There is some oddity in the documentation I've generated. What may be wrong?
  • Cannot insert an image into my XSDDoc output
• Where to learn more about XML schemas?