Help Index

- How to use application dashboard
- Owner section
- Pet section
- Users and account
- Calendar

Version Info
Version 0.1 (alpha)
Online help
This project is made just by volunteers.
If you find any malfunction, bug, issue or you want a new feature, please be patient and report it c/o the following resources:
www.oldauntie.org
oldauntie@oldauntie.org
Developer corner

### Naming convention:

ClassName
methodName
staticMethodName, static_method_name
property_name, propertyName
function_name (meant for global functions)
$variable_name

### Spaces

Ababu follows MediaWiki concentions thus it favors a heavily-spaced style for optimum readability.
Put spaces on either side of binary operators, for example:

    // No:
    $a=$b+$c;

    // Yes:
    $a = $b + $c;

Put spaces next to parentheses on the inside, except where the parentheses are empty. Do not put a space following a function name.

    $a = getFoo( $b );
    $c = getBar();

Put spaces in brackets when declaring an array, except where the array is empty. Do not put spaces in brackets when accessing array elements.

    // Yes
    $a = [ 'foo', 'bar' ];
    $c = $a[0];
    $x = [];

    //No
    $a = ['foo', 'bar'];
    $c = a[ 0 ];
    $x = [ ];

Control structures such as if, while, for, foreach, and switch, as well as the catch keyword, should be followed by a space:

    // Yes
    if ( isFoo() ) {
    	$a = 'foo';
    }

    // No
    if( isFoo() ) {
    	$a = 'foo';
    }

When type casting, do not use a space within or after the cast operator:

    // Yes
    (int)$foo;

    // No
    (int) $bar;
    ( int )$bar;
    ( int ) $bar;

In comments there should be one space between the # or // character and the comment.

    // Yes: Proper inline comment
    //No: Missing space
    /***** Do not comment like this ***/

To help developers fix code with an inadequately spacey style, a tool called stylize.php has been created, which uses PHP's tokenizer extension to enforce most whitespace conventions automatically.

### How to translate the platform

Get inside project root.

    cd ABABU_DOCUMENT_ROOT

Run the following script

    xgettext --from-code=utf-8 -L PHP --join-existing -p locale/en/LC_MESSAGES $(find . -name "*.php")

Change the path for any languages installed in the system.
This will create the tranlation files messages.po to translate terms used in the site.
Run the following command to compile the language file.

    sudo msgfmt messages.po