<menu-item label="API Doc" href="api-doc.html"></menu-item>
<menu-item label="Walk-Thru" href="implement.html"/>
<external label="Patch queue" href="http://nagoya.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Fop&short_desc=%5BPATCH%5D&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&namedcmd=Fop+all&newqueryname=fop+patch+queue&tofooter=1&order=Reuse+same+sort+as+last+time"/>
+ <menu-item label="Conventions" href="conventions.html"/>
</menu>
<menu label="Test">
<menu-item label="Testing" href="testing.html"/>
--- /dev/null
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
+ "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/resources/schema/dtd/document-v11.dtd">
+<document>
+ <header>
+ <title>FOP Development: Coding Conventions</title>
+ </header>
+ <body>
+ <section id="java">
+ <title>Java</title>
+ <section id="java-style">
+ <title>Java Style</title>
+ <p>In order to facilitate the human reading of FOP source code, the FOP developers have agreed on a set of coding conventions.
+The basis of these coding conventions is documented in the <link href="http://xml.apache.org/source.html">Apache XML Project Guidelines</link>, which requires that <strong>all Java Language source code in the repository must be written in conformance to Sun's</strong> <link href="http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html">Code Conventions for the Java Programming Language</link>.
+In addition, other conventions have been applied to the FOP project, which are summarized in the following table:</p>
+ <table>
+ <tr>
+ <th>Convention</th>
+ <th>Rationale</th>
+ <th>Enforced By</th>
+ </tr>
+ <tr>
+ <td>No tabs in content</td>
+ <td>Programmers should not have to adjust the tab settings in their editor to be able to read the source code.</td>
+ <td>checkstyle</td>
+ </tr>
+ <tr>
+ <th>Indentation of 4 spaces per level</th>
+ <th>Maximize readability.</th>
+ <th>Not enforced</th>
+ </tr>
+ </table>
+ <p>For developers that dislike these conventions, one workaround is to develop using their own style, then use a formatting tool like <link href="http://astyle.sourceforge.net/">astyle</link> (Artistic Style) before committing.</p>
+ </section>
+ </section>
+ </body>
+</document>
</ul>
<p>One of the committers will test your patch and consider its implications for the project. They will then either commit it to the repository or explain on the issue why they did not. Depending on the work load and skill-sets of the various committers, it may take some time before a a submitted patch is addressed.</p>
</section>
- <section id="code-conventions">
- <title>Coding Conventions</title>
- <p>As mentioned in <link href="http://xml.apache.org/source.html">Apache XML Project Guidelines</link>,
- <strong>all Java Language source code in the repository must be written in conformance to the</strong>
- <link href="http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html">Code Conventions
- for the Java Programming Language</link> as published by Sun. Additionally we agreed on 4
- spaces (no tabs) for indenting.</p>
- <p>If you don't like those conventions, just use your own standards while developing and reformat the source before
- committing with a tool like <link href="http://astyle.sourceforge.net/">astyle</link> (Artistic Style).
- </p>
- </section>
</section>
</body>
</document>
projects / xmlgraphics-fop.git / commitdiff