ossp-pkg/as/as-gui/as-accounts.pod
##
## OSSP asgui - Accounting system graphical user interface
## Copyright (c) 2002-2004 The OSSP Project (http://www.ossp.org/)
## Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>
## Copyright (c) 2002-2004 Michael Schloh von Bennewitz <michael@schloh.com>
## Copyright (c) 2002-2004 Cable & Wireless Telecommunications Services GmbH
##
## This file is part of OSSP asgui, an accounting system graphical user
## interface which can be found at http://www.ossp.org/pkg/tool/asgui/.
##
## Permission to use, copy, modify, and distribute this software for
## any purpose with or without fee is hereby granted, provided that
## the above copyright notice and this permission notice appear in all
## copies.
##
## THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
## WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
## MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
## IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
## USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
## ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
## SUCH DAMAGE.
##
## as-accounts.pod: Plain old documentation file
##
=pod
=head1 NAME
B<as-accounts> - accounting system accounts document format
=head1 DESCRIPTION
The B<as-gui> application specifies a user entry as including many individual
pieces of information (see as-events.5). One of these is the account,
describing a task on which the user worked. While the account field may
contain free text, there are a number of atomic values which are typical in
the work atmosphere. The B<as-gui> client reads a file of such values to offer
the user a listing in which to choose from. This file is called the
B<as-accounts> file, and is typically named F<accounts>. Its name and location
are arbitrary and may be changed through the user preferences.
=head1 FILE FORMAT
The B<as-accounts> file contains ASCII text. The first line consists of an
identifier to associate the file type and version. Following text may contain
white space, comments, and data tuples.
=head1 GRAMMAR
B<accounts> ::= B<accid> B<acclist>
B<accid> ::= "%!AS-ACCOUNTS-" [0-9] '.' [0-9]
B<acclist> ::= B<acclist> | B<acctuple> | B<comment> | EMPTY
B<comment> ::= ($#.*)
B<acctuple> ::= B<acctype> B<accfull> | B<acctype> B<accfull> B<comment>
B<accfull> ::= B<accfull> | B<accpart>
B<accpart> ::= B<accsep> B<acctext>
B<acctype> ::= [RM]
B<accsep> ::= '/'
B<acctext> ::= [a-zA-Z0-9_-]*
=head1 EXAMPLE
A typical B<as-accounts> file might look like this:
%!AS-ACCOUNTS-0.6
## Internet Services (IS) department ##
# General
R /is/common/meeting # Specify type
R /is/common/meeting/weekly # A weekly meeting
# Special
R /is/sales/absence/illness # Approved absence (illness)
R /is/sales/absence/vacation # Approved absence (vacation)
=head1 SEE ALSO
as-gui(1),
as-gui.conf(5),
as-events(5)
=cut
