Added More Comments and started doing data type checking so that if a ModuleName...
[mirror_edk2.git] / Tools / XMLSchema / FrameworkHeaders.xsd
1 <?xml version="1.0" encoding="UTF-8"?>
2 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" targetNamespace="http://www.TianoCore.org/2006/Edk2.0" xmlns="http://www.TianoCore.org/2006/Edk2.0">
3 <!--
4 Filename: FrameworkHeaders.xsd
5
6 Copyright (c) 2006, Intel Corp.
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which may be found at http://opensource.org/licenses/bsd-license.php
10
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13
14 -->
15 <xs:include schemaLocation="FrameworkDataElements.xsd"/>
16 <xs:element name="FdbHeader">
17 <xs:annotation>
18 <xs:documentation xml:lang="en">This is the header for the Framework Package Database file.</xs:documentation>
19 </xs:annotation>
20 <xs:complexType>
21 <xs:sequence>
22 <xs:element minOccurs="1" maxOccurs="1" ref="DatabaseName"/>
23 <!-- Value fixed during initialization: FrameworkDatabase -->
24 <xs:choice minOccurs="1" maxOccurs="1">
25 <xs:element minOccurs="0" maxOccurs="1" ref="Guid"/>
26 <!-- Guid needs to be removed -->
27 <xs:element minOccurs="0" maxOccurs="1" ref="GuidValue"/>
28 <!-- GuidValue needs to be required -->
29 </xs:choice>
30 <xs:element minOccurs="1" maxOccurs="1" ref="Version"/>
31 <!-- Version is the version of this file -->
32 <xs:element minOccurs="0" maxOccurs="1" ref="Path"/>
33 <!-- Path needs to be removed -->
34 <xs:choice minOccurs="1" maxOccurs="1">
35 <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>
36 <!-- Created needs to be removed -->
37 <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>
38 <!-- CreatedDate needs to be required -->
39 </xs:choice>
40 <xs:choice minOccurs="0">
41 <xs:element minOccurs="0" maxOccurs="1" ref="Updated"/>
42 <!-- Updated needs to be removed -->
43 <xs:element minOccurs="0" maxOccurs="1" ref="UpdatedDate"/>
44 </xs:choice>
45 <xs:element minOccurs="1" maxOccurs="1" ref="Abstract"/>
46 <xs:element minOccurs="1" maxOccurs="1" ref="Description"/>
47 <xs:element minOccurs="1" maxOccurs="1" ref="Copyright"/>
48 <xs:element minOccurs="1" maxOccurs="1" ref="License"/>
49 <xs:element minOccurs="0" maxOccurs="1" ref="Specification"/>
50 <!-- Specificatoin needs to be required - FRAMEWORK_BUILD_PACKAGING_SPECIFICATION 0x00090000 -->
51 </xs:sequence>
52 </xs:complexType>
53 </xs:element>
54 <xs:element name="MbdHeader">
55 <!-- MbdHeader needs to be removed -->
56 <xs:annotation>
57 <xs:documentation xml:lang="en">DO NOT USE! This is the header for the Component Module Build Description (MBD) file. NOTE: The GUID may be different from the GUID in the MSA file, as the Guid is updated every time the file is changed, as the Guid may change if the contents of the file are changed.</xs:documentation>
58 </xs:annotation>
59 <xs:complexType>
60 <xs:sequence>
61 <xs:element minOccurs="1" maxOccurs="1" ref="BaseName"/>
62 <xs:element minOccurs="1" maxOccurs="1" ref="Guid"/>
63 <xs:element minOccurs="1" maxOccurs="1" ref="Version"/>
64 <xs:element minOccurs="1" maxOccurs="1" ref="Description"/>
65 <xs:element minOccurs="1" maxOccurs="1" ref="Copyright"/>
66 <xs:element minOccurs="1" maxOccurs="1" ref="License"/>
67 <xs:element minOccurs="0" maxOccurs="1" ref="Specification"/>
68 <xs:choice minOccurs="1" maxOccurs="1">
69 <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>
70 <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>
71 </xs:choice>
72 <xs:choice minOccurs="1" maxOccurs="1">
73 <xs:element minOccurs="0" maxOccurs="1" ref="Modified"/>
74 <xs:element minOccurs="0" maxOccurs="1" ref="ModifiedDate"/>
75 </xs:choice>
76 </xs:sequence>
77 </xs:complexType>
78 </xs:element>
79 <xs:element name="MbdLibHeader">
80 <!-- MbdLibHeader needs to be removed -->
81 <xs:annotation>
82 <xs:documentation xml:lang="en">DO NOT USE! This is the header for the Library Module Build Description (MBD) file. NOTE: The Guid may be different from the Guid in the MSA file, as the Guid may change when the contents of the file are changed..</xs:documentation>
83 </xs:annotation>
84 <xs:complexType>
85 <xs:sequence>
86 <xs:element minOccurs="1" maxOccurs="1" ref="BaseName"/>
87 <xs:element minOccurs="1" maxOccurs="1" ref="Guid"/>
88 <xs:element minOccurs="1" maxOccurs="1" ref="Version"/>
89 <xs:element minOccurs="1" maxOccurs="1" ref="Description"/>
90 <xs:element minOccurs="1" maxOccurs="1" ref="Copyright"/>
91 <xs:element minOccurs="1" maxOccurs="1" ref="License"/>
92 <xs:element minOccurs="0" maxOccurs="1" ref="Specification"/>
93 <xs:choice minOccurs="1" maxOccurs="1">
94 <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>
95 <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>
96 </xs:choice>
97 <xs:choice minOccurs="1" maxOccurs="1">
98 <xs:element minOccurs="0" maxOccurs="1" ref="Modified"/>
99 <xs:element minOccurs="0" maxOccurs="1" ref="ModifiedDate"/>
100 </xs:choice>
101 </xs:sequence>
102 </xs:complexType>
103 </xs:element>
104 <xs:element name="MsaHeader">
105 <xs:annotation>
106 <xs:documentation xml:lang="en">This is the Component Module Surface Area Description Header - a replacement for INF files. The GUID may change when the contents of the file are changed.</xs:documentation>
107 </xs:annotation>
108 <xs:complexType>
109 <xs:sequence>
110 <xs:choice>
111 <xs:element minOccurs="0" maxOccurs="1" ref="BaseName"/>
112 <!-- BaseName needs to be removed -->
113 <xs:element minOccurs="0" maxOccurs="1" name="ModuleName" type="xs:NCName"/>
114 </xs:choice>
115 <xs:element minOccurs="1" maxOccurs="1" ref="ModuleType"/>
116 <xs:element minOccurs="1" maxOccurs="1" ref="ComponentType"/>
117 <xs:choice>
118 <xs:element minOccurs="0" maxOccurs="1" ref="Guid"/>
119 <!-- Guid needs to be removed -->
120 <xs:element minOccurs="0" maxOccurs="1" ref="GuidValue"/>
121 <!-- GuidValue needs to be required -->
122 </xs:choice>
123 <xs:element minOccurs="1" maxOccurs="1" ref="Version"/>
124 <xs:element minOccurs="1" maxOccurs="1" ref="Abstract"/>
125 <xs:element minOccurs="1" maxOccurs="1" ref="Description"/>
126 <xs:element minOccurs="1" maxOccurs="1" ref="Copyright"/>
127 <xs:element minOccurs="1" maxOccurs="1" ref="License"/>
128 <xs:choice minOccurs="1" maxOccurs="1">
129 <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>
130 <!-- Created needs to be removed -->
131 <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>
132 <!-- CreatedDate needs to be required -->
133 </xs:choice>
134 <xs:choice>
135 <xs:element minOccurs="0" maxOccurs="1" ref="Updated"/>
136 <!-- Updated needs to be removed -->
137 <xs:element minOccurs="0" maxOccurs="1" ref="ModifiedDate"/>
138 </xs:choice>
139 <xs:element minOccurs="0" maxOccurs="1" ref="Specification"/>
140 <!-- Specification needs to be required - FRAMEWORK_BUILD_PACKAGING_SPECIFICATION 0x00090000 -->
141 </xs:sequence>
142 </xs:complexType>
143 </xs:element>
144 <xs:element name="MsaLibHeader">
145 <!-- MsaLibHeader needs to be removed -->
146 <xs:annotation>
147 <xs:documentation xml:lang="en">DO NOT USE! This is the Library Module Surface Area Description Header - a replacement for INF files. The Guid may change when the contents of the file are changed.</xs:documentation>
148 </xs:annotation>
149 <xs:complexType>
150 <xs:sequence>
151 <xs:element minOccurs="1" maxOccurs="1" ref="BaseName"/>
152 <xs:element minOccurs="1" maxOccurs="1" ref="ModuleType"/>
153 <xs:element minOccurs="1" maxOccurs="1" ref="ComponentType"/>
154 <xs:element minOccurs="1" maxOccurs="1" ref="Guid"/>
155 <xs:element minOccurs="1" maxOccurs="1" ref="Version"/>
156 <xs:element minOccurs="1" maxOccurs="1" ref="Abstract"/>
157 <xs:element minOccurs="1" maxOccurs="1" ref="Description"/>
158 <xs:element minOccurs="1" maxOccurs="1" ref="Copyright"/>
159 <xs:element minOccurs="1" maxOccurs="1" ref="License"/>
160 <xs:choice minOccurs="1" maxOccurs="1">
161 <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>
162 <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>
163 </xs:choice>
164 <xs:element minOccurs="0" maxOccurs="1" ref="Updated"/>
165 <xs:element minOccurs="0" maxOccurs="1" ref="Specification"/>
166 </xs:sequence>
167 </xs:complexType>
168 </xs:element>
169 <xs:element name="PlatformHeader">
170 <xs:annotation>
171 <xs:documentation xml:lang="en">This head is for the Framework Platform Description file (FPD.)</xs:documentation>
172 </xs:annotation>
173 <xs:complexType>
174 <xs:sequence>
175 <xs:element minOccurs="1" maxOccurs="1" name="PlatformName" type="PlatformNamingConvention"/>
176 <xs:choice>
177 <xs:element minOccurs="0" maxOccurs="1" ref="Guid"/>
178 <!-- DO NOT USE Guid needs to be removed -->
179 <xs:element minOccurs="0" maxOccurs="1" ref="GuidValue"/>
180 <!-- GuidValue needs to be required -->
181 </xs:choice>
182 <xs:element minOccurs="0" maxOccurs="1" ref="Version"/>
183 <xs:element minOccurs="1" maxOccurs="1" ref="Abstract"/>
184 <xs:element minOccurs="1" maxOccurs="1" ref="Description"/>
185 <xs:element minOccurs="0" maxOccurs="1" ref="Copyright"/>
186 <xs:element minOccurs="0" maxOccurs="1" ref="License"/>
187 <xs:choice minOccurs="1" maxOccurs="1">
188 <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>
189 <!-- DO NOT USE Created needs to be removed -->
190 <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>
191 <!-- CreatedDate needs to be required -->
192 </xs:choice>
193 <xs:element minOccurs="0" maxOccurs="1" ref="CreatedBy"/>
194 <!-- DO NOT USE CreatedBy needs to be removed -->
195 <xs:choice>
196 <xs:element minOccurs="0" maxOccurs="1" ref="Updated"/>
197 <!-- DO NOT USE Updated needs to be removed -->
198 <xs:element minOccurs="0" maxOccurs="1" ref="ModifiedDate"/>
199 </xs:choice>
200 <xs:element minOccurs="0" maxOccurs="1" ref="PackageType"/>
201 <!-- DO NOT USE PackageType needs to be removed -->
202 <xs:element minOccurs="0" maxOccurs="1" name="BuildTarget" type="BuildTargets"/>
203 <xs:element minOccurs="0" maxOccurs="unbounded" ref="Specification"/>
204 <!-- Specification needs to be required - FRAMEWORK_BUILD_PACKAGING_SPECIFICATION 0x00090000 -->
205 </xs:sequence>
206 </xs:complexType>
207 </xs:element>
208 <xs:element name="SpdHeader">
209 <xs:annotation>
210 <xs:documentation xml:lang="en">This head is for the Surface Area Package Description file (SPD) The Guid may change when the contents of the file are changed.</xs:documentation>
211 </xs:annotation>
212 <xs:complexType>
213 <xs:sequence>
214 <xs:element minOccurs="1" maxOccurs="1" ref="PackageName"/>
215 <xs:choice minOccurs="1" maxOccurs="1">
216 <xs:element minOccurs="0" maxOccurs="1" ref="Guid"/>
217 <!-- Guid needs to be removed -->
218 <xs:element minOccurs="0" maxOccurs="1" ref="GuidValue"/>
219 <!-- GuidValue needs to be required -->
220 </xs:choice>
221 <xs:element minOccurs="1" maxOccurs="1" ref="Version"/>
222 <xs:element minOccurs="1" maxOccurs="1" ref="Abstract"/>
223 <xs:element minOccurs="1" maxOccurs="1" ref="Description"/>
224 <xs:element minOccurs="1" maxOccurs="1" ref="Copyright"/>
225 <xs:element minOccurs="1" maxOccurs="1" ref="License"/>
226 <xs:choice minOccurs="1" maxOccurs="1">
227 <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>
228 <!-- Created needs to be removed -->
229 <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>
230 <!-- CreatedDate needs to be required -->
231 </xs:choice>
232 <xs:element minOccurs="0" maxOccurs="1" ref="E-Mail"/>
233 <xs:choice minOccurs="0" maxOccurs="1">
234 <xs:element minOccurs="0" maxOccurs="1" ref="Updated"/>
235 <!-- Created needs to be removed -->
236 <xs:element minOccurs="0" maxOccurs="1" ref="ModifiedDate"/>
237 <!-- CreatedDate needs to be required -->
238 </xs:choice>
239 <xs:element minOccurs="0" maxOccurs="1" ref="URL"/>
240 <xs:element minOccurs="1" maxOccurs="1" ref="PackageType"/>
241 <xs:element minOccurs="0" maxOccurs="1" ref="ReadOnly"/>
242 <xs:element minOccurs="0" maxOccurs="1" ref="RePackage"/>
243 <xs:element minOccurs="0" maxOccurs="unbounded" ref="Specification"/>
244 <!-- Specification needs to be required - FRAMEWORK_BUILD_PACKAGING_SPECIFICATION 0x00090000 -->
245 <xs:element minOccurs="0" maxOccurs="1" ref="OutputDirectory"/>
246 <!-- OutputDirectory needs to be removed -->
247 </xs:sequence>
248 </xs:complexType>
249 </xs:element>
250 </xs:schema>