doc/BookkeepingSyntax.xml

   1
   2
   3 <!-- S  x | y | z | S + S | S - S | S * S | S/S | (S)
   4
   5 -->
   6
   7
   8
   9 <expression/>
  10
  11 <terminal/>
  12
  13 <nonterminal/>
  14
  15
  16
  17
  18
  19 <!-- command -opts (token -opts(token))
  20
  21 -->
  22
  23 <expression>
  24
  25         <command/>
  26
  27         <token/>
  28
  29 </expression>
  30
  31
  32
  33 <command>
  34
  35
  36
  37         <options/>
  38
  39
  40
  41         <!-- a token inside of a command means a descriptor -->
  42
  43         <token>
  44
  45
  46
  47                 <options/>
  48
  49
  50
  51                 <!-- a token inside of a token means the actual XML -->
  52
  53                 <token/>
  54
  55         </token>
  56
  57 </command>
  58
  59
  60
  61
  62
  63
  64
  65 <!-- command -opts (token -opts(token)) -->
  66
  67 <!-- CREATE -->
  68
  69 create(entry -entrynum -journal -date (
  70
  71         create(debit -entry -account -amount),
  72
  73         create(credit -entry -account -amount),
  74
  75         create(credit -entry -account -amount)
  76
  77 ));
  78
  79 create(journal -name(entry,entry,...));
  80
  81 create(transaction -date(entry,entry,...));
  82
  83 create(account -name -type -counterweight(debit|credit,...));
  84
  85
  86
  87
  88
  89
  90
  91 <!-- ADD
  92
  93 REMOVE
  94
  95 - this command has the same syntax as 'ADD' except the semantics are reversed
  96
  97 REVERSE
  98
  99 - only <entry/> can be reversed. however the syntax is the same
 100
 101 -->
 102
 103 add((load(journal -name)) entry, entry,...);
 104
 105 add((transaction) entry, entry,...);
 106
 107 add((entry) debit,...);
 108
 109 add((entry) credit,...);
 110
 111 add((account) debit,...);
 112
 113 add((account) credit,...);
 114
 115
 116
 117
 118
 119
 120
 121 <!-- LOAD -->
 122
 123 load(debit -id);
 124
 125 load(credit -id);
 126
 127 load(entry -id);
 128
 129 load(transaction -id);
 130
 131 load(journal -id | -name);
 132
 133 load(account -id | -name);
 134
 135
 136
 137
 138
 139
 140
 141 <!-- FIND
 142
 143 Right now, there are no conditionals, so find will only return results that meet exactly the criteria.
 144
 145
 146
 147 Some conditionals might look like:
 148
 149 String          regex
 150
 151 Number          <, >, <=, >=, ==, !=
 152
 153 Date            <, >, <=, >=, ==, !=
 154
 155 -->
 156
 157 find((token.literal) debit -entry -account -amount);
 158
 159 find((token.literal) credit -entry -account -amount);
 160
 161 find((token.literal) entry -entrynum -journal -date);
 162
 163 find((token.literal) transaction -date);
 164
 165 find((token.literal) journal -name);
 166
 167 find((token.literal) account -name -type -counterweight);
 168
 169
 170
 171
 172
 173
 174
 175 <!-- LIST -->
 176
 177 list((token.literal) debit -entry -account -amount);
 178
 179 list((token.literal) credit -entry -account -amount);
 180
 181 list((token.literal) entry -entrynum -journal -date);
 182
 183 list((token.literal) transaction -date);
 184
 185 list((token.literal) journal -name);
 186
 187 list((token.literal) account -name -type -counterweight);
 188
 189
 190
 191
 192
 193
 194
 195 <!-- ?? UPDATE -->
 196
 197 update((token.literal) debit -entry -account -amount);
 198
 199 update((token.literal) credit -entry -account -amount);
 200
 201 update((token.literal) entry -entrynum -journal -date);
 202
 203 update((token.literal) transaction -date);
 204
 205 update((token.literal) journal -name);
 206
 207 update((token.literal) account -name -type -counterweight);
 208
 209
 210
 211
 212
 213
 214
 215
 216