incubator-odf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From robw...@apache.org
Subject svn commit: r1161799 - /incubator/odf/site/trunk/content/odftoolkit/simple/Home.mdtext
Date Thu, 25 Aug 2011 23:41:16 GMT
Author: robweir
Date: Thu Aug 25 23:41:16 2011
New Revision: 1161799

URL: http://svn.apache.org/viewvc?rev=1161799&view=rev
Log:
Partial conversion to mdtext.

Modified:
    incubator/odf/site/trunk/content/odftoolkit/simple/Home.mdtext

Modified: incubator/odf/site/trunk/content/odftoolkit/simple/Home.mdtext
URL: http://svn.apache.org/viewvc/incubator/odf/site/trunk/content/odftoolkit/simple/Home.mdtext?rev=1161799&r1=1161798&r2=1161799&view=diff
==============================================================================
--- incubator/odf/site/trunk/content/odftoolkit/simple/Home.mdtext (original)
+++ incubator/odf/site/trunk/content/odftoolkit/simple/Home.mdtext Thu Aug 25 23:41:16 2011
@@ -1,110 +1,150 @@
-=Simple Java API for ODF=
+Title: Simple Java API for ODF
+##What is the Simple Java API for ODF?
 
-__TOC__
+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 ODFDOM API.
 
-==What is the Simple Java API for ODF?==
-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 [http://odftoolkit.org/projects/odfdom/pages/Home ODFDOM
API].
+##New Release 0.6.6
 
-==New Release 0.6.6==
+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:
 
-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:
-*Two critical bugs in the Navigation API are fixed, as well as several other issues.
-*Page columns,  a page layout feature in text documents, are supported.
-*Unit test coverage rate increased.  This work improves the stability of our API.
-You can download it [http://odftoolkit.org/projects/simple/downloads/directory/0.6.6 here].
The full release notes can be found [[ReleaseNotes|here]]. 
+  - Two critical bugs in the Navigation API are fixed, as well as
+    several other issues.
+  - *Page columns,  a page layout feature in text documents, are supported.
+  - *Unit test coverage rate increased.  This work improves the stability of our API.
 
-ODF Toolkit has been accepted as [http://incubator.apache.org/projects/odftoolkit.html Apache
incubator project ] and the move process has been started. The security features (encryption
and digital signatures) will be included in Apache version. Thanks all of the contributors
and users, please continue to pay attention to us in Apache.
+You can download it here. The full release notes can be found here. 
 
-You are welcomed to give us any feedback by [http://odftoolkit.org/bugzilla/buglist.cgi?product=simple&order=bugs.bug_id
Bugzilla], [http://odftoolkit.org/projects/simple/lists eMail] or [http://odftoolkit.org/projects/simple/forums
forum]. 
+ODF Toolkit has been accepted as an Apache incubator project and the move 
+process has been started. The security features (encryption and digital 
+signatures) will be included in Apache version. Thanks all of the contributors 
+and users, please continue to pay attention to us in Apache.
 
-==Project roadmap and schedule==
-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.
+##Project roadmap and schedule
 
-Proposed Roadmap:
-*Version 0.2 at the end of Oct, 2010 with the high-level methods migrated from ODFDOM and
organized in new package structure;
-*Version 0.3 at the end of Nov, 2010 with high-level style API;
-*Version 0.4 at the end of Jan, 2011 with additional high-level text methods;
-*Version 0.5 at the end of March, 2011 with text box and fields methods;
-*Version 0.6 at the end of May, 2011 with chart methods;
-*Version 0.6.6 at the middle of August, 2011 with bugs fixed;
-*More work will be started in Apache.
-
-==Frequently Asked Questions==
+The Simple Java API for ODF adheres 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.
 
-===For Users===
+Proposed Roadmap:
 
-====How to download and install====
-You can get Simple Java API for ODF as binary distribution from the [http://odftoolkit.org/projects/simple/downloads
download] area. There you'll find Javadocs as well. To obtain source code, please refer to
[[#download_source|development section]]. 
+  - Version 0.2 at the end of Oct, 2010 with the high-level methods migrated from ODFDOM
and organized in new package structure;
+  - Version 0.3 at the end of Nov, 2010 with high-level style API;
+  - Version 0.4 at the end of Jan, 2011 with additional high-level text methods;
+  - Version 0.5 at the end of March, 2011 with text box and fields methods;
+  - Version 0.6 at the end of May, 2011 with chart methods;
+  - Version 0.6.6 at the middle of August, 2011 with bugs fixed;
+  - More work will be started in Apache.
+
+##Frequently Asked Questions
+
+###For Users
+
+####How to download and install
+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 development section.

+
+####How to start development
+I suggest you to start from an overview of this project. 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.
 
-====How to start development====
-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.
+If you are familiar with ODFDOM, here are the API changes from ODFDOM.
 
-If you are familar with ODFDOM, [http://odftoolkit.org/projects/simple/pages/PackageLayer#APIchanges
Here] are the API changes from ODFDOM.
+####Prerequisites
 
-====Prerequisites====
 In addition to the Simple Java API JAR file you will need to download and install the following
runtime prerequisite:
 
 * JDK version 1.6
-* [https://oss.sonatype.org/content/groups/public/org/odftoolkit/odfdom-java/0.8.7/odfdom-java-0.8.7.jar
ODFDOM 0.8.7]
-* The Apache Xerces 2.9.1 or higher version. (download from [http://xerces.apache.org/mirrors.cgi
Apache Xerces web site])
+* ODFDOM 0.8.7
+* The Apache Xerces 2.9.1 or higher version.
+
+####Code examples
+
+You can find sample codes from our Cookbook] and Demos.
+
+####How to report defects
 
-====Code examples====
-You can find sample codes from our [http://simple.odftoolkit.org/ Cookbook] and [http://simple.odftoolkit.org/
Demos].
-====How to report defects====
 The Simple Java API for ODF uses Bugzilla to track the defects. You can report defects [http://odftoolkit.org/bugzilla/buglist.cgi?product=simple&order=bugs.bug_id
here].
 
-===For Developers===
+###For Developers
+
+###How to download source
 
-====<span id="download_source">How to download source</span>====
 First, install [http://mercurial.selenic.com/wiki/ latest Mercurial]
 
 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 /><pre>
-[ui]
-username = your Name <yourLoginName@odftoolkit.org>
-;merge = your-merge-program (or internal:merge)
-
-[diff]
-git = 1
-
-[defaults]
-diff=-p -U 8
-
-[extensions]
-# Enables mercurial EOL extension for line break handling
-# See http://mercurial.selenic.com/wiki/EolExtension (bundled since 1.5.4)
-eol =
-
-# It'll remove unknown files and empty directories by default. 
-# Usually you call 'hg update -C' and 'hg purge' in sequence
-# See http://mercurial.selenic.com/wiki/PurgeExtension  (bundled)
-hgext.purge=
-
-[eol]
-# Converts mixed line ending within a file to LF (Unix) format 
-# before adding the file to the source repository
-# See http://mercurial.selenic.com/wiki/EolExtension
-only-consistent = False
+Enhance the default configuration, using GIT diff and enable [http://mercurial.selenic.com/wiki/Win32TextExtension
default plugin] avoid different line breaks in the source.
+
+    [ui]
+    username = your Name <yourLoginName@odftoolkit.org>
+    ;merge = your-merge-program (or internal:merge)
+    
+    [diff]
+    git = 1
+    
+    [defaults]
+    diff=-p -U 8
+    
+    [extensions]
+    # Enables mercurial EOL extension for line break handling
+    # See http://mercurial.selenic.com/wiki/EolExtension (bundled since 1.5.4)
+    eol =
+    
+    # It'll remove unknown files and empty directories by default. 
+    # Usually you call 'hg update -C' and 'hg purge' in sequence
+    # See http://mercurial.selenic.com/wiki/PurgeExtension  (bundled)
+    hgext.purge=
+    
+    [eol]
+    # Converts mixed line ending within a file to LF (Unix) format 
+    # before adding the file to the source repository
+    # See http://mercurial.selenic.com/wiki/EolExtension
+    only-consistent = False
 
 </pre>
 
-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.
+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.
+
+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
+
+    hg clone https://odftoolkit.org/hg/simple~code-base -r v0.2
+
+Developers however always work on the latest changeset.
+
+####How to build and run the unit tests
 
-====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".
+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".
 
-If Maven is correctly installed, change into the project directory and build with command
"mvn".
+If Maven is correctly installed, change into the project directory and build 
+with command "mvn".
+
+##Communications
 
-==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.
 
 
-==Easy entry level tasks==
+##Easy entry level tasks
 TBD
 
-==<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".
+##Design of the API
+
+The design principle is "make it easy for users to locate the functions they 
+want".
 
 org.odftoolkit.simple.Document is the abstract base class which the specific document classes
are derived from:  TextDocument, SpreadsheetDocument, PresentationDocument, GraphicsDocument
and ChartDocument.
 
@@ -115,40 +155,52 @@ Besides the packages for different docum
 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.
 
 
-==How to contribute patches==
+##How to contribute patches
+
 If you want to contribute a patch to this project, following below steps:
-*Step 1. Create an issue in [http://odftoolkit.org/bugzilla/buglist.cgi?product=simple&order=bugs.bug_id
bugzilla], or write a comment to a related open issue, to describe what functions you want
to provide.
-*Step 2. Go through "[[#Design_of_the_API|Design of the API]]" to make sure your contribution
will follow it.
-*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.
-*Step 4. Test your contribution with Mecurial command to make sure all the unit tests pass.
- mvn
-*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
-*Step 6. Upload your patch to bugzilla.
-*Step 7. Refactor your patch if you get comments from reviewers.
 
-==How to review patches==
+  - Step 1. Create an issue in [http://odftoolkit.org/bugzilla/buglist.cgi?product=simple&order=bugs.bug_id
+    bugzilla], or write a comment to a related open issue, to describe
+    what functions you want to provide.
+  - Step 2. Go through "[[#Design_of_the_API|Design of the API]]" to make sure your contribution
will follow it.
+  - 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.
+  - Step 4. Test your contribution with Mecurial command to make sure all the unit tests
pass.  mvn
+  - 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
+  - Step 6. Upload your patch to bugzilla.
+  - Step 7. Refactor your patch if you get comments from reviewers.
+
+##How to review patches
+
 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.
-*Step 1. Write a comment to [http://odftoolkit.org/bugzilla/buglist.cgi?product=simple&order=bugs.bug_id
bugzilla], saying you would like to review this patch.
-*Step 2. Check out the source code following the steps in [[#download_source|development
selection]], and download the patch.
-*Step 3. Merge the patch to the source code with Mecurial command:
- hg import --no-commit ../someFile.patch
-*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.
-*Step 5. Carefully check the unit test code to make sure every public method has been enough
tested.
-*Step 6. Run the unit tests with Maven command to see if all the unit tests pass:
- mvn
-*Step 7. Write comment to bugzilla if you think anything needs to be improved.
-*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
 
-==Reference material==
-===ODF===
+  - Step 1. Write a comment to [http://odftoolkit.org/bugzilla/buglist.cgi?product=simple&order=bugs.bug_id
+    bugzilla], saying you would like to review this patch.
+  - Step 2. Check out the source code following the steps in [[#download_source|development
selection]], and download the patch.
+  - Step 3. Merge the patch to the source code with Mecurial command:  hg import --no-commit
../someFile.patch
+  - 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.
+  - Step 5. Carefully check the unit test code to make sure every public method has been
enough tested.
+  - Step 6. Run the unit tests with Maven command to see if all the unit tests pass:  mvn
+  - Step 7. Write comment to bugzilla if you think anything needs to be improved.
+  - 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
+
+##Reference material
+
+###ODF
+
 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].
-===Commands line tools===
-*[http://odftoolkit.org/projects/odfdom/pages/Development#Mercurial Here] is a list of the
most frequently used commands for Mercurial.
-*[http://odftoolkit.org/projects/odfdom/pages/Development#Maven Here] is a list of the most
frequently used commands for Maven.
 
+###Commands line tools
 
+*[http://odftoolkit.org/projects/odfdom/pages/Development#Mercurial Here] is a list of the
most frequently used commands for Mercurial.
+*[http://odftoolkit.org/projects/odfdom/pages/Development#Maven Here] is a list of the most
frequently used commands for Maven.



Mime
View raw message