文档流程

书籍

OpenERP的主文档按照业务需求，有几本书共同组成。这些书每年做一次审查。我们与作者、参与者、员工、翻译者一起在ERP的不同领域内工作。

本节描述了我们如何与作者和译者合作给OpenERP提供更好的文档。为了激励人们写出有质量的文档/章节我们设置了作者的权利，以体现(支付)他们付出的写作和翻译的努力。

构建一本书

我们已与不同国家的图书编辑达成协议，出版社这些书。

当有足够的章节书写完成后，我们能够组成一本完整的书，并出版发行。

书首先以纸本方式出版。三个月后，我们会在网络上发布。

著作权

一般著作权占标价的8%到10%， 付给作者、书籍出版所在国的译者。提成是按标价计算的，和实际成交价无关。

作者权利依据参与该书的人员进行分配：

  • 审核者： 10% 除以审核者数目

  • 翻译者： 30%除以翻译者数目

  • 作者： 剩余 (60%-90%) 除以作者数目

例如，Geoff 和 Fabien撰写了英文和法文的OpenERP手册，此书售价35欧元，著作权占10%。有个Eyrolles的家伙帮我们校稿。所以版税分成以下几个部分：

  • Geoff: 1.575 EUR/book (= 35 * 0.1 * (0.9 / 2))

  • Fabien: 1.575 EUR/book

  • Reviewer: 0.35 EUR/book (= 35 * 0.1 * 0.1)

一旦这本书被翻译为匈牙利文，并以30欧元的价格发行，作者享有10% （0.1）的权利，我们将：

  • Geoff: 1.05 EUR/book (=30 * 0.1 * 0.7 / 2)

  • Fabien: 1.05 EUR/book

  • Hungarian translator: 0.90 EUR/book (=30 * 0.1 * 0.30)

作者享有的权利在第一个月之后，会每3个月支付一次。（根据我们和出版社（编辑）确认到的结果）

个人

作者

任何人都可以是作者，并完成完整的一本书，或者仅仅关于OpenERP的某个特定方面的一章或几章的内容。这些章节将会被评审

来自 Tiny 的作者

在OpenERP公司，每个项目结束，员工可以为他给客户自定义的模块写一些章节。因为员工写这些的时间占用了他已被付薪的工作时间，版税的计算有所不同：

  • 计算得的权利被分成两份，给这些员工： 50%

  • 当雇员为Tiny公司工作时有效

建立文档

文档能从下面的源里下载到:

  1. bzr branch lp:openobject-doc

我们使用 Sphinx, 一个用来建立文档的生成器, 因此，将被安装在你的系统里。 你后面将了解如何使用它.

你可以使用 easy_install 来安装，在Ubuntu里面可以按下面的操作安装：

  1. sudo easy_install sphinx

Sphinx基于reStructuredText project，使您可以用纯文本文件写文档并基于它生成HTML、PDF或其它格式。reStructuredText的简介在这里`Quick reStructuredText`_ reference page。reStructuredText定义单页的布局和格式。Sphinx可以用来组织一个大文档的多个页面，支持目录和引用

注解

如果你发现有下面的错误信息(具体的行号可能会不一样)：

  1. ! Undefined control sequence.
  2. l.462 \capstart

有时候的错误则可能是由于 sphinx 版本不兼容靠成的。 推荐安装 Sphinx 1.0.2 版本：

  1. sudo easy_install sphinx==1.0.2 --upgrade

注解

如果你发现有下面的错误信息(具体的行号可能会不一样)：

  1. Traceceback on logs.
  2. AttributeError: type object 'Babel' has no attribute '_ISO639_TO_BABEL'

This sometimes means that you have a buggy version of sphinx incompatible with docutils on Ubuntu +11. Try to install Sphinx version 1.0.8:

  1. sudo easy_install sphinx==1.0.8

将文档转换为HTML或者PDF是需要安装 LaTex 系统以及它的相关的依赖（软件包及字体）。在 Ubuntu 系统中，你可以输入下面的命令进行安装：

  1. # Install Latex extras
  2. sudo apt-get install texlive-latex-extra texlive-fonts-recommended
  3. # Install ImageMagick for images conversion
  4. sudo apt-get install imagemagick

building the documentation in html:

  1. make clean
  2. make html

building the documentation in pdf:

  1. make clean
  2. make latex
  3. cd build/latex
  4. make all-pdf

building a book:

例如，你想编译生成 OpenERP for Retail and Industrial Management 这本书时可以使用下面的命令：

  1. cd books/book_mrp
  2. make clean
  3. make latex
  4. cd build/latex
  5. make all-pdf

链接到源码的文档

有些页面包含项目源代码中的类。如`developer/2_5_Objects_Fields_Methods/methods.rst`。你可以用`Sphinx autodoc extension`_添加更多源码中的文档。此工具用于导入类和方法中的docstring注释。如果你没有告诉Sphinx如何找到项目源代码，导入的过程将会失败，并显示一个警告。要想实现这种导入，请参照以下步骤：

  1. 看起来你需要至少 1.0版本的Sphinx（一种全文检索引擎 ——译者注）。如果你没有自动更新到那个版本，请参考上面的建议安装说明。需要查看你目前的版本，请运行如下命令：

    1. sphinx-build --help

  2. 你需要复制一份 OpenERP Server 的代码。源代码主干版本的OpenERP网站。

  3. 您需要通过注释掉最后一行的config.parse_config()的调用来调整`server/bin/tools/config.py`。希望这最后能被调整清楚，不过在您每次进行这个文档工作时，建立或是添加或删除这个调整，您需要有个备份。

  4. 需要在系统环境变量中添加 PYTHONPATH 指向 /path/to/server/bin 。然后按下面的方法使用 make 进行编译：

    1. PYTHONPATH=/path/to/server/bin make html

常见问题(FAQ)

How much items can we expect to sell for a book ?

The first French book we wrote is sold at 500 items 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 items per month for an English book.