incubator-odf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From robw...@apache.org
Subject svn commit: r1161365 - /incubator/odf/site/trunk/content/odftoolkit/simple/ReleaseNotes.mdtext
Date Thu, 25 Aug 2011 02:39:31 GMT
Author: robweir
Date: Thu Aug 25 02:39:31 2011
New Revision: 1161365

URL: http://svn.apache.org/viewvc?rev=1161365&view=rev
Log:
Partially converted to Markdown.  Still needs some work

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

Modified: incubator/odf/site/trunk/content/odftoolkit/simple/ReleaseNotes.mdtext
URL: http://svn.apache.org/viewvc/incubator/odf/site/trunk/content/odftoolkit/simple/ReleaseNotes.mdtext?rev=1161365&r1=1161364&r2=1161365&view=diff
==============================================================================
--- incubator/odf/site/trunk/content/odftoolkit/simple/ReleaseNotes.mdtext (original)
+++ incubator/odf/site/trunk/content/odftoolkit/simple/ReleaseNotes.mdtext Thu Aug 25 02:39:31
2011
@@ -1,92 +1,101 @@
-=Simple Java API for ODF=
+Title: Simple API Release Notes
+##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][1].
 
-==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:
-*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]]. 
 
-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.
+  - 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 here. The full release notes can be found here. 
+
+You are welcomed to give us any feedback by Bugzilla, eMail or forum. 
 
-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]. 
+##Project roadmap and schedule
 
-==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.
 
 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==
 
-===For Users===
 
-====How to download and install====
+  - 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 [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]]. 
 
-====How to start development====
+###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 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])
 
-====Code examples====
+####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===
 
-====<span id="download_source">How to download source</span>====
+###How to download source
+
 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.<br />
+
+    [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.
@@ -117,18 +126,26 @@ There is another package named org.odfto
 
 ==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.
@@ -144,10 +161,14 @@ As a reviewer, you need to carefully rea
  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===
+##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===
+
+###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.
 
+[1]: http://incubator.apache.org/odftoolkit/odfdom/index.html
\ No newline at end of file



Mime
View raw message