incubator-odf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r795775 - /websites/staging/odftoolkit/trunk/content/odftoolkit/odfdom/ODFDOM-Class-Structure.html
Date Thu, 15 Sep 2011 07:43:36 GMT
Author: buildbot
Date: Thu Sep 15 07:43:35 2011
New Revision: 795775

Log:
Staging update by buildbot

Modified:
    websites/staging/odftoolkit/trunk/content/odftoolkit/odfdom/ODFDOM-Class-Structure.html

Modified: websites/staging/odftoolkit/trunk/content/odftoolkit/odfdom/ODFDOM-Class-Structure.html
==============================================================================
--- websites/staging/odftoolkit/trunk/content/odftoolkit/odfdom/ODFDOM-Class-Structure.html
(original)
+++ websites/staging/odftoolkit/trunk/content/odftoolkit/odfdom/ODFDOM-Class-Structure.html
Thu Sep 15 07:43:35 2011
@@ -78,44 +78,43 @@
   <div id="contenta">
   
     
-    <p><strong>TOC</strong></p>
-<p>=Class Structure in ODFDOM=
+    <p>Title:Class Structure in ODFDOM
 The Java packages reflect the layers of the ODFDOM library.</p>
-<p>==Shared Functionality==</p>
-<p>Shared by all layers are the basic XML classes as in the <code>org.odftoolkit.odfdom</code>
package, like
-;<code>OdfElement</code> 
-:parent of all ODFDOM elements
-;<code>OdfAttribute</code> 
-:parent of all ODFDOM attributes 
-;<code>OdfName</code> 
-:the union of an ODF local name and an ODF namespace, represented by 
-;<code>OdfNamespace</code> 
-:embracing all ODF namespaces (prefixes and URIs) defined in the specification.</p>
-<p>Similar used through all layers are the ODF datatypes, to be found in
-;<code>org.odftoolkit.odfdom.type</code>
-:All datatypes defined in the ODF 1.2 specification, mostly overtaken from W3C Schema types,
like AnyURI.
-Helper functionality can be found at those types, like in case for AnyURI en/decode() methods.</p>
-<p>==The Package/Physical Layer==</p>
+<h2 id="shared-functionality">Shared Functionality</h2>
+<p>Shared by all layers are the basic XML classes as in the <code>org.odftoolkit.odfdom</code>
package, like  <br />
+</p>
+<ul>
+<li><code>OdfElement</code>: parent of all ODFDOM elements</li>
+<li><code>OdfAttribute</code>: parent of all ODFDOM attributes </li>
+<li><code>OdfName</code>: the union of an ODF local name and an ODF namespace,
represented by </li>
+<li><code>OdfNamespace</code>: embracing all ODF namespaces (prefixes and
URIs) defined in the specification.</li>
+</ul>
+<p>Similar used through all layers are the ODF datatypes, to be found in</p>
+<ul>
+<li><code>org.odftoolkit.odfdom.type</code>: All datatypes defined in the
ODF 1.2 specification, mostly overtaken from W3C Schema types, like AnyURI.
+Helper functionality can be found at those types, like in case for AnyURI en/decode() methods.</li>
+</ul>
+<h2 id="the-packagephysical-layer">The Package/Physical Layer</h2>
 <p>These classes are in the <code>org.odftoolkit.odfdom.pkg</code> package
to access files from the ODF package.
 The classes you will find here include:</p>
-<p>;<code>OdfPackage</code>
-:Allows you to access, insert, delete, load, and save individual entries in a packaged ODF
document.</p>
-<p>; <code>OdfPackageStream</code>
-:Allows you to write to a member of the ODF document as an output stream.</p>
-<p>;<code>OdfXMLHelper</code>
-:Provides utility methods to parse the XML content of a package member and apply an XSLT
transformation to it.</p>
-<p>==The ODF Typed DOM / XML Layer==</p>
-<p>These classes are in general the generated DOM elements and attributes of ODF 1.2.

-;<code>org.odftoolkit.odfdom.dom.element</code>
-:These classes give you access to the individual ODF elements. Its sub-packages are divided
by namespace, so you would find the code for a <code>draw:ellipse</code> element
in the <code>org.odftoolkit.odfdom.dom.element.draw.DrawEllipseElement</code>
class.
-;<code>org.odftoolkit.odfdom.dom.attribute</code>
-:These classes give you access to the individual ODF attributes  (similar to the elements
before). Again its sub-packages are divided by namespace, so you would find the code for a
<code>xml:id</code> attribute in the <code>org.odftoolkit.odfdom.dom.attribute.xml.XmlId</code>
class.</p>
+<ul>
+<li><code>OdfPackage</code>: Allows you to access, insert, delete, load,
and save individual entries in a packaged ODF document.</li>
+<li><code>OdfPackageStream</code>: Allows you to write to a member of the
ODF document as an output stream.</li>
+<li><code>OdfXMLHelper</code>: Provides utility methods to parse the XML
content of a package member and apply an XSLT transformation to it.</li>
+</ul>
+<h2 id="the-odf-typed-dom-xml-layer">The ODF Typed DOM / XML Layer</h2>
+<p>These classes are in general the generated DOM elements and attributes of ODF 1.2.
</p>
+<ul>
+<li><code>org.odftoolkit.odfdom.dom.element</code>: These classes give
you access to the individual ODF elements. Its sub-packages are divided by namespace, so you
would find the code for a <code>draw:ellipse</code> element in the <code>org.odftoolkit.odfdom.dom.element.draw.DrawEllipseElement</code>
class.</li>
+<li><code>org.odftoolkit.odfdom.dom.attribute</code>: These classes give
you access to the individual ODF attributes  (similar to the elements before). Again its sub-packages
are divided by namespace, so you would find the code for a <code>xml:id</code>
attribute in the <code>org.odftoolkit.odfdom.dom.attribute.xml.XmlId</code> class.</li>
+</ul>
 <p>The third package <code>org.odftoolkit.odfdom.dom.style</code> will
vanish in the future (mostly parts will be moved to the DOC layer in an upcoming release).</p>
-<p>;<code>org.odftoolkit.odfdom.dom.style</code>
-:These classes and the <code>.props</code> sub-packages give you access to ODF&rsquo;s
style families and their properties</p>
+<ul>
+<li><code>org.odftoolkit.odfdom.dom.style</code>: These classes and the
<code>.props</code> sub-packages give you access to ODF&rsquo;s style families
and their properties.</li>
+</ul>
 <p>If you are using an IDE such as NetBeans or Eclipse, you don't have to memorize
this hierarchy; the IDE can generate the proper <code>import</code> statements
for you. </p>
-<p>The code in these classes is generated directly from the [http://www.relaxng.org/
Relax NG] (RNG) schema for ODF.</p>
-<p>==The ODF Document / Convenience Functionality Layer==</p>
+<p>The code in these classes is generated directly from <a href="http://www.relaxng.org/">the
Relax NG</a> (RNG) schema for ODF.</p>
+<h2 id="the-odf-document-convenience-functionality-layer">The ODF Document / Convenience
Functionality Layer</h2>
 <p>This is the layer that developers will use most often. A sub-level like <code>org.odftoolkit.odfdom.doc.text</code>
inherits (currently) from the elements of the <code>org.odftoolkit.odfdom.dom.element.text</code>
package. Aside of the namespace prefix an 'Odf' prefix is being used in the beginning. Furthermore
is the namespace prefix neglected in case it already exists in the local name. The convenient
class for the ODF element <code>table:table</code>, which is represented in the
DOM layer by <code>org.odftoolkit.odfdom.table.TableTableElement</code>, is OdfTable
and NOT OdfTableTable.
 We encourage developers to create methods for these classes, based on actual use cases of
the toolkit.</p>
 <p>The entry point for the convenient layer should be in the future the document itself.
Some example functions had been added to <code>OdfTextDocument</code> to show
this, like <code>newParagraph()</code>, adding a paragraph (ie. <code>text:p</code>
element) at the end of the document.</p>



Mime
View raw message