incubator-odf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From devin...@apache.org
Subject svn commit: r795867 - in /websites/production/odftoolkit: ./ content/odftoolkit/simple/document/faq.html content/odftoolkit/simple/document/simple_odf_structure.jpg
Date Fri, 16 Sep 2011 07:52:40 GMT
Author: devinhan
Date: Fri Sep 16 07:52:39 2011
New Revision: 795867

Log:
Publishing merge to odftoolkit site by devinhan

Added:
    websites/production/odftoolkit/content/odftoolkit/simple/document/simple_odf_structure.jpg
      - copied unchanged from r795866, websites/staging/odftoolkit/trunk/content/odftoolkit/simple/document/simple_odf_structure.jpg
Modified:
    websites/production/odftoolkit/   (props changed)
    websites/production/odftoolkit/content/odftoolkit/simple/document/faq.html

Propchange: websites/production/odftoolkit/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Fri Sep 16 07:52:39 2011
@@ -1 +1 @@
-/websites/staging/odftoolkit/trunk:794771-795859
+/websites/staging/odftoolkit/trunk:794771-795866

Modified: websites/production/odftoolkit/content/odftoolkit/simple/document/faq.html
==============================================================================
--- websites/production/odftoolkit/content/odftoolkit/simple/document/faq.html (original)
+++ websites/production/odftoolkit/content/odftoolkit/simple/document/faq.html Fri Sep 16
07:52:39 2011
@@ -21,7 +21,7 @@
 
 <link href="/odftoolkit/css/odf.css" rel="stylesheet" type="text/css">
 
-<title></title>
+<title>Frequently Asked Questions</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
 </head>
@@ -77,29 +77,36 @@
   </div>
   <div id="contenta">
   
-    
-    <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 <a href="../download.html">download</a>
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 [http://simple.odftoolkit.org/cookbook/ Cookbook] and [http://simple.odftoolkit.org/ 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, [http://odftoolkit.org/projects/simple/pages/PackageLayer#APIchanges
Here] are the API changes from ODFDOM.</p>
-<h3 id="prerequisites">Prerequisites</h3>
+    <h1 class="title">Frequently Asked Questions</h1>
+    <h2 id="for_users">For Users</h2>
+<p><strong>How to download and install</strong>  <br />
+</p>
+<p>You can get Simple Java API for ODF as binary distribution from the <a href="../download.html">download</a>
area. There you'll find Javadocs as well. To obtain source code, please refer to development
section. </p>
+<p><strong>How to start development</strong>  <br />
+</p>
+<p>I suggest you to start from an overview of this project. <a href="PackageLayer.html">This
page</a> will give you an overall introduction of the package structures. After that,
you can go to the <a href="cookbook/index.html">Cookbook</a> and <a href="../demo/index.html">Demos</a>
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, <a href="PackageLayer.html">Here</a>
are the API changes from ODFDOM.</p>
+<p><strong>Prerequisites</strong> <br />
+</p>
 <p>In addition to the Simple Java API JAR file you will need to download and install
the following runtime prerequisite:</p>
 <ul>
 <li>JDK version 1.6</li>
-<li>[https://oss.sonatype.org/content/groups/public/org/odftoolkit/odfdom-java/0.8.7/odfdom-java-0.8.7.jar
ODFDOM 0.8.7]</li>
-<li>The Apache Xerces 2.9.1 or higher version. (download from [http://xerces.apache.org/mirrors.cgi
Apache Xerces web site])</li>
+<li><a href="http://odftoolkit-extra.apache-extras.org.codespot.com/files/odfdom-0.8.7.jar">ODFDOM
0.8.7</a></li>
+<li>The Apache Xerces 2.9.1 or higher version. (download from <a href="http://xerces.apache.org/mirrors.cgi">Apache
Xerces web site</a>)</li>
 </ul>
-<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 [http://simple.odftoolkit.org/ Cookbook] and [http://simple.odftoolkit.org/
Demos].</h1>
-<p>The Simple Java API for ODF uses Bugzilla to track the defects. You can report defects
[http://odftoolkit.org/bugzilla/buglist.cgi?product=simple&amp;order=bugs.bug_id here].</p>
-<p>===For Developers===</p>
-<h3 id="how_to_download_source">How to download source</h3>
-<p>First, install [http://mercurial.selenic.com/wiki/ 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 [http://mercurial.selenic.com/wiki/Win32TextExtension
default plugin] avoid different line breaks in the source.<br /></p>
+<p><strong>Code examples</strong>  <br />
+You can find sample codes from our <a href="cookbook/index.html">Cookbook</a>
and <a href="../demo/index.html">Demos</a>.  <br />
+</p>
+<p><strong>How to report defects</strong>   <br />
+The Simple API uses Bugzilla to track the defects. You can report defects <a href="http://odftoolkit.org/bugzilla/buglist.cgi?product=simple&amp;order=bugs.bug_id">here</a>.</p>
+<h2 id="for_developers">For Developers</h2>
+<p><strong>How to download source</strong>  <br />
+</p>
+<p>First, install <a href="http://mercurial.selenic.com/wiki/">latest Mercurial</a>
<br />
+Second, setup Mercurial (optional): <br />
+     Config file &lt;Hg Install Dir&gt;Mercurial.ini on Windows or &lt;Hg Install
Dir&gt;/.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>
 <div class="codehilite"><pre><span class="k">[ui]</span>
 <span class="na">username</span> <span class="o">=</span> <span
class="s">your Name &lt;yourLoginName@odftoolkit.org&gt;</span>
 <span class="c">;merge = your-merge-program (or internal:merge)</span>
@@ -128,62 +135,103 @@ Enhance the default configuration, using
 </pre></div>
 
 
-<p>Now, get the source code from the Simple project [http://www.selenic.com/mercurial/wiki/
Mercurial] 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 /><pre>
-hg clone https://hg.odftoolkit.org/hg/simple~code-base</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
https://odftoolkit.org/hg/simple~code-base -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 [http://maven.apache.org/ 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>
-<p>==Communications==
-You can subscribe to the project's mailing lists from [http://odftoolkit.org/projects/simple/lists
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==
-TBD</p>
-<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>
-<ul>
-<li>Step 1. Create an issue in
-    [http://odftoolkit.org/bugzilla/buglist.cgi?product=simple&amp;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
-    [http://odftoolkit.org/projects/odfdom/pages/Development#Coding_Guidelines
-    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>
+<p>Now, get the source code from the Simple project <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 help on how to use source control systems on odftoolkit.org. The
command   <br />
+</p>
+<p><code>hg clone https://hg.odftoolkit.org/hg/simple~code-base</code></p>
+<p>will download the repository into a new directory. </p>
+<p>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 https://odftoolkit.org/hg/simple~code-base
-r v0.2</pre>Developers however always work on the latest changeset.</p>
+<p><strong>How to build and run the unit tests</strong>   <br />
+After the source code is checked out, now get and install <a href="http://maven.apache.org/">Apache
Maven</a>. On command line test your installation with <code>"mvn -v"</code>.</p>
+<p>If Maven is correctly installed, change into the project directory and build with
command <code>"mvn"</code>.</p>
+<h2 id="communications">Communications</h2>
+<p>You can subscribe to the project's mailing lists from <a href="http://incubator.apache.org/odftoolkit/mailing-lists.html">this
page</a>.  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 "commit" mailing list so they will receive those automatic notifications.</p>
+<h2 id="easy_entry_level_tasks">Easy entry level tasks</h2>
+<p>TBD</p>
+<h2 id="design_of_the_api">Design of the API</h2>
+<p>The design principle is "make it easy for users to locate the functions they want".
  <br />
+</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.   <br />
+</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.  <br />
+</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.    <br />
+</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.   <br />
+</p>
+<h2 id="how_to_contribute_patches">How to contribute patches</h2>
+<p>If you want to contribute a patch to this project, following below steps:</p>
+<ul>
+<li>Step 1. Create an issue in <a href="http://odftoolkit.org/bugzilla/buglist.cgi?product=simple&amp;order=bugs.bug_id">bugzilla</a>,
or write a comment to a related open issue, to describe what functions you want to provide.
   <br />
+</li>
+<li>Step 2. Go through "Design of the API" to make sure your contribution will follow
it.  <br />
+</li>
+<li>Step 3. Check out the source code following the steps in development selection,
and add your  <br />
+    contribution codes, including the source code and the unit tests.  <br />
+    Every public method should have a corresponding unit test method.   <br />
+    The <a href="http://incubator.apache.org/odftoolkit/odfdom/Development.html">code
guidelines</a> are same as ODFDOM.  <br />
+</li>
+<li>Step 4. Test your contribution with Mecurial command to make sure all the unit
tests pass.  <code>mvn</code>  <br />
+</li>
+<li>
+<p>Step 5. Generate a patch with hg commands.     <br />
+</p>
+<p><code>hg commit -A -u "Developer:xxx" -m "#bug XY# Description of changes"</code>
   <br />
+<code>hg export -a -g -o ../myChanges.patch</code></p>
+</li>
+<li>
+<p>Step 6. Upload your patch to bugzilla.</p>
+</li>
 <li>Step 7. Refactor your patch if you get comments from reviewers.</li>
 </ul>
 <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 [http://odftoolkit.org/bugzilla/buglist.cgi?product=simple&amp;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
enough:
- hg commit -A -u "Developer:xxx Reviewer:yyy" -m "#bug XY# Description of changes"
- hg push https://<your user id>:<your password>@odftoolkit.org/hg/simple~code-base</p>
+<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.<br />
+</p>
+<ul>
+<li>Step 1. Write a comment to <a href="http://odftoolkit.org/bugzilla/buglist.cgi?product=simple&amp;order=bugs.bug_id">bugzilla</a>,
saying you would like to review this patch.       <br />
+</li>
+<li>Step 2. Check out the source code following the steps in development selection,
and download the patch.    <br />
+</li>
+<li>
+<p>Step 3. Merge the patch to the source code with Mecurial command: <br />
+</p>
+<p><code>hg import --no-commit ../someFile.patch</code></p>
+</li>
+<li>
+<p>Step 4. Carefully read the code to make sure the code follows the Design of the
API, the code can reach the goal and the code won't bring other problems.  <br />
+</p>
+</li>
+<li>Step 5. Carefully check the unit test code to make sure every public method has
been enough tested.  <br />
+</li>
+<li>
+<p>Step 6. Run the unit tests with Maven command to see if all the unit tests pass:
<br />
+</p>
+<p><code>mvn</code></p>
+</li>
+<li>
+<p>Step 7. Write comment to bugzilla if you think anything needs to be improved. <br
/>
+</p>
+</li>
+<li>Step 8. Repeat step 2 to 7 after the contributor improves the patch.  <br />
+</li>
+<li>
+<p>Step 9. Push the patch to repository with Mecurial command if you think the patch
is good enough: <br />
+</p>
+<p><code>hg commit -A -u "Developer:xxx Reviewer:yyy" -m "#bug XY# Description
of changes"</code> <br />
+<code>hg push https://&lt;your user id&gt;:&lt;your password&gt;@odftoolkit.org/hg/simple~code-base</code></p>
+</li>
+</ul>
 <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 [http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office#odf12
here].</p>
-<h3 id="commands_line_tools">Commands line tools</h3>
-<p><em>[http://odftoolkit.org/projects/odfdom/pages/Development#Mercurial Here]
is a list of the most frequently used commands for Mercurial.
-</em>[http://odftoolkit.org/projects/odfdom/pages/Development#Maven Here] is a list
of the most frequently used commands for Maven.</p>
+<p><strong>ODF</strong>  <br />
+</p>
+<p>The current draft of the OASIS ODF 1.2 standard can be downloaded <a href="http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office#odf12">here</a>.</p>
+<p><strong>Commands line tools</strong> <br />
+</p>
+<ul>
+<li><a href="http://incubator.apache.org/odftoolkit/odfdom/Development.html">Here</a>
is a list of the most frequently used commands for Mercurial.<br />
+</li>
+<li><a href="http://incubator.apache.org/odftoolkit/odfdom/Development.html">Here</a>
is a list of the most frequently used commands for Maven.<br />
+</li>
+</ul>
   </div>
 
   <div id="footera">



Mime
View raw message