1 <?xml version="1.0" encoding="UTF-8"?>
2 <!-- $Id: config.xsd,v 1.17 2006-06-08 22:20:04 mike Exp $ -->
4 This Schema prescribes the format of YP2 configuration files.
6 xmllint -noout -schema config.xsd config1.xml
7 But use double-dashes for the option names instead of single.
8 (I couldn't include them literally, as, believe it or not,
9 it's an error to include a double dash in an XML comment.
11 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
12 elementFormDefault="qualified"
13 targetNamespace="http://indexdata.dk/yp2/config/1"
14 xmlns:config="http://indexdata.dk/yp2/config/1">
16 <xs:element name="yp2">
19 <xs:element ref="config:start"/>
20 <xs:element minOccurs="0" ref="config:filters"/>
21 <xs:element ref="config:routes"/>
27 <xs:element name="start">
29 <!-- Absence of elements listed here mandates that <start> is empty -->
30 <xs:attribute name="route" use="required" type="xs:NCName"/>
35 <xs:element name="filters">
38 <xs:element maxOccurs="unbounded" ref="config:filter"/>
43 <xs:element name="filter">
46 <!-- In general, the content depends on the "type" attribute.
47 Perhaps the various filter-types' configuration
48 structures should each be described by their own little
51 <!-- type="frontend_net" -->
53 <xs:element minOccurs="0" ref="config:threads"/>
54 <xs:element ref="config:port"/>
57 <!-- type="z3950_client" -->
58 <xs:element ref="config:timeout"/>
61 <xs:element ref="config:message"/>
63 <!-- type="virt_db" or type="multi" -->
65 <xs:element minOccurs="0" maxOccurs="unbounded" ref="config:virtual"/>
66 <xs:element minOccurs="0" maxOccurs="1" name="hideunavailable">
71 <!-- type="auth_simple" -->
73 <xs:element minOccurs="0" ref="config:userRegister"/>
74 <xs:element minOccurs="0" ref="config:targetRegister"/>
75 <xs:element minOccurs="0" name="discardUnauthorisedTargets">
80 <!-- type="backend_test" -->
81 <!-- No elements included -->
83 <!-- type="session_shared" -->
84 <!-- No example configuration to deduce from yet -->
86 <!-- type="template" -->
87 <!-- No example configuration to deduce from yet -->
89 <!-- type="http_file" -->
91 <xs:element ref="config:mimetypes"/>
92 <xs:element name="area">
95 <xs:element ref="config:documentroot"/>
96 <xs:element ref="config:prefix"/>
102 <!-- type="query_rewrite" -->
103 <xs:element ref="config:xslt"/>
106 <xs:attribute name="id" type="xs:NCName"/>
107 <xs:attribute name="refid" type="xs:NCName"/>
108 <xs:attribute name="type">
110 <xs:restriction base="xs:NCName">
111 <xs:enumeration value="frontend_net"/>
112 <xs:enumeration value="z3950_client"/>
113 <xs:enumeration value="log"/>
114 <xs:enumeration value="virt_db"/>
115 <xs:enumeration value="auth_simple"/>
116 <xs:enumeration value="backend_test"/>
117 <xs:enumeration value="multi"/>
118 <xs:enumeration value="session_shared"/>
119 <xs:enumeration value="template"/>
120 <xs:enumeration value="http_file"/>
121 <xs:enumeration value="query_rewrite"/>
128 <xs:element name="threads" type="xs:integer"/>
129 <xs:element name="port" type="xs:string"/>
130 <xs:element name="timeout" type="xs:integer"/>
131 <xs:element name="message" type="xs:NCName"/>
132 <xs:element name="userRegister" type="xs:string"/>
133 <xs:element name="targetRegister" type="xs:string"/>
134 <xs:element name="discardUnauthorisedTargets" type="xs:string"/>
135 <xs:element name="mimetypes" type="xs:string"/>
136 <xs:element name="documentroot" type="xs:string"/>
137 <xs:element name="prefix" type="xs:string"/>
138 <xs:element name="xslt" type="xs:string"/>
140 <!-- ### This is used differently depending on whether it occurs
141 within a "virt_db" or "multi" filter: for the former, it
142 contains one database and one target; for the latter, it
143 contains an optional vhost and one or more targets. This
144 schema should be tweaked to enforce this. -->
145 <xs:element name="virtual">
148 <xs:element minOccurs="0" ref="config:database"/>
149 <xs:element minOccurs="0" ref="config:vhost"/>
150 <xs:element maxOccurs="unbounded" ref="config:target"/>
152 <xs:attribute name="route" type="xs:NCName"/>
156 <xs:element name="database" type="xs:NCName"/>
157 <xs:element name="vhost" type="xs:NCName"/>
158 <xs:element name="target" type="xs:anyURI"/>
161 <xs:element name="routes">
164 <xs:element minOccurs="1" maxOccurs="unbounded" ref="config:route"/>
169 <xs:element name="route">
172 <xs:element maxOccurs="unbounded" ref="config:filter"/>
174 <xs:attribute name="id" use="required" type="xs:NCName"/>