1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/as-events.pod Fri Nov 28 11:21:08 2008 +0100
1.3 @@ -0,0 +1,142 @@
1.4 +##
1.5 +## OSSP asgui - Accounting system graphical user interface
1.6 +## Copyright (c) 2002-2004 The OSSP Project (http://www.ossp.org/)
1.7 +## Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>
1.8 +## Copyright (c) 2002-2004 Michael Schloh von Bennewitz <michael@schloh.com>
1.9 +## Copyright (c) 2002-2004 Cable & Wireless Telecommunications Services GmbH
1.10 +##
1.11 +## This file is part of OSSP asgui, an accounting system graphical user
1.12 +## interface which can be found at http://www.ossp.org/pkg/tool/asgui/.
1.13 +##
1.14 +## Permission to use, copy, modify, and distribute this software for
1.15 +## any purpose with or without fee is hereby granted, provided that
1.16 +## the above copyright notice and this permission notice appear in all
1.17 +## copies.
1.18 +##
1.19 +## THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
1.20 +## WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
1.21 +## MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
1.22 +## IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
1.23 +## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
1.24 +## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
1.25 +## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
1.26 +## USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
1.27 +## ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
1.28 +## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
1.29 +## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
1.30 +## SUCH DAMAGE.
1.31 +##
1.32 +## as-events.pod: Plain old documentation file
1.33 +##
1.34 +
1.35 +=pod
1.36 +
1.37 +=head1 NAME
1.38 +
1.39 +B<as-events> - accounting system events document format
1.40 +
1.41 +=head1 DESCRIPTION
1.42 +
1.43 +The B<as-gui> application takes input from the user and may store its data to
1.44 +a file on the local filesystem. Among other functions, a user can enter time,
1.45 +amounts, remarks, and other values. This data tuple is termed an I<event>, and
1.46 +may either be transmitted to a B<AS> server or stored to a local file. Should
1.47 +it be stored to a local file, the file name is arbitrary and is shown in the
1.48 +title bar of B<as-gui>. Typically, the file is called F<events.as>. In most
1.49 +cases the postfix B<.as> is appended to the file name, although this behaviour
1.50 +can be turned on or off through the user preferences.
1.51 +
1.52 +=head1 FILE FORMAT
1.53 +
1.54 +The B<as-events> file contains ASCII text. The first line consists of an
1.55 +identifier to associate the file type and version. Following text may contain
1.56 +white space, comments, and data tuples.
1.57 +
1.58 +=head1 GRAMMAR
1.59 +
1.60 +B<events.as> ::= B<eventsid> B<tuplelist>
1.61 +
1.62 +B<eventsid> ::= "%!AS-EVENTS-" [0-9] '.' [0-9]
1.63 +
1.64 +B<tuplelist> ::= B<tuplelist> | B<tuple> | B<comment> | EMPTY
1.65 +
1.66 +B<tuple> ::= B<user> B<uuid> B<crc> B<revision> B<date> B<begin> B<end> B<amount> B<account> B<remark>
1.67 +
1.68 +B<comment> ::= ($#.*)
1.69 +
1.70 +(* user field *)
1.71 +
1.72 +B<user> ::= [a-zA-Z][a-zA-Z0-9]+
1.73 +
1.74 +(* uuid field *)
1.75 +
1.76 +B<uuid> ::= B<hexoctet> '-' B<hexquartet> '-' B<hexquartet> '-' B<hexquartet> '-' B<hextwelvetet>
1.77 +
1.78 +(* crc field *)
1.79 +
1.80 +B<crc> ::= B<hexoctet>
1.81 +
1.82 +B<hextwelvetet> ::= B<hexoctet> | B<hexquartet>
1.83 +
1.84 +B<hexoctet> ::= B<hexquartet> | B<hexquartet>
1.85 +
1.86 +B<hexquartet> ::= B<hexdigit> | B<hexdigit> | B<hexdigit> | B<hexdigit>
1.87 +
1.88 +B<hexdigit> ::= B<a-zA-Z0-9>
1.89 +
1.90 +(* revision field *)
1.91 +
1.92 +B<revision> ::= [0-9]
1.93 +
1.94 +(* date field *)
1.95 +
1.96 +B<date> ::= [0-9][0-9][0-9][0-9] '-' [01][0-9] '-' [0123][0-9]
1.97 +
1.98 +(* time fields *)
1.99 +
1.100 +B<begin> ::= B<timeval>
1.101 +
1.102 +B<end> ::= B<endval>
1.103 +
1.104 +B<amount> ::= B<timeval>
1.105 +
1.106 +B<timeval> ::= B<hourval> ':' B<minuteval>
1.107 +
1.108 +B<endval> ::= B<hourinc> ':' B<minuteval>
1.109 +
1.110 +B<hourval> ::= [01][0-9]
1.111 +
1.112 +B<hourinc> ::= B<hourval> | 2[0-4]
1.113 +
1.114 +B<minval> ::= [0-5][0-9]
1.115 +
1.116 +(* account field *)
1.117 +
1.118 +B<account> ::= B<account> | B<accpart>
1.119 +
1.120 +B<accpart> ::= B<accsep> B<acctext>
1.121 +
1.122 +B<accsep> ::= '/'
1.123 +
1.124 +B<acctext> ::= [a-zA-Z0-9_-]*
1.125 +
1.126 +(* remark field *)
1.127 +
1.128 +B<remark> ::= '"' .* '"'
1.129 +
1.130 +=head1 EXAMPLE
1.131 +
1.132 +A typical B<as-events> file might look like this:
1.133 +
1.134 +%!AS-EVENTS-0.6
1.135 +harvey 0ccf1d42-743b-43df-9b5d-202451b3c26f e8f212b6 0 2002-09-30 00:00 00:00 02:00 /it/development/meeting/weekly "Code review"
1.136 +harvey 9c497382-ae88-4a1a-91b5-202451b3c26f c8637e9a 0 2002-09-30 00:00 00:00 00:30 /it/common/office/communication "Conference call"
1.137 +harvey e230eae7-367f-4c35-bee1-202451b3c26f 02cb1abb 0 2002-09-30 00:00 00:00 00:30 /sales/travel/customer "Simontech visit"
1.138 +
1.139 +=head1 SEE ALSO
1.140 +
1.141 +as-gui(1),
1.142 +as-gui.conf(5),
1.143 +as-accounts(5),
1.144 +
1.145 +=cut
