1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/as-accounts.pod Fri Nov 28 11:21:08 2008 +0100
1.3 @@ -0,0 +1,103 @@
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-accounts.pod: Plain old documentation file
1.33 +##
1.34 +
1.35 +=pod
1.36 +
1.37 +=head1 NAME
1.38 +
1.39 +B<as-accounts> - accounting system accounts document format
1.40 +
1.41 +=head1 DESCRIPTION
1.42 +
1.43 +The B<as-gui> application specifies a user entry as including many individual
1.44 +pieces of information (see as-events.5). One of these is the account,
1.45 +describing a task on which the user worked. While the account field may
1.46 +contain free text, there are a number of atomic values which are typical in
1.47 +the work atmosphere. The B<as-gui> client reads a file of such values to offer
1.48 +the user a listing in which to choose from. This file is called the
1.49 +B<as-accounts> file, and is typically named F<accounts>. Its name and location
1.50 +are arbitrary and may be changed through the user preferences.
1.51 +
1.52 +=head1 FILE FORMAT
1.53 +
1.54 +The B<as-accounts> 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<accounts> ::= B<accid> B<acclist>
1.61 +
1.62 +B<accid> ::= "%!AS-ACCOUNTS-" [0-9] '.' [0-9]
1.63 +
1.64 +B<acclist> ::= B<acclist> | B<acctuple> | B<comment> | EMPTY
1.65 +
1.66 +B<comment> ::= ($#.*)
1.67 +
1.68 +B<acctuple> ::= B<acctype> B<accfull> | B<acctype> B<accfull> B<comment>
1.69 +
1.70 +B<accfull> ::= B<accfull> | B<accpart>
1.71 +
1.72 +B<accpart> ::= B<accsep> B<acctext>
1.73 +
1.74 +B<acctype> ::= [RM]
1.75 +
1.76 +B<accsep> ::= '/'
1.77 +
1.78 +B<acctext> ::= [a-zA-Z0-9_-]*
1.79 +
1.80 +=head1 EXAMPLE
1.81 +
1.82 +A typical B<as-accounts> file might look like this:
1.83 +
1.84 +%!AS-ACCOUNTS-0.6
1.85 +
1.86 +## Internet Services (IS) department ##
1.87 +
1.88 +# General
1.89 +
1.90 +R /is/common/meeting # Specify type
1.91 +
1.92 +R /is/common/meeting/weekly # A weekly meeting
1.93 +
1.94 +# Special
1.95 +
1.96 +R /is/sales/absence/illness # Approved absence (illness)
1.97 +
1.98 +R /is/sales/absence/vacation # Approved absence (vacation)
1.99 +
1.100 +=head1 SEE ALSO
1.101 +
1.102 +as-gui(1),
1.103 +as-gui.conf(5),
1.104 +as-events(5)
1.105 +
1.106 +=cut
