As-gui Sources: as-events.pod@ceb4ba3d2d00

     1 ##

     2 ##  OSSP asgui - Accounting system graphical user interface

     3 ##  Copyright (c) 2002-2009 The OSSP Project (http://www.ossp.org/)

     4 ##  Copyright (c) 2002-2009 Ralf S. Engelschall <rse@engelschall.com>

     5 ##  Copyright (c) 2002-2009 Michael Schloh von Bennewitz <michael@schloh.com>

     6 ##  Copyright (c) 2002-2009 Cable & Wireless Telecommunications Services GmbH

     7 ##

     8 ##  This file is part of OSSP asgui, an accounting system graphical user

     9 ##  interface which can be found at http://asgui.europalab.com/.

    10 ##

    11 ##  Permission to use, copy, modify, and distribute this software for

    12 ##  any purpose with or without fee is hereby granted, provided that

    13 ##  the above copyright notice and this permission notice appear in all

    14 ##  copies.

    15 ##

    16 ##  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED

    17 ##  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF

    18 ##  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.

    19 ##  IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR

    20 ##  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

    21 ##  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

    22 ##  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF

    23 ##  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

    24 ##  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

    25 ##  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT

    26 ##  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

    27 ##  SUCH DAMAGE.

    28 ##

    29 ##  as-events.pod: Plain old documentation file

    30 ##

    32 =pod

    34 =head1 NAME

    36 B<as-events> - accounting system events document format

    38 =head1 DESCRIPTION

    40 The B<as-gui> application takes input from the user and may store its data to

    41 a file on the local filesystem. Among other functions, a user can enter time,

    42 amounts, remarks, and other values. This data tuple is termed an I<event>, and

    43 may either be transmitted to a B<AS> server or stored to a local file. Should

    44 it be stored to a local file, the file name is arbitrary and is shown in the

    45 title bar of B<as-gui>. Typically, the file is called F<events.as>. In most

    46 cases the postfix B<.as> is appended to the file name, although this behaviour

    47 can be turned on or off through the user preferences.

    49 =head1 FILE FORMAT

    51 The B<as-events> file contains ASCII text. The first line consists of an

    52 identifier to associate the file type and version. Following text may contain

    53 white space, comments, and data tuples.

    55 =head1 GRAMMAR

    57 B<events.as>    ::= B<eventsid> B<tuplelist>

    59 B<eventsid>     ::= "%!AS-EVENTS-" [0-9] '.' [0-9]

    61 B<tuplelist>    ::= B<tuplelist> | B<tuple> | B<comment> | EMPTY

    63 B<tuple>        ::= B<user> B<uuid> B<crc> B<revision> B<date> B<begin> B<end> B<amount> B<account> B<remark>

    65 B<comment>      ::= ($#.*)

    67 (* user field *)

    69 B<user>         ::= [a-zA-Z][a-zA-Z0-9]+

    71 (* uuid field *)

    73 B<uuid>         ::= B<hexoctet> '-' B<hexquartet> '-' B<hexquartet> '-' B<hexquartet> '-' B<hextwelvetet>

    75 (* crc field *)

    77 B<crc>          ::= B<hexoctet>

    79 B<hextwelvetet> ::= B<hexoctet> | B<hexquartet>

    81 B<hexoctet>     ::= B<hexquartet> | B<hexquartet>

    83 B<hexquartet>   ::= B<hexdigit> | B<hexdigit> | B<hexdigit> | B<hexdigit>

    85 B<hexdigit>     ::= B<a-zA-Z0-9>

    87 (* revision field *)

    89 B<revision>     ::= [0-9]

    91 (* date field *)

    93 B<date>         ::= [0-9][0-9][0-9][0-9] '-' [01][0-9] '-' [0123][0-9]

    95 (* time fields *)

    97 B<begin>        ::= B<timeval>

    99 B<end>          ::= B<endval>

   101 B<amount>       ::= B<timeval>

   103 B<timeval>      ::= B<hourval> ':' B<minuteval>

   105 B<endval>       ::= B<hourinc> ':' B<minuteval>

   107 B<hourval>      ::= [01][0-9]

   109 B<hourinc>      ::= B<hourval> | 2[0-4]

   111 B<minval>       ::= [0-5][0-9]

   113 (* account field *)

   115 B<account>      ::= B<account> | B<accpart>

   117 B<accpart>      ::= B<accsep> B<acctext>

   119 B<accsep>       ::= '/'

   121 B<acctext>      ::= [a-zA-Z0-9_-]*

   123 (* remark field *)

   125 B<remark>       ::= '"' .* '"'

   127 =head1 EXAMPLE

   129 A typical B<as-events> file might look like this:

   131 %!AS-EVENTS-0.6

   132 harvey 0ccf1d42-743b-43df-9b5d-202451b3c26f e8f212b6 0 2002-09-30 00:00 00:00 02:00 /it/development/meeting/weekly "Code review"

   133 harvey 9c497382-ae88-4a1a-91b5-202451b3c26f c8637e9a 0 2002-09-30 00:00 00:00 00:30 /it/common/office/communication "Conference call"

   134 harvey e230eae7-367f-4c35-bee1-202451b3c26f 02cb1abb 0 2002-09-30 00:00 00:00 00:30 /sales/travel/customer "Simontech visit"

   136 =head1 SEE ALSO

   138 as-gui(1),

   139 as-gui.conf(5),

   140 as-accounts(5),

   142 =cut

As-gui Sources / file revision