Schema "mule-schemadoc.xsd"
Target Namespace:
http://www.mulesoft.org/schema/mule/schemadoc
Defined Components:
5 global elements, 1 local element, 4 complexTypes
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
http://www.mulesoft.org/schema/mule/schemadoc/3.3/mule-schemadoc.xsd; see XML source
Imported by Schemas (45):
_mule-all-included.xsd, mule-ajax.xsd [src], mule-atom.xsd [src], mule-axis.xsd [src], mule-bpm.xsd [src], mule-client.xsd [src], mule-cxf.xsd [src], mule-ejb.xsd [src], mule-email.xsd [src], mule-file.xsd [src], mule-ftp.xsd [src], mule-http.xsd [src], mule-https.xsd [src], mule-imap.xsd [src], mule-imaps.xsd [src], mule-jaas.xsd [src], mule-jdbc.xsd [src], mule-jetty-ssl.xsd [src], mule-jetty.xsd [src], mule-jms.xsd [src], mule-jnp.xsd [src], mule-json.xsd [src], mule-multicast.xsd [src], mule-ognl.xsd [src], mule-pattern.xsd [src], mule-pgp.xsd [src], mule-pop3.xsd [src], mule-pop3s.xsd [src], mule-quartz.xsd [src], mule-rmi.xsd [src], mule-rss.xsd [src], mule-servlet.xsd [src], mule-sftp.xsd [src], mule-smtp.xsd [src], mule-smtps.xsd [src], mule-ssl.xsd [src], mule-stdio.xsd [src], mule-sxc.xsd [src], mule-tcp.xsd [src], mule-tls.xsd [src], mule-udp.xsd [src], mule-vm.xsd [src], mule-ws.xsd [src], mule-xml.xsd [src], mule-xmpp.xsd [src]
Annotation
This schema provides a schema doc extentions that can be embedded in Mule schemas. These elements will be used to render additional wiki content associated with the element being annotated. Elements within this schema should be embedded under 'xsd:element/xsd:annotation/xsd:appinfo'. To stick to convention and to ensure that XSLs will work this schema should be included in other mule schemas using the 'schemadoc' prefix namespace.
All Element Summary
additional-documentation Additional documentation that can be rendered with the schema.
Type:
additionalDocumentationType
Content:
mixed (allows character data), 1 attribute
Defined:
globally; see XML source
Used:
never
MEPs The MEPs that are supported by this Transport. and the dafault MEP
Type:
MEPsType
Content:
empty, 2 attributes
Defined:
locally witnin transportFeaturesType complexType; see XML source
page-title The page title to use when rendering this schema.
Type:
xsd:string
Content:
simple
Defined:
globally; see XML source
Used:
never
short-name The short name of the module or transport, i.e.
Type:
xsd:string
Content:
simple
Defined:
globally; see XML source
Used:
never
snippet The snippet allows for code snippets to be associated with an element in a schema.
Type:
snippetType
Content:
mixed (allows character data), 3 attributes
Defined:
globally; see XML source
Used:
never
transport-features Defines meta information about transports such as whether they can send or receive events and if they supprt transactions.
Type:
transportFeaturesType
Content:
complex, 7 attributes, 1 element
Defined:
globally; see XML source
Used:
never
Complex Type Summary
additionalDocumentationType
Content:
mixed (allows character data), 1 attribute
Defined:
globally; see XML source
Includes:
definition of 1 attribute
Used:
at 1 location
MEPsType
Content:
empty, 2 attributes
Defined:
globally; see XML source
Includes:
definitions of 2 attributes
Used:
at 1 location
snippetType
Content:
mixed (allows character data), 3 attributes
Defined:
globally; see XML source
Includes:
definitions of 3 attributes
Used:
at 1 location
transportFeaturesType
Content:
complex, 7 attributes, 1 element
Defined:
globally; see XML source
Includes:
definitions of 7 attributes, 1 element
Used:
at 1 location
XML Source
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xsd:schema attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://www.mulesoft.org/schema/mule/schemadoc" xmlns="http://www.mulesoft.org/schema/mule/schemadoc" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:annotation>
<xsd:documentation>
This schema provides a schema doc extentions that can be embedded in Mule schemas. These
elements will be used to render additional wiki content associated with the element being annotated.
Elements within this schema should be embedded under 'xsd:element/xsd:annotation/xsd:appinfo'.
To stick to convention and to ensure that XSLs will work this schema should be included in other mule
schemas using the 'schemadoc' prefix namespace.
</xsd:documentation>
<xsd:appinfo>
<page-title>SchemaDoc Reference</page-title>
</xsd:appinfo>
</xsd:annotation>
<xsd:element name="snippet" type="snippetType">
<xsd:annotation>
<xsd:documentation>
The snippet allows for code snippets to be associated with an element in a schema. This
is useful for surfacing documentation on the wiki. When the schema reference is generated for the wiki,
the code snippets will also be rendered when using the 'single-element-wike.xsl'.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="page-title" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The page title to use when rendering this schema.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="short-name" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
The short name of the module or transport, i.e. 'xml' or 'tcp'.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="additional-documentation" type="additionalDocumentationType">
<xsd:annotation>
<xsd:documentation>
Additional documentation that can be rendered with the schema. Note that this element can
only be used in {{/xsd:schema/xsd:annotation/xsd:appinfo}}, it will be ignorred if used anywhere else.
Enter
the documentation in the body of this element.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:complexType mixed="true" name="additionalDocumentationType">
<xsd:attribute name="where" use="required">
<xsd:annotation>
<xsd:documentation>
The point at which the documentation is rendered.
</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:NMTOKEN">
<xsd:enumeration value="before-common-elements">
<xsd:annotation>
<xsd:documentation>
The documentation will appear after any title text but before any of the
common elements are rendered.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="after-common-elements">
<xsd:annotation>
<xsd:documentation>
The documentation will appear right after common elements are rendered.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="before-specific-elements">
<xsd:annotation>
<xsd:documentation>
The documentation will appear right before the elements specific to the
schema are rendered.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="after-specific-elements">
<xsd:annotation>
<xsd:documentation>
The documentation will appear right after the elements specific to the
schema are rendered.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="before-single-element">
<xsd:annotation>
<xsd:documentation>
If a specific element was named, this documentation will appear directly
before the element. The mode is less useful but supported for completeness.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="after-single-element">
<xsd:annotation>
<xsd:documentation>
If a specific element was named, this documentation will appear directly
after the element. The mode is less useful but supported for completeness.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
</xsd:complexType>
<xsd:complexType mixed="true" name="snippetType">
<xsd:attribute name="id" type="xsd:NMTOKEN" use="required">
<xsd:annotation>
<xsd:documentation>
The ID of the snippet to embed in the wiki page. This ID is embedded in the source
file using a START SNIPPET xxx comment.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="lang">
<xsd:annotation>
<xsd:documentation>
The language format to use when rendering the content of the snippet on the wiki.
</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:NMTOKEN">
<xsd:enumeration value="xml"/>
<xsd:enumeration value="java"/>
<xsd:enumeration value="javadoc"/>
<xsd:enumeration value="bash"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="sourcePath" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
This is the path to the source file. Note this should be relative to the project root
directory i.e. transport/jms/src/main/resources/etc...
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
<xsd:element name="transport-features" type="transportFeaturesType">
<xsd:annotation>
<xsd:documentation>
Defines meta information about transports such as whether they can send or receive events
and if they supprt transactions.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:complexType name="transportFeaturesType">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="MEPs" type="MEPsType">
<xsd:annotation>
<xsd:documentation>
The MEPs that are supported by this Transport. and the dafault MEP
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="receiveEvents" type="xsd:boolean" use="required">
<xsd:annotation>
<xsd:documentation>
Whether the transport can receive events and thus can be used for an inbound
endpoint.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="dispatchEvents" type="xsd:boolean" use="required">
<xsd:annotation>
<xsd:documentation>
Ehether the transport can be used to dispatch events and thus is supported as an
outbound endpoint.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="requestEvents" type="xsd:boolean" use="required">
<xsd:annotation>
<xsd:documentation>
Whether the transport can be used to request events directly from the source.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="transactions" type="xsd:boolean" use="required">
<xsd:annotation>
<xsd:documentation>
Whether transactions are supported by the transports. Transports that support (/)A
transactions can be configured in a distributed 2 Phase Commit (Distributed) transaction.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="transactionTypes" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
A comma separated list of transaction types, i.e. local, XA
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="streaming" type="xsd:boolean" use="required">
<xsd:annotation>
<xsd:documentation>
Whether the transport supports streaming of the data is provides or publishes.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="retries" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Whether the transport support retry policies. Note most transports can be configured with retry policies, but this flag marks the transports that MuleSoft explicitly test and support.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
<xsd:complexType name="MEPsType">
<xsd:attribute name="supported" type="xsd:string" use="required"/>
<xsd:attribute name="default" type="xsd:string" use="required"/>
</xsd:complexType>
</xsd:schema>
XML schema documentation generated with DocFlex/XML RE 1.8.5 using DocFlex/XML XSDDoc 2.5.0 template set. All content model diagrams generated by Altova XMLSpy via DocFlex/XML XMLSpy Integration.