The main documentation of OpenERP is composed of a set of books according to the business need. These books are reviewed once a year. We are working with authors/contributors/employees/translators to build chapters on the different aspects of the ERP.
This section describes how we collaborate with authors and translators to provide very good documentation on OpenERP. To motivate people to write quality documentation/chapters we set up author rights to pay each contributor and translator according to their effort.
Building a Book¶
We have contracts with several editors to publish books in different countries.
Once we have enough chapters written, we can compose a book and publish it.
Books are first published in a paper version. Three months after, we release it online.
Building the documentation¶
The Sources for the documentation can be downloaded from:
bzr branch lp:openobject-doc
We use Sphinx, a documentation generator, to build the documentation. So, Sphinx should be installed on your system and you should know how to use it.
You can install it with easy_install. For example, on Ubuntu:
sudo easy_install sphinx
Sphinx is built on top of the reStructuredText project that lets you write documents in plain text files and then generate HTML, PDF or other formats from them. A good introduction to reStructuredText is the Quick reStructuredText reference page. reStructuredText defines the layout and formatting of a single page. Sphinx lets you organise several pages into a large document with a table of contents and cross references.
if you step into this error message (line number can vary):
! Undefined control sequence. l.462 \capstart
This sometimes means that you have a buggy version of sphinx. Try to install Sphinx version 1.0.2:
sudo easy_install sphinx==1.0.2 --upgrade
Building the documentation in HTML and in PDF requires a few dependencies, namely for the LaTeX system (additional packages and fonts). On Ubuntu you can install the required packages with the following command::
# Install Latex extras sudo apt-get install texlive-latex-extra texlive-fonts-recommended # Install ImageMagick for images conversion sudo apt-get install imagemagick
- building the documentation in html:
make clean make html
- building the documentation in pdf:
make clean make latex cd build/latex make all-pdf
- building a book:
For example, if you want to build the OpenERP for Retail and Industrial Management book:
cd books/book_mrp make clean make latex cd build/latex make all-pdf
- How many units can we expect to sell for a book ?
Our first French book sold 500 units per month. It's good as it was our the first book on OpenERP but we can expect better results with an English version. So probably between 250 and 1500 units per month for an English book.