As-gui Sources / file comparison
comparison: as-events.pod
as-events.pod
- changeset 2
- e8292658d5b3
- child 3
- c1941114ca88
equal
deleted
inserted
replaced
| -1:000000000000 | 0:d4f13cb50f6c |
|---|---|
| 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-events.pod: Plain old documentation file | |
| 30 ## | |
| 31 | |
| 32 =pod | |
| 33 | |
| 34 =head1 NAME | |
| 35 | |
| 36 B<as-events> - accounting system events document format | |
| 37 | |
| 38 =head1 DESCRIPTION | |
| 39 | |
| 40 The B<as-gui> application takes input from the user and may store its data to | |
| 41 a file on the local filesystem. Among other functions, a user can enter time, | |
| 42 amounts, remarks, and other values. This data tuple is termed an I<event>, and | |
| 43 may either be transmitted to a B<AS> server or stored to a local file. Should | |
| 44 it be stored to a local file, the file name is arbitrary and is shown in the | |
| 45 title bar of B<as-gui>. Typically, the file is called F<events.as>. In most | |
| 46 cases the postfix B<.as> is appended to the file name, although this behaviour | |
| 47 can be turned on or off through the user preferences. | |
| 48 | |
| 49 =head1 FILE FORMAT | |
| 50 | |
| 51 The B<as-events> 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<events.as> ::= B<eventsid> B<tuplelist> | |
| 58 | |
| 59 B<eventsid> ::= "%!AS-EVENTS-" [0-9] '.' [0-9] | |
| 60 | |
| 61 B<tuplelist> ::= B<tuplelist> | B<tuple> | B<comment> | EMPTY | |
| 62 | |
| 63 B<tuple> ::= B<user> B<uuid> B<crc> B<revision> B<date> B<begin> B<end> B<amount> B<account> B<remark> | |
| 64 | |
| 65 B<comment> ::= ($#.*) | |
| 66 | |
| 67 (* user field *) | |
| 68 | |
| 69 B<user> ::= [a-zA-Z][a-zA-Z0-9]+ | |
| 70 | |
| 71 (* uuid field *) | |
| 72 | |
| 73 B<uuid> ::= B<hexoctet> '-' B<hexquartet> '-' B<hexquartet> '-' B<hexquartet> '-' B<hextwelvetet> | |
| 74 | |
| 75 (* crc field *) | |
| 76 | |
| 77 B<crc> ::= B<hexoctet> | |
| 78 | |
| 79 B<hextwelvetet> ::= B<hexoctet> | B<hexquartet> | |
| 80 | |
| 81 B<hexoctet> ::= B<hexquartet> | B<hexquartet> | |
| 82 | |
| 83 B<hexquartet> ::= B<hexdigit> | B<hexdigit> | B<hexdigit> | B<hexdigit> | |
| 84 | |
| 85 B<hexdigit> ::= B<a-zA-Z0-9> | |
| 86 | |
| 87 (* revision field *) | |
| 88 | |
| 89 B<revision> ::= [0-9] | |
| 90 | |
| 91 (* date field *) | |
| 92 | |
| 93 B<date> ::= [0-9][0-9][0-9][0-9] '-' [01][0-9] '-' [0123][0-9] | |
| 94 | |
| 95 (* time fields *) | |
| 96 | |
| 97 B<begin> ::= B<timeval> | |
| 98 | |
| 99 B<end> ::= B<endval> | |
| 100 | |
| 101 B<amount> ::= B<timeval> | |
| 102 | |
| 103 B<timeval> ::= B<hourval> ':' B<minuteval> | |
| 104 | |
| 105 B<endval> ::= B<hourinc> ':' B<minuteval> | |
| 106 | |
| 107 B<hourval> ::= [01][0-9] | |
| 108 | |
| 109 B<hourinc> ::= B<hourval> | 2[0-4] | |
| 110 | |
| 111 B<minval> ::= [0-5][0-9] | |
| 112 | |
| 113 (* account field *) | |
| 114 | |
| 115 B<account> ::= B<account> | B<accpart> | |
| 116 | |
| 117 B<accpart> ::= B<accsep> B<acctext> | |
| 118 | |
| 119 B<accsep> ::= '/' | |
| 120 | |
| 121 B<acctext> ::= [a-zA-Z0-9_-]* | |
| 122 | |
| 123 (* remark field *) | |
| 124 | |
| 125 B<remark> ::= '"' .* '"' | |
| 126 | |
| 127 =head1 EXAMPLE | |
| 128 | |
| 129 A typical B<as-events> file might look like this: | |
| 130 | |
| 131 %!AS-EVENTS-0.6 | |
| 132 harvey 0ccf1d42-743b-43df-9b5d-202451b3c26f e8f212b6 0 2002-09-30 00:00 00:00 02:00 /it/development/meeting/weekly "Code review" | |
| 133 harvey 9c497382-ae88-4a1a-91b5-202451b3c26f c8637e9a 0 2002-09-30 00:00 00:00 00:30 /it/common/office/communication "Conference call" | |
| 134 harvey e230eae7-367f-4c35-bee1-202451b3c26f 02cb1abb 0 2002-09-30 00:00 00:00 00:30 /sales/travel/customer "Simontech visit" | |
| 135 | |
| 136 =head1 SEE ALSO | |
| 137 | |
| 138 as-gui(1), | |
| 139 as-gui.conf(5), | |
| 140 as-accounts(5), | |
| 141 | |
| 142 =cut |
