incubator-odf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From devin...@apache.org
Subject svn commit: r1209586 - /incubator/odf/trunk/README.txt
Date Fri, 02 Dec 2011 17:03:41 GMT
Author: devinhan
Date: Fri Dec  2 17:03:40 2011
New Revision: 1209586

URL: http://svn.apache.org/viewvc?rev=1209586&view=rev
Log:
Update README.txt to supply more detail information about sub components.

Modified:
    incubator/odf/trunk/README.txt

Modified: incubator/odf/trunk/README.txt
URL: http://svn.apache.org/viewvc/incubator/odf/trunk/README.txt?rev=1209586&r1=1209585&r2=1209586&view=diff
==============================================================================
--- incubator/odf/trunk/README.txt (original)
+++ incubator/odf/trunk/README.txt Fri Dec  2 17:03:40 2011
@@ -1,55 +1,116 @@
-*************************************************************
-*                                                           *
-*                Apache ODF Toolkit                         *
-*                                                           *
-*************************************************************
-
-About ODF Toolkit
-------------------
-
-The ODF Toolkit is a set of Java modules that allow programmatic creation, 
-scanning and manipulation of OpenDocument Format (ISO/IEC 26300 == ODF) documents. 
-Unlike other approaches which rely on runtime manipulation of heavy-weight editors 
-via an automation interface, the ODF Toolkit is lightweight and ideal for server use.
+====================================================================================
+
+							Apache ODF Toolkit  
+			<http://incubator.apache.org/odftoolkit/index.html>
+		
+====================================================================================
+
+ODF Toolkit is a set of Java modules that allow programmatic creation, scanning and 
+manipulation of OpenDocument Format (ISO/IEC 26300 == ODF) documents. Unlike other 
+approaches which rely on runtime manipulation of heavy-weight editors via an 
+automation interface, the ODF Toolkit is lightweight and ideal for server use.
+It's an incubator project of the Apache Software Foundation <http://www.apache.org/>.
+
+ODF Toolkit owns 4 subcomponents:
+
+1. ODFDOM (odfdom-java-*.jar) 
+	This is an OpenDocument Format (ODF) framework. Its purpose is to provide 
+	an easy common way to create, access and manipulate ODF files, without 
+	requiring detailed knowledge of the ODF specification. It is designed to 
+	provide the ODF developer community with an easy lightwork programming API 
+	portable to any object-oriented language.
+	
+2. Simple API (simple-odf-*.jar)
+	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
+
+3. ODF Validator (odfvalidator-*.jar, odfvalidator-*.war)
+	This is a tool that validates OpenDocument Format (ODF) files and checks them
+	for certain conformance criteria. ODF Validator is available as an online 
+	service and as a command line tool. This page primarily describes the command 
+	line tool. Please visit web page:
+	   http://incubator.apache.org/odftoolkit/conformance/ODFValidator.html
+	for details regarding the online tool.
+
+4. ODF XSLT Runner(xslt-runner-*.jar, xslt-runner-task-*.jar)
+	ODF XSLT Runner is a small Java application that allows you to apply XSLT 
+	stylesheets to XML streams included in ODF packages without extracting them 
+	from the package. It can be used from the command line. A driver to use it 
+	within Ant build files, ODF XSLT Runner Task, is also available.
+
+
+Getting Started
+===============
+
+ODF Toolkit is based on Java 5 and uses the Maven 2 <http://maven.apache.org/>
+build system. To build ODF Toolkit, use the following command in this directory:
+
+    mvn clean install
+
+The simplest way to use these modules are just put the jar-with-dependencies files
+in your classpath directly.
 
 Documentation
-------------------
-The home page of this project:
+=============
+
+The Home Page of ODF Toolkit:
     http://incubator.apache.org/odftoolkit/index.html
     
-Simple ODF API Getting Start Guide:    
-    http://incubator.apache.org/odftoolkit/simple/gettingstartguide.html
-    
-Simple ODF API Cookbook:
+ODFDOM Getting Start Guide:    
+    http://incubator.apache.org/odftoolkit/odfdom/index.html   
+     
+Simple API Getting Start Guide:    
+    http://incubator.apache.org/odftoolkit/simple/gettingstartguide.html    
+       
+Simple API Cookbook:
     http://simple.odftoolkit.org/
     
-Simple ODF API Demos:
+Simple API Demos:
     http://incubator.apache.org/odftoolkit/simple/demo/index.html
     
-Simple ODF API Online JavaDoc:
+Simple API Online JavaDoc:
     http://incubator.apache.org/odftoolkit/simple/document/javadoc/index.html
     
+ODF Validator Getting Start Guide:   
+    http://incubator.apache.org/odftoolkit/conformance/ODFValidator.html
+    
+ODF XSLT Runner Getting Start Guide:   
+    http://incubator.apache.org/odftoolkit/xsltrunner/ODFXSLTRunner.html     
+    
+    
+License (see also LICENSE.txt)
+==============================
+
+Collective work: Copyright 2011 The Apache Software Foundation.
+
+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
+
+     http://www.apache.org/licenses/LICENSE-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.
+
+Apache ODF Toolkit includes a number of subcomponents with separate copyright
+notices and license terms. Your use of these subcomponents is subject to
+the terms and conditions of the licenses listed in the LICENSE.txt file.
+    
     
-License
-------------------
-Apache License, Version 2.0. Please see file LICENSE.txt.
-
-
-Installation
-------------------
-Just put the file simple.jar in your classpath. You will
-need ODFDOM0.9-SNAPSHOT and Apache Xerces-J 2.9.1 as well. Get them from
-    http://odftoolkit.org/projects/simple/downloads/directory/tools
-    http://xerces.apache.org/mirrors.cgi
- 
-How to build
-------------------   
-The Apache ODF Toolkit uses Apache Maven for building (http://maven.apache.org/).  
-If you have Maven already installed you can build by entering the command "mvn install".
  
+Mailing Lists
+=============
 
+Discussion about ODF Toolkit takes place on the following mailing lists:
 
-Mail List
-------------------
 Development Mailing List
     Subscribe: odf-dev-subscribe@incubator.apache.org
     Post (after subscription): odf-dev@incubator.apache.org
@@ -64,9 +125,24 @@ Users Mailing List
     Unsubscribe: odf-users-unsubscribe@incubator.apache.org
     Archives: http://mail-archives.apache.org/mod_mbox/incubator-odf-users/
 
+Notification on all code changes are sent to the following mailing list:
+
+    odf-commits@incubator.apache.org
+
+The mailing lists are open to anyone and publicly archived.
+
+
+Issue Tracker
+=============
+
+If you encounter errors in ODF Toolkit or want to suggest an improvement or
+a new feature, please visit the ODF Toolkit issue tracker at
+https://issues.apache.org/jira/browse/ODFTOOLKIT. There you can also find the
+latest information on known issues and recent bug fixes and enhancements.
+
+
+
+
 
-JIRA for Issues
-------------------
-https://issues.apache.org/jira/browse/ODFTOOLKIT
     
     
\ No newline at end of file



Mime
View raw message