1
0
Fork 0
mirror of https://github.com/Findus23/invoices.git synced 2024-09-18 14:03:48 +02:00

unify template and add all params to readme

* renamed 'plz' and 'ort' from recipients side to 'zip' and 'city'
* added phone, email and url params to documentation
This commit is contained in:
fkarg 2020-09-30 22:40:49 +02:00
parent 0248e829dc
commit b4c6e285e2
2 changed files with 7 additions and 7 deletions

View file

@ -21,6 +21,9 @@ Have a file called `from.yaml` with your own information structured like this:
| `IBAN` | string | The IBAN of your bank account. |
| `BIC` | string | The BIC of your bank account. |
| `bank` | string | The name of your bank. |
| `phone` | string | Optional. Your phone number. |
| `email` | string | Optional. Your mail address. |
| `url` | string | Optional. Your homepage. |
### Example
```from.yaml
@ -36,6 +39,8 @@ BIC: <BIC>
bank: <name of bank>
```
It's no big deal to leave some of the fields empty.
## Clients: recipients/\<rname\>.yaml
For every clients `rname`, have a `recipients/<rname>.yaml` file structured
like this:
@ -48,11 +53,6 @@ like this:
| `zip` | int | ZIP code of your clients address. |
| `city` | string | City correlating to the zip code. |
| `country` | string | Country of your clients business address. |
<!--
| `IBAN` | string | The IBAN of your bank account. |
| `BIC` | string | The BIC of your bank account. |
| `bank` | string | The name of your bank. |
-->
### Example
```recipients/<rname>.yaml

View file

@ -82,8 +82,8 @@
% Begin document
\begin{document}
\begin{letter}{\VAR{to.name} \\ \VAR{to.address} \\ \VAR{to.plz}~\VAR{to.ort}
\BLOCK{if to.country!="Österreich"}\\\VAR{to.country}\BLOCK{endif}}
\begin{letter}{\VAR{to.name} \\ \VAR{to.address} \\ \VAR{to.zip}~\VAR{to.city}
\\\VAR{to.country}}
\setkomavar{title}{\VAR{invoice.title}}
\opening{}