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