incubator-odf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From devin...@apache.org
Subject svn commit: r1170962 - /incubator/odf/site/trunk/content/odftoolkit/odfdom/Development.mdtext
Date Thu, 15 Sep 2011 06:08:04 GMT
Author: devinhan
Date: Thu Sep 15 06:08:04 2011
New Revision: 1170962

URL: http://svn.apache.org/viewvc?rev=1170962&view=rev
Log:
CMS commit to odftoolkit by devinhan

Modified:
    incubator/odf/site/trunk/content/odftoolkit/odfdom/Development.mdtext

Modified: incubator/odf/site/trunk/content/odftoolkit/odfdom/Development.mdtext
URL: http://svn.apache.org/viewvc/incubator/odf/site/trunk/content/odftoolkit/odfdom/Development.mdtext?rev=1170962&r1=1170961&r2=1170962&view=diff
==============================================================================
--- incubator/odf/site/trunk/content/odftoolkit/odfdom/Development.mdtext (original)
+++ incubator/odf/site/trunk/content/odftoolkit/odfdom/Development.mdtext Thu Sep 15 06:08:04
2011
@@ -1,55 +1,69 @@
-=Development=
+title:Development
+**Get and Build the Source Code**
 
-__TOC__
+1. Install latest Mercurial
+1. Setup Mercurial (optional):    
+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][1] 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
+
+1. Get the [ODFDOM source code][2] from the odfdom~developer [Mercurial][3] 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   
+<pre>hg clone https://odftoolkit.org/hg/odfdom~developer</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.8.6, you may want to use<br /><pre>hg clone https://odftoolkit.org/hg/odfdom~developer
-r v0.8.6</pre>
+
+ODFDOM Developers however always work on the latest changeset.   
+Now get and install [Apache Maven][4]. On command line test your installation with "mvn -v".
 
-==Get and Build the Source Code==
+If Maven is correctly installed, change into the project directory and build with command
"mvn".   
 
-# Install [http://mercurial.selenic.com/wiki/ latest Mercurial]
-# Setup Mercurial (optional):<br />Config file <Hg Install Dir>\Mercurial.ini
on Windows or <Hg Install Dir>/.hgrc on Unix.<br/>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
 
-</pre>
-# Get the [http://odftoolkit.org/projects/odfdom/sources ODFDOM source code] from the odfdom~developer
[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://odftoolkit.org/hg/odfdom~developer</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.8.6, you may want to use<br /><pre>hg
clone https://odftoolkit.org/hg/odfdom~developer -r v0.8.6</pre>ODFDOM Developers however
always work on the latest changeset.
+**Set up ODFDOM Development Environment**
 
-Now get and install [http://maven.apache.org/ Apache Maven]. On command line test your installation
with "mvn -v".
+***Using Eclipse IDE***
 
-If Maven is correctly installed, change into the project directory and build with command
"mvn".
+You can also set up your own ODFDOM development environment in Eclipse.
 
-==Set up ODFDOM Development Environment ==
+1. Install [http://java.sun.com/javase/downloads/index_jdk5.jsp Java / JDK 5] (you might
use [http://java.sun.com/javase/downloads/index.jsp JDK 6] if you do not recontribute)
+1. Install [http://www.eclipse.org Eclipse].
+1. Open Eclipse, choose "Window->Preferences->Java->Installed JREs", add JDK 5 as
a installed JRE, and check it to add to the build path of a java project by default.
+1. Install Maven Plugin for Eclipse, see http://m2eclipse.sonatype.org/installing-m2eclipse.html
+1. Install Mercurial Plugin for Eclipse, see http://javaforge.com/project/HGE#download
+1. Get the source code with Mercurial as described above.  
+1. Import ODFDOM Maven project: Choose "File->Import->Maven->Existing Maven project"
 
-=== Using Netbeans IDE ===
+***Using Netbeans IDE***     
 
 To establish your own ODFDOM development environment:
 
-# Install [http://java.sun.com/javase/downloads/index_jdk5.jsp Java / JDK 5] (you might use
[http://java.sun.com/javase/downloads/index.jsp JDK 6] if you do not recontribute)
-# Install [http://netbeans.org NetBeans 6.x]. In case you are new to Netbeans, there are
several nice [http://www.netbeans.org/kb/trails/platform.html tutorials] available.
-# Get the source code with Mercurial as described above.
-# Start Netbeans,  choose "File->Open Project.." from the Netbeans menu and select the
ODFDOM directory.
+1. Install [http://java.sun.com/javase/downloads/index_jdk5.jsp Java / JDK 5] (you might
use [http://java.sun.com/javase/downloads/index.jsp JDK 6] if you do not recontribute)
+1. Install [http://netbeans.org NetBeans 6.x]. In case you are new to Netbeans, there are
several nice [http://www.netbeans.org/kb/trails/platform.html tutorials] available.
+1. Get the source code with Mercurial as described above.
+1. Start Netbeans,  choose "File->Open Project.." from the Netbeans menu and select the
ODFDOM directory.
 As the ODFDOM source bundle comes together with Netbeans project files, ODFDOM opens as a
pre-configured project.
 You still have the opportunity to work solely with [http://maven.apache.org/ Maven] directly
on the command line instead having the IDE GUI comfort provided by Netbeans.
 
@@ -57,24 +71,13 @@ Since Netbeans 6.1 the [http://wiki.netb
 
 After the commitment of your changed files, you need to pull the latest updates from the
server, perhaps merge them with your changes and finally push your changes to the repository
using in the menu Versioning->Mercurial->Share->Push Other...
 and adding
-https://myUserName:myPassword@odftoolkit.org/hg/odfdom~developer
-
-=== Using Eclipse IDE ===
-
-You can also set up your own ODFDOM development environment in Eclipse.
-
-# Install [http://java.sun.com/javase/downloads/index_jdk5.jsp Java / JDK 5] (you might use
[http://java.sun.com/javase/downloads/index.jsp JDK 6] if you do not recontribute)
-# Install [http://www.eclipse.org Eclipse].
-# Open Eclipse, choose "Window->Preferences->Java->Installed JREs", add JDK 5 as
a installed JRE, and check it to add to the build path of a java project by default.
-# Install Maven Plugin for Eclipse, see http://m2eclipse.sonatype.org/installing-m2eclipse.html
-# Install Mercurial Plugin for Eclipse, see http://javaforge.com/project/HGE#download
-# Get the source code with Mercurial as described above.  
-# Import ODFDOM Maven project: Choose "File->Import->Maven->Existing Maven project"
-
-==Command Line Tools==
-
-===Mercurial===
-[http://mercurial.selenic.com/wiki/ Mercurial] is the version control system used for ODFDOM
development.
+https://myUserName:myPassword@odftoolkit.org/hg/odfdom~developer      
+   
+**Command Line Tools**    
+
+***Mercurial***       
+    
+[Mercurial][5] is the version control system used for ODFDOM development.
 
 Here a list of the most frequently used commands:
 <pre>
@@ -125,12 +128,12 @@ Here a list of the most frequently used 
   hg help addremove
   ...
 </pre>
-In case you do changes for a bug or feature request, please export them as a patch and attach
them to the bug's entry on the [http://odftoolkit.org/bugzilla/buglist.cgi?product=odfdom&order=bugs.bug_id
issue list]. If there's no such entry, please create one first.
+In case you do changes for a bug or feature request, please export them as a patch and attach
them to the bug's entry on the [issue list][6]. If there's no such entry, please create one
first.
 
 That way others will review your patch for you. If everything is ok, the reviewer will push
your changes to the global repository. This procedure is the same for all developers and is
meant to keep up code quality.
 
-===Maven===
-[http://maven.apache.org/ Maven] is the build manager used for ODFDOM development.
+***Maven***  
+[Maven][7] is the build manager used for ODFDOM development.
 <pre>
   // Build the project and create target/odfdom.jar
   mvn
@@ -151,31 +154,31 @@ That way others will review your patch f
 
 </pre>
 
-==Coding Guidelines==
-ODFDOM take advantage of the existing [http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html
Java Coding Guidelines]. 
+**Coding Guidelines**
+ODFDOM take advantage of the existing [Java Coding Guidelines][8]. 
 
-===Naming Convention===
-Aside of the [http://java.sun.com/docs/codeconv/html/CodeConventions.doc8.html#367 Naming
Convention of Java Coding Guideline], we use an 'm' as prefix for member object variables,
e.g. "mParentDocument". 
+***Naming Convention***    
+Aside of [the Naming Convention of Java Coding Guideline][9], we use an 'm' as prefix for
member object variables, e.g. "mParentDocument". 
 Note: There should be NO datatype prefix being used as 'i', 's', etc.
 
-===Source Code Format===
+***Source Code Format***   
 Although Maven may support source code formatting it has not yet been enabled.
 Instead the automated formatting via the IDE is used (e.g. by Netbeans via the context menu
- Format).  
 
-===Spaces===
+***Spaces***   
 To allow a customized indentation within the IDE based on the user's taste, the indent shall
be done using TABs.
 For instance, Svante uses a 4 whitespace indent by TABs configured within Netbeans.
 
-===Line Feed===
+***Line Feed***   
 There have been recently problems with merging sources using Mercurial when working with
different platforms (windows/unix).
 For this reason, some additional [[#Get_and_Build_the_Source_Code|Mercurial configuration]]
 shall be used to unify the interal line feed handling.
 
 
-==Current and Future Work==
+**Current and Future Work**
 
 Especially the convenient layer will grow on demand. As ODFDOM should be the base of many
future ODF projects, a high quality is desired. Therefore automatic tests are obligatory for
all new sources of the Java reference implementation.
 
-The development is being discussed on the [http://odftoolkit.org/projects/odfdom/lists/dev/archive
dev mailing list].
+The development is being discussed on the [dev mailing list][10].
 
 While we still plan to deliver quarterly results, we created some large feature groups/headlines
for the upcoming versions
 
@@ -183,33 +186,48 @@ In general when building a layered API, 
 button to base higher APIs on the stable lower layers:
 
 
-===Version 0.9===
-* Complete ODF 1.2 PKG functionality (package), e.g. 
-** Add PKG validation feature
-* Complete ODF 1.2 DOM functionality, e.g.
-** Style handling refactoring
-** Add DOM validation feature
-** RDF metadata feature
-** Some create child element methods (ie. office:body and style:style element) dependent
on attribute value
-* ODF 1.2 DOC API 
-** Create a lean convenient API working on the complete DOM layer, but hiding XML design
details of ODF 1.2
-* Complete ODF 1.2 TEST API (largly dependent on DOC API, but should be developed in parallel)
-
-===Version 1.0===
-* PKG performance tweaks
-* DOM performance tweaks
-* important DOC functionality
-* Test coverage
+***Version 0.9***
+
+  - Complete ODF 1.2 PKG functionality (package), e.g.   
+   - Add PKG validation feature
+  - Complete ODF 1.2 DOM functionality, e.g.
+   - Style handling refactoring
+   - Add DOM validation feature
+   - RDF metadata feature
+   - Some create child element methods (ie. office:body and style:style element) dependent
on attribute value
+  - ODF 1.2 DOC API 
+   - Create a lean convenient API working on the complete DOM layer, but hiding XML design
details of ODF 1.2
+  - Complete ODF 1.2 TEST API (largly dependent on DOC API, but should be developed in parallel)
+
+***Version 1.0***   
+
+- PKG performance tweaks
+- DOM performance tweaks
+- important DOC functionality
+- Test coverage
 
-Please see also for [https://odftoolkit.org/bugzilla/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=&product=odfdom&long_desc_type=allwordssubstr&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&emailtype1=substring&email1=&emailtype2=substring&email2=&bugidtype=include&bug_id=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&order=Reuse+same+sort+as+last+time&field0-0-0=noop&type0-0-0=noop&value0-0-0=
open tasks]
+Please see also for [open tasks][11].
 
-== ODFDOM Code Generator ==
+**ODFDOM Code Generator**  
 
 The ODFDOM Code Generator is used to generate the core Classes for ODFDOM which are a typed
mapping of the ODF elements on real Java Classes. For the future we also plan to generate
ODFDOM e.g. C# ( .NET ) for other programming languages with this generator. Take a look at
this page [[ODFDOM-Code-Generator|(ODFDOM Code Generator)]] to see how the generator works
in general (will be updated soon). We are moving toward treating the code generator as a separate
component. The repository [http://odftoolkit.org/hg/odfdom~relaxng2template] is the new home
of the code generator. It may move to its own project on this site at some point.
 
 
-== Other Useful Pages ==
-*[[ODFDOM-Class-Structure|Class Structure in ODFDOM]]
-*[[Convenience Layer Design Ideas]]
+**Other Useful Pages**     
+ 
+
+  - [[ODFDOM-Class-Structure|Class Structure in ODFDOM]]
+  - [[Convenience Layer Design Ideas]]
+
 
-<p style="margin: 15px 0px; text-align:center">[[Home|Go back to ODFDOM Wiki Home]]</p>
+  [1]: http://mercurial.selenic.com/wiki/Win32TextExtension
+  [2]: http://odftoolkit.org/projects/odfdom/sources
+  [3]: http://www.selenic.com/mercurial/wiki/
+  [4]: http://maven.apache.org/
+  [5]: http://mercurial.selenic.com/wiki/
+  [6]: http://odftoolkit.org/bugzilla/buglist.cgi?product=odfdom&order=bugs.bug_id
+  [7]: http://maven.apache.org/
+  [8]: http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html
+  [9]: http://java.sun.com/docs/codeconv/html/CodeConventions.doc8.html#367
+  [10]: mailto:odf-dev@incubator.apache.org
+  [11]: https://odftoolkit.org/bugzilla/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=&product=odfdom&long_desc_type=allwordssubstr&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&emailtype1=substring&email1=&emailtype2=substring&email2=&bugidtype=include&bug_id=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&order=Reuse+same+sort+as+last+time&field0-0-0=noop&type0-0-0=noop&value0-0-0=
\ No newline at end of file



Mime
View raw message