TAB: We use 4 spaces. Examples for braces:

if ($Condition) {
    Foo();
}
else {
    Bar();
}

while ($Condition == 1) {
    Foo();
}
        

Names and comments are written in English. Variables, Objects and Methods must be descriptive nouns or noun phrases with the first letter set upper case.

e. g. @TicktIDs or $Output or BuildQueueView()
        

Attach the following header to each and every source file. Source files are saved in Charset ISO-8859-1.

# --
# (file name) - a short description what it does
# Copyright (C) 2001-2011 OTRS AG, http://otrs.org/
# --
# $Id: perl.xml,v 1.3 2011-03-09 14:54:40 mb Exp $
# --
# This software comes with ABSOLUTELY NO WARRANTY. For details, see
# the enclosed file COPYING for license information (AGPL). If you
# did not receive this file, see http://www.gnu.org/licenses/agpl.txt.
# --
        

Executable files (*.pl) have a special header.

#!/usr/bin/perl -w
# --
# (file name) - a short description what it does
# Copyright (C) 2001-2011 OTRS AG, http://otrs.org/
# --
# $Id: perl.xml,v 1.3 2011-03-09 14:54:40 mb Exp $
# --
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU AFFERO General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
# or see http://www.gnu.org/licenses/agpl.txt.
# --
        

The following line is updated by the CVS:

# $Id: perl.xml,v 1.3 2011-03-09 14:54:40 mb Exp $
        

Some functions may not be available in the current framework version. Thus, sometimes settings have to be changed when a new module and framework version will be released. If you use version comments, you can search for information (e.g. using grep) on what must be changed when a new version is published. The keyword for version comments is 'FRAMEWORK' For perl use '#' and for xml use the xml comments.

e.g. for perl-code
# FRAMEWORK-2.1: the function ID2UserName is first available in OTRS 2.1
        

The only ways to create special comments are the following ways. Example 1 - especially for subactions of frontend modules

    # -----------------------------#
    # here starts a special area
    # -----------------------------#
            

Example 2 - especially for customizing standard OTRS files

    # --- customizing for bsi
            

Some functions are not useful in every script. Please pay attention to the following restrictions.

Every function which could be used outside of its package must have a perldoc. It should look like the following example.

=item SystemTime2TimeStamp()

returns a time stamp in "yyyy-mm-dd 23:59:59" format.

    my $TimeStamp = $TimeObject->SystemTime2TimeStamp(
        SystemTime => $SystemTime,
    );

If you need the short format "23:59:59" for dates that are "today",
pass the Type parameter like this:

    my $TimeStamp = $TimeObject->SystemTime2TimeStamp(
        SystemTime => $SystemTime,
        Type       => 'Short',
    );

=cut
            

Please see that a line of code is not longer then 100 charactars.

For regular expressions we always use the m// operator with curly braces as delimiters. We also use the modifiers x, m and s. The x modifiers allows you two comment your regex and use spaces to "group" logical groups.

    $Date =~ m{ \A \d{4} - \d{2} - \d{2} \z }xms
    $Date =~ m{
        \A    # beginning of the string
        \d{4} - # year
        \d{2} - # month
        [^\n]   # everything but newline
        #..
    }xms;

As the space has no longer a special meaning, you have to use a single character class to match a single space ( [ ]). If you want to match any whitespace you can use \s. In the regex, the dot ('.') includes the newline (whereas in regex without s modifier the dot means 'everything but newline'). If you want to match anything but newline, you have to use the negated single character class ([^\n]).

    $Text =~ m{
        Test
        [ ]    # there must be a space between 'Test' and 'Regex'
        Regex
    }xms;

All JavaScript is loaded in all browsers (no browser hacks in the .dtl files). The code is responsible to decide if it has to skip or execute certain parts of itself only in certain browsers.

Directory structure inside the js/ folder:

* js
    * thirdparty              # thirdparty libs always have the version number inside the directory
        * ckeditor-3.0.1
        * jquery-1.3.2
    * Core.Agent.*            # stuff specific to the agent interface
    * Core.Customer.*         # customer interface
    * Core.*                  # common API