vmote       2003/07/01 10:24:35

  Modified:    src/documentation/content/xdocs/dev book.xml index.xml
  Added:       src/documentation/content/xdocs/dev conventions.xml
  Move "conventions" section of index.xml to a new conventions.xml document, and add 
it to the menu.
  Revision  Changes    Path
  1.28      +1 -0      xml-fop/src/documentation/content/xdocs/dev/book.xml
  Index: book.xml
  RCS file: /home/cvs/xml-fop/src/documentation/content/xdocs/dev/book.xml,v
  retrieving revision 1.27
  retrieving revision 1.28
  diff -u -r1.27 -r1.28
  --- book.xml  14 Jun 2003 05:41:18 -0000      1.27
  +++ book.xml  1 Jul 2003 17:24:34 -0000       1.28
  @@ -21,6 +21,7 @@
         <menu-item label="API Doc" href="api-doc.html"></menu-item>
         <menu-item label="Walk-Thru" href="implement.html"/>
         <external label="Patch queue" 
  +      <menu-item label="Conventions" href="conventions.html"/>
       <menu label="Test">
         <menu-item label="Testing" href="testing.html"/>
  1.17      +0 -11     xml-fop/src/documentation/content/xdocs/dev/index.xml
  Index: index.xml
  RCS file: /home/cvs/xml-fop/src/documentation/content/xdocs/dev/index.xml,v
  retrieving revision 1.16
  retrieving revision 1.17
  diff -u -r1.16 -r1.17
  --- index.xml 15 May 2003 16:28:01 -0000      1.16
  +++ index.xml 1 Jul 2003 17:24:35 -0000       1.17
  @@ -126,17 +126,6 @@
           <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 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>
  1.1                  xml-fop/src/documentation/content/xdocs/dev/conventions.xml
  Index: conventions.xml
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
      <title>FOP Development: Coding Conventions</title>
      <section id="java">
        <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>
              <th>Enforced By</th>
              <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>
              <th>Indentation of 4 spaces per level</th>
              <th>Maximize readability.</th>
              <th>Not enforced</th>
          <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 

To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to