XML Schema "webpart.xsd"

Target Namespace:

Defined Components:

1 global element, 6 local elements, 6 complexTypes, 4 simpleTypes

Default Namespace-Qualified Form:

Local Elements: qualified; Local Attributes: unqualified

Schema Location:

C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\webpart.xsd, see XML source

Imported by Schema:

folderType.xsd [src]

Annotation

File-based WebPart Definition

XML Source

<?xml version="1.0" encoding="UTF-8"?>

<xsd:schema attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://labkey.org/data/xml/webpart" xmlns:wp="http://labkey.org/data/xml/webpart" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<xsd:annotation>

<xsd:documentation xml:lang="en">File-based WebPart Definition</xsd:documentation>

</xsd:annotation>

<xsd:element name="webpart" type="wp:webpartType"/>

<xsd:complexType name="webpartType">

<xsd:sequence>

<xsd:element name="view" type="wp:viewType"/>

<xsd:element maxOccurs="1" minOccurs="0" name="locations" type="wp:locationsListType"/>

<xsd:element maxOccurs="1" minOccurs="0" name="scopes" type="wp:scopeListType"/>

<xsd:element maxOccurs="1" minOccurs="0" name="customizeHandler" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

This JS string will be called when the customize button is clicked. The following variables will be in scope: webPartRowId (the rowId used to uniquely idenitfy this webaprt), and webPartProperties, an map with the properties of this webpart.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

</xsd:sequence>

<xsd:attribute name="title" type="xsd:string"/>

<xsd:attribute name="available" type="wp:availableEnum"/>

</xsd:complexType>

<xsd:complexType name="viewType">

<xsd:attribute name="name" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

The name of a file-based view to use for the content of the web part

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute name="frame" type="wp:frameType"/>

</xsd:complexType>

<xsd:simpleType name="frameType">

<xsd:restriction base="xsd:string">

<xsd:enumeration value="portal"/>

<xsd:enumeration value="title"/>

<xsd:enumeration value="dialog"/>

<xsd:enumeration value="div"/>

<xsd:enumeration value="left_navigation"/>

<xsd:enumeration value="none"/>

</xsd:restriction>

</xsd:simpleType>

<xsd:simpleType name="availableEnum">

<xsd:restriction base="xsd:string">

<xsd:enumeration value="always">

<xsd:annotation>

<xsd:documentation>

Always advertise the web as available, regardless of which modules are enabled in the current container

</xsd:documentation>

</xsd:annotation>

</xsd:enumeration>

<xsd:enumeration value="whenActive">

<xsd:annotation>

<xsd:documentation>

Advertise the web as available when its owning module is enabled in the current container

</xsd:documentation>

</xsd:annotation>

</xsd:enumeration>

<xsd:enumeration value="never">

<xsd:annotation>

<xsd:documentation>

Never advertise the web as available for usage in portal pages

</xsd:documentation>

</xsd:annotation>

</xsd:enumeration>

</xsd:restriction>

</xsd:simpleType>

<xsd:complexType name="locationsListType">

<xsd:sequence>

<xsd:element maxOccurs="unbounded" minOccurs="1" name="location" type="wp:locationType"/>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="locationType">

<xsd:attribute name="name" type="wp:locationEnum"/>

</xsd:complexType>

<xsd:simpleType name="locationEnum">

<xsd:restriction base="xsd:string">

<xsd:enumeration value="body"/>

<xsd:enumeration value="right"/>

<xsd:enumeration value="menu"/>

</xsd:restriction>

</xsd:simpleType>

<xsd:complexType name="scopeListType">

<xsd:sequence>

<xsd:element maxOccurs="unbounded" minOccurs="1" name="scope" type="wp:scopeType"/>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="scopeType">

<xsd:attribute name="name" type="wp:scopeEnum"/>

</xsd:complexType>

<xsd:simpleType name="scopeEnum">

<xsd:restriction base="xsd:string">

<xsd:enumeration value="folder"/>

<xsd:enumeration value="participant"/>

</xsd:restriction>

</xsd:simpleType>

</xsd:schema>

This XML schema documentation has been generated with DocFlex/XML RE 1.7.2 using DocFlex/XML XSDDoc 2.1.0 template set.

DocFlex/XML RE is a reduced edition of DocFlex/XML, which is a tool for programming and running highly sophisticated documentation and reports generators by the data obtained from any kind of XML files. The actual doc-generators are implemented in the form of special templates that are designed visually using a high quality Template Designer GUI basing on the XML schema (or DTD) files describing the data source XML.

DocFlex/XML XSDDoc is a commercial template application of DocFlex/XML that implements a high-end XML Schema documentation generator with simultaneous support of framed multi-file HTML, single-file HTML and RTF output formats. (More formats are planned in the future).

A commercial license for "DocFlex/XML XSDDoc" will allow you:

To configure the generated documentation so much as you want. Thanks to our template technology, it was possible to support more than 300 template parameters (working the same as "options" of an ordinary doc-gen), which will give you an unprecedented control over the generated content!
To use certain features disabled in the free mode (such as the full documenting of substitution groups).
To enable/disable documenting of the initial, imported, included and redefined XML schemas selectively.
To document local element components both globally and locally (similar to attributes).
To enable/disable reproducing of namespace prefixes.
To format your annotations with XHTML tags and reproduce that formatting both in HTML and RTF output.
To insert images in your annotations using XHTML <img> tags (supported both in HTML and RTF output).
To use PlainDoc.tpl main template to generate all the XML schema documentation in the form of a single HTML file.
To use the same template to generate the incredible quality RTF documentation.
To document only selected XML schema components specified by name.
To remove this very advertisement text

Once having only such a license, you will be able to run the fully-featured XML schema documentation generator both with DocFlex/XML SDK and with DocFlex/XML RE, which is a reduced free edition containing only the template interpretor / output generator. No other licenses will be required!

But this is not all. In addition to it, a commercial license for DocFlex/XML SDK will allow you to modify the XSDDoc templates themselves as much as you want. You will be able to achieve whatever was impossible to do with the template parameters only. And, of course, you could develop any template applications by your own!

Please note: By purchasing a license for this software, you not only acquire a useful tool, you will also make an important investment in its future development, the result of which you could enjoy later by yourself. Every single your purchase matters and makes a difference for us!

To buy a license, please follow this link: http://www.filigris.com/shop/