Open Object News

Open ERP version 5.0.6

Olivier — Tue, 29 Sep 2009 09:04:48 +0000

We are proud to announce the release of Open ERP version 5.0.6.

This release fixes a number of issues. The complete changelogs are available on Launchpad:

Sources as well as Windows binaries can be downloaded on the download page of our web site

Open ERP version 5.0.5

Olivier — Fri, 18 Sep 2009 11:38:48 +0000

We are proud to announce the release of Open ERP version 5.0.5.

This release fixes a number of issues. The complete changelogs are available on Launchpad:

Sources as well as Windows binaries can be downloaded on the download page of our web site

Hiding documentation comments.

Olivier — Thu, 18 Jun 2009 07:02:43 +0000

Comments in the documentation are becoming very numerous. They begin to hinder the reading.

If you want to read the Open ERp documentation without those comments, we have added a small utility to control the appearance of these comments. There is now a small selection list on the right of the next, previous links:

You can now choose to read the documentation without these comments if you want.

Your choice will be remembered from page to page and even if you start a new web session (a cookie is used to store your choice)

New filtering option on the documentation search page

Olivier — Mon, 27 Apr 2009 11:40:24 +0000

The Open Object Documentation is very big and the default search facilities offered by Sphinx displays a lot of pages in sections you probably do not need.

For example, if you search for the account word in the documentation, you will get 373 results (out of 389) dispatched like this:

Module Index: 228
Community Book :4
Open ERP Book: 81
Installation Manuals: 3
Business Intelligence: 0
Open ERP Features: 34
Developer Book: 23

But most of the time, you probably wanted to search in one or two specific sections.

This is now a possibility with the new search option list:

You can choose one or several sections and Sphinx will only search in these sections.

By default, Sphinx will search in all sections.

New features in the Module Index.

Olivier — Tue, 21 Apr 2009 09:03:27 +0000

The Module Index lists all the available Open ERP modules. Each page displays a list of important information about a module:

some metadata:
- last module version
- module author
- …
the module description
the module dependencies
its menus, reports and views
its objects (useful for developers)

Download links

There is now a Download links section listing the available download files for a specific module.

The following version are checked for availability:

4.2 (old stable version)
5.0 (last stable version)
trunk (development version)

The file to be downloaded is a zip file.

Rate your favorite modules

Beside download links, you can now rate your favorite modules in this section. For example:

You can give from 1 to 5 points to each module.

This will help the Open Object Community understand which modules should be improved.

New feature: commenting on Open Object Documentation

Olivier — Mon, 06 Apr 2009 14:55:09 +0000

Thanks to JS-Kit Comments, you are now able to leave comments in the Open Object Documentation.

You can leave comments under every important sections on the Open Object Documentation pages. There is also a global commenting area at the bottom of the page.

You can see an example in the Open ERP Book section of the documentation, in System Administration and Implementation -> Configuration & Administration -> Importing and exporting data, at the bottom of the page:

So, feel free to comment the documentation.

How to translate the Open Object Documentation in your language.

Olivier — Wed, 01 Apr 2009 08:12:40 +0000

Prerequisite

You should be able to build the untranslated documentation. So Sphinx should be installed on your system
and you should know how to use it.

If this is not the case, please read the Community Guide

Understanding the directory structure

We are supposing that is the root of the Open Object
documentation bazaar branch.

The untranslated sources are located in /source

The translated documentation will be located in /i18n//source.

For example, the documentation in french will be located in
/i18n/fr/source and it will be built in
/i18n/fr/build/html for example.

Summary

Directory	Description
/source	untranslated sources
/i18n//source	translated sources
/i18n//build/html	translated documentation in html

Creating the translation directory structure

Use the make i18n LANG= command to create the translation
templates. Example, supposing you want to translate the documentation in
french:

  make i18n LANG=fr

This command will do several things:

create these directories, if they does not exist yet:
- i18n
- i18n/fr
- i18n/fr/source
- i18n/fr/build
copy files in i18n/fr/ required for the html build:
- MakeFile
- conf.py
create the translation templates based on the untranslated restructured text files. They will be created in i18n/fr/source
copy all the other necessary files (images for example)

Translation templates

The template structure for a given file is very simple. Each text section is
prepended by the original context. Here is a title, for example:


  .. i18n: %%%%%%%%%%%%%%%%%%%%%%%%%
  .. i18n: Open Object Documentation
  .. i18n: %%%%%%%%%%%%%%%%%%%%%%%%%

  %%%%%%%%%%%%%%%%%%%%%%%%%
  Open Object Documentation
  %%%%%%%%%%%%%%%%%%%%%%%%%

The context is a commented section starting with .. i18n:. It helps you
understand the section in its context. It also helps you remember the original
section.

And here is the translated section:


  .. i18n: %%%%%%%%%%%%%%%%%%%%%%%%%
  .. i18n: Open Object Documentation
  .. i18n: %%%%%%%%%%%%%%%%%%%%%%%%%

  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  Documentation sur Open Object
  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Managing source changes

If someone adds or changes something in the documentation, that section will
have to be retranslated but all the other sections will hopefully keep their
translation.

When you will get the documentation changes with bzr pull (for example), the
new sections and some changed sections will be reset to the untranslated text
when you will rebuild the translation with make i18n LANG=fr.

Complete documentation

The complete documentation is available in the Community Book.

Status

At the moment, this script is in alpha status and has not been thoroughly
tested. It should work but expect some bugs to pop up at unexpected times.