MFB: Upgrade to the new-reference-structure

- Moved the intro from reference.xml to book.xml
    - Change the intro ID to intro.<extname>
    - Added setup <chapter>
    - Changed the constants section to be <appendix>


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@248356 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hannes Magnusson 2007-12-16 13:10:43 +00:00
parent c4cc4cbda2
commit 7fde5c7d75
22 changed files with 2989 additions and 6 deletions

123
reference/dom/book.xml Normal file
View file

@ -0,0 +1,123 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- Purpose: xml -->
<!-- Membership: bundled, external -->
<book xml:id="book.dom" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>DOM Extension</title>
<titleabbrev>DOM</titleabbrev>
<preface xml:id="intro.dom">
&reftitle.intro;
<para>
The DOM extension allows you to operate on XML documents through the DOM
API with PHP 5.
</para>
<para>
For PHP 4, use <link linkend="ref.domxml">DOM XML</link>.
</para>
<note>
<para>
DOM extension uses UTF-8 encoding. Use <function>utf8_encode</function>
and <function>utf8_decode</function> to work with texts in ISO-8859-1
encoding or <link linkend="ref.iconv">Iconv</link> for other encodings.
</para>
</note>
</preface>
&reference.dom.setup;
&reference.dom.constants;
<!--
<reference xml:id="functions.dom" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>DOM &Functions;</title>
&reference.dom.entities.functions;
</reference>
-->
&reference.dom.domattr;
&reference.dom.domcharacterdata;
&reference.dom.domcomment;
&reference.dom.domdocument;
&reference.dom.domdocumentfragment;
&reference.dom.domdocumenttype;
&reference.dom.domelement;
&reference.dom.domentity;
&reference.dom.domentityreference;
&reference.dom.domexception;
&reference.dom.domimplementation;
&reference.dom.domnamednodemap;
&reference.dom.domnode;
&reference.dom.domnodelist;
&reference.dom.domnotation;
&reference.dom.domprocessinginstruction;
&reference.dom.domtext;
&reference.dom.domxpath;
<!-- FIXME:
<section xml:id='dom.class.domnamelist'>
<title><classname>DOMNameList</classname></title>
<para>
</para>
<section xml:id='dom.class.domnamelist.methods'>
&reftitle.methods;
<itemizedlist>
<listitem>
<para><xref linkend='function.dom-domnamelist-getname' /> - </para>
</listitem>
<listitem>
<para><xref linkend='function.dom-domnamelist-getnamespaceuri' /> - </para>
</listitem>
</itemizedlist>
</section>
<section xml:id='dom.class.domnamelist.properties'>
&reftitle.properties;
<table>
<title/>
<tgroup cols="4">
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>Read-only</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>length</entry>
<entry>int</entry>
<entry>yes</entry>
<entry>
The number of pairs (name and namespaceURI) in the list. The range
of valid child node indices is 0 to <literal>length - 1</literal>
inclusive.
</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
</section>-->
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<section xml:id="dom.constants" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.4 $ -->
<chapter xml:id="dom.constants" xmlns="http://docbook.org/ns/docbook">
&reftitle.constants;
&extension.constants;
<table>
@ -405,7 +405,7 @@
</tbody>
</tgroup>
</table>
</section>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:

160
reference/dom/domattr.xml Normal file
View file

@ -0,0 +1,160 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<reference xml:id="class.domattr" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The <classname>DOMAttr</classname> class</title>
<titleabbrev>DOMAttr</titleabbrev>
<partintro>
<!-- {{{ DOMAttr intro -->
<section xml:id="domattr.intro">
&reftitle.intro;
<para>
<classname>DOMAttr</classname> represents an attribute in the
<classname>DOMElement</classname> object.
</para>
</section>
<!-- }}} -->
<section xml:id="domattr.synopsis">
<title>Class synopsis</title>
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>DOMAttr</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>DOMAttr</classname>
</ooclass>
<!-- If the class extends another one, use this -->
<ooclass>
<modifier>extends</modifier>
<classname>DOMNode</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<!-- If the property is documented below (xml:id=classname.props) use this -->
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>string</type>
<varname linkend="domattr.props.name">name</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>DOMElement</type>
<varname linkend="domattr.props.ownerelement">ownerElement</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>bool</type>
<varname linkend="domattr.props.schematypeinfo">schemaTypeInfo</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>bool</type>
<varname linkend="domattr.props.specified">specified</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domattr.props.value">value</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domattr')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<!-- Again, if the class extends a class use this -->
<classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ ClassName properties -->
<section xml:id="domattr.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="domattr.props.name">
<term><varname>name</varname></term>
<listitem>
<para>The name of the attribute</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domattr.props.ownerelement">
<term><varname>ownerElement</varname></term>
<listitem>
<para>The element which contains the attribute</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domattr.props.schematypeinfo">
<term><varname>schemaTypeInfo</varname></term>
<listitem>
<para>Not implemented yet, always is &null;</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domattr.props.specified">
<term><varname>specified</varname></term>
<listitem>
<para>Not implemented yet, always is &null;</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domattr.props.value">
<term><varname>value</varname></term>
<listitem>
<para>The value of the attribute</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ See also -->
<section role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link xlink:href="&spec.dom3.attr;">W3C specification of Attr</link></member>
</simplelist>
</para>
</section>
<!-- }}} -->
</partintro>
&reference.dom.entities.domattr;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,122 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<reference xml:id="class.domcharacterdata" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The DOMCharacterData class</title>
<titleabbrev>DOMCharacterData</titleabbrev>
<partintro>
<!-- {{{ DOMCharacterData intro -->
<section xml:id="domcharacterdata.intro">
&reftitle.intro;
<para>
Represents nodes with character data. No nodes directly correspond to
this class, but other nodes do inherit from it.
</para>
</section>
<!-- }}} -->
<section xml:id="domcharacterdata.synopsis">
<title>Class synopsis</title>
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>DOMCharacterData</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>DOMCharacterData</classname>
</ooclass>
<!-- If the class extends another one, use this -->
<ooclass>
<modifier>extends</modifier>
<classname>DOMNode</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<!-- If the property is documented below (xml:id=domcharacterdata.props) use this -->
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domcharacterdata.props.data">data</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>int</type>
<varname linkend="domcharacterdata.props.length">length</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domcharacterdata')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<!-- Again, if the class extends a class use this -->
<classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ DOMCharacterData properties -->
<section xml:id="domcharacterdata.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="domcharacterdata.props.data">
<term><varname>data</varname></term>
<listitem>
<para>The contents of the node.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domcharacterdata.props.length">
<term><varname>length</varname></term>
<listitem>
<para>The length of the contents.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<section role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link xlink:href="&spec.dom3.characterdata;">W3C specification of CharacterData</link></member>
</simplelist>
</para>
</section>
</partintro>
&reference.dom.entities.domcharacterdata;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,88 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<reference xml:id="class.domcomment" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The DOMComment class</title>
<titleabbrev>DOMComment</titleabbrev>
<partintro>
<!-- {{{ DOMComment intro -->
<section xml:id="domcomment.intro">
&reftitle.intro;
<para>
Represents comment nodes, characters delimited by <code>&lt;!--</code>
and <code>--&gt;</code>.
</para>
</section>
<!-- }}} -->
<section xml:id="domcomment.synopsis">
<title>Class synopsis</title>
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>DOMComment</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>DOMComment</classname>
</ooclass>
<!-- If the class extends another one, use this -->
<ooclass>
<modifier>extends</modifier>
<classname>DOMCharacterData</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domcomment')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<!-- Again, if the class extends a class use this -->
<classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domcharacterdata')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<section role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link xlink:href="&spec.dom3.comment;">W3C specification of Comment</link></member>
</simplelist>
</para>
</section>
</partintro>
&reference.dom.entities.domcomment;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,368 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<reference xml:id="class.domdocument" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The DOMDocument class</title>
<titleabbrev>DOMDocument</titleabbrev>
<partintro>
<!-- {{{ DOMDocument intro -->
<section xml:id="domdocument.intro">
&reftitle.intro;
<para>
Represents an entire HTML or XML document; serves as the root of the
document tree.
</para>
</section>
<!-- }}} -->
<section xml:id="domdocument.synopsis">
<title>Class synopsis</title>
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>DOMDocument</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>DOMDocument</classname>
</ooclass>
<!-- If the class extends another one, use this -->
<ooclass>
<modifier>extends</modifier>
<classname>DOMNode</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<!-- If the property is documented below (xml:id=domdocument.props) use this -->
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domdocument.props.actualencoding">actualEncoding</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>DOMConfiguration</type>
<varname linkend="domdocument.props.config">config</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>DOMDocumentType</type>
<varname linkend="domdocument.props.doctype">doctype</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>DOMElement</type>
<varname linkend="domdocument.props.documentelement">documentElement</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domdocument.props.documenturi">documentURI</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domdocument.props.encoding">encoding</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="domdocument.props.formatoutput">formatOutput</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>DOMImplementation</type>
<varname linkend="domdocument.props.implementation">implementation</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="domdocument.props.preservewhitespace">preserveWhiteSpace</varname>
<initializer>true</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="domdocument.props.recover">recover</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="domdocument.props.resolveexternals">resolveExternals</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="domdocument.props.standalone">standalone</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="domdocument.props.stricterrorchecking">strictErrorChecking</varname>
<initializer>true</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="domdocument.props.substituteentities">substituteEntities</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="domdocument.props.validateonparse">validateOnParse</varname>
<initializer>false</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domdocument.props.version">version</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domdocument.props.xmlencoding">xmlEncoding</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="domdocument.props.xmlstandalone">xmlStandalone</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domdocument.props.xmlversion">xmlVersion</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domdocument')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<!-- Again, if the class extends a class use this -->
<classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ DOMDocument properties -->
<section xml:id="domdocument.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="domdocument.props.actualencoding">
<term><varname>actualEncoding</varname></term>
<listitem>
<para>
<emphasis>Deprecated</emphasis>. Actual encoding of the document,
is a readonly equivalent to
<varname linkend="domdocument.props.encoding">encoding</varname>.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.config">
<term><varname>config</varname></term>
<listitem>
<para>
<emphasis>Deprecated</emphasis>. Configuration used when
<function>DOMDocument::normalizeDocument</function> is
invoked.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.doctype">
<term><varname>doctype</varname></term>
<listitem>
<para>The Document Type Declaration associated with this document.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.documentelement">
<term><varname>documentElement</varname></term>
<listitem>
<para>
This is a convenience attribute that allows direct access to the
child node that is the document element of the document.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.documenturi">
<term><varname>documentURI</varname></term>
<listitem>
<para>The location of the document or &null; if undefined.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.encoding">
<term><varname>encoding</varname></term>
<listitem>
<para>
Encoding of the document, as specified by the XML declaration. This
attribute is not present in the final DOM Level 3 specification, but
is the only way of manipulating XML document encoding in this
implementation.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.formatoutput">
<term><varname>formatOutput</varname></term>
<listitem>
<para>Nicely formats output with indentation and extra space.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.implementation">
<term><varname>implementation</varname></term>
<listitem>
<para>
The <classname>DOMImplementation</classname> object that handles
this document.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.preservewhitespace">
<term><varname>preserveWhiteSpace</varname></term>
<listitem>
<para>Do not remove redundant white space. Default to &true;.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.recover">
<term><varname>recover</varname></term>
<listitem>
<para>
<emphasis>Proprietary</emphasis>. Enables recovery mode, i.e. trying
to parse non-well formed documents. This attribute is not part of
the DOM specification and is specific to libxml.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.resolveexternals">
<term><varname>resolveExternals</varname></term>
<listitem>
<para>
Set it to &true; to load external entities from a doctype
declaration. This is useful for including character entities in
your XML document.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.standalone">
<term><varname>standalone</varname></term>
<listitem>
<para>
<emphasis>Deprecated</emphasis>. Whether or not the document is
standalone, as specified by the XML declaration, corresponds to
<varname linkend="domdocument.props.xmlstandalone">xmlStandalone</varname>.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.stricterrorchecking">
<term><varname>strictErrorChecking</varname></term>
<listitem>
<para>Throws <classname>DOMException</classname> on errors. Default to &true;.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.substituteentities">
<term><varname>substituteEntities</varname></term>
<listitem>
<para>
<emphasis>Proprietary</emphasis>. Whether or not to substitute
entities. This attribute is not part of
the DOM specification and is specific to libxml.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.validateonparse">
<term><varname>validateOnParse</varname></term>
<listitem>
<para>Loads and validates against the DTD. Default to &false;.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.version">
<term><varname>version</varname></term>
<listitem>
<para>
<emphasis>Deprecated</emphasis>. Version of XML, corresponds to
<varname linkend="domdocument.props.xmlversion">xmlVersion</varname>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.xmlencoding">
<term><varname>xmlEncoding</varname></term>
<listitem>
<para>
An attribute specifying, as part of the XML declaration, the
encoding of this document. This is &null; when unspecified or when it
is not known, such as when the Document was created in memory.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.xmlstandalone">
<term><varname>xmlStandalone</varname></term>
<listitem>
<para>
An attribute specifying, as part of the XML declaration, whether
this document is standalone. This is &false; when unspecified.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocument.props.xmlversion">
<term><varname>xmlVersion</varname></term>
<listitem>
<para>
An attribute specifying, as part of the XML declaration, the
version number of this document. If there is no declaration and if
this document supports the "XML" feature, the value is "1.0".
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ See also -->
<section role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link xlink:href="&spec.dom3.document;">W3C specification for Document</link></member>
</simplelist>
</para>
</section>
<!-- }}} -->
</partintro>
&reference.dom.entities.domdocument;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,119 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<reference xml:id="class.domdocumentfragment" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The DOMDocumentFragment class</title>
<titleabbrev>DOMDocumentFragment</titleabbrev>
<partintro>
<!-- {{{ DOMDocumentFragment intro -->
<!--
<section xml:id="domdocumentfragment.intro">
&reftitle.intro;
<para>
Description of the class.
</para>
</section>
-->
<!-- }}} -->
<section xml:id="domdocumentfragment.synopsis">
<title>Class synopsis</title>
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>DOMDocumentFragment</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>DOMDocumentFragment</classname>
</ooclass>
<!-- If the class extends another one, use this -->
<ooclass>
<modifier>extends</modifier>
<classname>DOMNode</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<!-- If the property is documented below (xml:id=domdocumentfragment.props) use this -->
<!--
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domdocumentfragment.props.name">name</varname>
</fieldsynopsis>
-->
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domdocumentfragment')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<!-- Again, if the class extends a class use this -->
<classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ DOMDocumentFragment properties -->
<!--
<section xml:id="domdocumentfragment.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="domdocumentfragment.props.name">
<term><varname>name</varname></term>
<listitem>
<para>Prop description</para>
</listitem>
</varlistentry>
</variablelist>
</section>
-->
<!-- }}} -->
<!-- {{{ See also -->
<!--
<section role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link xlink:href="&spec.dom3.;">W3C specification for</link></member>
</simplelist>
</para>
</section>
-->
<!-- }}} -->
</partintro>
&reference.dom.entities.domdocumentfragment;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,200 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<reference xml:id="class.domdocumenttype" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The DOMDocumentType class</title>
<titleabbrev>DOMDocumentType</titleabbrev>
<partintro>
<!-- {{{ DOMDocumentType intro -->
<section xml:id="domdocumenttype.intro">
&reftitle.intro;
<para>
Each <classname>DOMDocument</classname> has a <literal>doctype</literal>
attribute whose value is either &null; or a <classname>DOMDocumentType</classname> object.
</para>
</section>
<!-- }}} -->
<section xml:id="domdocumenttype.synopsis">
<title>Class synopsis</title>
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>DOMDocumentType</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>DOMDocumentType</classname>
</ooclass>
<!-- If the class extends another one, use this -->
<ooclass>
<modifier>extends</modifier>
<classname>DOMNode</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<!-- If the property is documented below (xml:id=domdocumenttype.props) use this -->
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domdocumenttype.props.publicid">publicId</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domdocumenttype.props.systemid">systemId</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domdocumenttype.props.name">name</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>DOMNamedNodeMap</type>
<varname linkend="domdocumenttype.props.entities">entities</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>DOMNamedNodeMap</type>
<varname linkend="domdocumenttype.props.notations">notations</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domdocumenttype.props.internalsubset">internalSubset</varname>
</fieldsynopsis>
<!--
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domdocumenttype')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
-->
<!-- Again, if the class extends a class use this -->
<classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ DOMDocumentType properties -->
<section xml:id="domdocumenttype.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="domdocumenttype.props.publicid">
<term><varname>publicId</varname></term>
<listitem>
<para>The public identifier of the external subset.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocumenttype.props.systemid">
<term><varname>systemId</varname></term>
<listitem>
<para>
The system identifier of the external subset. This may be an
absolute URI or not.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocumenttype.props.name">
<term><varname>name</varname></term>
<listitem>
<para>
The name of DTD; i.e., the name immediately following the
<literal>DOCTYPE</literal> keyword.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocumenttype.props.entities">
<term><varname>entities</varname></term>
<listitem>
<para>
A <classname>DOMNamedNodeMap</classname> containing the general
entities, both external and internal, declared in the DTD.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocumenttype.props.notations">
<term><varname>notations</varname></term>
<listitem>
<para>
A <classname>DOMNamedNodeMap</classname> containing the notations
declared in the DTD.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domdocumenttype.props.internalsubset">
<term><varname>internalSubset</varname></term>
<listitem>
<para>
The internal subset as a string, or null if there is none. This is
does not contain the delimiting square brackets.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ See also -->
<!--
<section role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link xlink:href="&spec.dom3.;">W3C specification for</link></member>
</simplelist>
</para>
</section>
-->
<!-- }}} -->
</partintro>
<!-- FIXME: this class has no methods -->
<!--&reference.dom.entities.domdocumenttype;-->
<refentry>
<refnamediv>
<refname />
<refpurpose />
</refnamediv>
<refsect1 />
</refentry>
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,128 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<reference xml:id="class.domelement" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The DOMElement class</title>
<titleabbrev>DOMElement</titleabbrev>
<partintro>
<!-- {{{ DOMElement intro -->
<!--
<section xml:id="domelement.intro">
&reftitle.intro;
<para>
Description of the class.
</para>
</section>
-->
<!-- }}} -->
<section xml:id="domelement.synopsis">
<title>Class synopsis</title>
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>DOMElement</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>DOMElement</classname>
</ooclass>
<!-- If the class extends another one, use this -->
<ooclass>
<modifier>extends</modifier>
<classname>DOMNode</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<!-- If the property is documented below (xml:id=domelement.props) use this -->
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>bool</type>
<varname linkend="domelement.props.schematypeinfo">schemaTypeInfo</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domelement.props.tagname">tagName</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domelement')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<!-- Again, if the class extends a class use this -->
<classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ DOMElement properties -->
<section xml:id="domelement.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="domelement.props.schematypeinfo">
<term><varname>schemaTypeInfo</varname></term>
<listitem>
<para>Not implemented yet, always return &null;</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domelement.props.tagname">
<term><varname>tagName</varname></term>
<listitem>
<para>The element name</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ See also -->
<!--
<section role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link xlink:href="&spec.dom3.;">W3C specification for</link></member>
</simplelist>
</para>
</section>
-->
<!-- }}} -->
</partintro>
&reference.dom.entities.domelement;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

205
reference/dom/domentity.xml Normal file
View file

@ -0,0 +1,205 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<reference xml:id="class.domentity" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The DOMEntity class</title>
<titleabbrev>DOMEntity</titleabbrev>
<partintro>
<!-- {{{ DOMEntity intro -->
<section xml:id="domentity.intro">
&reftitle.intro;
<para>
This interface represents a known entity, either parsed or unparsed, in an XML document.
</para>
</section>
<!-- }}} -->
<section xml:id="domentity.synopsis">
<title>Class synopsis</title>
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>DOMEntity</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>DOMEntity</classname>
</ooclass>
<!-- If the class extends another one, use this -->
<ooclass>
<modifier>extends</modifier>
<classname>DOMNode</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<!-- If the property is documented below (xml:id=domentity.props) use this -->
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domentity.props.publicid">publicId</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domentity.props.systemid">systemId</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domentity.props.notationname">notationName</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domentity.props.actualencoding">actualEncoding</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domentity.props.encoding">encoding</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domentity.props.version">version</varname>
</fieldsynopsis>
<!--
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domentity')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
-->
<!-- Again, if the class extends a class use this -->
<classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ DOMEntity properties -->
<section xml:id="domentity.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="domentity.props.publicid">
<term><varname>publicId</varname></term>
<listitem>
<para>
The public identifier associated with the entity if specified, and
&null; otherwise.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domentity.props.systemid">
<term><varname>systemId</varname></term>
<listitem>
<para>
The system identifier associated with the entity if specified, and
&null; otherwise. This may be an absolute URI or not.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domentity.props.notationname">
<term><varname>notationName</varname></term>
<listitem>
<para>
For unparsed entities, the name of the notation for the entity. For
parsed entities, this is &null;.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domentity.props.actualencoding">
<term><varname>actualEncoding</varname></term>
<listitem>
<para>
An attribute specifying the encoding used for this entity at the
time of parsing, when it is an external parsed entity. This is
&null; if it an entity from the internal subset or if it is not
known.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domentity.props.encoding">
<term><varname>encoding</varname></term>
<listitem>
<para>
An attribute specifying, as part of the text declaration, the
encoding of this entity, when it is an external parsed entity. This
is &null; otherwise.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domentity.props.version">
<term><varname>version</varname></term>
<listitem>
<para>
An attribute specifying, as part of the text declaration, the
version number of this entity, when it is an external parsed
entity. This is &null; otherwise.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ See also -->
<!--
<section role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link xlink:href="&spec.dom3.;">W3C specification for</link></member>
</simplelist>
</para>
</section>
-->
<!-- }}} -->
</partintro>
<!-- FIXME: this class has no methods -->
<!--&reference.dom.entities.domentity;-->
<refentry>
<refnamediv>
<refname />
<refpurpose />
</refnamediv>
<refsect1 />
</refentry>
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,127 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!--
Remove me once you perform substitutions
domentityreference
DOMEntityReference
domnode
DOMNode
dom
-->
<reference xml:id="class.domentityreference" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The DOMEntityReference class</title>
<titleabbrev>DOMEntityReference</titleabbrev>
<partintro>
<!-- {{{ DOMEntityReference intro -->
<!--
<section xml:id="domentityreference.intro">
&reftitle.intro;
<para>
Description of the class.
</para>
</section>
-->
<!-- }}} -->
<section xml:id="domentityreference.synopsis">
<title>Class synopsis</title>
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>DOMEntityReference</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>DOMEntityReference</classname>
</ooclass>
<!-- If the class extends another one, use this -->
<ooclass>
<modifier>extends</modifier>
<classname>DOMNode</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<!-- If the property is documented below (xml:id=domentityreference.props) use this -->
<!--
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domentityreference.props.name">name</varname>
</fieldsynopsis>
-->
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domentityreference')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<!-- Again, if the class extends a class use this -->
<classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ DOMEntityReference properties -->
<!--
<section xml:id="domentityreference.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="domentityreference.props.name">
<term><varname>name</varname></term>
<listitem>
<para>Prop description</para>
</listitem>
</varlistentry>
</variablelist>
</section>
-->
<!-- }}} -->
<!-- {{{ See also -->
<!--
<section role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link xlink:href="&spec.dom3.;">W3C specification for</link></member>
</simplelist>
</para>
</section>
-->
<!-- }}} -->
</partintro>
&reference.dom.entities.domentityreference;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,137 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!--
FIXME: Remove me once you perform substitutions
domexception
DOMException
exception
Exception
dom
-->
<reference xml:id="class.domexception" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The DOMException class</title>
<titleabbrev>DOMException</titleabbrev>
<partintro>
<!-- {{{ DOMException intro -->
<section xml:id="domexception.intro">
&reftitle.intro;
<para>
DOM operations raise exceptions under particular circumstances, i.e.,
when an operation is impossible to perform for logical reasons.
</para>
<para>
See also <xref linkend="language.exceptions"/>.
</para>
</section>
<!-- }}} -->
<section xml:id="domexception.synopsis">
<title>Class synopsis</title>
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>DOMException</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>DOMException</classname>
</ooclass>
<!-- If the class extends another one, use this -->
<ooclass>
<modifier>extends</modifier>
<classname>Exception</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<!-- If the property is documented below (xml:id=domexception.props) use this -->
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>int</type>
<varname linkend="domexception.props.code">code</varname>
</fieldsynopsis>
<!--
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
-->
<!-- Again, if the class extends a class use this -->
<!--
<classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
-->
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ DOMException properties -->
<section xml:id="domexception.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="domexception.props.code">
<term><varname>code</varname></term>
<listitem>
<para>An integer indicating the type of error generated</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ See also -->
<!--
<section role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link xlink:href="&spec.dom3.;">W3C specification for</link></member>
</simplelist>
</para>
</section>
-->
<!-- }}} -->
</partintro>
<!-- FIXME: this class has no methods -->
<!--&reference.dom.entities.domexception;-->
<refentry>
<refnamediv>
<refname />
<refpurpose />
</refnamediv>
<refsect1 />
</refentry>
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,115 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!--
Remove me once you perform substitutions
domimplementation
DOMImplementation
dom
-->
<reference xml:id="class.domimplementation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The DOMImplementation class</title>
<titleabbrev>DOMImplementation</titleabbrev>
<partintro>
<!-- {{{ DOMImplementation intro -->
<section xml:id="domimplementation.intro">
&reftitle.intro;
<para>
The <classname>DOMImplementation</classname> interface provides a number
of methods for performing operations that are independent of any
particular instance of the document object model.
</para>
</section>
<!-- }}} -->
<section xml:id="domimplementation.synopsis">
<title>Class synopsis</title>
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>DOMImplementation</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>DOMImplementation</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<!-- If the property is documented below (xml:id=domimplementation.props) use this -->
<!--
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domimplementation.props.name">name</varname>
</fieldsynopsis>
-->
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domimplementation')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ DOMImplementation properties -->
<!--
<section xml:id="domimplementation.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="domimplementation.props.name">
<term><varname>name</varname></term>
<listitem>
<para>Prop description</para>
</listitem>
</varlistentry>
</variablelist>
</section>
-->
<!-- }}} -->
<!-- {{{ See also -->
<!--
<section role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link xlink:href="&spec.dom3.;">W3C specification for</link></member>
</simplelist>
</para>
</section>
-->
<!-- }}} -->
</partintro>
&reference.dom.entities.domimplementation;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,115 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!--
Remove me once you perform substitutions
domnamednodemap
DOMNamedNodeMap
dom
-->
<reference xml:id="class.domnamednodemap" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The DOMNamedNodeMap class</title>
<titleabbrev>DOMNamedNodeMap</titleabbrev>
<partintro>
<!-- {{{ DOMNamedNodeMap intro -->
<!-- FIXME:
<section xml:id="domnamednodemap.intro">
&reftitle.intro;
<para>
Description of the class.
</para>
</section>
-->
<!-- }}} -->
<section xml:id="domnamednodemap.synopsis">
<title>Class synopsis</title>
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>DOMNamedNodeMap</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>DOMNamedNodeMap</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<!-- If the property is documented below (xml:id=domnamednodemap.props) use this -->
<!--
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domnamednodemap.props.name">name</varname>
</fieldsynopsis>
-->
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnamednodemap')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ DOMNamedNodeMap properties -->
<!--
<section xml:id="domnamednodemap.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="domnamednodemap.props.name">
<term><varname>name</varname></term>
<listitem>
<para>Prop description</para>
</listitem>
</varlistentry>
</variablelist>
</section>
-->
<!-- }}} -->
<!-- {{{ See also -->
<!--
<section role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link xlink:href="&spec.dom3.;">W3C specification for</link></member>
</simplelist>
</para>
</section>
-->
<!-- }}} -->
</partintro>
&reference.dom.entities.domnamednodemap;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

297
reference/dom/domnode.xml Normal file
View file

@ -0,0 +1,297 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<reference xml:id="class.domnode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The DOMNode class</title>
<titleabbrev>DOMNode</titleabbrev>
<partintro>
<!-- {{{ DOMNode intro
<section xml:id="domnode.intro">
&reftitle.intro;
<para>
Description of the class.
</para>
</section>
}}} -->
<section xml:id="domnode.synopsis">
<title>Class synopsis</title>
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>DOMNode</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>DOMNode</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<!-- If the property is documented below (xml:id=domnode.props) use this -->
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>string</type>
<varname linkend="domnode.props.nodename">nodeName</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domnode.props.nodevalue">nodeValue</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>int</type>
<varname linkend="domnode.props.nodetype">nodeType</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>DOMNode</type>
<varname linkend="domnode.props.parentnode">parentNode</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>DOMNodeList</type>
<varname linkend="domnode.props.childnodes">childNodes</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>DOMNode</type>
<varname linkend="domnode.props.firstchild">firstChild</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>DOMNode</type>
<varname linkend="domnode.props.lastchild">lastChild</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>DOMNode</type>
<varname linkend="domnode.props.previoussibling">previousSibling</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>DOMNode</type>
<varname linkend="domnode.props.nextsibling">nextSibling</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>DOMNamedNodeMap</type>
<varname linkend="domnode.props.attributes">attributes</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>DOMDocument</type>
<varname linkend="domnode.props.ownerdocument">ownerDocument</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>string</type>
<varname linkend="domnode.props.namespaceuri">namespaceURI</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domnode.props.prefix">prefix</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>string</type>
<varname linkend="domnode.props.localname">localName</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>string</type>
<varname linkend="domnode.props.baseuri">baseURI</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domnode.props.textcontent">textContent</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ DOMNode properties -->
<section xml:id="domnode.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="domnode.props.nodename">
<term><varname>nodeName</varname></term>
<listitem>
<para>Returns the most accurate name for the current node type</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domnode.props.nodevalue">
<term><varname>nodeValue</varname></term>
<listitem>
<para>The value of this node, depending on its type</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domnode.props.nodetype">
<term><varname>nodeType</varname></term>
<listitem>
<para>Gets the type of the node. One of the predefined XML_xxx_NODE constants</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domnode.props.parentnode">
<term><varname>parentNode</varname></term>
<listitem>
<para>The parent of this node</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domnode.props.childnodes">
<term><varname>childNodes</varname></term>
<listitem>
<para>
A <classname>DOMNodeList</classname> that contains all
children of this node. If there are no children, this is an empty
<classname>DOMNodeList</classname>.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domnode.props.firstchild">
<term><varname>firstChild</varname></term>
<listitem>
<para>
The first child of this node. If there is no such node, this
returns &null;.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domnode.props.lastchild">
<term><varname>lastChild</varname></term>
<listitem>
<para>The last child of this node. If there is no such node, this returns &null;.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domnode.props.previoussibling">
<term><varname>previousSibling</varname></term>
<listitem>
<para>
The node immediately preceding this node. If there is no such
node, this returns &null;.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domnode.props.nextsibling">
<term><varname>nextSibling</varname></term>
<listitem>
<para>
The node immediately following this node. If there is no such
node, this returns &null;.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domnode.props.attributes">
<term><varname>attributes</varname></term>
<listitem>
<para>
A <classname>DOMNamedNodeMap</classname> containing the
attributes of this node (if it is a <classname>DOMElement</classname>)
or &null; otherwise.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domnode.props.ownerdocument">
<term><varname>ownerDocument</varname></term>
<listitem>
<para>The <classname>DOMDocument</classname> object associated with this node.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domnode.props.namespaceuri">
<term><varname>namespaceURI</varname></term>
<listitem>
<para>The namespace URI of this node, or &null; if it is unspecified.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domnode.props.prefix">
<term><varname>prefix</varname></term>
<listitem>
<para>The namespace prefix of this node, or &null; if it is unspecified.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domnode.props.localname">
<term><varname>localName</varname></term>
<listitem>
<para>Returns the local part of the qualified name of this node.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domnode.props.baseuri">
<term><varname>baseURI</varname></term>
<listitem>
<para>
The absolute base URI of this node or &null; if the implementation
wasn't able to obtain an absolute URI.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domnode.props.textcontent">
<term><varname>textContent</varname></term>
<listitem>
<para>This attribute returns the text content of this node and its descendants.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ See also -->
<section role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link xlink:href="&spec.dom3.node;">W3C specification of Node</link></member>
</simplelist>
</para>
</section>
<!-- }}} -->
</partintro>
&reference.dom.entities.domnode;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,115 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!--
Remove me once you perform substitutions
domnodelist
DOMNodeList
dom
-->
<reference xml:id="class.domnodelist" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The DOMNodeList class</title>
<titleabbrev>DOMNodeList</titleabbrev>
<partintro>
<!-- {{{ DOMNodeList intro -->
<!-- FIXME:
<section xml:id="domnodelist.intro">
&reftitle.intro;
<para>
Description of the class.
</para>
</section>
-->
<!-- }}} -->
<section xml:id="domnodelist.synopsis">
<title>Class synopsis</title>
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>DOMNodeList</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>DOMNodeList</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<!-- If the property is documented below (xml:id=domnodelist.props) use this -->
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>int</type>
<varname linkend="domnodelist.props.length">length</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnodelist')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ DOMNodeList properties -->
<section xml:id="domnodelist.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="domnodelist.props.length">
<term><varname>length</varname></term>
<listitem>
<para>
The number of nodes in the list. The range of valid child node
indices is 0 to <literal>length - 1</literal> inclusive.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ See also -->
<!--
<section role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link xlink:href="&spec.dom3.;">W3C specification for</link></member>
</simplelist>
</para>
</section>
-->
<!-- }}} -->
</partintro>
&reference.dom.entities.domnodelist;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,150 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!--
FIXME: huh?
Remove me once you perform substitutions
domnotation
DOMNotation
domnode
DOMNode
dom
-->
<reference xml:id="class.domnotation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The DOMNotation class</title>
<titleabbrev>DOMNotation</titleabbrev>
<partintro>
<!-- {{{ DOMNotation intro -->
<!-- FIXME:
<section xml:id="domnotation.intro">
&reftitle.intro;
<para>
Description of the class.
</para>
</section>
-->
<!-- }}} -->
<section xml:id="domnotation.synopsis">
<title>Class synopsis</title>
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>DOMNotation</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>DOMNotation</classname>
</ooclass>
<!-- If the class extends another one, use this -->
<ooclass>
<modifier>extends</modifier>
<classname>DOMNode</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<!-- If the property is documented below (xml:id=domnotation.props) use this -->
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domnotation.props.publicid">publicId</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domnotation.props.systemid">systemId</varname>
</fieldsynopsis>
<!--
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnotation')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
-->
<!-- Again, if the class extends a class use this -->
<classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ DOMNotation properties -->
<!-- FIXME: Add descriptions -->
<section xml:id="domnotation.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="domnotation.props.publicid">
<term><varname>publicId</varname></term>
<listitem>
<para>Prop description</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domnotation.props.systemid">
<term><varname>systemId</varname></term>
<listitem>
<para>Prop description</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ See also -->
<!--
<section role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link xlink:href="&spec.dom3.;">W3C specification for</link></member>
</simplelist>
</para>
</section>
-->
<!-- }}} -->
</partintro>
<!-- FIXME: this class has no methods -->
<!--&reference.dom.entities.domnotation;-->
<refentry>
<refnamediv>
<refname />
<refpurpose />
</refnamediv>
<refsect1 />
</refentry>
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,130 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<reference xml:id="class.domprocessinginstruction" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The DOMProcessingInstruction class</title>
<titleabbrev>DOMProcessingInstruction</titleabbrev>
<partintro>
<!-- {{{ DOMProcessingInstruction intro -->
<!-- FIXME:
<section xml:id="domprocessinginstruction.intro">
&reftitle.intro;
<para>
Description of the class.
</para>
</section>
-->
<!-- }}} -->
<section xml:id="domprocessinginstruction.synopsis">
<title>Class synopsis</title>
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>DOMProcessingInstruction</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>DOMProcessingInstruction</classname>
</ooclass>
<!-- If the class extends another one, use this -->
<ooclass>
<modifier>extends</modifier>
<classname>DOMNode</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<!-- If the property is documented below (xml:id=domprocessinginstruction.props) use this -->
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domprocessinginstruction.props.target">target</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domprocessinginstruction.props.data">data</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domprocessinginstruction')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<!-- Again, if the class extends a class use this -->
<classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domnode')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ DOMProcessingInstruction properties -->
<!-- FIXME: Add descrtiptions -->
<section xml:id="domprocessinginstruction.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="domprocessinginstruction.props.target">
<term><varname>target</varname></term>
<listitem>
<para>Prop description</para>
</listitem>
</varlistentry>
<varlistentry xml:id="domprocessinginstruction.props.data">
<term><varname>data</varname></term>
<listitem>
<para>Prop description</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ See also -->
<!--
<section role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link xlink:href="&spec.dom3.;">W3C specification for</link></member>
</simplelist>
</para>
</section>
-->
<!-- }}} -->
</partintro>
&reference.dom.entities.domprocessinginstruction;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

117
reference/dom/domtext.xml Normal file
View file

@ -0,0 +1,117 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<reference xml:id="class.domtext" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The DOMText class</title>
<titleabbrev>DOMText</titleabbrev>
<partintro>
<!-- {{{ DOMText intro -->
<!-- FIXME:
<section xml:id="domtext.intro">
&reftitle.intro;
<para>
Description of the class.
</para>
</section>
-->
<!-- }}} -->
<section xml:id="domtext.synopsis">
<title>Class synopsis</title>
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>DOMText</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>DOMText</classname>
</ooclass>
<!-- If the class extends another one, use this -->
<ooclass>
<modifier>extends</modifier>
<classname>DOMCharacterData</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<!-- If the property is documented below (xml:id=domtext.props) use this -->
<fieldsynopsis>
<modifier>readonly</modifier>
<modifier>public</modifier>
<type>string</type>
<varname linkend="domtext.props.wholeText">wholeText</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domtext')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<!-- Again, if the class extends a class use this -->
<classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domcharacterdata')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ DOMText properties -->
<!-- FIXME: Add description -->
<section xml:id="domtext.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="domtext.props.wholeText">
<term><varname>wholeText</varname></term>
<listitem>
<para>Prop description</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ See also -->
<!--
<section role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link xlink:href="&spec.dom3.;">W3C specification for</link></member>
</simplelist>
</para>
</section>
-->
<!-- }}} -->
</partintro>
&reference.dom.entities.domtext;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

112
reference/dom/domxpath.xml Normal file
View file

@ -0,0 +1,112 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!--
Remove me once you perform substitutions
domxpath
DOMXPath
dom
-->
<reference xml:id="class.domxpath" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The DOMXPath class</title>
<titleabbrev>DOMXPath</titleabbrev>
<partintro>
<!-- {{{ DOMXPath intro -->
<!-- FIXME:
<section xml:id="domxpath.intro">
&reftitle.intro;
<para>
Description of the class.
</para>
</section>
-->
<!-- }}} -->
<section xml:id="domxpath.synopsis">
<title>Class synopsis</title>
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>DOMXPath</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>DOMXPath</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<!-- If the property is documented below (xml:id=domxpath.props) use this -->
<fieldsynopsis>
<modifier>public</modifier>
<type>DOMDocument</type>
<varname linkend="domxpath.props.document">document</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.domxpath')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ DOMXPath properties -->
<!-- FIXME: Add description -->
<section xml:id="domxpath.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="domxpath.props.document">
<term><varname>document</varname></term>
<listitem>
<para>Prop description</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ See also -->
<!--
<section role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link xlink:href="&spec.dom3.;">W3C specification for</link></member>
</simplelist>
</para>
</section>
-->
<!-- }}} -->
</partintro>
&reference.dom.entities.domxpath;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -1,7 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.32 $ -->
<!-- Purpose: xml -->
<!-- Membership: bundled, external -->
<!-- $Revision: 1.33 $ -->
<reference xml:id="ref.dom" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>DOM Functions</title>

57
reference/dom/setup.xml Normal file
View file

@ -0,0 +1,57 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<chapter xml:id="dom.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.setup;
<!-- {{{ Requirements -->
<section xml:id="dom.requirements">
&reftitle.required;
&no.requirement;
</section>
<!-- }}} -->
<!-- {{{ Installation -->
<section xml:id="dom.installation">
&reftitle.install;
&no.install;
</section>
<!-- }}} -->
<!-- {{{ Configuration -->
<section xml:id="dom.configuration">
&reftitle.runtime;
&no.config;
</section>
<!-- }}} -->
<!-- {{{ Resources -->
<section xml:id="dom.resources">
&reftitle.resources;
&no.resource;
</section>
<!-- }}} -->
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->