WikiTracer : WTSchema

About :: Browse :: PageIndex :: RecentChanges :: RecentlyCommented :: Login/Register
Home

WT XML Schema

See also
Draft version: v0.4
 

<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns="http://www.w3.org/2001/XMLSchema" targetNamespace="http://wikitracer.com"  xmlns:wt="http://wikitracer.com">
    <!-- response wrapper -->
    <annotation>
        <documentation>
            This is the XML Schema definition for the WikiTracer plugin data format. The full specifications are available at: http://wikitracer.com/docs
        </documentation>
    </annotation>
    <element name="rsp">
        <annotation>
            <documentation>
                This element is the wiki response wrapper.
            </documentation>
        </annotation>
        <complexType>
        <sequence>
            <element name="ts" type="dateTime">
                    <annotation>
                        <documentation>
                            The ISO 8601 timestamp of the response.
                        </documentation>
                    </annotation>
            </element>
            <element name="wtformat">
                <annotation>
                    <documentation>
                        The data format of the response.
                    </documentation>
                </annotation>
                <simpleType>
                    <restriction base="string">
                        <pattern
                            value="[0-9]+(\.[0-9]+)?(\.[0-9]+)?">

                        </pattern>
                    </restriction>
                </simpleType>
            </element>
            <element name="wtplugin">
                <annotation>
                    <documentation>
                        The plugin version installed in the client wiki.
                    </documentation>
                </annotation>
                <simpleType>
                    <restriction base="string">
                        <pattern
                            value="wt_[a-zA-Z0-9]+_[0-9]+(\.[0-9]+)?(\.[0-9]+)?">

                        </pattern>
                    </restriction>
                </simpleType>
            </element>
            <element name="wiki" type="wt:Wiki">
            </element>
        </sequence>
    </complexType>
    </element>

    <!-- wiki information -->
    <complexType name="Wiki">
        <annotation>
            <documentation>
                This element contains information about the client wiki.
            </documentation>
        </annotation>
        <sequence>
            <element name="title" type="string" minOccurs="1" maxOccurs="1">
                <annotation>
                    <documentation>
                        The title of the wiki.
                    </documentation>
                </annotation>
            </element>
            <element name="url" minOccurs="1" maxOccurs="1">
                <annotation>
                    <documentation>
                        The base URL of the wiki. Appending a wiki page name to the base URL will provide the full URL for that page.
                    </documentation>
                </annotation>
                <simpleType>
                    <restriction base="string">
                        <pattern
                            value="http(s){0,1}:\/\/.+">

                        </pattern>
                    </restriction>
                </simpleType>
            </element>
            <element name="engine_type" type="int" minOccurs="1" maxOccurs="1">
                <annotation>
                    <documentation>
                        The WikiTracer identifier for the engine running the wiki.
                    </documentation>
                </annotation>
            </element>
            <element name="engine_version" type="string" minOccurs="1" maxOccurs="1">
                <annotation>
                    <documentation>
                        The wiki engine version.
                    </documentation>
                </annotation>
            </element>
            <element name="age" type="wt:Age">
                <annotation>
                    <documentation>
                        This element holds information about the age of the wiki.
                    </documentation>
                </annotation></element>
            <element name="pop" type="wt:Pop">
                <annotation>
                    <documentation>
                        This element holds information about the population of the wiki.
                    </documentation>
                </annotation></element>
            <element name="cont" type="wt:Cont">
                <annotation>
                    <documentation>
                        This element holds information about the content of the wiki.
                    </documentation>
                </annotation></element>
            <element name="del" type="wt:Del">
                <annotation>
                    <documentation>
                        This element holds information about the moderation of the wiki.
                    </documentation>
                </annotation></element>
            <element name="access" type="wt:Access">
                <annotation>
                    <documentation>
                        This element holds information about access control of the wiki.
                    </documentation>
                </annotation></element>
        </sequence>
        <attribute name="wid" use="required">
            <annotation>
                <documentation>
                    Identifier provided by WikiTracer to uniquely identify the client wiki.
                </documentation>
            </annotation>
            <simpleType>
                <restriction base="int">
                </restriction>
            </simpleType>
        </attribute>
    </complexType>

    <!-- age data -->
    <complexType name="Age">
        <annotation>
            <documentation>
                This element holds information about the age of the wiki.
            </documentation>
        </annotation>
        <sequence>
            <element name="first_edit" type="dateTime" maxOccurs="1">
                <annotation>
                    <documentation>
                        ISO 8601 timestamp of the oldest known edit in the wiki.
                    </documentation>
                </annotation></element>
            <element name="last_edit" type="dateTime" maxOccurs="1">
                <annotation>
                    <documentation>
                        ISO 8601 timestamp of the most recent edit in the wiki at the time of the response.
                    </documentation>
                </annotation></element>
        </sequence>
    </complexType>


    <!-- content data -->
    <complexType name="Cont">
        <annotation>
            <documentation></documentation>
        </annotation>
        <sequence>
            <element name="pages" type="int" maxOccurs="1"
                minOccurs="0">

                <annotation>
                    <documentation>
                        Total number of pages in the wiki, including
                        system or default pages (if any).
                    </documentation>
                </annotation>
            </element>
            <element name="good" type="int" minOccurs="0"
                maxOccurs="1">

                <annotation>
                    <documentation>
                        Number of actual content pages. If the wiki does
                        not support special or system pages, this number
                        should have the same value as "pages".
                    </documentation>
                </annotation>
            </element>
            <element name="wanted" type="int" minOccurs="0"
                maxOccurs="1">

                <annotation>
                    <documentation>
                        Number of missing pages (empty nodes for which
                        inbound links have been created).
                    </documentation>
                </annotation>
            </element>
            <element name="orphaned" type="int" minOccurs="0"
                maxOccurs="1">

                <annotation>
                    <documentation>
                        Number of pages not linked from any other page.
                    </documentation>
                </annotation>
            </element>
            <element name="namespaces" type="int" minOccurs="0"
                maxOccurs="1">

                <annotation>
                    <documentation>
                        Total number of available namespaces in the
                        wiki.
                    </documentation>
                </annotation>
            </element>
            <element name="comments" type="int" minOccurs="0"
                maxOccurs="1">

                <annotation>
                    <documentation>
                        Total number of comments (if supported).
                    </documentation>
                </annotation>
            </element>
            <element name="files" type="int" minOccurs="0"
                maxOccurs="1">

                <annotation>
                    <documentation>
                        Total number of files uploaded to the wiki (if
                        supported).
                    </documentation>
                </annotation>
            </element>
            <element name="edits" minOccurs="0">
                <annotation>
                    <documentation>Total number of edits</documentation>
                </annotation>
                <complexType mixed="true">
                <simpleContent>
                  <extension base="int">
                    <attribute name="anon" type="int" >
                        <annotation>
                            <documentation>Number of edits by anonymous users (if any)</documentation>
                        </annotation>
                    </attribute>
                    <attribute name="user">
                        <annotation>
                            <documentation>Number of edits by registered users (if any)</documentation>
                        </annotation>
                    </attribute>
                    <attribute name="admin">
                        <annotation>
                            <documentation>Number of edits by admins or superusers (if any)</documentation>
                        </annotation>
                    </attribute>
                  </extension>
                </simpleContent>
              </complexType>
            </element>
        </sequence>
    </complexType>

    <!-- population data -->
    <complexType name="Pop">
        <annotation>
            <documentation>
                This element holds information about the population of the wiki.
            </documentation>
        </annotation>
        <sequence>
            <element name="users" type="int" maxOccurs="1">
                <annotation>
                    <documentation>
                        Total number of registered users of the wiki, including administrators.
                    </documentation>
                </annotation></element>
            <element name="admins" type="int" maxOccurs="1">
                <annotation>
                    <documentation>
                        Number of users with admin or moderator privileges.
                    </documentation>
                </annotation></element>
        </sequence>
    </complexType>

    <!-- moderation data -->
    <complexType name="Del">
        <annotation>
            <documentation>
                This element holds data about moderation activity.
            </documentation>
        </annotation>
        <sequence>
            <element name="pages" type="int" minOccurs="0" maxOccurs="1">
                <annotation>
                    <documentation>
                        Number of pages in the wiki that have been removed.
                    </documentation>
                </annotation>
            </element>
            <element name="users" type="int" minOccurs="0" maxOccurs="1">
                <annotation>
                    <documentation>
                        Number of users of the wiki that have been permanently banned or removed.
                    </documentation>
                </annotation>
            </element>
        </sequence>
    </complexType>

    <!-- access data -->
    <complexType name="Access">
        <annotation>
            <documentation>
                This element holds data about access control in the wiki.
            </documentation>
        </annotation>
        <sequence>
            <element name="anon_edit" minOccurs="0" maxOccurs="1" type="int">
                <annotation>
                    <documentation>
                        Edit restrictions on the wiki: "0" registration required, "1" anonymous edits allowed.
                    </documentation>
                </annotation>
            </element>
            <element name="anon_readable_pages" type="int" minOccurs="0" maxOccurs="1">
                <annotation>
                    <documentation>
                        Total number of pages readable by unregistered or anonymous users.
                    </documentation>
                </annotation>
            </element>
            <element name="anon_writable_pages" type="int" minOccurs="0" maxOccurs="1">
                <annotation>
                    <documentation>
                        Total number of pages writable by unregistered or anonymous users.
                    </documentation>
                </annotation>
            </element>
            <element name="user_readable_pages" minOccurs="0" maxOccurs="1" type="int">
                <annotation>
                    <documentation>
                        Total number of pages readable by registered users.
                    </documentation>
                </annotation>
            </element>
            <element name="user_writable_pages" type="int" minOccurs="0" maxOccurs="1">
                <annotation>
                    <documentation>
                        Total number of pages writable by registered users.
                    </documentation>
                </annotation>
            </element>
        </sequence>
    </complexType>
</schema>
There are no comments on this page.
Valid XHTML 1.0 Transitional :: Valid CSS :: Powered by WikkaWiki
Page was generated in 0.5821 seconds