Site Map   PRODUCTS ----------------------------------- DocFlex Technology    About    Features        Key Features        Data Processing        Formatting        Templates / Designer GUI    Documentaion        Template Components        Element Iterator (details)   DocFlex/XML    About    Documentaion        Installation & Config Files        Running Generator        Designing Templates    Sample        XMLDoc        Sales Report        Alternative to XSLT    XSDDoc        Features        Organization        Examples        Templates            Templates            Parameters        FAQ    Integrations        Apache Ant        Apache Maven        XMLSpy    Tutorials   DocFlex/Javadoc    About    Documentaion        Installation & Config Files        DocFlex Doclet        Integrations        FAQ    Basic Templates        Templates        Parameters    JavadocPro        Templates        Parameters    Examples    Tutorials   DocFlex/Together    About    Examples    Basic Templates    Documentaion    Tutorials   TRY ----------------------------------- Downloads Registration Trial License   BUY ----------------------------------- Licensing/Pricing Shop   COMPANY ----------------------------------- News Products Services Customers About Us Imprint Legal    Terms of Use    Business Terms & Conditions    End User License Terms Contact Links

DocFlex/XML - XSDDoc - Parameters

Parameter Tree

• [.]
• Generate Details
• Details
  • Overview Summary
  • All Component Summary
  • Namespace Overview
  • Schema Overview
  • Component Documentation
• Navigation
• Show
• Processing
  • Annotations
• Formatting
• Integrations
  • XMLSpy
    • XMLSpy Version
    • Show Application
    • Delete Temporary Docs
    • Diagram Format
    • Workarounds
      • Fix Imagemap Coordinates
      • Use Namespace Prefixes
      • Include Attributes
        • Exclude Attribute Groups
      • Include Redefined Components

“Integrations” parameter group

Parameter/Group	Name / Type / Description
XMLSpy	integration.xmlspy : boolean Enables XMLSpy Integration. When this parameter is unselected (false), XMLSpy won't be called.
XMLSpy Version	integration.xmlspy.version : string Specify the version number of the XMLSpy installed on your system. The default value of this parameter is obtained from the -m:XMLSPY_VERSION option specified on the generator command line. Here you can override it and specify a different XMLSpy version number, which will be used only by XSDDoc templates. Note that the XMLSpy version number is not used by the XMLSpy integration itself. Rather, it is used essentially to calculate the default values of the “Integration | XMLSpy | Workarounds” parameters (which allows you to not bother yourself much about their meanings).
Show Application	integration.xmlspy.showApp : boolean Specify whether XMLSpy application (IDE) should show itself, when it is called from DocFlex to process the XML schemas.
Delete Temporary Docs	integration.xmlspy.deleteTempDocs : boolean Specify whether to delete all files temporarily generated by XMLSpy. When this parameter is selected (true), the entire 'xmlspy' subdirectory will be deleted on the finishing of XSDDoc. Otherwise, all original output files generated by XMLSpy will be left.
Diagram Format	integration.xmlspy.diagramFormat : enum {"PNG", "EMF"} Select the graphics format of the diagrams generated by XMLSpy. Possible Choices: "PNG" All diagrams will be in PNG formats. This is the default format. It is best for HTML documentation. (However, in RTF/PDF documentation it will work as well.) "EMF" The diagrams will be generated in EMF format. This format is more suitable for printable RTF/PDF documentation. (In case of HTML, the diagrams will be generated in EMF as well, however, whether you can see them will depend on your HTML browser.) Important: The generation of diagrams in EMF format is possible only since XMLSpy 2009 or later. (Although, XMLSpy itself supported EMF much earlier, they provided the Java API for it only since 2009.) Therefore, if you have an earlier version of XMLSpy and select "EMF" in this parameter, only PNG graphics will be generated instead.
Workarounds	integration.xmlspy.workarounds This parameter group is needed to let the integration know some specifics about how the HTML output produced by XMLSpy should be parsed and interpreted. Note: The default values of these parameters are calculated from the value of the “Integrations | XMLSpy | XMLSpy Version” parameter. So, in most cases you don't need to change them.
Fix Imagemap Coordinates	integration.xmlspy.workarounds.fixCoords : boolean Specify whether to correct imagemap coordinates generated by XMLSpy. As of the versions XMLSpy 2004-2012, all rectangle areas contained in the hypertext imagemaps associated with the content model diagrams generated by XMLSpy are shifted slightly to the top and left, which makes every clickable area to appear somewhat displaced from where it should be. We have found no rational purpose behind this and assumed that it was simply a bug. Therefore, we programmed a correction by adding (+10,+5) to every (x,y) coordinate found in the imagemaps. Now, this works fine. But since it is likely a bug in XMLSpy, they may fix it some time later. In that case, our correction would actually produce a distortion by itself. With this parameter, you can disable any corrections. Unselect it (or specify false) to have only the original imagemap coordinates (generated by XMLSpy) used in the result documentation.
Use Namespace Prefixes	integration.xmlspy.workarounds.useNSPrefixes : boolean This parameter tells the integration whether namespace prefixes may be used in the component names in the HTML documentation generated by XMLSpy. In the XML schema documentation generated by XMLSpy 2007 and erlier versions (as well as XMLSpy 2008 base), the titles of components from imported schemas may start with the namespace prefixes declared in the main (importing) schema for the target namespaces of the schemas being imported.
Include Attributes	integration.xmlspy.workarounds.includeAttributes : boolean This parameter tells the integration whether attributes are documented in the HTML output file generated by XMLSpy. Attributes are documented only since XMLSpy 2006
Exclude Attribute Groups	integration.xmlspy.workarounds.includeAttributes : boolean This parameter informs the integration that the local attributes defined within global attribute groups are not documented in the HTML output file generated by XMLSpy. This problem occurs in XMLSpy 2006-2007. Although these XMLSpy versions do depict all local attributes on the diagrams and even generates hyperlinks for them, those local attributes that are defined within global attribute groups are actually never documented separately in the HTML output produced by XMLSpy. (So, the diagram hyperlinks to them in fact lead to nowhere!) To process such an HTML correctly, the integration needs to know about that omission.
Include Redefined Components	integration.xmlspy.workarounds.includeRedefinedComps : boolean This parameter tells the integration if the redefined (original) components are documented by XMLSpy. Although all tested XMLSpy versions process redefinitions of XML schema components (those specified within <xs:redefine> elements), XMLSpy 2006 and early versions do not document separately the original components (those being redefined) in the HTML output they generate. To process such an HTML correctly, the integration needs to know about this.