EekBoek quick start guide: verschil tussen versies

Uit EekBoek
Naar navigatie springenNaar zoeken springen
(Aanmaken nieuwe pagina)
 
 
(5 tussenliggende versies door dezelfde gebruiker niet weergegeven)
Regel 15: Regel 15:
 
For instance <tt>'''help memoriaal'''</tt>.
 
For instance <tt>'''help memoriaal'''</tt>.
  
===Entering bookings===
+
===Using EekBoek===
EekBoek bookings can be entered as in the following format:
+
The attached file contains working examples of bookings which are further explained below.
[kas|bank|inkoop|verkoop]:[booking number] [date] [description] [relation]
+
 
memoriaal [date] [description] [relation]
+
[[Media:mutaties-en.txt]]
Example:
+
 
  verkoop:12 20xx-10-20 "Consulting hours" ACME
+
Use the following commands to import this file:
 +
 
 +
import --file=mutaties-en.txt
 +
 
 +
Or in the shell directly:
 +
 
 +
ebshell --import --file=mutaties-en.txt
 +
 
 +
===Syntax===
 +
The following syntax is used in the booking examples below:
 +
* ? = optional
 +
* * = zero or more
 +
* + = one or more
 +
* | = alternatives
 +
 
 +
===Booking formats===
 +
 
 +
<div style="font-family: Monospace">
 +
{|
 +
| [http://www.eekboek.nl/docs/bookings/payable.html Inkoopfactuur]:
 +
| inkoop(:nr)? date description crediteur (--totaal=amount)? <b><i>regel</i></b>+
 +
|-
 +
| [http://www.eekboek.nl/docs/bookings/receivable.html Verkoopfactuur]:
 +
| verkoop(:nr)? date description debiteur (--totaal=amount)? <b><i>regel</i></b>+
 +
|-
 +
| [http://www.eekboek.nl/docs/bookings/bank.html Bankafschrift]:
 +
| bank(:nr)? date description (<b><i>crd_regel</i></b> <nowiki>|</nowiki> <b><i>deb_regel</i></b> <nowiki>|</nowiki> <b><i>std_regel</i></b>)+
 +
|-
 +
| [http://www.eekboek.nl/docs/bookings/cash.html Kas]:
 +
| kas(:nr)? date description (<b><i>crd_regel</i></b> <nowiki>|</nowiki> <b><i>deb_regel</i></b> <nowiki>|</nowiki> <b><i>std_regel</i></b>)+
 +
|-
 +
| [http://www.eekboek.nl/docs/bookings/memorial.html Memoriaal]:
 +
| memoriaal(:nr)? date description (<b><i>crd_regel</i></b> <nowiki>|</nowiki> <b><i>deb_regel</i></b> <nowiki>|</nowiki> <b><i>std_regel</i></b>)+
 +
|-
 +
| <b><i>crd_regel</i></b>:
 +
| crd date? crediteur amount
 +
|-
 +
| <b><i>deb_regel</i></b>:
 +
| deb date? debiteur amount
 +
|-
 +
| <b><i>std_regel</i></b>:
 +
| std date? <b><i>regel</i></b>
 +
|-
 +
| <b><i>regel</i></b>:
 +
| description amount account
 +
|}
 +
</div>
 +
 
 +
===Sample bookings===
 +
Example of a booking as sales, with booking number 12:
 +
  verkoop:12 20xx-10-20 "Consulting hours" ACME Activities 369,82 8900
  
For backdated bookings, use the following format:
+
For backdated bookings, add the <tt>'''year'''</tt> to which the booking should be attributed:
  [kas|bank|inkoop|verkoop]:[year]:[accountnumber] [date] [description] [relation]
+
  [kas|bank|inkoop|verkoop]:[<b>year</b>]:[accountnumber] [date] [description] [relation] [regel]
 
Example:
 
Example:
  verkoop:2006:12 20xx-10-20 "Consulting hours" ACME
+
  verkoop:<b>2006</b>:12 20xx-10-20 "Consulting hours" ACME Activities 369,82 8900
  
 
===Removing bookings===
 
===Removing bookings===
 
To remove bookings, use the following command:
 
To remove bookings, use the following command:
 
  verwijder
 
  verwijder
for the last entered booking, or:
+
which will remove the last entered booking. Use the following to remove the booking with the specified booking number.:
 
  verwijder verkoop:12
 
  verwijder verkoop:12
to remove the booking with the specified booking number.
 
  
 
===Leaving EekBoek===
 
===Leaving EekBoek===
 
Type <tt>'''quit'''</tt> to leave the EekBoek environment.
 
Type <tt>'''quit'''</tt> to leave the EekBoek environment.
 +
 +
===EekBoek support===
 +
Even though the language may bar you from using EekBoek more often, there is a wealth of assistance available. A short-list:
 +
* [[Meer_documentatie_en_gebruikstips|This wiki]]
 +
* [http://www.eekboek.nl/docs/ Official documentation]
 +
* [https://lists.sourceforge.net/lists/listinfo/eekboek-users EekBoek gebruikers mailing list]: user forum
 +
* [https://lists.sourceforge.net/lists/listinfo/eekboek-devel EekBoek development mailing list]: developers forum

Huidige versie van 24 feb 2012 om 10:16

Using EekBoek for the first time can be confusing, not only because it was originally conceived in Dutch, but also because the configurations and options may be hard to find. The following assumes that you have a working operating system with the latest version of EekBoek installed and a terminal window logged in as a user with the ability to run sudo commands (root privileges).

Setting up an administration

Type the following to enter the EekBoek environment in english:

LANG=en_US.UTF-8 ebshell

The ebshell is the environment in which all EekBoek commands can be entered. If this is the first time you log into the EekBoek environment, you will now be presented with an interactive menu consisting of 6 questions. These questions help to set up an administration for you. After completion, there is a directory under $HOME/.eekboek/admdir with the name of the administration that contains the set of configuration files. So, if the administration is called eekboek_test_2015, then the configuration files will be stored under $HOME/.eekboek/admdir/eekboek_test_2015.

Type help to get a list of commands. Type the following command to find help on that command:

help

For instance help memoriaal.

Using EekBoek

The attached file contains working examples of bookings which are further explained below.

Media:mutaties-en.txt

Use the following commands to import this file:

import --file=mutaties-en.txt

Or in the shell directly:

ebshell --import --file=mutaties-en.txt

Syntax

The following syntax is used in the booking examples below:

  • ? = optional
  • * = zero or more
  • + = one or more
  • | = alternatives

Booking formats

Inkoopfactuur: inkoop(:nr)? date description crediteur (--totaal=amount)? regel+
Verkoopfactuur: verkoop(:nr)? date description debiteur (--totaal=amount)? regel+
Bankafschrift: bank(:nr)? date description (crd_regel | deb_regel | std_regel)+
Kas: kas(:nr)? date description (crd_regel | deb_regel | std_regel)+
Memoriaal: memoriaal(:nr)? date description (crd_regel | deb_regel | std_regel)+
crd_regel: crd date? crediteur amount
deb_regel: deb date? debiteur amount
std_regel: std date? regel
regel: description amount account

Sample bookings

Example of a booking as sales, with booking number 12:

verkoop:12 20xx-10-20 "Consulting hours" ACME Activities 369,82 8900

For backdated bookings, add the year to which the booking should be attributed:

[kas|bank|inkoop|verkoop]:[year]:[accountnumber] [date] [description] [relation] [regel]

Example:

verkoop:2006:12 20xx-10-20 "Consulting hours" ACME Activities 369,82 8900

Removing bookings

To remove bookings, use the following command:

verwijder

which will remove the last entered booking. Use the following to remove the booking with the specified booking number.:

verwijder verkoop:12

Leaving EekBoek

Type quit to leave the EekBoek environment.

EekBoek support

Even though the language may bar you from using EekBoek more often, there is a wealth of assistance available. A short-list: