176 |
<h2>The <code>DocumentXDoctype</code> Interface</h2> |
<h2>The <code>DocumentXDoctype</code> Interface</h2> |
177 |
|
|
178 |
<pre class=idl><code>interface <dfn id=DocumentXDoctype><code>DocumentXDoctype</code></dfn> { |
<pre class=idl><code>interface <dfn id=DocumentXDoctype><code>DocumentXDoctype</code></dfn> { |
179 |
|
DocumentType <a href="#createDocumentTypeDefinition">createDocumentTypeDefinition</a> |
180 |
|
(in DOMString <a href="#createDocumentTypeDefinition-name"><var>name</var></a>) |
181 |
|
raises (DOMException); |
182 |
|
ElementTypeDefinition <a href="#createElementTypeDefinition">createElementTypeDefinition</a> |
183 |
|
(in DOMString <a href="#createElementTypeDefinition-name"><var>name</var></a>) |
184 |
|
raises (DOMException); |
185 |
|
AttributeDefinition <a href="#createAttributeDefinition">createAttributeDefinition</a> |
186 |
|
(in DOMString <a href="#createAttributeDefinition-name"><var>name</var></a>) |
187 |
|
raises (DOMException); |
188 |
|
Entity <a href="#createGeneralEntity">createGeneralEntityDefinition</a> |
189 |
|
(in DOMString <a href="#createGeneralEntity-name"><var>name</var></a>) |
190 |
|
raises (DOMException); |
191 |
|
Notation <a href="#createNotation">createNotation</a> |
192 |
|
(in DOMString <a href="#createNotation-name"><var>name</var></a>) |
193 |
|
raises (DOMException); |
194 |
}</code></pre> |
}</code></pre> |
195 |
|
|
196 |
<pre class=ed> |
<div class=ed>@@ cast definition</div> |
|
* The [CODE(DOMi)@en[DocumentXDoctype]] Interface Specification |
|
197 |
|
|
198 |
[1] [[manakai//DOM Extensions]] > New Interfaces > |
<dl> |
199 |
[[DOM XML Document Type Definition]] module > |
<dt><dfn id=createDocumentTypeDefinition class=dom-method><code>createDocumentTypeDefinition</code></dfn>, |
200 |
The [CODE(DOMi)@en[[[DocumentXDoctype]]]] Interface |
method</dt> |
201 |
|
<dd> |
202 |
[2] |
<p>This method creates a <code>DocumentType</code> node with the specified |
203 |
@@ cast |
name, belonging to the document.</p> |
204 |
|
<p>The <dfn id=createDocumentTypeDefinition-name class=dom-param><var>name</var></dfn> |
205 |
** Constructors |
parameter is the name of the document type.</p> |
206 |
|
|
207 |
[3] The |
<p>When invoked, the method <em class=rfc2119>MUST</em> create and |
208 |
[DFN@en[[CODE(DOMm)@en[[[createDocumentTypeDefinition]]]] method]] |
return a <code>DocumentType</code> node with the following attributes:</p> |
209 |
returns a [CODE(DOMi)@en[[[DocumentType]]]] node |
<dl> |
210 |
or raises a [CODE(DOMi)@en[[[DOMException]]]]. |
<dt><code>attributes</code>, <code>parentNode</code></dt> |
211 |
It creates a [CODE(DOMi)@en[[[DocumentType]]]] node |
<dd><code>null</code>.</dd> |
212 |
of the given name, belonging to the document. |
<dt><code>elementTypes</code>, <code>generalEntities</code>, and |
213 |
|
<code>notations</code></dt> |
214 |
[3] The |
<dd>Empty <code>NamedNodeMap</code> objects.</dd> |
215 |
[DFN@en[[CODE(DOMm)@en[[[createElementTypeDefinition]]]] method]] |
<dt><code>entities</code></dt> |
216 |
returns an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] node |
<dd>The same value as the <code>generalEntities</code> attribute.</dd> |
217 |
or raises a [CODE(DOMi)@en[[[DOMException]]]]. |
<dt><code>childNodes</code></dt> |
218 |
It creates an [CODE(DOMi)@en[[[ElementTypeDefinition]]]] node |
<dd>An empty <code>NodeList</code> object.</dd> |
219 |
of the given name, belonging to the document. |
<dt><code>internalSubset</code>, <code>publicId</code>, and |
220 |
|
<code>systemId</code></dt> |
221 |
[4] The |
<dd>Empty strings.</dd> |
222 |
[DFN@en[[CODE(DOMm)@en[[[createAttributeDefinition]]]] method]] |
<dt><code>manakaiReadOnly</code> <span class=ed>[manakai]</span></dt> |
223 |
returns an [CODE(DOMi)@en[[[AttributeDefinition]]]] node |
<dd><code>false</code>.</dd> |
224 |
or raises a [CODE(DOMi)@en[[[DOMException]]]]. |
<dt><code>nodeName</code></dt> |
225 |
It creates an [CODE(DOMi)@en[[[AttributeDefinition]]]] node |
<dd><a href="#createDocumentTypeDefinition-name"><var>name</var></a>.</dd> |
226 |
of the given name, belonging to the document. |
<dt><code>ownerDocument</code></dt> |
227 |
|
<dd>The <code>Document</code> over which the method is invoked.</dd> |
228 |
[10] The |
</dl> |
229 |
[DFN@en[[CODE(DOMm)@en[[[createGeneralEntity]]]] method]] |
<p>In addition, the method <em class=rfc2119>MUST</em> be marked as |
230 |
returns an [CODE(DOMi)@en[[[Entity]]]] node |
containing five general entity declarations: <code>amp</code>, |
231 |
or raises a [CODE(DOMi)@en[[[DOMException]]]]. |
<code>lt</code>, <code>gt</code>, <code>quot</code>, and |
232 |
It creates an [CODE(DOMi)@en[[[Entity]]]] node, |
<code>apos</code>.</p> |
233 |
which represents a general entity, |
</dd> |
234 |
of the given name, belonging to the document. |
<dt><dfn id=createElementTypeDefinition class=dom-method><code>createElementTypeDefinition</code></dfn>, |
235 |
|
method</dt> |
236 |
[12] The |
<dd> |
237 |
[DFN@en[[CODE(DOMm)@en[[[createNotation]]]] method]] |
<p>This method creates a <code>ElementTypeDefinition</code> node with the |
238 |
returns a [CODE(DOMi)@en[[[Notation]]]] node |
specified name, belonging to the document.</p> |
239 |
or raises a [CODE(DOMi)@en[[[DOMException]]]]. |
<p>The <dfn id=createElementTypeDefinition-name class=dom-param><var>name</var></dfn> |
240 |
It creates a [CODE(DOMi)@en[[[Notation]]]] node |
parameter is the name of the element type defined by the element |
241 |
of the given name, belonging to the document. |
type definition.</p> |
242 |
|
|
243 |
[5] |
<p>When invoked, the method <em class=rfc2119>MUST</em> create and |
244 |
These method take a parameter [CODE(DOMp)@en[[[name]]]], |
return an |
245 |
of type [CODE(DOMi)@en[[[DOMString]]]]. It is |
<a href="#ElementTypeDefinition"><code>ElementTypeDefinition</code></a> |
246 |
the document type name, element type name, |
node with the following attributes:</p> |
247 |
or attribute name of the node to be created. |
<dl> |
248 |
|
<dt><a href="#attributeDefinitions"><code>attributeDefinitions</code></a></dt> |
249 |
[6] |
<dd>An empty <code>NamedNodeMap</code> object.</dd> |
250 |
The [CODE(DOMm)@en[[[createDocumentTypeDefinition]]]] |
<dt><code>attributes</code>, <code>parentNode</code></dt> |
251 |
method [['''MUST''']] create a [CODE(DOMi)@en[[[DocumentType]]]] |
<dd><code>null</code>.</dd> |
252 |
object with the following attribute values: |
<dt><code>childNodes</code></dt> |
253 |
- [CODE(DOMa)@en[[[attributes]]]], |
<dd>An empty <code>NodeList</code> object.</dd> |
254 |
[CODE(DOMa)@en[[[parentNode]]]]: [CODE(DOM)@en[[[null]]]]. |
<dt><code>manakaiReadOnly</code> <span class=ed>[manakai]</span></dt> |
255 |
- [CODE(DOMa)@en[[[elementTypes]]]], |
<dd><code>false</code>.</dd> |
256 |
[CODE(DOMa)@en[[[generalEntities]]]], |
<dt><code>nodeName</code></dt> |
257 |
[CODE(DOMa)@en[[[notations]]]]: Empty |
<dd><a href="#createElementTypeDefinition-name"><var>name</var></a>.</dd> |
258 |
[CODE(DOMi)@en[[[NamedNodeMap]]]]s. |
<dt><code>ownerDocument</code></dt> |
259 |
- [CODE(DOMa)@en[[[childNodes]]]]: An empty |
<dd>The <code>Document</code> node over which the method is invoked.</dd> |
260 |
[CODE(DOMi)@en[[[NodeList]]]]. |
<dt><a href="#ownerDocumentTypeDefinition"><code>ownerDocumentTypeDefinition</code></a></dt> |
261 |
- [CODE(DOMa)@en[[[entities]]]]: The same |
<dd><code>null</code>.</dd> |
262 |
[CODE(DOMi)@en[[[NamedNodeMap]]]] as |
<dt class=ed>@@ Ensure all attributes are defined</dt> |
263 |
[CODE(DOMa)@en[[[generalEntities]]]]. |
</dl> |
264 |
- [CODE(DOMa)@en[[[internalSubset]]]], |
</dd> |
265 |
[CODE(DOMa)@en[[[publicId]]]], [CODE(DOMa)@en[[[systemId]]]]: |
<dt><dfn id=createAttributeDefinition class=dom-method><code>createAttributeDefinition</code></dfn>, |
266 |
Empty strings. |
method</dt> |
267 |
- [CODE(DOMa)@en[[[manakaiReadOnly]]]]: |
<dd> |
268 |
[CODE(IDL)@en[[[false]]]]. |
<p>This method creates a <code>AttributeDefinition</code> node with the |
269 |
- [CODE(DOMa)@en[[[nodeName]]]]: [CODE(DOMp)@en[[[name]]]]. |
specified name, belonging to the document.</p> |
270 |
- [CODE(DOMa)@en[[[ownerDocument]]]]: The |
<p>The <dfn id=createAttributeDefinition-name class=dom-param><var>name</var></dfn> |
271 |
[CODE(DOMi)@en[[[Document]]]] node on which the method |
parameter is the name of the attribute defined by the attribute |
272 |
is invoked. |
definition.</p> |
273 |
|
|
274 |
In addition, it [['''MUST''']] be marked as containing |
<p>When invoked, the method <em class=rfc2119>MUST</em> create and |
275 |
five general entity declarations for XML predefined |
return an |
276 |
entities, i.e. [CODE(XML)@en[[[amp]]]], [CODE(XML)@en[[[lt]]]], |
<a href="#AttributeDefinition"><code>AttributeDefinition</code></a> |
277 |
[CODE(XML)@en[[[gt]]]], [CODE(XML)@en[[[quot]]]], and |
node with the following attributes:</p> |
278 |
[CODE(XML)@en[[[apos]]]]. |
<dl> |
279 |
|
<dt><code>allowedTokens</code></dt> |
280 |
[8] |
<dd>An empty <code>DOMStringList</code> object.</dd> |
281 |
The [CODE(DOMm)@en[[[createElementTypeDefinition]]]] |
<dt><code>attributes</code>, |
282 |
method [['''MUST''']] create an |
<a href="#ownerElementTypeDefinition"><code>ownerElementTypeDefinition</code></a>, |
283 |
[CODE(DOMi)@en[[[ElementTypeDefinition]]]] |
and <code>parentNode</code></dt> |
284 |
object with the following attribute values: |
<dd><code>null</code>.</dd> |
285 |
- [CODE(DOMa)@en[[[attributeDefinitions]]]]: |
<dt><code>childNodes</code></dt> |
286 |
An empty [CODE(DOMi)@en[[[NamedNodeMap]]]]. |
<dd>An empty <code>NodeList</code> object.</dd> |
287 |
- [CODE(DOMa)@en[[[attributes]]]], |
<dt><code>declaredType</code></dt> |
288 |
[CODE(DOMa)@en[[[parentNode]]]]: [CODE(DOM)@en[[[null]]]]. |
<dd><a href="#NO_TYPE_ATTR"><code>NO_TYPE_ATTR</code></a>.</dd> |
289 |
- [CODE(DOMa)@en[[[childNodes]]]]: An empty |
<dt><code>defaultType</code></dt> |
290 |
[CODE(DOMi)@en[[[NodeList]]]]. |
<dd><a href="#UNKNOWN_DEFAULT"><code>UNKNOWN_DEFAULT</code></a>.</dd> |
291 |
- [CODE(DOMa)@en[[[manakaiReadOnly]]]]: |
<dt><code>manakaiReadOnly</code> <span class=ed>[manakai]</span></dt> |
292 |
[CODE(IDL)@en[[[false]]]]. |
<dd><code>false</code>.</dd> |
293 |
- [CODE(DOMa)@en[[[nodeName]]]]: [CODE(DOMp)@en[[[name]]]]. |
<dt><code>nodeName</code></dt> |
294 |
- [CODE(DOMa)@en[[[ownerDocument]]]]: The |
<dd><a href="#createAttributeDefinition-name"><var>name</var></a>.</dd> |
295 |
[CODE(DOMi)@en[[[Document]]]] node on which the method |
<dt><code>ownerDocument</code></dt> |
296 |
is invoked. |
<dd>The <code>Document</code> node over which the method is invoked.</dd> |
297 |
- [CODE(DOMa)@en[[[ownerDocumentTypeDefinition]]]]: |
<dt class=ed>@@ Ensure all attributes are defined</dt> |
298 |
[CODE(IDL)@en[[[null]]]]. |
</dl> |
299 |
|
|
300 |
@@ Ensure all attributes are defined |
<div class=ed> |
301 |
|
<p>@@ Should we keep these statements?: |
302 |
[9] The [CODE(DOMm)@en[[[createAttributeDefinition]]]] |
However, if the <cfg::cfg|xml-id> configuration |
303 |
method [['''MUST''']] create an |
parameter is set to <code>true</code> and the <var>name</var> |
304 |
[CODE(DOMi)@en[[[AttributeDefinition]]]] |
is <code>xml:id</code>, then the [CODE(DOMa)@en[[[declaredType]]]] |
305 |
object with the following attribute values: |
attribute is set to <code>ID_ATTR</code>. |
306 |
- [CODE(DOMa)@en[[[allowedTokens]]]]: |
[CODE(DOMa)@en[[[defaultType]]]]?</p> |
307 |
An empty [CODE(DOMi)@en[[[DOMStringList]]]]. |
</div> |
308 |
- [CODE(DOMa)@en[[[attributes]]]], |
</dd> |
309 |
[CODE(DOMa)@en[[[parentNode]]]]: [CODE(DOM)@en[[[null]]]]. |
<dt><dfn id=createGeneralEntity class=dom-method><code>createGeneralEntity</code></dfn>, |
310 |
- [CODE(DOMa)@en[[[childNodes]]]]: An empty |
method</dt> |
311 |
[CODE(DOMi)@en[[[NodeList]]]]. |
<dd> |
312 |
- [CODE(DOMa)@en[[[declaredType]]]]: |
<p>This method creates a <code>Entity</code> node with the |
313 |
[CODE(DOMc)@en[[[NO_TYPE_ATTR]]]]. |
specified name, which represents a general entity, belonging to the |
314 |
- [CODE(DOMa)@en[[[defaultType]]]]: |
document.</p> |
315 |
[CODE(DOMc)@en[[[UNKNOWN_DEFAULT]]]]. |
<p>The <dfn id=createGeneralEntity-name class=dom-param><var>name</var></dfn> |
316 |
- [CODE(DOMa)@en[[[manakaiReadOnly]]]]: |
parameter is the name of the general entity.</p> |
317 |
[CODE(IDL)@en[[[false]]]]. |
</dd> |
318 |
- [CODE(DOMa)@en[[[nodeName]]]]: [CODE(DOMp)@en[[[name]]]]. |
<dt><dfn id=createNotation class=dom-method><code>createNotation</code></dfn>, |
319 |
- [CODE(DOMa)@en[[[ownerDocument]]]]: The |
method</dt> |
320 |
[CODE(DOMi)@en[[[Document]]]] node on which the method |
<dd> |
321 |
is invoked. |
<p>This method creates a <code>Notation</code> node with the |
322 |
- [CODE(DOMa)@en[[[ownerElementTypeDefinition]]]]: |
specified name, belonging to the document.</p> |
323 |
[CODE(IDL)@en[[[null]]]]. |
<p>The <dfn id=createNotation-name class=dom-param><var>name</var></dfn> |
324 |
|
parameter is the name of the notation.</p> |
325 |
@@ Ensure all attributes are defined |
</dd> |
326 |
|
</dl> |
|
@@ Should we keep these statements?: |
|
|
However, if the <cfg::cfg|xml-id> configuration |
|
|
parameter is set to <DOM::true> and the <P::name> |
|
|
is <XA::xml:id>, then the [CODE(DOMa)@en[[[declaredType]]]] |
|
|
attribute is set to |
|
|
<C::AttributeDefinition.ID_ATTR>. |
|
|
[CODE(DOMa)@en[[[defaultType]]]]? |
|
327 |
|
|
328 |
|
<pre class=ed> |
329 |
[11] The [CODE(DOMm)@en[[[createGeneralEntity]]]] |
[11] The [CODE(DOMm)@en[[[createGeneralEntity]]]] |
330 |
method [['''MUST''']] create an [CODE(DOMi)@en[[[Entity]]]] |
method [['''MUST''']] create an [CODE(DOMi)@en[[[Entity]]]] |
331 |
node with the following attribute values: |
node with the following attribute values: |