Add DiscussionThreading info to export-0.4.xsd. TODO: Test against real data to make...
[lhc/web/wiklou.git] / docs / export-0.4.xsd
1 <?xml version="1.0" encoding="UTF-8" ?>
2 <!--
3 This is an XML Schema description of the format
4 output by MediaWiki's Special:Export system.
5
6 Version 0.2 adds optional basic file upload info support,
7 which is used by our OAI export/import submodule.
8
9 Version 0.3 adds some site configuration information such
10 as a list of defined namespaces.
11
12 Version 0.4 adds per-revision delete flags, log exports,
13 discussion threading data, and a per-page redirect flag.
14
15 The canonical URL to the schema document is:
16 http://www.mediawiki.org/xml/export-0.4.xsd
17
18 Use the namespace:
19 http://www.mediawiki.org/xml/export-0.4/
20 -->
21 <schema xmlns="http://www.w3.org/2001/XMLSchema"
22 xmlns:mw="http://www.mediawiki.org/xml/export-0.4/"
23 targetNamespace="http://www.mediawiki.org/xml/export-0.4/"
24 elementFormDefault="qualified">
25
26 <annotation>
27 <documentation xml:lang="en">
28 MediaWiki's page export format
29 </documentation>
30 </annotation>
31
32 <!-- Need this to reference xml:lang -->
33 <import namespace="http://www.w3.org/XML/1998/namespace"
34 schemaLocation="http://www.w3.org/2001/xml.xsd"/>
35
36 <!-- Our root element -->
37 <element name="mediawiki" type="mw:MediaWikiType"/>
38
39 <complexType name="MediaWikiType">
40 <sequence>
41 <element name="siteinfo" type="mw:SiteInfoType"
42 minOccurs="0" maxOccurs="1"/>
43 <element name="page" type="mw:PageType"
44 minOccurs="0" maxOccurs="unbounded"/>
45 </sequence>
46 <attribute name="version" type="string" use="required"/>
47 <attribute ref="xml:lang" use="required"/>
48 </complexType>
49
50 <complexType name="SiteInfoType">
51 <sequence>
52 <element name="sitename" type="string" minOccurs="0" />
53 <element name="base" type="anyURI" minOccurs="0" />
54 <element name="generator" type="string" minOccurs="0" />
55 <element name="case" type="mw:CaseType" minOccurs="0" />
56 <element name="namespaces" type="mw:NamespacesType" minOccurs="0" />
57 </sequence>
58 </complexType>
59
60 <simpleType name="CaseType">
61 <restriction base="NMTOKEN">
62 <!-- Cannot have two titles differing only by case of first letter. -->
63 <!-- Default behavior through 1.5, $wgCapitalLinks = true -->
64 <enumeration value="first-letter" />
65
66 <!-- Complete title is case-sensitive -->
67 <!-- Behavior when $wgCapitalLinks = false -->
68 <enumeration value="case-sensitive" />
69
70 <!-- Cannot have two titles differing only by case. -->
71 <!-- Not yet implemented as of MediaWiki 1.5 -->
72 <enumeration value="case-insensitive" />
73 </restriction>
74 </simpleType>
75
76 <simpleType name="DeletedFlagType">
77 <restriction base="NMTOKEN">
78 <enumeration value="deleted"/>
79 </restriction>
80 </simpleType>
81
82 <complexType name="NamespacesType">
83 <sequence>
84 <element name="namespace" type="mw:NamespaceType"
85 minOccurs="0" maxOccurs="unbounded" />
86 </sequence>
87 </complexType>
88
89 <complexType name="NamespaceType">
90 <simpleContent>
91 <extension base="string">
92 <attribute name="key" type="integer" />
93 </extension>
94 </simpleContent>
95 </complexType>
96
97 <complexType name="PageType">
98 <sequence>
99 <!-- Title in text form. (Using spaces, not underscores; with namespace ) -->
100 <element name="title" type="string"/>
101
102 <!-- optional page ID number -->
103 <element name="id" type="positiveInteger" minOccurs="0"/>
104
105 <!-- flag if the current revision is a redirect -->
106 <element name="redirect" minOccurs="0"/>
107
108 <!-- comma-separated list of string tokens, if present -->
109 <element name="restrictions" type="string" minOccurs="0"/>
110
111 <!-- Zero or more sets of revision or upload data -->
112 <choice minOccurs="0" maxOccurs="unbounded">
113 <element name="revision" type="mw:RevisionType" />
114 <element name="upload" type="mw:UploadType" />
115 <element name="logitem" type="mw:LogItemType" />
116 </choice>
117
118 <!-- Zero or One sets of discussion threading data -->
119 <element minOccurs="0" maxOccurs="1" type="mw:DiscussionThreadingInfo" />
120 </sequence>
121 </complexType>
122
123 <complexType name="RevisionType">
124 <sequence>
125 <element name="id" type="positiveInteger" minOccurs="0"/>
126 <element name="timestamp" type="dateTime"/>
127 <element name="contributor" type="mw:ContributorType"/>
128 <element name="minor" minOccurs="0" />
129 <element name="comment" type="mw:CommentType" minOccurs="0"/>
130 <element name="text" type="mw:TextType" />
131 </sequence>
132 </complexType>
133
134 <complexType name="LogItemType">
135 <sequence>
136 <element name="id" type="positiveInteger" minOccurs="0"/>
137 <element name="timestamp" type="dateTime"/>
138 <element name="contributor" type="mw:ContributorType"/>
139 <element name="comment" type="mw:CommentType" minOccurs="0"/>
140 <element name="type" type="string" />
141 <element name="action" type="string" />
142 <element name="text" type="mw:TextType" />
143 </sequence>
144 </complexType>
145
146 <complexType name="CommentType">
147 <simpleContent>
148 <extension base="string">
149 <!-- This allows deleted=deleted on non-empty elements, but XSD is not omnipotent -->
150 <attribute name="deleted" use="optional" type="mw:DeletedFlagType"/>
151 </extension>
152 </simpleContent>
153 </complexType>
154
155
156 <complexType name="TextType">
157 <simpleContent>
158 <extension base="string">
159 <attribute ref="xml:space" use="optional" default="preserve" />
160 <!-- This allows deleted=deleted on non-empty elements, but XSD is not omnipotent -->
161 <attribute name="deleted" use="optional" type="mw:DeletedFlagType"/>
162 </extension>
163 </simpleContent>
164 </complexType>
165
166 <complexType name="ContributorType">
167 <sequence>
168 <element name="username" type="string" minOccurs="0"/>
169 <element name="id" type="positiveInteger" minOccurs="0" />
170
171 <element name="ip" type="string" minOccurs="0"/>
172 </sequence>
173 <!-- This allows deleted=deleted on non-empty elements, but XSD is not omnipotent -->
174 <attribute name="deleted" use="optional" type="mw:DeletedFlagType"/>
175 </complexType>
176
177 <complexType name="UploadType">
178 <sequence>
179 <!-- Revision-style data... -->
180 <element name="timestamp" type="dateTime"/>
181 <element name="contributor" type="mw:ContributorType"/>
182 <element name="comment" type="string" minOccurs="0"/>
183
184 <!-- Filename. (Using underscores, not spaces. No 'Image:' namespace marker.) -->
185 <element name="filename" type="string"/>
186
187 <!-- URI at which this resource can be obtained -->
188 <element name="src" type="anyURI"/>
189
190 <element name="size" type="positiveInteger" />
191
192 <!-- TODO: add other metadata fields -->
193 </sequence>
194 </complexType>
195
196 <!-- Discussion threading data for LiquidThreads -->
197 <complexType name="DiscussionThreadingInfo">
198 <sequence>
199 <element name="ThreadSubject" type="string" />
200 <element name="ThreadParent" type="positiveInteger" />
201 <element name="ThreadAncestor" type="positiveInteger" />
202 <element name="ThreadPage" type="string" />
203 <element name="ThreadID" type="positiveInteger" />
204 <element name="ThreadAuthor" type="string" />
205 <element name="ThreadEditStatus" type="string" />
206 <element name="ThreadType" type="string" />
207 </sequence>
208 </complexType>
209
210 </schema>