incubator-odf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r795351 - /websites/staging/odftoolkit/trunk/content/odftoolkit/simple/document/faq.html
Date Tue, 06 Sep 2011 03:01:28 GMT
Author: buildbot
Date: Tue Sep  6 03:01:27 2011
New Revision: 795351

Staging update by buildbot


Added: websites/staging/odftoolkit/trunk/content/odftoolkit/simple/document/faq.html
--- websites/staging/odftoolkit/trunk/content/odftoolkit/simple/document/faq.html (added)
+++ websites/staging/odftoolkit/trunk/content/odftoolkit/simple/document/faq.html Tue Sep
 6 03:01:27 2011
@@ -0,0 +1,235 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "">
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements.  See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You under the Apache License, Version 2.0
+    (the "License"); you may not use this file except in compliance with
+    the License.  You may obtain a copy of the License at
+ 2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+<link href="/odftoolkit/css/odf.css" rel="stylesheet" type="text/css">
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+  <div id="banner">
+   <!-- <div id="bannerleft"><a alt="Apache ODF Toolkit (incubating)" href="">
+      <img id="logo" alt="Apache ODF Toolkit (Incubating)" src="/odftoolkit/images/ooo-logo.png"/></a></div>
+    <div id="bannerright"><a alt="Apache Incubator" href="">
+      <img id="asf-logo" alt="Apache Incubator" src="/odftoolkit/images/apache-incubator-logo.png"/></a></div>
+   <div id="bannercenter"><br/>&nbsp;&nbsp;&nbsp;&nbsp;Apache
ODF Toolkit (incubating)</div>
+  </div>
+  <div id="clear"></div>
+  <div id="sidenav">
+    <h1 id="general">General</h1>
+<li><a href="/odftoolkit/index.html">About</a></li>
+<li><a href="">Incubator
+<li><a href="/odftoolkit/license.html">License</a></li>
+<h1 id="components">Components</h1>
+<li><a href="/odftoolkit/odfdom/index.html">ODFDOM</a></li>
+<li><a href="/odftoolkit/simple/index.html">Simple API</a></li>
+<li><a href="/odftoolkit/conformance/ODFValidator.html">Conformance Tools</a></li>
+<li><a href="/odftoolkit/xsltrunner/ODFXSLTRunner.html">XSLT Runner</a></li>
+<h1 id="community">Community</h1>
+<li><a href="/odftoolkit/get-involved.html">Get Involved</a></li>
+<li><a href="/odftoolkit/mailing-lists.html">Mailing Lists</a></li>
+<li><a href="/odftoolkit/people.html">People</a></li>
+<li><a href="/odftoolkit/community-faqs.html">Community FAQs</a></li>
+<h1 id="development">Development</h1>
+<li><a href="/odftoolkit/source.html">Source Code</a></li>
+<li><a href="/odftoolkit/website-local.html">Website</a></li>
+<li><a href="/odftoolkit/developer-faqs.html">Developer FAQs</a></li>
+<h1 id="ppmc">PPMC</h1>
+<li><a href="/odftoolkit/ppmc-faqs.html">PPMC FAQs</a><br />
+<h1 id="asf">ASF</h1>
+<li><a href="">Apache Software Foundation</a></li>
+<li><a href="">Thanks</a></li>
+<li><a href="">Become a Sponsor</a></li>
+  </div>
+  <div id="contenta">
+    <h2 id="what_is_the_simple_java_api_for_odf">What is the Simple Java API for ODF?</h2>
+<p>The Simple Java API for ODF is an easy-to-use, high-level Java API for creating,
modifying and extracting data from ODF 1.2 documents.  It is written in pure Java and does
not require that you install any document editor on your system.  The Simple Java API for
ODF is a high level abstraction of the lower-level <a href="">ODFDOM
+<h2 id="new_release_066">New Release 0.6.6</h2>
+<p>We are pleased to announce the release of the Simple Java API for ODF version 0.6.6
on Auguest 12th. The improvements in this version include:</p>
+<li>Two critical bugs in the Navigation API are fixed, as well as
+    several other issues.</li>
+<li>Page columns,  a page layout feature in text documents, are supported.</li>
+<li>Unit test coverage rate increased.  This work improves the stability of our API.</li>
+<p>You can download it here. The full release notes can be found here. </p>
+<p>You are welcomed to give us any feedback by Bugzilla, eMail or forum. </p>
+<h2 id="project_roadmap_and_schedule">Project roadmap and schedule</h2>
+<p>The Simple Java API for ODF adhears to the "Release Early and Often" development
philosophy.  We will target a monthly release, for the end of each month.  Code that is ready
makes it into that month's release.  Code that is not yet ready will wait.</p>
+<p>Proposed Roadmap:</p>
+<li>Version 0.2 at the end of Oct, 2010 with the high-level methods
+    migrated from ODFDOM and organized in new package structure;</li>
+<li>Version 0.3 at the end of Nov, 2010 with high-level style API;</li>
+<li>Version 0.4 at the end of Jan, 2011 with additional high-level text methods;</li>
+<li>Version 0.5 at the end of March, 2011 with text box and fields methods;</li>
+<li>Version 0.6 at the end of May, 2011 with chart methods;</li>
+<li>Version 0.6.6 at the middle of August, 2011 with bugs fixed;</li>
+<p>More work will be started in Apache.</p>
+<h1 id="frequently_asked_questions">Frequently Asked Questions</h1>
+<h3 id="for_users">For Users</h3>
+<h4 id="how_to_download_and_install">How to download and install</h4>
+<p>You can get Simple Java API for ODF as binary distribution from the [
download] area. There you'll find Javadocs as well. To obtain source code, please refer to
[[#download_source|development section]]. </p>
+<h3 id="how_to_start_development">How to start development</h3>
+<p>I suggest you to start from an overview of this project. [[PackageLayer|This page]]
will give you an overall introduction of the package structures. After that, you can go to
the [ Cookbook] and [ Demos]
to read some code samples. And then, you can start your own program to manipulate ODF document.</p>
+<p>If you are familar with ODFDOM, [
Here] are the API changes from ODFDOM.</p>
+<h3 id="prerequisites">Prerequisites</h3>
+<p>In addition to the Simple Java API JAR file you will need to download and install
the following runtime prerequisite:</p>
+<li>JDK version 1.6</li>
ODFDOM 0.8.7]</li>
+<li>The Apache Xerces 2.9.1 or higher version. (download from [
Apache Xerces web site])</li>
+<h4 id="code_examples">Code examples</h4>
+<h1 id="you-can-find-sample-codes-from-our-httpsimpleodftoolkitorg-cookbook-and-httpsimpleodftoolkitorg-demos">You
can find sample codes from our [ Cookbook] and [
+<p>The Simple Java API for ODF uses Bugzilla to track the defects. You can report defects
[;order=bugs.bug_id here].</p>
+<p>===For Developers===</p>
+<h3 id="how_to_download_source">How to download source</h3>
+<p>First, install [ latest Mercurial]</p>
+<p>Second, setup Mercurial (optional):<br />Config file <Hg Install Dir>Mercurial.ini
on Windows or <Hg Install Dir>/.hgrc on Unix.
+Enhance the default configuration, using GIT diff and enable [
default plugin] avoid different line breaks in the source.<br /></p>
+<div class="codehilite"><pre><span class="k">[ui]</span>
+<span class="na">username</span> <span class="o">=</span> <span
class="s">your Name &lt;;</span>
+<span class="c">;merge = your-merge-program (or internal:merge)</span>
+<span class="k">[diff]</span>
+<span class="na">git</span> <span class="o">=</span> <span class="s">1</span>
+<span class="k">[defaults]</span>
+<span class="na">diff</span><span class="o">=</span><span class="s">-p
-U 8</span>
+<span class="k">[extensions]</span>
+<span class="c"># Enables mercurial EOL extension for line break handling</span>
+<span class="c"># See (bundled since
+<span class="na">eol</span> <span class="o">=</span>
+<span class="c"># It&#39;ll remove unknown files and empty directories by default.
+<span class="c"># Usually you call &#39;hg update -C&#39; and &#39;hg purge&#39;
in sequence</span>
+<span class="c"># See  (bundled)</span>
+<span class="na">hgext.purge</span><span class="o">=</span>
+<span class="k">[eol]</span>
+<span class="c"># Converts mixed line ending within a file to LF (Unix) format </span>
+<span class="c"># before adding the file to the source repository</span>
+<span class="c"># See</span>
+<span class="na">only-consistent</span> <span class="o">=</span>
<span class="s">False</span>
+<p>Now, get the source code from the Simple project [
Mercurial] repository. Please see below for a short introduction to using Mercurial on
There's also a more general <a href="{{project help page SourceControl}}">help</a>
on how to use source control systems on The command <br /><pre>
+hg clone</pre>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.2, you may want to use<br /><pre>hg clone -r v0.2</pre>Developers however always work
on the latest changeset.</p>
+<p>====How to build and run the unit tests=====
+After the source code is checked out, now get and install [ Apache
Maven]. On command line test your installation with "mvn -v".</p>
+<p>If Maven is correctly installed, change into the project directory and build with
command "mvn".</p>
+You can subscribe to the project's mailing lists from [
this page].  The "users" list is for discussions about using the toolkit, and the "dev" list
is for discussing the development of the toolkit.  Active developers should also subscribe
to the "issues" and "commit" mailing lists so they will receive those automatic notifications.</p>
+<p>==Easy entry level tasks==
+<p>==<span id="Design_of_the_API">Design of the API</span>==
+The design principle is "make it easy for users to locate the functions they want".</p>
+<p>org.odftoolkit.simple.Document is the abstract base class which the specific document
classes are derived from:  TextDocument, SpreadsheetDocument, PresentationDocument, GraphicsDocument
and ChartDocument.</p>
+<p>For each document type  we have a subpackage that contain additional classes related
to that kind of documents.  So org.odftoolkit.simple.chart has classes related to chart, org.odftoolkit.simple.text
has classes related to text content,  and org.odftoolkit.simple.presentation has classes related
to presentation documents.</p>
+<p>Besides the packages for different document types, there are additional packages
defined for important common ODF features which are available across all kinds of documents,
such as table, meta and style. </p>
+<p>There is another package named org.odftoolkit.simple.common, which contains functions
that are not related with a specific document type nor a specific feature. For example, the
text extractor functions are put in this package.</p>
+<p>==How to contribute patches==
+If you want to contribute a patch to this project, following below steps:</p>
+<li>Step 1. Create an issue in
+    [;order=bugs.bug_id
+    bugzilla], or write a comment to a related open issue, to describe
+    what functions you want to provide.</li>
+<li>Step 2. Go through "[[#Design_of_the_API|Design of the API]]" to make sure your
contribution will follow it.</li>
+<li>Step 3. Check out the source code following the steps in [[#download_source|development
selection]], and add your
+    contribution codes, including the source code and the unit tests.
+    Every public method should have a corresponding unit test method.
+    The
+    [
+    code guidelines] are same as ODFDOM.</li>
+<li>Step 4. Test your contribution with Mecurial command to make sure all the unit
tests pass.  mvn</li>
+<li>Step 5. Generate a patch with hg commands.  hg commit -A -u "Developer:xxx" -m
"#bug XY# Description of changes"  hg export -a
+    -g -o ../myChanges.patch</li>
+<li>Step 6. Upload your patch to bugzilla.</li>
+<li>Step 7. Refactor your patch if you get comments from reviewers.</li>
+<h2 id="how_to_review_patches">How to review patches</h2>
+<p>As a reviewer, you need to carefully read the source code, run the unit tests, to
make sure the new contributed code won't hurt the quality of this project.
+<em>Step 1. Write a comment to [;order=bugs.bug_id
bugzilla], saying you would like to review this patch.
+</em>Step 2. Check out the source code following the steps in [[#download_source|development
selection]], and download the patch.
+<em>Step 3. Merge the patch to the source code with Mecurial command:
+ hg import --no-commit ../someFile.patch
+</em>Step 4. Carefully read the code to make sure the code follows the "[[#Design_of_the_API|Design
of the API]]", the code can reach the goal and the code won't bring other problems.
+<em>Step 5. Carefully check the unit test code to make sure every public method has
been enough tested.
+</em>Step 6. Run the unit tests with Maven command to see if all the unit tests pass:
+ mvn
+<em>Step 7. Write comment to bugzilla if you think anything needs to be improved.
+</em>Step 8. Repeat step 2 to 7 after the contributor improves the patch.
+*Step 9. Push the patch to repository with Mecurial command if you think the patch is good
+ hg commit -A -u "Developer:xxx Reviewer:yyy" -m "#bug XY# Description of changes"
+ hg push https://<your user id>:<your password></p>
+<h2 id="reference_material">Reference material</h2>
+<h3 id="odf">ODF</h3>
+<p>The current draft of the OASIS ODF 1.2 standard can be downloaded [
+<h3 id="commands_line_tools">Commands line tools</h3>
+<p><em>[ Here]
is a list of the most frequently used commands for Mercurial.
+</em>[ Here] is a list
of the most frequently used commands for Maven.</p>
+  </div>
+  <div id="footera">
+    <div id="poweredby">
+      <p><img src="/odftoolkit/images/feather-small.gif"/><br/>Powered
by the Apache CMS.</p>
+    </div>
+    <div id="copyrighta">
+      <p>
+	Apache "ODF Toolkit" is an effort undergoing incubation at The Apache Software Foundation
(ASF), sponsored by the Apache Incubator.
+	Incubation is required of all newly accepted projects until a further review indicates that
the infrastructure, communications, and
+	decision making process	have stabilized in a manner consistent with other successful ASF
projects. While incubation status is
+	not necessarily a reflection of the completeness or stability of the code, it does indicate
that the project has
+	yet to be fully endorsed by the ASF.</p>
+      <p>
+	Copyright &copy; 2011 The Apache Software Foundation Licensed under the <a href="">Apache
License, Version 2.0</a>.
+	<a href="/openofficeorg/contact.html">Contact Us</a>
+	<br />Apache and the Apache feather logos are trademarks of The Apache Software Foundation.
+	<br />Other names appearing on the site may be trademarks of their respective owners.
+      </p>
+    </div>
+  </div>

View raw message