<?xml version="1.0"?>

<!--
   Copyright 2000-2004 The Apache Software Foundation

   Licensed 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.
-->


<document>

 <properties>
  <title>Coding Standards</title>
  <author email="jvanzyl@zenplex.com">Velocity Documentation Team</author>
 </properties>

<body>

<section name="Coding Standards">

<p>
This document describes a list of coding conventions that are required
for code submissions to the project. By default, the coding conventions
for most Open Source Projects should follow the existing coding conventions
in the code that you are working on. For example, if the bracket is on
the same line as the if statement, then you should write all your code
to have that convention.
</p>

<p>
<strong>If you commit code that does not follow these conventions and you
are caught, you are responsible for also fixing your own code.</strong>
</p>

<p>
Below is a list of coding conventions that are specific to Velocity,
everything else not specificially mentioned here should follow the official
<a href="http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html">Sun
Java Coding Conventions</a>.
</p>

<p>
1. Brackets should begin and end on a new line. Examples:
</p>

<source test=""><![CDATA[

if ( foo )
{
    // code here
}

try
{
    // code here
}
catch (Exception bar)
{
    // code here
}
finally
{
    // code here
}

while ( true )
{
    // code here
}

]]></source>

<p>
2. It is <strong>OK</strong> to have spaces between the parens or not. The
preference is to not include the extra spaces. For example, both of these are
ok:
</p>

<source test=""><![CDATA[

if (foo)

or

if ( foo )

]]></source>

<p>
3. 4 spaces. <strong>NO</strong> tabs. Period. We understand that a lot of you
like to use tabs, but the fact of the matter is that in a distributed
development enviroment, when the cvs commit messages get sent to a mailing list,
they are almost impossible to read if you use tabs.
</p>

<p>
In Emacs-speak, this translates to the following command:

(setq-default tab-width 4 indent-tabs-mode nil)

</p>

<p>
4. Unix linefeeds for all .java source code files. Other platform specific
files should have the platform specific linefeeds.
</p>

<p>
5. Javadoc <strong>MUST</strong> exist on all your methods. Also, if you are
working on existing code and there currently isn't a javadoc for that
method/class/variable or whatever, then you should contribute and add it.
This will improve the project as a whole.
</p>

<p>
6. The <a href="license.html">Apache Software License</a> <strong>MUST</strong> be placed at the top
of each and every file.
</p>

<p>
7. If you contribute to a file (code or documentation), add yourself to the
top of the file. For java files the preferred Javadoc format is:
</p>

<source><![CDATA[
@author <a href="mailto:user@domain.com">John Doe</a>
]]></source>

<p>
Thanks for your cooperation.
</p>

</section>

<section name="More Fun For Emacs">

<p>
  To make coding easier,  following bit of Emacs LISP does 
  the 'right thing' with bracing, if you want.
 </p>
<source><![CDATA[
(defun apache-jakarta-mode ()
  "The Java mode specialization for Apache Jakarta projects."
  (if (not (assoc "apache-jakarta" c-style-alist))
      ;; Define the Apache Jakarta cc-mode style.
      (c-add-style "apache-jakarta" '("java" (indent-tabs-mode . nil))))

  (c-set-style "apache-jakarta")
  (c-set-offset 'substatement-open 0 nil)
  (setq mode-name "Apache Jakarta")

  ;; Turn on syntax highlighting when X is running.
  (if (boundp 'window-system)
      (progn (setq font-lock-support-mode 'lazy-lock-mode)
             (font-lock-mode t))))

;; Activate Jakarta mode.
(if (fboundp 'jde-mode)
    (add-hook 'jde-mode-hook 'apache-jakarta-mode)
  (add-hook 'java-mode-hook 'apache-jakarta-mode))
]]></source>

  <p>
  Note that  this will apply to all java in emacs. 
  To control it :

  <ul>
  <li>
      Turn off : <code>M-: (remove-hook 'java-mode 'apache-jakarta-mode)</code>
  </li>
  <li>
     Turn on : <code>M-: (add-hook 'java-mode 'apache-jakarta-mode)</code>
  </li>
  </ul>
   'M-:' is &lt;meta&gt; followed by ':', of course.  
   It will be on by default at startup.
  </p>
  
  <p>
  This was stolen lock, stock and barrel from the contribution 
  to the Turbine project by Daniel L. Rall. Thanks Daniel!
  </p>

</section>

</body>
</document>
