================================
Coding Guidelines for the viewer
================================

Plucker is distributed under and protected by the GNU GENERAL PUBLIC 
LICENSE (the full copy of which is found in COPYING). We make the 
source code available so that others can alter it for their own needs.  
All we ask in return is that you submit your changes back to us so that 
we can merge them into the main version of the product. Changes can be 
submitted to plucker-dev@rubberchicken.org

These guidelines are only meant to give the source code a similar
format. Try to follow the programming conventions you already find 
in the source code and remember that common sense is never wrong ;-)

*   Naming conventions:

    Function names begin with upper case letters (e.g. ViewDocument).
    Variables begin with lower case letters (e.g. documentPtr).

    Global variable should be given descriptive names.

    Local variables should be given short names, i.e.
    some random loop variable should be called "i" not
    "loop_counter".

*   Indentation is 4 characters deep (use spaces instead of tabs).

*   Braces go like this:

        if (...) {
            ...
        }
        else {
            ...
        }

    However functions have the opening brace at the beginning of the
    line.

*   All functions should have a short description (one or two sentences) at
    the top. If you can't describe the function in a short sentence or two,
    then it's probably a sign that the the design isn't as good as it should
    be.

*   Error messages should look like this:

        SOURCE-FILE-NAME:LINENO: MESSAGE

    The string MESSAGE should not end with a period.

