← Back to branch summary

~xrg/openobject-doc/trunk-xrg

« back to all changes in this revision

Viewing changes to i18n/vi/source/contribute/documentation_process.rst

  • Committer: TruongSinh Tran
  • Date: 2009-07-17 18:59:45 UTC
  • Revision ID: truongsinh@vipescoserver-20090717185945-ajjp3zso6xh5jddm
[FIX]private issue

Show diffs side-by-side

added added

removed removed

Lines of Context:
i18n/vi/source/contribute/documentation_process.rst
 
1
 
 
2
.. i18n: Documentation Process
 
3
.. i18n: ---------------------
 
4
 
 
5
Documentation Process
 
6
---------------------
 
7
 
 
8
.. i18n: Books
 
9
.. i18n: +++++
 
10
 
 
11
Books
 
12
+++++
 
13
 
 
14
.. i18n: The main documentation of OpenERP is composed of a set of books according to
 
15
.. i18n: the business need. These books are reviewed once a year. We are working with
 
16
.. i18n: authors/contributors/employees/translators to build chapters on the different
 
17
.. i18n: aspects of the ERP. As to motivate people to write quality documentation, 
 
18
 
 
19
The main documentation of OpenERP is composed of a set of books according to
 
20
the business need. These books are reviewed once a year. We are working with
 
21
authors/contributors/employees/translators to build chapters on the different
 
22
aspects of the ERP. As to motivate people to write quality documentation, 
 
23
 
 
24
.. i18n: This section describe how we collaborate with authors and translators to
 
25
.. i18n: provide a very good documentation on OpenERP. As to motivate people to write
 
26
.. i18n: quality documentation/chapters we set up author rights to pay every contributor
 
27
.. i18n: and translator according to their effort.
 
28
 
 
29
This section describe how we collaborate with authors and translators to
 
30
provide a very good documentation on OpenERP. As to motivate people to write
 
31
quality documentation/chapters we set up author rights to pay every contributor
 
32
and translator according to their effort.
 
33
 
 
34
.. i18n: Building a Book
 
35
.. i18n: """""""""""""""
 
36
 
 
37
Building a Book
 
38
"""""""""""""""
 
39
 
 
40
.. i18n: We have contract with several editors to publish books in different countries.
 
41
 
 
42
We have contract with several editors to publish books in different countries.
 
43
 
 
44
.. i18n: Once we have enough chapters written, we can compose a book and publish it.
 
45
 
 
46
Once we have enough chapters written, we can compose a book and publish it.
 
47
 
 
48
.. i18n: Books are first published in a paper version. Three months after, we release it online.
 
49
 
 
50
Books are first published in a paper version. Three months after, we release it online.
 
51
 
 
52
.. i18n: ..  Guidelines
 
53
.. i18n: ..  """"""""""
 
54
 
 
55
..  Guidelines
 
56
..  """"""""""
 
57
 
 
58
.. i18n: .. todo:: write the 'guidelines' section
 
59
 
 
60
.. todo:: write the 'guidelines' section
 
61
 
 
62
.. i18n: Author Rights
 
63
.. i18n: """""""""""""
 
64
 
 
65
Author Rights
 
66
"""""""""""""
 
67
 
 
68
.. i18n: The typical author rights are between 8% and 10% on the public price, according
 
69
.. i18n: to the authors, the country and the editor in which the book will be published.
 
70
.. i18n: This commission is on the public price, no matter of the final selling price
 
71
.. i18n: per item.
 
72
 
 
73
The typical author rights are between 8% and 10% on the public price, according
 
74
to the authors, the country and the editor in which the book will be published.
 
75
This commission is on the public price, no matter of the final selling price
 
76
per item.
 
77
 
 
78
.. i18n: These author rights have to be divided according to people working on the book:
 
79
 
 
80
These author rights have to be divided according to people working on the book:
 
81
 
 
82
.. i18n:   * Reviewers: 10% to be divided by number of reviewers
 
83
.. i18n:   * Translators: 30% to be divided by the number of translators
 
84
.. i18n:   * Authors: the rest (60%-90%) to be divided by number of authors
 
85
 
 
86
  * Reviewers: 10% to be divided by number of reviewers
 
87
  * Translators: 30% to be divided by the number of translators
 
88
  * Authors: the rest (60%-90%) to be divided by number of authors
 
89
 
 
90
.. i18n: As an example, Geoff and Fabien worked on the french and english book on
 
91
.. i18n: OpenERP. This book is sold at a public price of 35 EUR with 10% author rights.
 
92
.. i18n: We had one reviewer for this book from Eyrolles. So author rights are splitted
 
93
.. i18n: in that way:
 
94
 
 
95
As an example, Geoff and Fabien worked on the french and english book on
 
96
OpenERP. This book is sold at a public price of 35 EUR with 10% author rights.
 
97
We had one reviewer for this book from Eyrolles. So author rights are splitted
 
98
in that way:
 
99
 
 
100
.. i18n:   * Geoff: 1.575 EUR/book (= 35 * 0.1 * (0.9 / 2))
 
101
.. i18n:   * Fabien: 1.575 EUR/book
 
102
.. i18n:   * Reviewer: 0.35 EUR/book (= 35 * 0.1 * 0.1)
 
103
 
 
104
  * Geoff: 1.575 EUR/book (= 35 * 0.1 * (0.9 / 2))
 
105
  * Fabien: 1.575 EUR/book
 
106
  * Reviewer: 0.35 EUR/book (= 35 * 0.1 * 0.1)
 
107
 
 
108
.. i18n: Once this book will be translated to Hungarian, with a public price of 30 EUR
 
109
.. i18n: and author rights of 10% (0.1) we will have:
 
110
 
 
111
Once this book will be translated to Hungarian, with a public price of 30 EUR
 
112
and author rights of 10% (0.1) we will have:
 
113
 
 
114
.. i18n:   * Geoff: 1.05 EUR/book (=30 * 0.1 * 0.7 / 2)
 
115
.. i18n:   * Fabien: 1.05 EUR/book
 
116
.. i18n:   * Hungarian translator: 0.90 EUR/book (=30 * 0.1 * 0.30)
 
117
 
 
118
  * Geoff: 1.05 EUR/book (=30 * 0.1 * 0.7 / 2)
 
119
  * Fabien: 1.05 EUR/book
 
120
  * Hungarian translator: 0.90 EUR/book (=30 * 0.1 * 0.30)
 
121
 
 
122
.. i18n: Author rights are paid every 3 months, after one month. (to be verified
 
123
.. i18n: according to what we can do with editors)
 
124
 
 
125
Author rights are paid every 3 months, after one month. (to be verified
 
126
according to what we can do with editors)
 
127
 
 
128
.. i18n: People
 
129
.. i18n: ++++++
 
130
 
 
131
People
 
132
++++++
 
133
 
 
134
.. i18n: Authors
 
135
.. i18n: """""""
 
136
 
 
137
Authors
 
138
"""""""
 
139
 
 
140
.. i18n: Everyone can be an author and write a complete book or just one or several
 
141
.. i18n: chapters on particular aspects of OpenERP. Chapters are then review
 
142
 
 
143
Everyone can be an author and write a complete book or just one or several
 
144
chapters on particular aspects of OpenERP. Chapters are then review
 
145
 
 
146
.. i18n: Authors from Tiny
 
147
.. i18n: """""""""""""""""
 
148
 
 
149
Authors from Tiny
 
150
"""""""""""""""""
 
151
 
 
152
.. i18n: At Tiny (the editor of OpenERP), each employee can write a few chapters based
 
153
.. i18n: on new module he wrote for specific customers, at the end of the project. As
 
154
.. i18n: employees get a salary to write these chapters during their working hours,
 
155
.. i18n: author rights are computed slightly differently:
 
156
 
 
157
At Tiny (the editor of OpenERP), each employee can write a few chapters based
 
158
on new module he wrote for specific customers, at the end of the project. As
 
159
employees get a salary to write these chapters during their working hours,
 
160
author rights are computed slightly differently:
 
161
 
 
162
.. i18n:   * Computed rights are divided by two for the employee: 50%
 
163
.. i18n:   * Valid until the employee work for Tiny
 
164
 
 
165
  * Computed rights are divided by two for the employee: 50%
 
166
  * Valid until the employee work for Tiny
 
167
 
 
168
.. i18n: ..  Translators
 
169
.. i18n: ..  """""""""""
 
170
 
 
171
..  Translators
 
172
..  """""""""""
 
173
 
 
174
.. i18n: ..  Reviewers
 
175
.. i18n: ..  """""""""
 
176
 
 
177
..  Reviewers
 
178
..  """""""""
 
179
 
 
180
.. i18n: Modules
 
181
.. i18n: +++++++
 
182
 
 
183
Modules
 
184
+++++++
 
185
 
 
186
.. i18n: Each module should have a small and minimal documentation.
 
187
 
 
188
Each module should have a small and minimal documentation.
 
189
 
 
190
.. i18n: Building the documentation
 
191
.. i18n: ++++++++++++++++++++++++++
 
192
 
 
193
Building the documentation
 
194
++++++++++++++++++++++++++
 
195
 
 
196
.. i18n: We use `Sphinx <http://sphinx.pocoo.org>`_, a documentation generator, to build
 
197
.. i18n: the documentation. So, Sphinx should be installed on your system and you should
 
198
.. i18n: know how to use it.
 
199
 
 
200
We use `Sphinx <http://sphinx.pocoo.org>`_, a documentation generator, to build
 
201
the documentation. So, Sphinx should be installed on your system and you should
 
202
know how to use it.
 
203
 
 
204
.. i18n: You can install it with `easy_install
 
205
.. i18n: <http://peak.telecommunity.com/DevCenter/EasyInstall>`_. For example, on Ubuntu: ::
 
206
.. i18n: 
 
207
.. i18n:   sudo easy_install sphinx
 
208
 
 
209
You can install it with `easy_install
 
210
<http://peak.telecommunity.com/DevCenter/EasyInstall>`_. For example, on Ubuntu: ::
 
211
 
 
212
  sudo easy_install sphinx
 
213
 
 
214
.. i18n: .. describe:: building the documentation in html:
 
215
 
 
216
.. describe:: building the documentation in html:
 
217
 
 
218
.. i18n: ::
 
219
.. i18n: 
 
220
.. i18n:   make clean
 
221
.. i18n:   make html
 
222
 
 
223
::
 
224
 
 
225
  make clean
 
226
  make html
 
227
 
 
228
.. i18n: .. describe:: building the documentation in pdf:
 
229
 
 
230
.. describe:: building the documentation in pdf:
 
231
 
 
232
.. i18n: ::
 
233
.. i18n: 
 
234
.. i18n:   make clean
 
235
.. i18n:   make latex
 
236
.. i18n:   cd build/latex
 
237
.. i18n:   make all
 
238
 
 
239
::
 
240
 
 
241
  make clean
 
242
  make latex
 
243
  cd build/latex
 
244
  make all
 
245
 
 
246
.. i18n: .. describe:: building a book:
 
247
 
 
248
.. describe:: building a book:
 
249
 
 
250
.. i18n: For example, if you want to build the *Open ERP for Retail and Industrial Management* book:
 
251
 
 
252
For example, if you want to build the *Open ERP for Retail and Industrial Management* book:
 
253
 
 
254
.. i18n: ::
 
255
.. i18n: 
 
256
.. i18n:   cd books/book_mrp
 
257
.. i18n:   make clean
 
258
.. i18n:   make latex
 
259
.. i18n:   cd build/latex
 
260
.. i18n:   make all
 
261
 
 
262
::
 
263
 
 
264
  cd books/book_mrp
 
265
  make clean
 
266
  make latex
 
267
  cd build/latex
 
268
  make all
 
269
 
 
270
.. i18n: FAQ
 
271
.. i18n: +++
 
272
 
 
273
FAQ
 
274
+++
 
275
 
 
276
.. i18n: .. describe:: How much items can we expect to sell for a book ?
 
277
 
 
278
.. describe:: How much items can we expect to sell for a book ?
 
279
 
 
280
.. i18n: The first french book we wrote is sold at 500 items per month. It's good as it
 
281
.. i18n: was our the first book on OpenERP but we can expect better results with an
 
282
.. i18n: english version. So probably between 250 and 1500 items per month for an
 
283
.. i18n: english book.
 
284
 
 
285
The first french book we wrote is sold at 500 items per month. It's good as it
 
286
was our the first book on OpenERP but we can expect better results with an
 
287
english version. So probably between 250 and 1500 items per month for an
 
288
english book.