sfos/ledger
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ledger/contrib/non-profit-audit-reports
History
Bradley M. Kuhn 88667ca0c5 Comment to expound more on what it means for <Adjustment> entries to be ignored by these reports. 
Loïc Dachary <loic@dachary.org>, during patch review, pondered whether the
ignoring of <Adjustment> by these scripts could ever be used to hide funds,
ala the movies Superman III and Office Space.

After discussion, we both concluded that it would not be possible to hide
funds merely with this report.  Such hiding would have to also dig into the
main Ledger codebase and muck with how it handles auto-generated <Adjustment>
entries.
2013-02-20 08:10:27 -05:00
..
ooolib2 First pass technical study of creating ODS from ledger 2012-09-08 00:30:37 -05:00
tests MANIFEST file is now also generated by general-ledger report. 2013-01-04 12:24:30 -05:00
bank-reconcilation.plx Sort solution by date in output. 2013-02-18 14:08:46 -05:00
cash-receipts-and-disbursments-journals.plx Comment to expound more on what it means for <Adjustment> entries to be ignored by these reports. 2013-02-20 08:10:27 -05:00
csv2ods.py Support for title: field, to name sheets in the ODS file. 2013-02-18 14:08:46 -05:00
demo.sh MANIFEST output file that indicates which files are mentioned in general-ledger. 2012-11-26 13:54:42 -05:00
fund-report.plx The restricted fund report has been almost entirely rewritten. 2013-01-06 19:48:22 -05:00
general-ledger-report.plx Equity and Adjustment accounts should not appear in these reports at all. 2013-02-19 09:13:05 -05:00
GPLv3 contrib/non-profit-audit-reports/ directory will be a small GPLv3'd application. 2012-09-06 20:31:48 -04:00
LICENSE contrib/non-profit-audit-reports/ directory will be a small GPLv3'd application. 2012-09-06 20:31:48 -04:00
readcsv.py First pass technical study of creating ODS from ledger 2012-09-08 00:30:37 -05:00
README First pass technical study of creating ODS from ledger 2012-09-08 00:30:37 -05:00
summary-reports.plx Fix typo in error output. 2013-02-20 07:49:50 -05:00
unpaid-accruals-report.plx Completed report on unpaid accruals. 2013-01-06 19:28:21 -05:00

README 

README

This document provides backround on the enclosed example

Demo
----
To run the demo do
./demo.sh

Which should generate the following files in tests/
  chart-of-accounts.txt
  general-ledger.txt
  general-ledger.csv
  general-ledger.ods

And a final, "portable" zip file with the spreadsheet in
  general-ledger.zip

It *should* be possible to copy general-ledger.zip to another system,
unzip it, open general-ledger.ods in Libre Office and have the relative
links resolve correctly.

NOTE: Export to PDF should also work.


Known Dependencies
------------------
ledger (3.0)
python (2.x)
zip
libdate-manip-perl
libmath-gmp-perl


Temporary Hacks
---------------
Due to an urgent project deadline the ooolib2 directory
represents some fixes to:
  http://ooolib.sourceforge.net/

The proper version of this library can be installed on Debian systems with
# apt-get install python-ooolib

Compare the deltas to the current version with 
# diff -u /usr/share/pyshared/ooolib/__init__.py ooolib2/__init__.py

Note also that the csv2ods.py treats columns 4 and 5 (numbering from 1) of the csv 
magically. If column 4 contains a non-empty string which is not 'Receipt'
then it is interpreted as a relative path of an artifact to link to.
Similary for column 5 and 'Invoice'.


Sample PDF files
----------------
The sample PDF files were created as follows:

paps --font="Courier 12" --paper letter --top-margin=18 tests/Projects/Foo/Expenses/hosting/AprilHostingReceipt.txt | ps2pdf - tests/Projects/Foo/Expenses/hosting/AprilHostingReceipt.pdf

paps --font="Courier 12" --paper letter --top-margin=18 tests/Financial/Invoices/Invoice20110510.txt | ps2pdf - tests/Financial/Invoices/Invoice20110510.pdf


Resources
---------
ooolib
  http://ooolib.sourceforge.net/
  
LIBPF
  probably does not replace ooolib
  http://wp.libpf.com/?p=82

Libre Office Calc Guide (contains function reference)
  https://www.libreoffice.org/get-help/documentation/

Libre Office API
  http://api.libreoffice.org/examples/examples.html
  http://api.libreoffice.org/examples/DevelopersGuide/examples.html

OpenOffice Developers Guide
  http://wiki.openoffice.org/wiki/Documentation/DevGuide/OpenOffice.org_Developers_Guide

Spreadsheet Documents
  http://wiki.openoffice.org/wiki/Documentation/DevGuide/Spreadsheets/Spreadsheet_Documents

How to correctly create ODF documents using zip
(Do NOT do this, use ooolib instead)
   http://www.jejik.com/articles/2010/03/how_to_correctly_create_odf_documents_using_zip/

Line Breaks
  fo:break-before="page"
  http://books.evc-cit.info/oobook/ch03.html#page-content-section

ODF Validator
  http://opendocumentfellowship.com/validator

Editing Hyperlinks
  http://help.libreoffice.org/Common/Editing_Hyperlinks

Perl OODoc
NOTE: a replacement for POD, not ooolib
  http://search.cpan.org/dist/OpenOffice-OODoc/