freeipa/doc/guide
Martin Kosek 092dd8db12 Replace float with Decimal
Having float type as a base type for floating point parameters in
ipalib introduces several issues, e.g. problem with representation
or value comparison. Python language provides a Decimal type which
help overcome these issues.

This patch replaces a float type and Float parameter with a
decimal.Decimal type in Decimal parameter. A precision attribute
was added to Decimal parameter that can be used to limit a number
of decimal places in parameter representation. This approach fixes
a problem with API.txt validation where comparison of float values
may fail on different architectures due to float representation error.

In order to safely transfer the parameter value over RPC it is
being converted to string which is then converted back to
decimal.Decimal number on a server side.

https://fedorahosted.org/freeipa/ticket/2260
2012-01-20 08:13:44 +01:00
..
guide.org Replace float with Decimal 2012-01-20 08:13:44 +01:00
Makefile Add "Extending FreeIPA" developer guide 2011-11-22 15:52:02 +02:00
netgroup.js Add "Extending FreeIPA" developer guide 2011-11-22 15:52:02 +02:00
README Add "Extending FreeIPA" developer guide 2011-11-22 15:52:02 +02:00
role.py.txt Rename included snippets to avoid problems with pylint 2011-11-22 17:04:03 +02:00
wsgi.py.txt Rename included snippets to avoid problems with pylint 2011-11-22 17:04:03 +02:00

Extending FreeIPA
-----------------

"Extending FreeIPA" is a developer guide to understand how FreeIPA core 
framework is built and how to extend it.

The Guide is written using Emacs Org Mode, see http://orgmode.org/org.html
for extensive manual of supported markup features.

You don't need to use Emacs to edit it, the markup is a plain text.

Building the guide
------------------

There is Makefile which can be used to convert the Guide from
Emacs Org Mode format to different targets.

Prerequisites:
==============
On Fedora system following packages are required to generate The Guide:

docbook-style-xsl
fop
emacs
xmlto

HTML, Docbook, and plain text
---
As Org Mode is part of Emacs since version 22, building HTML, TXT, and 
Docbook targets requires Emacs v22 and above (tested with v23.3 in Fedora).

PDF
---
Building PDF is done first generating Docbook source, converting it to FO format,
and then running 'fop' processor.