As-gui Sources / file comparison
comparison: as-accounts.pod
as-accounts.pod
- changeset 2
- e8292658d5b3
- child 3
- c1941114ca88
equal
deleted
inserted
replaced
| -1:000000000000 | 0:297bbf0e4dda |
|---|---|
| 1 ## | |
| 2 ## OSSP asgui - Accounting system graphical user interface | |
| 3 ## Copyright (c) 2002-2004 The OSSP Project (http://www.ossp.org/) | |
| 4 ## Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com> | |
| 5 ## Copyright (c) 2002-2004 Michael Schloh von Bennewitz <michael@schloh.com> | |
| 6 ## Copyright (c) 2002-2004 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://www.ossp.org/pkg/tool/asgui/. | |
| 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-accounts.pod: Plain old documentation file | |
| 30 ## | |
| 31 | |
| 32 =pod | |
| 33 | |
| 34 =head1 NAME | |
| 35 | |
| 36 B<as-accounts> - accounting system accounts document format | |
| 37 | |
| 38 =head1 DESCRIPTION | |
| 39 | |
| 40 The B<as-gui> application specifies a user entry as including many individual | |
| 41 pieces of information (see as-events.5). One of these is the account, | |
| 42 describing a task on which the user worked. While the account field may | |
| 43 contain free text, there are a number of atomic values which are typical in | |
| 44 the work atmosphere. The B<as-gui> client reads a file of such values to offer | |
| 45 the user a listing in which to choose from. This file is called the | |
| 46 B<as-accounts> file, and is typically named F<accounts>. Its name and location | |
| 47 are arbitrary and may be changed through the user preferences. | |
| 48 | |
| 49 =head1 FILE FORMAT | |
| 50 | |
| 51 The B<as-accounts> 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. | |
| 54 | |
| 55 =head1 GRAMMAR | |
| 56 | |
| 57 B<accounts> ::= B<accid> B<acclist> | |
| 58 | |
| 59 B<accid> ::= "%!AS-ACCOUNTS-" [0-9] '.' [0-9] | |
| 60 | |
| 61 B<acclist> ::= B<acclist> | B<acctuple> | B<comment> | EMPTY | |
| 62 | |
| 63 B<comment> ::= ($#.*) | |
| 64 | |
| 65 B<acctuple> ::= B<acctype> B<accfull> | B<acctype> B<accfull> B<comment> | |
| 66 | |
| 67 B<accfull> ::= B<accfull> | B<accpart> | |
| 68 | |
| 69 B<accpart> ::= B<accsep> B<acctext> | |
| 70 | |
| 71 B<acctype> ::= [RM] | |
| 72 | |
| 73 B<accsep> ::= '/' | |
| 74 | |
| 75 B<acctext> ::= [a-zA-Z0-9_-]* | |
| 76 | |
| 77 =head1 EXAMPLE | |
| 78 | |
| 79 A typical B<as-accounts> file might look like this: | |
| 80 | |
| 81 %!AS-ACCOUNTS-0.6 | |
| 82 | |
| 83 ## Internet Services (IS) department ## | |
| 84 | |
| 85 # General | |
| 86 | |
| 87 R /is/common/meeting # Specify type | |
| 88 | |
| 89 R /is/common/meeting/weekly # A weekly meeting | |
| 90 | |
| 91 # Special | |
| 92 | |
| 93 R /is/sales/absence/illness # Approved absence (illness) | |
| 94 | |
| 95 R /is/sales/absence/vacation # Approved absence (vacation) | |
| 96 | |
| 97 =head1 SEE ALSO | |
| 98 | |
| 99 as-gui(1), | |
| 100 as-gui.conf(5), | |
| 101 as-events(5) | |
| 102 | |
| 103 =cut |
