as-accounts.pod@0e0eb7c91312 (annotated)
as-accounts.pod
Thu, 06 Aug 2009 13:21:30 +0200
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 06 Aug 2009 13:21:30 +0200
- changeset 15
- 0e0eb7c91312
- parent 3
- c1941114ca88
- permissions
- -rw-r--r--
Remove seemingly declarations unnecessary according to Qt 4.5.2 headers.
| michael@1 | 1 | ## |
| michael@1 | 2 | ## OSSP asgui - Accounting system graphical user interface |
| michael@12 | 3 | ## Copyright (c) 2002-2009 The OSSP Project (http://www.ossp.org/) |
| michael@12 | 4 | ## Copyright (c) 2002-2009 Ralf S. Engelschall <rse@engelschall.com> |
| michael@12 | 5 | ## Copyright (c) 2002-2009 Michael Schloh von Bennewitz <michael@schloh.com> |
| michael@12 | 6 | ## Copyright (c) 2002-2009 Cable & Wireless Telecommunications Services GmbH |
| michael@1 | 7 | ## |
| michael@1 | 8 | ## This file is part of OSSP asgui, an accounting system graphical user |
| michael@3 | 9 | ## interface which can be found at http://asgui.europalab.com/. |
| michael@1 | 10 | ## |
| michael@1 | 11 | ## Permission to use, copy, modify, and distribute this software for |
| michael@1 | 12 | ## any purpose with or without fee is hereby granted, provided that |
| michael@1 | 13 | ## the above copyright notice and this permission notice appear in all |
| michael@1 | 14 | ## copies. |
| michael@1 | 15 | ## |
| michael@1 | 16 | ## THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| michael@1 | 17 | ## WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
| michael@1 | 18 | ## MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
| michael@1 | 19 | ## IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR |
| michael@1 | 20 | ## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| michael@1 | 21 | ## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| michael@1 | 22 | ## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| michael@1 | 23 | ## USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| michael@1 | 24 | ## ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| michael@1 | 25 | ## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| michael@1 | 26 | ## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| michael@1 | 27 | ## SUCH DAMAGE. |
| michael@1 | 28 | ## |
| michael@1 | 29 | ## as-accounts.pod: Plain old documentation file |
| michael@1 | 30 | ## |
| michael@1 | 31 | |
| michael@1 | 32 | =pod |
| michael@1 | 33 | |
| michael@1 | 34 | =head1 NAME |
| michael@1 | 35 | |
| michael@1 | 36 | B<as-accounts> - accounting system accounts document format |
| michael@1 | 37 | |
| michael@1 | 38 | =head1 DESCRIPTION |
| michael@1 | 39 | |
| michael@1 | 40 | The B<as-gui> application specifies a user entry as including many individual |
| michael@1 | 41 | pieces of information (see as-events.5). One of these is the account, |
| michael@1 | 42 | describing a task on which the user worked. While the account field may |
| michael@1 | 43 | contain free text, there are a number of atomic values which are typical in |
| michael@1 | 44 | the work atmosphere. The B<as-gui> client reads a file of such values to offer |
| michael@1 | 45 | the user a listing in which to choose from. This file is called the |
| michael@1 | 46 | B<as-accounts> file, and is typically named F<accounts>. Its name and location |
| michael@1 | 47 | are arbitrary and may be changed through the user preferences. |
| michael@1 | 48 | |
| michael@1 | 49 | =head1 FILE FORMAT |
| michael@1 | 50 | |
| michael@1 | 51 | The B<as-accounts> file contains ASCII text. The first line consists of an |
| michael@1 | 52 | identifier to associate the file type and version. Following text may contain |
| michael@1 | 53 | white space, comments, and data tuples. |
| michael@1 | 54 | |
| michael@1 | 55 | =head1 GRAMMAR |
| michael@1 | 56 | |
| michael@1 | 57 | B<accounts> ::= B<accid> B<acclist> |
| michael@1 | 58 | |
| michael@1 | 59 | B<accid> ::= "%!AS-ACCOUNTS-" [0-9] '.' [0-9] |
| michael@1 | 60 | |
| michael@1 | 61 | B<acclist> ::= B<acclist> | B<acctuple> | B<comment> | EMPTY |
| michael@1 | 62 | |
| michael@1 | 63 | B<comment> ::= ($#.*) |
| michael@1 | 64 | |
| michael@1 | 65 | B<acctuple> ::= B<acctype> B<accfull> | B<acctype> B<accfull> B<comment> |
| michael@1 | 66 | |
| michael@1 | 67 | B<accfull> ::= B<accfull> | B<accpart> |
| michael@1 | 68 | |
| michael@1 | 69 | B<accpart> ::= B<accsep> B<acctext> |
| michael@1 | 70 | |
| michael@1 | 71 | B<acctype> ::= [RM] |
| michael@1 | 72 | |
| michael@1 | 73 | B<accsep> ::= '/' |
| michael@1 | 74 | |
| michael@1 | 75 | B<acctext> ::= [a-zA-Z0-9_-]* |
| michael@1 | 76 | |
| michael@1 | 77 | =head1 EXAMPLE |
| michael@1 | 78 | |
| michael@1 | 79 | A typical B<as-accounts> file might look like this: |
| michael@1 | 80 | |
| michael@1 | 81 | %!AS-ACCOUNTS-0.6 |
| michael@1 | 82 | |
| michael@1 | 83 | ## Internet Services (IS) department ## |
| michael@1 | 84 | |
| michael@1 | 85 | # General |
| michael@1 | 86 | |
| michael@1 | 87 | R /is/common/meeting # Specify type |
| michael@1 | 88 | |
| michael@1 | 89 | R /is/common/meeting/weekly # A weekly meeting |
| michael@1 | 90 | |
| michael@1 | 91 | # Special |
| michael@1 | 92 | |
| michael@1 | 93 | R /is/sales/absence/illness # Approved absence (illness) |
| michael@1 | 94 | |
| michael@1 | 95 | R /is/sales/absence/vacation # Approved absence (vacation) |
| michael@1 | 96 | |
| michael@1 | 97 | =head1 SEE ALSO |
| michael@1 | 98 | |
| michael@1 | 99 | as-gui(1), |
| michael@1 | 100 | as-gui.conf(5), |
| michael@1 | 101 | as-events(5) |
| michael@1 | 102 | |
| michael@1 | 103 | =cut |
