incubator-odf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From devin...@apache.org
Subject svn commit: r795777 - in /websites/production/odftoolkit: ./ content/odftoolkit/odfdom/Development.html content/odftoolkit/odfdom/ODFDOM-Class-Structure.html
Date Thu, 15 Sep 2011 07:44:53 GMT
Author: devinhan
Date: Thu Sep 15 07:44:53 2011
New Revision: 795777

Log:
Publishing merge to odftoolkit site by devinhan

Modified:
    websites/production/odftoolkit/   (props changed)
    websites/production/odftoolkit/content/odftoolkit/odfdom/Development.html
    websites/production/odftoolkit/content/odftoolkit/odfdom/ODFDOM-Class-Structure.html

Propchange: websites/production/odftoolkit/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Thu Sep 15 07:44:53 2011
@@ -1 +1 @@
-/websites/staging/odftoolkit/trunk:794771-795770
+/websites/staging/odftoolkit/trunk:794771-795776

Modified: websites/production/odftoolkit/content/odftoolkit/odfdom/Development.html
==============================================================================
--- websites/production/odftoolkit/content/odftoolkit/odfdom/Development.html (original)
+++ websites/production/odftoolkit/content/odftoolkit/odfdom/Development.html Thu Sep 15 07:44:53
2011
@@ -85,10 +85,10 @@
 <p>Setup Mercurial (optional):  <br />
 Config file $Hg Install DirMercurial.ini on Windows or <Hg Install Dir>/.hgrc on Unix.
 <br />
 Enhance the default configuration, using GIT diff and enable <a href="http://mercurial.selenic.com/wiki/Win32TextExtension">default
plugin</a> avoid different line breaks in the source.<br />
-</p>
-<p>[ui]
-username = your Name <a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;&#121;&#111;&#117;&#114;&#76;&#111;&#103;&#105;&#110;&#78;&#97;&#109;&#101;&#64;&#111;&#100;&#102;&#116;&#111;&#111;&#108;&#107;&#105;&#116;&#46;&#111;&#114;&#103;">&#121;&#111;&#117;&#114;&#76;&#111;&#103;&#105;&#110;&#78;&#97;&#109;&#101;&#64;&#111;&#100;&#102;&#116;&#111;&#111;&#108;&#107;&#105;&#116;&#46;&#111;&#114;&#103;</a>
-;merge = your-merge-program (or internal:merge)</p>
+<pre>
+    [ui]
+    username = your Name <a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;&#121;&#111;&#117;&#114;&#76;&#111;&#103;&#105;&#110;&#78;&#97;&#109;&#101;&#64;&#111;&#100;&#102;&#116;&#111;&#111;&#108;&#107;&#105;&#116;&#46;&#111;&#114;&#103;">&#121;&#111;&#117;&#114;&#76;&#111;&#103;&#105;&#110;&#78;&#97;&#109;&#101;&#64;&#111;&#100;&#102;&#116;&#111;&#111;&#108;&#107;&#105;&#116;&#46;&#111;&#114;&#103;</a>
+    ;merge = your-merge-program (or internal:merge)</p>
 <p>[diff]
 git = 1</p>
 <p>[defaults]
@@ -105,11 +105,10 @@ hgext.purge=</p>
 # Converts mixed line ending within a file to LF (Unix) format   <br />
 # before adding the file to the source repository  <br />
 # See http://mercurial.selenic.com/wiki/EolExtension  <br />
-only-consistent = False</p>
-</li>
-<li>
-<p>Get the <a href="http://odftoolkit.org/projects/odfdom/sources">ODFDOM source
code</a> from the odfdom~developer <a href="http://www.selenic.com/mercurial/wiki/">Mercurial</a>
repository. Please see below for a short introduction to using Mercurial on odftoolkit.org.
There's also a more general <a href="{{project help page SourceControl}}">help</a>
on how to use source control systems on odftoolkit.org. The command <br />
-<code>hg clone https://odftoolkit.org/hg/odfdom~developer</code>will download
the repository into a new directory.  <br />
+only-consistent = False
+</pre>
+1. Get the <a href="http://odftoolkit.org/projects/odfdom/sources">ODFDOM source code</a>
from the odfdom~developer <a href="http://www.selenic.com/mercurial/wiki/">Mercurial</a>
repository. Please see below for a short introduction to using Mercurial on odftoolkit.org.
There's also a more general <a href="SourceControl.html">help</a> on how to use
source control systems on odftoolkit.org. The command <br />
+<code>hg clone https://odftoolkit.org/hg/odfdom~developer</code> will download
the repository into a new directory.  <br />
 Please note that by this you'll get the latest changeset. If you for example want stable
release 0.8.6, you may want to use<br />
 <code>hg clone https://odftoolkit.org/hg/odfdom~developer -r v0.8.6</code></p>
 </li>
@@ -176,12 +175,12 @@ and adding <code>https://myUserName:myPa
   hg commit -A -u "your Name" -m "#bug XY# Description of changes"
   hg tip
   // Export your locally committed changes as patch
-  hg export -a -g -o ../myChanges.patch <RevisionNumbersOfYourCommit></p>
-<p>// Import changes into your local repository
-  hg import --no-commit ../someFile.patch</p>
-<p>// Get help
-  hg help</p>
-<p>// Get help about a special command
+  hg export -a -g -o ../myChanges.patch <RevisionNumbersOfYourCommit>
+  // Import changes into your local repository
+  hg import --no-commit ../someFile.patch
+  // Get help
+  hg help
+  // Get help about a special command
   hg help <command>
   hg help export
   hg help addremove
@@ -193,19 +192,18 @@ In case you do changes for a bug or feat
 <a href="http://maven.apache.org/">Maven</a> is the build manager used for ODFDOM
development.
 <pre>
   // Build the project and create target/odfdom.jar
-  mvn</p>
-<p>// Workaround: Ignore failed test when building
-  mvn -Dmaven.test.failure.ignore=true clean install</p>
-<p>// Create javadoc
-  mvn javadoc:javadoc</p>
-<p>// Generate DOM layer elements and attributes from RelaxNG
-  mvn clean test -P codegen</p>
-<p>// Generate code coverage documentation in
+  mvn
+  // Workaround: Ignore failed test when building
+  mvn -Dmaven.test.failure.ignore=true clean install
+  // Create javadoc
+  mvn javadoc:javadoc
+  // Generate DOM layer elements and attributes from RelaxNG
+  mvn clean test -P codegen
+  // Generate code coverage documentation in
   // <PROJECT_DIR>/target/site/cobertura/index.html
   // see http://mojo.codehaus.org/cobertura-maven-plugin/
-  mvn cobertura:cobertura</p>
-</pre>
-
+  mvn cobertura:cobertura
+</pre></p>
 <p><strong>Coding Guidelines</strong>
 ODFDOM take advantage of the existing <a href="http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html">Java
Coding Guidelines</a>. </p>
 <p><strong><em>Naming Convention</em></strong>  <br />
@@ -257,9 +255,9 @@ button to base higher APIs on the stable
 </p>
 <ul>
 <li><a href="ODFDOM-Class-Structure.html">Class Structure in ODFDOM</a></li>
-<li>[Convenience Layer Design Ideas][24]</li>
+<li>[Convenience Layer Design Ideas][25]</li>
 </ul>
-<p>[24]: Convenience Layer Design Ideas.html</p>
+<p>[25]: Convenience Layer Design Ideas.html</p>
   </div>
 
   <div id="footera">

Modified: websites/production/odftoolkit/content/odftoolkit/odfdom/ODFDOM-Class-Structure.html
==============================================================================
--- websites/production/odftoolkit/content/odftoolkit/odfdom/ODFDOM-Class-Structure.html (original)
+++ websites/production/odftoolkit/content/odftoolkit/odfdom/ODFDOM-Class-Structure.html Thu
Sep 15 07:44:53 2011
@@ -21,7 +21,7 @@
 
 <link href="/odftoolkit/css/odf.css" rel="stylesheet" type="text/css">
 
-<title></title>
+<title>Class Structure in ODFDOM   </title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
 </head>
@@ -77,45 +77,43 @@
   </div>
   <div id="contenta">
   
-    
-    <p><strong>TOC</strong></p>
-<p>=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>
+    <h1 class="title">Class Structure in ODFDOM   </h1>
+    <p>The Java packages reflect the layers of the ODFDOM library.</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