freeipa/doc/guide
Petr Viktorin eef5acd9d7 Remove the unused ipalib.frontend.Property class
This class was built into the framework from its early days but it's
not used anywhere.
Remove it along with its tests

https://fedorahosted.org/freeipa/ticket/3460

Reviewed-By: Jan Cholasta <jcholast@redhat.com>
2014-02-21 11:58:00 +01:00
..
guide.org Remove the unused ipalib.frontend.Property class 2014-02-21 11:58:00 +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.