Doxygen doc extended for python invoice export

This commit is contained in:
Christoph Holtermann
2014-11-12 14:54:56 +01:00
parent 3818f3272e
commit 398fb96065
3 changed files with 47 additions and 2 deletions

View File

@@ -5,7 +5,7 @@
# @ingroup python_bindings_examples
# @author Christoph Holtermann (c.holtermann (at) gmx.de)
# @date 2014-11
# @brief exports an invoice from gnucash using a template file
# @brief exports an invoice from gnucash using a template file, see \ref py_invoice_export
#
# Input is a template file that will be filled with information from
# gnucash Invoices. Jinja2 templating engine ist used. Templates can
@@ -20,6 +20,8 @@
# The approach used here is not as dependent on external files and
# more modular as it allows to use arbitrary templates
#
# Doxygen: see page \ref py_invoice_export
#
# Questions / Issues:
# - How much logic in the template, how much preprocessing in this file ?
# - Internationalization - currencies, formatting of numbers

View File

@@ -0,0 +1,42 @@
/**
\page py_invoice_export Python invoice export
The goal of these example scripts is to export invoices to
LaTeX or other output formats as desired.
\par Files:
- latex_invoices.py
A first approach which exports invoice data to an .lco file which is subsequently included into the template
- Templates:
- Invoice.tex
File derived vom scrlttr2.tex v0.3. by Juergen Fenn.
rechnung.sty is used to create the table of entries
- gncinvoice_jinja.py
A second step. Imports jinja2 templates and fills in the invoices values. More flexibility in creating the output files. Output can be anything: LaTeX, HTML, CSV, XML, ...
- Templates:
- Invoice.tex.tmpl
LaTeX template using rechnung.sty, close to the one used by latex_invoices.py.
- Invoice_2.tex.tmpl
LaTeX template using a table to fill in the invoices values. No rechnung.sty required.
\par Goals / Issues:
- How much logic in the template, how much preprocessing in this file ?
- Internationalization - currencies, formatting of numbers, templates
- Providing data of gnucash owner. At the moment this has to be put into the invoices (template/final file) by hand.
- A jinja2 template mimicking the original html invoices
\par See also:
- Modules
- \ref python_bindings_examples
- \ref python_bindings
- Pages
- \ref python_bindings_page
*/

View File

@@ -5,7 +5,7 @@
# @ingroup python_bindings_examples
# @author Christoph Holtermann (c.holtermann (at) gmx.de)
# @date May 2011
# @brief Exports an invoice to lco-file for use with LaTeX
# @brief Exports an invoice to lco-file for use with LaTeX, see \ref py_invoice_export
#
# The output file can be imported into KOMA-Script-letters.
# This works primarily for germany. Internationalization welcome!
@@ -27,6 +27,7 @@
#
# Additional information :
#
# - Doxygen: see page \ref py_invoice_export
# - http://www.uweziegenhagen.de/latex/documents/rechnung/rechnungen.pdf (german)
#
# Credits to and ideas from