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 - Templates - Parameters

Parameter Tree

• [.]
• Generate Details
• Details
  • Overview Summary
  • All Component Summary
  • Namespace Overview
    • Namespace Profile
    • Schema Summary
      • Sorting
      • Annotation
      • Schema Profile
    • Component Summaries
      • Summary Item
        • Annotation
        • Component Profile
      • Sorting
      • {Component Types}
  • Schema Overview
  • Component Documentation
• Navigation
• Show
• Processing
  • Annotations
• Formatting
• Integrations

“Details | Namespace Overview” parameter group

Parameter/Group	Name / Type / Description
Namespace Profile	doc.namespace.profile : boolean Specify whether to generate the Namespace Profile section.
Schema Summary	doc.namespace.schemas : boolean Specify whether to generate the Schema Summary section.
Sorting	doc.namespace.schemas.sorting : boolean Specify how the Schema Summary is sorted. The exact meaning of this parameter is the same as of “Generate Details | Sorting | Schemas” parameter, from which it also inherits its default value.
Annotation	doc.namespace.schemas.annotation : enum {"first_sentence", "full", "none"} Specify whether to include the XML schema annotation and which part of it. The full annotation text is obtained from all <xs:documentation> elements found by the following path: xs:schema/xs:annotation/xs:documentation Multiple <xs:documentation> elements produce multiple sections of the annotation text. Possible Choices: "first sentence" Include only the first sentence of the annotation text. "full" Include the full annotation. "none" Do not include annotation. See Also: “Processing | Annotations” parameter group, where you can specify how annotations are processed and displayed.
Schema Profile	doc.namespace.schemas.profile : boolean Specifies whether to generate the Schema Profile section, which shows the general summary information about the component. Nested Parameters: Control what is included in the Schema Profile section. These parameters are similar to those found in “Detail | Schema Overview | Schema Profile” parameter group.
Component Summaries	doc.namespace.comps : boolean Specify whether to generate the Component Summaries section. Nested Parameters: Specify the types of the components to be shown in the summary tables, the ordering of the components and which information must be displayed about each component. The default values of the parameters selecting the components are calculated dynamically from the corresponding parameters of the “Generate Details” group. That is, by default, only those components will appear in the summary tables which you have already specified to be documented in full. The parameters just allow you to override this.
Summary Item	doc.namespace.comps.item This parameter group controls which information about a component will appear in a summary table item.
Annotation	doc.namespace.comps.item.annotation : enum {"first_sentence", "full", "none"} Specify whether to include the component annotation and which part of it. Possible Choices: "first sentence" Include only the first sentence of the annotation text. "full" Include the full annotation. "none" Do not include annotation. See Also: “Processing | Annotations” parameter group, where you can specify how annotations are processed and displayed.
Component Profile	doc.namespace.comps.item.profile : boolean Specifies whether to generate the Component Profile section, which shows the general summary information about the component. Nested Parameters: Control what is included in the Component Profile section. These parameters are similar to those found in “Detail | Component Documentation | Component Profile” parameter group.
Sorting	doc.namespace.comps.sorting : boolean Specify the sorting order of components. The exact meaning of this parameter is the same as of “Generate Details | Sorting | Components” parameter, from which it also inherits its default value.
Elements Local Elements Complex Types Simple Types Element Groups Global Attributes Attribute Groups	doc.namespace.comps.elements : boolean doc.namespace.comps.element.local : enum {"all", "complexType", "none"} doc.namespace.comps.complexTypes : boolean doc.namespace.comps.simpleTypes : boolean doc.namespace.comps.groups : boolean doc.namespace.comps.attributes : boolean doc.namespace.comps.attributeGroups : boolean Specify whether to generate component summaries for particular components types. Note: The default values of these parameters are provided dynamically by the respective parameters in “Generate Details” group (e.g. “Generate Details | Elements”).