diff options
| author | Christophe Simonis <chs@odoo.com> | 2019-10-09 02:08:17 +0200 |
|---|---|---|
| committer | Christophe Simonis <chs@odoo.com> | 2019-10-09 02:08:17 +0200 |
| commit | d74b4518052066446e2a1975a91ce53c745ca75a (patch) | |
| tree | c08180f88a512d15e37fbec628931f02b3825f65 /doc | |
| parent | ec162dd0cb5622ab6e56db1a63dab5f531a96f4a (diff) | |
| parent | f4105eb9c7010f8693e5d2fd20c0bd9d9cc2e483 (diff) | |
[MERGE] forward port branch 13.0 up to f4105eb9c70
Diffstat (limited to 'doc')
37 files changed, 1072 insertions, 752 deletions
diff --git a/doc/_extensions/odoo_ext/sub-menu_list.html b/doc/_extensions/odoo_ext/sub-menu_list.html index ba1a2ad9542..179c57bd455 100644 --- a/doc/_extensions/odoo_ext/sub-menu_list.html +++ b/doc/_extensions/odoo_ext/sub-menu_list.html @@ -1,8 +1,8 @@ {# note: if odoo.com/page/docs sub-menu's structure change, these links have to change as well #} -<li><a href="https://www.odoo.com/documentation/user/12.0/index.html">User</a></li> -<li><a href="https://www.odoo.com/documentation/12.0/index.html">Developer</a></li> -<li><a href="https://www.odoo.com/documentation/12.0/setup/install.html">Installation</a></li> +<li><a href="https://www.odoo.com/documentation/user/13.0/index.html">User</a></li> +<li><a href="https://www.odoo.com/documentation/13.0/index.html">Developer</a></li> +<li><a href="https://www.odoo.com/documentation/13.0/setup/install.html">Installation</a></li> <li><a href="https://odoo.com/slides">eLearning</a></li> <li><a href="https://www.odoo.com/page/odoo-white-paper">White Papers</a></li> <li><a href="https://www.odoo.com/page/legal">Legal</a></li> diff --git a/doc/cla/corporate/camptocamp.md b/doc/cla/corporate/camptocamp.md index 73857696466..562e296c8d5 100644 --- a/doc/cla/corporate/camptocamp.md +++ b/doc/cla/corporate/camptocamp.md @@ -36,3 +36,4 @@ Patrick Tombez patrick.tombez@camptocamp.com https://github.com/p-tombez Julien Coux julien.coux@camptocamp.com https://github.com/jcoux Alexandre Saunier alexandre.saunier@camptocamp.com https://github.com/asaunier Frédéric Junod frederic.junod@camptocamp.com https://github.com/fredj +Sébastien Alix sebastien.alix@camptocamp.com https://github.com/sebalix diff --git a/doc/cla/corporate/komit.md b/doc/cla/corporate/komit.md new file mode 100644 index 00000000000..b907afb27d3 --- /dev/null +++ b/doc/cla/corporate/komit.md @@ -0,0 +1,18 @@ +Vietnam, 2019-08-23 + +KOMIT CO.,LTD agrees to the terms of the Odoo Corporate Contributor License +Agreement v1.0. + +I declare that I am authorized and able to make this agreement and sign this +declaration. + +Signed, + +Jean-Charles DRUBAY jc@komit-consulting.com https://github.com/jcdrubay + +List of contributors: + +Cuong NGUYEN MINH TRAN MANH cuong.nmtm@komit-consulting.com https://github.com/cuongnmtm +Duc TRUONG DINH MINH duc.tdm@komit-consulting.com https://github.com/DucTruongKomit +Hieu VO MINH BAO hieu.vmb@komit-consulting.com https://github.com/hieulucky111 +Jean-Charles DRUBAY jc@komit-consulting.com https://github.com/jcdrubay diff --git a/doc/cla/corporate/odooexperts.md b/doc/cla/corporate/odooexperts.md index 3a73e799b87..2ca9dc2adc1 100644 --- a/doc/cla/corporate/odooexperts.md +++ b/doc/cla/corporate/odooexperts.md @@ -13,4 +13,4 @@ Erwin van der Ploeg erwin@bas-solutions.nl https://github.com/erwin-bas-solution List of contributors: Erwin van der Ploeg erwin@odooexperts.nl https://github.com/ploegvde -Yenthe Van Ginneken yenthe@odooexperts.nl https://github.com/Yenthe666 +Yenthe Van Ginneken yenthe@odooexperts.nl https://github.com/Yenthe666 (up to 2019-09-25) diff --git a/doc/cla/individual/ezchan.md b/doc/cla/individual/ezchan.md new file mode 100644 index 00000000000..3050509e10f --- /dev/null +++ b/doc/cla/individual/ezchan.md @@ -0,0 +1,11 @@ +United States, 2019-09-19 + +I hereby agree to the terms of the Odoo Individual Contributor License +Agreement v1.0. + +I declare that I am authorized and able to make this agreement and sign this +declaration. + +Signed, + +Eric Channey ericchanney@gmail.com https://github.com/ezchan
\ No newline at end of file diff --git a/doc/cla/individual/herawais.md b/doc/cla/individual/herawais.md new file mode 100644 index 00000000000..ec455781d00 --- /dev/null +++ b/doc/cla/individual/herawais.md @@ -0,0 +1,11 @@ +Pakistan, 2019-10-01 + +I hereby agree to the terms of the Odoo Individual Contributor License +Agreement v1.0. + +I declare that I am authorized and able to make this agreement and sign this +declaration. + +Signed, + +Muhammad Awais herawais@users.noreply.github.com https://github.com/herawais diff --git a/doc/cla/individual/joeycodinja.md b/doc/cla/individual/joeycodinja.md new file mode 100644 index 00000000000..a1106429e3b --- /dev/null +++ b/doc/cla/individual/joeycodinja.md @@ -0,0 +1,11 @@ +Jamaica, 2019-09-02 + +I hereby agree to the terms of the Odoo Individual Contributor License +Agreement v1.0. + +I declare that I am authorized and able to make this agreement and sign this +declaration. + +Signed, + +Danuel Williams joseph_thesaint@hotmail.com https://github.com/JoeyCodinja diff --git a/doc/cla/individual/kig-odoo.md b/doc/cla/individual/kig-odoo.md new file mode 100644 index 00000000000..070a0dcf539 --- /dev/null +++ b/doc/cla/individual/kig-odoo.md @@ -0,0 +1,11 @@ +India, 2019-10-09 + +I hereby agree to the terms of the Odoo Individual Contributor License +Agreement v1.0. + +I declare that I am authorized and able to make this agreement and sign this +declaration. + +Signed, + +Kishan Gajjar kishanegajjar@gmail.com https://github.com/kig-odoo diff --git a/doc/cla/individual/kos94ok-3d.md b/doc/cla/individual/kos94ok-3d.md new file mode 100644 index 00000000000..73c697562ae --- /dev/null +++ b/doc/cla/individual/kos94ok-3d.md @@ -0,0 +1,10 @@ +Ukraine, 2019-07-03 + +I hereby agree to the terms of the Odoo Individual Contributor License Agreement v1.0. + +I declare that I am authorized and able to make this agreement and sign this declaration. + +Signed, + +Andrii Skrypka andrijskrypa@ukr.net https://github.com/kos94ok-3D + diff --git a/doc/conf.py b/doc/conf.py index 3c50d394318..ebee78ccbf6 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -54,9 +54,9 @@ copyright = u'Odoo S.A.' # built documents. # # The short X.Y version. -version = '12.0' +version = '13.0' # The full version, including alpha/beta/rc tags. -release = '12.0' +release = '13.0' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: diff --git a/doc/howtos/backend/exercise-creation b/doc/howtos/backend/exercise-creation index b5cf555845f..52de611b686 100644 --- a/doc/howtos/backend/exercise-creation +++ b/doc/howtos/backend/exercise-creation @@ -22,7 +22,7 @@ Index: addons/openacademy/__manifest__.py + 'website': "http://www.yourcompany.com", + + # Categories can be used to filter modules in modules listing -+ # Check https://github.com/odoo/odoo/blob/12.0/odoo/addons/base/data/ir_module_category_data.xml ++ # Check https://github.com/odoo/odoo/blob/13.0/odoo/addons/base/data/ir_module_category_data.xml + # for the full list + 'category': 'Test', + 'version': '0.1', diff --git a/doc/howtos/backend/exercise-kanban b/doc/howtos/backend/exercise-kanban index d98adf6a7b7..42cbd8b096b 100644 --- a/doc/howtos/backend/exercise-kanban +++ b/doc/howtos/backend/exercise-kanban @@ -22,7 +22,7 @@ Index: addons/openacademy/views/openacademy.xml </record> + <record model="ir.ui.view" id="view_openacad_session_kanban"> -+ <field name="name">openacad.session.kanban</field> ++ <field name="name">openacademy.session.kanban</field> + <field name="model">openacademy.session</field> + <field name="arch" type="xml"> + <kanban default_group_by="course_id"> diff --git a/doc/howtos/website/module-empty b/doc/howtos/website/module-empty index 88fe8079d92..2632ab2e1fb 100644 --- a/doc/howtos/website/module-empty +++ b/doc/howtos/website/module-empty @@ -28,10 +28,10 @@ new file mode 100644 + """, + + 'author': "My Company", -+ 'website': "http://www.yourcompany.com", ++ 'website': "https://www.yourcompany.com", + + # Categories can be used to filter modules in modules listing -+ # Check https://github.com/odoo/odoo/blob/12.0/odoo/addons/base/data/ir_module_category_data.xml ++ # Check https://github.com/odoo/odoo/blob/13.0/odoo/addons/base/data/ir_module_category_data.xml + # for the full list + 'category': 'Uncategorized', + 'version': '0.1', diff --git a/doc/reference/actions.rst b/doc/reference/actions.rst index e247bde9e61..614c06187e4 100644 --- a/doc/reference/actions.rst +++ b/doc/reference/actions.rst @@ -18,19 +18,23 @@ e.g. button methods. All actions share two mandatory attributes: ``name`` short user-readable description of the action, may be displayed in the client's interface +``binding_model_id`` + if set, the action is available in the action bar for the given model + + .. note:: For Server Actions, use ``model_id``. A client can get actions in 4 forms: -``False`` - if any action dialog is currently open, close it -A string - if a :ref:`client action <reference/actions/client>` matches, interpret as - a client action's tag, otherwise treat as a number -A number - read the corresponding action record from the database, may be a database - identifier or an :term:`external id` -A dictionary - treat as a client action descriptor and execute +* ``False`` + if any action dialog is currently open, close it +* A string + if a :ref:`client action <reference/actions/client>` matches, interpret as + a client action's tag, otherwise treat as a number +* A number + read the corresponding action record from the database, may be a database + identifier or an :term:`external id` +* A dictionary + treat as a client action descriptor and execute Bindings ======== @@ -122,12 +126,27 @@ dialog:: In-database window actions have a few different fields which should be ignored by clients, mostly to use in composing the ``views`` list: -``view_mode`` - comma-separated list of view types as a string. All of these types will be +``view_mode`` (default= ``tree,form`` ) + comma-separated list of view types as a string (/!\\ No spaces /!\\). All of these types will be present in the generated ``views`` list (with at least a ``False`` view_id) ``view_ids`` M2M\ [#notquitem2m]_ to view objects, defines the initial content of ``views`` + + .. note:: Act_window views can also be defined cleanly through ``ir.actions.act_window.view``. + + If you plan to allow multiple views for your model, prefer using + ir.actions.act_window.view instead of the action ``view_ids`` + + .. code-block:: xml + + <record model="ir.actions.act_window.view" id="test_action_tree"> + <field name="sequence" eval="1"/> + <field name="view_mode">tree</field> + <field name="view_id" ref="view_test_tree"/> + <field name="act_window_id" ref="test_action"/> + </record> + ``view_id`` specific view added to the ``views`` list in case its type is part of the ``view_mode`` list and not already filled by one of the views in @@ -160,6 +179,9 @@ The server-side composition of the ``views`` sequence is the following: * ``groups_id``? * ``filter``? +.. [#notquitem2m] technically not an M2M: adds a sequence field and may be + composed of just a view type, without a view id. + .. _reference/actions/url: URL Actions (``ir.actions.act_url``) @@ -178,7 +200,7 @@ via two fields: { "type": "ir.actions.act_url", - "url": "http://odoo.com", + "url": "https://odoo.com", "target": "self", } @@ -189,6 +211,8 @@ will replace the current content section by the Odoo home page. Server Actions (``ir.actions.server``) ====================================== +.. autoclass:: odoo.addons.base.models.ir_actions.IrActionsServer + Allow triggering complex server code from any valid action location. Only two fields are relevant to clients: @@ -202,151 +226,90 @@ specific or generic actions based on their ``state``. Some fields (and corresponding behaviors) are shared between states: ``model_id`` - Odoo model linked to the action, made available in - :ref:`evaluation contexts <reference/actions/server/context>` -``condition`` (optional) - evaluated as Python code using the server action's - :ref:`evaluation context <reference/actions/server/context>`. If - ``False``, prevents the action from running. Default: ``True`` + Odoo model linked to the action. -Valid action types (``state`` field) are extensible, the default types are: +``state`` -``code`` --------- +* ``code``: Executes python code given through the ``code`` argument. -The default and most flexible server action type, executes arbitrary Python -code with the action's :ref:`evaluation context -<reference/actions/server/context>`. Only uses one specific type-specific -field: +* ``object_create``: Creates a new record of model ``crud_model_id`` following ``fields_lines`` specifications. -``code`` - a piece of Python code to execute when the action is called +* ``object_write``: Updates the current record(s) following ``fields_lines`` specifications -.. code-block:: xml +* ``multi``: Executes serveral actions given through the ``child_ids`` argument. - <record model="ir.actions.server" id="print_instance"> - <field name="name">Res Partner Server Action</field> - <field name="model_id" ref="model_res_partner"/> - <field name="code"> - raise Warning(object.name) - </field> - </record> +State fields +------------ + +Depending on its state, the behavior is defined through different fields. +The concerned state is given after each field. + +``code`` (code) + Specify a piece of Python code to execute when the action is called + + .. code-block:: xml + + <record model="ir.actions.server" id="print_instance"> + <field name="name">Res Partner Server Action</field> + <field name="model_id" ref="model_res_partner"/> + <field name="code"> + raise Warning(record.name) + </field> + </record> + + .. note:: + + The code segment can define a variable called ``action``, which will be + returned to the client as the next action to execute: + + .. code-block:: xml + + <record model="ir.actions.server" id="print_instance"> + <field name="name">Res Partner Server Action</field> + <field name="model_id" ref="model_res_partner"/> + <field name="code"> + if record.some_condition(): + action = { + "type": "ir.actions.act_window", + "view_mode": "form", + "res_model": record._name, + "res_id": record.id, + } + </field> + </record> + + will ask the client to open a form for the record if it fulfills some + condition + + .. This tends to be the only action type created from :ref:`data files + <reference/data>`, other types aside from + :ref:`reference/actions/server/multi` are simpler than Python code to define + from the UI, but not from :ref:`data files <reference/data>`. + +``crud_model_id`` (create)(required) + model in which to create a new record +``link_field_id`` (create) + many2one to ``ir.model.fields``, specifies the current record's m2o field + on which the newly created record should be set (models should match) -.. note:: - - The code segment can define a variable called ``action``, which will be - returned to the client as the next action to execute: - - .. code-block:: xml - - <record model="ir.actions.server" id="print_instance"> - <field name="name">Res Partner Server Action</field> - <field name="model_id" ref="model_res_partner"/> - <field name="code"> - if object.some_condition(): - action = { - "type": "ir.actions.act_window", - "view_mode": "form", - "res_model": object._name, - "res_id": object.id, - } - </field> - </record> - - will ask the client to open a form for the record if it fulfills some - condition - -This tends to be the only action type created from :ref:`data files -<reference/data>`, other types aside from -:ref:`reference/actions/server/multi` are simpler than Python code to define -from the UI, but not from :ref:`data files <reference/data>`. - -.. _reference/actions/server/object_create: - -``object_create`` ------------------ - -Creates a new record, from scratch (via :meth:`~odoo.models.Model.create`) -or by copying an existing record (via :meth:`~odoo.models.Model.copy`) - -``use_create`` - the creation policy, one of: - - ``new`` - creates a record in the model specified by ``model_id`` - ``new_other`` - creates a record in the model specified by ``crud_model_id`` - ``copy_current`` - copies the record on which the action was invoked - ``copy_other`` - copies an other record, obtained via ``ref_object`` -``fields_lines`` +``fields_lines`` (create/write) fields to override when creating or copying the record. :class:`~odoo.fields.One2many` with the fields: ``col1`` - ``ir.model.fields`` to set in the model implied by ``use_create`` + ``ir.model.fields`` to set in the concerned model + (``crud_model_id`` for creates, ``model_id`` for updates) ``value`` value for the field, interpreted via ``type`` - ``type`` + ``type`` (value|reference|equation) If ``value``, the ``value`` field is interpreted as a literal value (possibly converted), if ``equation`` the ``value`` field is interpreted as a Python expression and evaluated -``crud_model_id`` - model in which to create a new record, if ``use_create`` is set to - ``new_other`` -``ref_object`` - :class:`~odoo.fields.Reference` to an arbitrary record to copy, used if - ``use_create`` is set to ``copy_other`` -``link_new_record`` - boolean flag linking the newly created record to the current one via a - many2one field specified through ``link_field_id``, defaults to ``False`` -``link_field_id`` - many2one to ``ir.model.fields``, specifies the current record's m2o field - on which the newly created record should be set (models should match) - -``object_write`` ----------------- - -Similar to :ref:`reference/actions/server/object_create` but alters an -existing records instead of creating one - -``use_write`` - write policy, one of: - - ``current`` - write to the current record - ``other`` - write to an other record selected via ``crud_model_id`` and - ``ref_object`` - ``expression`` - write to an other record whose model is selected via ``crud_model_id`` - and whose id is selected by evaluating ``write_expression`` -``write_expression`` - Python expression returning a record or an object id, used when - ``use_write`` is set to ``expression`` in order to decide which record - should be modified -``fields_lines`` - see :ref:`reference/actions/server/object_create` -``crud_model_id`` - see :ref:`reference/actions/server/object_create` -``ref_object`` - see :ref:`reference/actions/server/object_create` - -.. _reference/actions/server/multi: - -``multi`` ---------- - -Executes multiple actions one after the other. Actions to execute are defined -via the ``child_ids`` m2m. If sub-actions themselves return actions, the last -one will be returned to the client as the multi's own next action -``client_action`` ------------------ - -Indirection for directly returning an other action defined using -``action_id``. Simply returns that action to the client for execution. +``child_ids`` (multi) + Specify the multiple sub-actions (``ir.actions.server``) to enact in state multi. + If sub-actions themselves return actions, the last + one will be returned to the client as the multi's own next action .. _reference/actions/server/context: @@ -356,23 +319,12 @@ Evaluation context A number of keys are available in the evaluation context of or surrounding server actions: -``model`` - the model object linked to the action via ``model_id`` -``object``, ``obj`` - only available if ``active_model`` and ``active_id`` are provided (via - context) otherwise ``None``. The actual record selected by ``active_id`` -``pool`` - the current database registry -``datetime``, ``dateutil``, ``time`` - corresponding Python modules -``cr`` - the current cursor -``user`` - the current user record -``context`` - execution context -``Warning`` - constructor for the ``Warning`` exception +* ``model`` model object linked to the action via ``model_id`` +* ``record``/``records`` record/recorset on which the action is triggered, can be void. +* ``env`` Odoo Environment +* ``datetime``, ``dateutil``, ``time``, ``timezone`` corresponding Python modules +* ``log: log(message, level='info')`` logging function to record debug information in ir.logging table +* ``Warning`` constructor for the ``Warning`` exception .. _reference/actions/report: @@ -386,13 +338,15 @@ Triggers the printing of a report in a list of some sort ``model`` (mandatory) the model your report will be about -``report_type`` (mandatory) +``report_type`` (default=qweb-pdf) either ``qweb-pdf`` for PDF reports or ``qweb-html`` for HTML -``report_name`` +``report_name`` (mandatory) the name of your report (which will be the name of the PDF output) ``groups_id`` :class:`~odoo.fields.Many2many` field to the groups allowed to view/use the current report +``multi`` + if set to ``True``, the action will not be displayed on a form view. ``paperformat_id`` :class:`~odoo.fields.Many2one` field to the paper format you wish to use for this report (if not specified, the company format will be used) @@ -436,5 +390,40 @@ Triggers an action implemented entirely in the client. tells the client to start the Point of Sale interface, the server has no idea how the POS interface works. -.. [#notquitem2m] technically not an M2M: adds a sequence field and may be - composed of just a view type, without a view id. +.. _reference/actions/cron: + +Automated Actions (``ir.cron``) +====================================== + +Actions triggered automatically on a predefined frequency. + +``name`` + Name of the automated action (Mainly used in log display) + +``interval_number`` + Number of *interval_type* uom between two executions of the action + +``interval_type`` + Unit of measure of frequency interval (``minutes``, ``hours``, ``days``, ``weeks``, ``months``, + +``numbercall`` + Number of times this action has to be run. + If the action is expected to run indefinitely, set to ``-1``. + +``doall`` + Boolean precising whether the missed actions have to be executed in case of + server restarts. + +``model_id`` + Model on which this action will be called + +``code`` + Code content of the action. + Can be a simple call to the model's method : + + .. code-block:: python + + model.<method_name>() + +``nextcall`` + Next planned execution date of this action (date/time format) diff --git a/doc/reference/cmdline.rst b/doc/reference/cmdline.rst index 8ab38abdc51..5652571f9be 100644 --- a/doc/reference/cmdline.rst +++ b/doc/reference/cmdline.rst @@ -19,6 +19,8 @@ Running the server Providing a comma-separated list restrict access to databases provided in list. + For advanced database options, take a look :ref:`below <reference/cmdline/server/database>`. + .. option:: -i <modules>, --init <modules> comma-separated list of modules to install before running the server @@ -32,82 +34,24 @@ Running the server .. option:: --addons-path <directories> comma-separated list of directories in which modules are stored. These - directories are scanned for modules (nb: when and why?) - -.. option:: --workers <count> - - if ``count`` is not 0 (the default), enables multiprocessing and sets up - the specified number of HTTP workers (sub-processes processing HTTP - and RPC requests). - - .. note:: multiprocessing mode is only available on Unix-based systems - - A number of options allow limiting and recycling workers: - - .. option:: --limit-request <limit> - - Number of requests a worker will process before being recycled and - restarted. - - Defaults to 8196. - - .. option:: --limit-memory-soft <limit> - - Maximum allowed virtual memory per worker. If the limit is exceeded, - the worker is killed and recycled at the end of the current request. - - Defaults to 2048MiB. - - .. option:: --limit-memory-hard <limit> - - Hard limit on virtual memory, any worker exceeding the limit will be - immediately killed without waiting for the end of the current request - processing. + directories are scanned for modules. - Defaults to 2560MiB. - - .. option:: --limit-time-cpu <limit> - - Prevents the worker from using more than <limit> CPU seconds for each - request. If the limit is exceeded, the worker is killed. - - Defaults to 60. - - .. option:: --limit-time-real <limit> - - Prevents the worker from taking longer than <limit> seconds to process - a request. If the limit is exceeded, the worker is killed. - - Differs from :option:`--limit-time-cpu` in that this is a "wall time" - limit including e.g. SQL queries. - - Defaults to 120. - -.. option:: --max-cron-threads <count> - - number of workers dedicated to cron jobs. Defaults to 2. The workers are - threads in multi-threading mode and processes in multi-processing mode. - - For multi-processing mode, this is in addition to the HTTP worker - processes. + .. (nb: when and why?) .. option:: -c <config>, --config <config> - provide an alternate configuration file + provide an alternate :ref:`configuration file <reference/cmdline/config>` .. option:: -s, --save saves the server configuration to the current configuration file (:file:`{$HOME}/.odoorc` by default, and can be overridden using - :option:`-c`) + :option:`-c`). -.. option:: --proxy-mode - - enables the use of ``X-Forwarded-*`` headers through `Werkzeug's proxy - support`_. +.. option:: --without-demo - .. warning:: proxy mode *must not* be enabled outside of a reverse proxy - scenario + disables demo data loading for modules installed + comma-separated, use ``all`` for all modules. .. option:: --test-enable @@ -131,25 +75,9 @@ Running the server ``1``, ``t`` or ``true`` can be used to use the same directory as the above mentioned ``--screenshots`` option. -.. option:: --dev <feature,feature,...,feature> - - * ``all``: all the features below are activated - - * ``xml``: read template qweb from xml file directly instead of database. - Once a template has been modified in database, it will be not be read from - the xml file until the next update/init. - - * ``reload``: restart server when python file are updated (may not be detected - depending on the text editor used) - - * ``qweb``: break in the evaluation of qweb template when a node contains ``t-debug='debugger'`` - - * ``(i)p(u)db``: start the chosen python debugger in the code when an - unexpected error is raised before logging and returning the error. - .. _reference/cmdline/server/database: -database +Database -------- .. option:: -r <user>, --db_user <user> @@ -189,40 +117,40 @@ database listen by using the --database parameter and specifying a comma-separated list of databases - When combining the two parameters, db-filter superseed the comma-separated + When combining the two parameters, db-filter supersedes the comma-separated database list for restricting database list, while the comma-separated list is used for performing requested operations like upgrade of modules. - + .. code-block:: bash - odoo-bin --db-filter ^11.*$ + $ odoo-bin --db-filter ^11.*$ Restrict access to databases whose name starts with 11 .. code-block:: bash - odoo-bin --database 11firstdatabase,11seconddatabase + $ odoo-bin --database 11firstdatabase,11seconddatabase Restrict access to only two databases, 11firstdatabase and 11seconddatabase - + .. code-block:: bash - odoo-bin --database 11firstdatabase,11seconddatabase -u base + $ odoo-bin --database 11firstdatabase,11seconddatabase -u base Restrict access to only two databases, 11firstdatabase and 11seconddatabase, - and update base module on one database: 11firstdatabase + and update base module on one database: 11firstdatabase. If database 11seconddatabase doesn't exist, the database is created and base modules is installed - + .. code-block:: bash - odoo-bin --db-filter ^11.*$ --database 11firstdatabase,11seconddatabase -u base - + $ odoo-bin --db-filter ^11.*$ --database 11firstdatabase,11seconddatabase -u base + Restrict access to databases whose name starts with 11, - and update base module on one database: 11firstdatabase + and update base module on one database: 11firstdatabase. If database 11seconddatabase doesn't exist, the database is created and base modules is installed - + .. option:: --db-template <template> when creating new databases from the database-management screens, use the @@ -237,7 +165,7 @@ database .. option:: --no-database-list Suppresses the ability to list databases available on the system - + .. option:: --db_sslmode Control the SSL security of the connection between Odoo and PostgreSQL. @@ -245,6 +173,33 @@ database 'verify-ca' or 'verify-full' Default value is 'prefer' +.. _reference/cmdline/server/emails: + +Emails +------ + +.. option:: --email-from <address> + + Email address used as <FROM> when Odoo needs to send mails + +.. option:: --smtp <server> + + Address of the SMTP server to connect to in order to send mails + +.. option:: --smtp-port <port> + +.. option:: --smtp-ssl + + If set, odoo should use SSL/STARTSSL SMTP connections + +.. option:: --smtp-user <name> + + Username to connect to the SMTP server + +.. option:: --smtp-password <password> + + Password to connect to the SMTP server + .. _reference/cmdline/server/internationalisation: Internationalisation @@ -283,13 +238,41 @@ of importation specify modules to export. Use in combination with --i18n-export +.. _reference/cmdline/advanced: + +Advanced Options +---------------- + +.. _reference/cmdline/dev: -built-in HTTP -------------- +Developer features +'''''''''''''''''' + +.. option:: --dev <feature,feature,...,feature> + + * ``all``: all the features below are activated + + * ``xml``: read template qweb from xml file directly instead of database. + Once a template has been modified in database, it will be not be read from + the xml file until the next update/init. + + * ``reload``: restart server when python file are updated (may not be detected + depending on the text editor used) + + * ``qweb``: break in the evaluation of qweb template when a node contains ``t-debug='debugger'`` + + * ``(i)p(u)db``: start the chosen python debugger in the code when an + unexpected error is raised before logging and returning the error. + + +.. _reference/cmdline/server/http: + +HTTP +'''' .. option:: --no-http - do not start the HTTP or long-polling workers (may still start cron + do not start the HTTP or long-polling workers (may still start :ref:`cron <reference/actions/cron>` workers) .. warning:: has no effect if :option:`--test-enable` is set, as tests @@ -309,25 +292,35 @@ built-in HTTP TCP port for long-polling connections in multiprocessing or gevent mode, defaults to 8072. Not used in default (threaded) mode. -logging -------- +.. option:: --proxy-mode + + enables the use of ``X-Forwarded-*`` headers through `Werkzeug's proxy + support`_. + + .. warning:: proxy mode *must not* be enabled outside of a reverse proxy + scenario + +.. _reference/cmdline/server/logging: + +Logging +''''''' By default, Odoo displays all logging of level_ ``info`` except for workflow logging (``warning`` only), and log output is sent to ``stdout``. Various options are available to redirect logging to other destinations and to -customize the amount of logging output +customize the amount of logging output. .. option:: --logfile <file> sends logging output to the specified file instead of stdout. On Unix, the file `can be managed by external log rotation programs - <https://docs.python.org/2/library/logging.handlers.html#watchedfilehandler>`_ + <https://docs.python.org/3/library/logging.handlers.html#watchedfilehandler>`_ and will automatically be reopened when replaced .. option:: --syslog - logs to the system's event logger: `syslog on unices <https://docs.python.org/2/library/logging.handlers.html#sysloghandler>`_ - and `the Event Log on Windows <https://docs.python.org/2/library/logging.handlers.html#nteventloghandler>`_. + logs to the system's event logger: `syslog on unices <https://docs.python.org/3/library/logging.handlers.html#sysloghandler>`_ + and `the Event Log on Windows <https://docs.python.org/3/library/logging.handlers.html#nteventloghandler>`_. Neither is configurable @@ -335,7 +328,7 @@ customize the amount of logging output logs to the ``ir.logging`` model (``ir_logging`` table) of the specified database. The database can be the name of a database in the "current" - PostgreSQL, or `a PostgreSQL URI`_ for e.g. log aggregation + PostgreSQL, or `a PostgreSQL URI`_ for e.g. log aggregation. .. option:: --log-handler <handler-spec> @@ -402,60 +395,66 @@ customize the amount of logging output In case of conflict between :option:`--log-level` and :option:`--log-handler`, the latter is used -emails ------- +.. _reference/cdmline/workers: -.. option:: --email-from <address> +Multiprocessing +''''''''''''''' - Email address used as <FROM> when Odoo needs to send mails +.. option:: --workers <count> -.. option:: --smtp <server> + if ``count`` is not 0 (the default), enables multiprocessing and sets up + the specified number of HTTP workers (sub-processes processing HTTP + and RPC requests). - Address of the SMTP server to connect to in order to send mails + .. note:: multiprocessing mode is only available on Unix-based systems -.. option:: --smtp-port <port> + A number of options allow limiting and recycling workers: -.. option:: --smtp-ssl + .. option:: --limit-request <limit> - If set, odoo should use SSL/STARTSSL SMTP connections + Number of requests a worker will process before being recycled and + restarted. -.. option:: --smtp-user <name> + Defaults to *8196*. - Username to connect to the SMTP server + .. option:: --limit-memory-soft <limit> -.. option:: --smtp-password <password> + Maximum allowed virtual memory per worker. If the limit is exceeded, + the worker is killed and recycled at the end of the current request. - Password to connect to the SMTP server + Defaults to *2048MiB*. + .. option:: --limit-memory-hard <limit> -.. _reference/cmdline/scaffold: + Hard limit on virtual memory, any worker exceeding the limit will be + immediately killed without waiting for the end of the current request + processing. -Scaffolding -=========== + Defaults to *2560MiB*. -.. program:: odoo-bin scaffold + .. option:: --limit-time-cpu <limit> -Scaffolding is the automated creation of a skeleton structure to simplify -bootstrapping (of new modules, in the case of Odoo). While not necessary it -avoids the tedium of setting up basic structures and looking up what all -starting requirements are. + Prevents the worker from using more than <limit> CPU seconds for each + request. If the limit is exceeded, the worker is killed. -Scaffolding is available via the :command:`odoo-bin scaffold` subcommand. + Defaults to *60*. -.. option:: -t <template> + .. option:: --limit-time-real <limit> - a template directory, files are passed through jinja2_ then copied to - the ``destination`` directory + Prevents the worker from taking longer than <limit> seconds to process + a request. If the limit is exceeded, the worker is killed. -.. option:: name + Differs from :option:`--limit-time-cpu` in that this is a "wall time" + limit including e.g. SQL queries. - the name of the module to create, may munged in various manners to - generate programmatic names (e.g. module directory name, model names, …) + Defaults to *120*. -.. option:: destination +.. option:: --max-cron-threads <count> - directory in which to create the new module, defaults to the current - directory + number of workers dedicated to :ref:`cron <reference/actions/cron>` jobs. Defaults to *2*. + The workers are threads in multi-threading mode and processes in multi-processing mode. + + For multi-processing mode, this is in addition to the HTTP worker processes. .. _reference/cmdline/config: @@ -487,15 +486,67 @@ can be overridden using :option:`--config <odoo-bin -c>`. Specifying to that file. .. _jinja2: http://jinja.pocoo.org -.. _regular expression: https://docs.python.org/2/library/re.html +.. _regular expression: https://docs.python.org/3/library/re.html .. _password authentication: - http://www.postgresql.org/docs/9.3/static/auth-methods.html#AUTH-PASSWORD + https://www.postgresql.org/docs/9.3/static/auth-methods.html#AUTH-PASSWORD .. _template database: - http://www.postgresql.org/docs/9.3/static/manage-ag-templatedbs.html + https://www.postgresql.org/docs/9.3/static/manage-ag-templatedbs.html .. _level: - https://docs.python.org/2/library/logging.html#logging.Logger.setLevel + https://docs.python.org/3/library/logging.html#logging.Logger.setLevel .. _a PostgreSQL URI: - http://www.postgresql.org/docs/9.2/static/libpq-connect.html#AEN38208 + https://www.postgresql.org/docs/9.2/static/libpq-connect.html#AEN38208 .. _Werkzeug's proxy support: http://werkzeug.pocoo.org/docs/contrib/fixers/#werkzeug.contrib.fixers.ProxyFix .. _pyinotify: https://github.com/seb-m/pyinotify/wiki + + +Shell +===== + +Odoo command-line also allows to launch odoo as a python console environment. +This enables direct interaction with the :ref:`orm <reference/orm>` and its functionalities. + + +.. code-block:: console + + $ odoo_bin shell + +.. option:: --shell-interface (ipython|ptpython|bpython|python) + + Specify a preferred REPL to use in shell mode. + + +.. _reference/cmdline/scaffold: + +Scaffolding +=========== + +.. program:: odoo-bin scaffold + +Scaffolding is the automated creation of a skeleton structure to simplify +bootstrapping (of new modules, in the case of Odoo). While not necessary it +avoids the tedium of setting up basic structures and looking up what all +starting requirements are. + +Scaffolding is available via the :command:`odoo-bin scaffold` subcommand. + +.. option:: name (required) + + the name of the module to create, may munged in various manners to + generate programmatic names (e.g. module directory name, model names, …) + +.. option:: destination (default=current directory) + + directory in which to create the new module, defaults to the current + directory + +.. option:: -t <template> + + a template directory, files are passed through jinja2_ then copied to + the ``destination`` directory + +.. code-block:: console + + $ odoo_bin scaffold my_module /addons/ + +This will create module *my_module* in directory */addons/*.
\ No newline at end of file diff --git a/doc/reference/data.rst b/doc/reference/data.rst index 2165a490dd0..416121b8255 100644 --- a/doc/reference/data.rst +++ b/doc/reference/data.rst @@ -22,6 +22,7 @@ of an XML data file is the following: .. code-block:: xml <!-- the root elements of the data file --> + <?xml version="1.0" encoding="UTF-8"?> <odoo> <operation/> ... @@ -30,6 +31,25 @@ of an XML data file is the following: Data files are executed sequentially, operations can only refer to the result of operations defined previously +.. note:: + + If the content of the data file is expected to be applied only once, you + can specify the odoo flag ``noupdate`` set to 1. If part of + the data in the file is expected to be applied once, you can place this part + of the file in a <data noupdate="1"> domain. + + .. code-block:: xml + + <odoo> + <data noupdate="1"> + <!-- Only loaded when installing the module (odoo-bin -i module) --> + <operation/> + </data> + + <!-- (Re)Loaded at install and update (odoo-bin -i/-u) --> + <operation/> + </odoo> + Core operations =============== @@ -152,8 +172,31 @@ Parameters can be provided using ``eval`` (should evaluate to a sequence of parameters to call the method with) or ``value`` elements (see ``list`` values). +.. code-block:: xml + + <odoo> + <data noupdate="1"> + <record name="partner_1" model="res.partner"> + <field name="name">Odude</field> + </record> + + <function model="res.partner" name="send_inscription_notice" + eval="[[ref('partner_1'), ref('partner_2')]]"/> + + <function model="res.users" name="send_vip_inscription_notice"> + <function eval="[[('vip','=',True)]]" model="res.partner" name="search"/> + </function> + </data> + + <record id="model_form_view" model="ir.ui.view"> + + </record> + </odoo> + .. ignored assert +.. _reference/data/shortcuts: + Shortcuts ========= @@ -166,7 +209,7 @@ data files provide shorter alternatives to defining them using Defines an ``ir.ui.menu`` record with a number of defaults and fallbacks: -Parent menu +``parent`` * If a ``parent`` attribute is set, it should be the :term:`external id` of an other menu item, used as the new item's parent * If no ``parent`` is provided, tries to interpret the ``name`` attribute @@ -175,10 +218,10 @@ Parent menu created * Otherwise the menu is defined as a "top-level" menu item (*not* a menu with no parent) -Menu name +``name`` If no ``name`` attribute is specified, tries to get the menu name from a linked action if any. Otherwise uses the record's ``id`` -Groups +``groups`` A ``groups`` attribute is interpreted as a comma-separated sequence of :term:`external identifiers` for ``res.groups`` models. If an :term:`external identifier` is prefixed with a minus (``-``), the group @@ -218,7 +261,7 @@ section of the view, and allowing a few *optional* attributes: ``report`` ---------- -Creates a ``ir.actions.report`` record with a few default values. +Creates a :ref:`IrActionsReport <reference/actions/report>` record with a few default values. Mostly just proxies attributes to the corresponding fields on ``ir.actions.report``, but also automatically creates the item in the @@ -263,5 +306,5 @@ For each row (record): * the third column is the ``name`` field for ``res.country.state`` * the fourth column is the ``code`` field for ``res.country.state`` -.. _base64: http://tools.ietf.org/html/rfc3548.html#section-3 -.. _csv: http://en.wikipedia.org/wiki/Comma-separated_values +.. _base64: https://tools.ietf.org/html/rfc3548.html#section-3 +.. _csv: https://en.wikipedia.org/wiki/Comma-separated_values diff --git a/doc/reference/guidelines.rst b/doc/reference/guidelines.rst index 28e7d57acba..367a30ddad8 100644 --- a/doc/reference/guidelines.rst +++ b/doc/reference/guidelines.rst @@ -296,7 +296,7 @@ Use the following pattern : lowercase string briefly explaining the action. This is used only if multiple actions are declared for the model. * For window actions: suffix the action name by the specific view information - like :samp:`{<model_name>}_action_view_{<view_type}`. + like :samp:`{<model_name>}_action_view_{<view_type>}`. * For a group: :samp:`{<model_name>}_group_{<group_name>}` where *group_name* is the name of the group, generally 'user', 'manager', ... * For a rule: :samp:`{<model_name>}_rule_{<concerned_group>}` where diff --git a/doc/reference/javascript_api.rst b/doc/reference/javascript_api.rst index bc17cd0c82a..23faacd3836 100644 --- a/doc/reference/javascript_api.rst +++ b/doc/reference/javascript_api.rst @@ -1,9 +1,12 @@ +:orphan: :banner: banners/javascript.jpg .. highlight:: javascript .. default-domain:: js +.. _api/js: + ============== Javascript API ============== diff --git a/doc/reference/javascript_cheatsheet.rst b/doc/reference/javascript_cheatsheet.rst index 97f7ba5cb5c..b6c5251c46c 100644 --- a/doc/reference/javascript_cheatsheet.rst +++ b/doc/reference/javascript_cheatsheet.rst @@ -1,5 +1,7 @@ :banner: banners/javascript.jpg +.. _reference/jscs: + ===================== Javascript Cheatsheet ===================== @@ -280,6 +282,7 @@ using the view in the kanban arch (a specific example is the helpdesk dashboard) Promises and asynchronous code =============================== + For a very good and complete introduction to promises, please read this excellent article https://github.com/getify/You-Dont-Know-JS/blob/master/async%20%26%20performance/ch3.md Creating new Promises @@ -418,6 +421,7 @@ Waiting for Promises Error handling -------------- + - in general in promises The general idea is that a promise should not be rejected for control flow, but should only be rejected for errors. When that is the case, you would have multiple resolutions of your promise with, for instance status codes that you would have to check in the `then` handlers and a single `catch` handler at the end of the promise chain. @@ -540,4 +544,4 @@ Testing asynchronous code }); }); - as you can see, the nicer form is to use `async/await` as it is clearer and shorter to write.
\ No newline at end of file + as you can see, the nicer form is to use `async/await` as it is clearer and shorter to write. diff --git a/doc/reference/javascript_reference.rst b/doc/reference/javascript_reference.rst index a6eeb5e8d4e..f724485f86a 100644 --- a/doc/reference/javascript_reference.rst +++ b/doc/reference/javascript_reference.rst @@ -15,13 +15,8 @@ description into a live application, able to interact with every model and records in the database. It is even possible to use the web client to modify the interface of the web client. -.. note:: An html version of all docstrings in Odoo is available at: - - .. toctree:: - :maxdepth: 2 - - javascript_api - +.. note:: An html version of all js docstrings in Odoo is available at: + :ref:`JS API <api/js>` Overview ========= @@ -1421,7 +1416,7 @@ the AbstractView, AbstractController, AbstractRenderer and AbstractModel classes .. raw:: html <svg width="550" height="173"> - <!-- Created with Method Draw - http://github.com/duopixel/Method-Draw/ --> + <!-- Created with Method Draw - https://github.com/duopixel/Method-Draw/ --> <path id="svg_1" d="m147.42498,79.79206c0.09944,-8.18859 -0.06363,-16.38812 0.81774,-24.5623c21.65679,2.68895 43.05815,7.08874 64.35,11.04543c1.14304,-4.01519 0.60504,-7.34585 1.59817,-11.05817c13.67878,7.81176 27.23421,15.73476 40.23409,24.03505c-12.47212,9.41539 -26.77809,17.592 -40.82272,25.96494c-0.4548,-3.89916 -0.90967,-7.79828 -1.36448,-11.69744c-20.69972,3.77225 -42.59036,7.6724 -63.42391,11.12096c-1.41678,-7.95741 -1.37514,-16.62327 -1.38888,-24.84846z" stroke-width="1.5" stroke="#000" fill="#fff"/> <rect id="svg_3" height="41" width="110" y="57.5" x="7" fill-opacity="null" stroke-opacity="null" stroke-width="1.5" stroke="#000" fill="#fff"/> <rect stroke="#000" id="svg_5" height="41" width="135" y="20.5" x="328" fill-opacity="null" stroke-opacity="null" stroke-width="1.5" fill="#fff"/> @@ -1467,6 +1462,8 @@ the AbstractView, AbstractController, AbstractRenderer and AbstractModel classes context of a view manager/action manager. They could be used in a client action, or, they could be displayed in the public website (with some work on the assets). +.. _reference/js/widgets: + Field Widgets ============= @@ -1927,7 +1924,6 @@ order. Options: - - title: title of the bar, displayed on top of the bar options - editable: boolean if value is editable - current_value: get the current_value from the field that must be present in the view - max_value: get the max_value from the field that must be present in the view @@ -2278,18 +2274,18 @@ do that, several steps should be done. For more information, look into the *control_panel.js* file. .. _.appendTo(): - http://api.jquery.com/appendTo/ + https://api.jquery.com/appendTo/ .. _.prependTo(): - http://api.jquery.com/prependTo/ + https://api.jquery.com/prependTo/ .. _.insertAfter(): - http://api.jquery.com/insertAfter/ + https://api.jquery.com/insertAfter/ .. _.insertBefore(): - http://api.jquery.com/insertBefore/ + https://api.jquery.com/insertBefore/ .. _event delegation: - http://api.jquery.com/delegate/ + https://api.jquery.com/delegate/ .. _datepicker: https://github.com/Eonasdan/bootstrap-datetimepicker diff --git a/doc/reference/mixins.rst b/doc/reference/mixins.rst index 2f8e79bf649..7e72f533c77 100644 --- a/doc/reference/mixins.rst +++ b/doc/reference/mixins.rst @@ -39,11 +39,11 @@ widgets) to your form view will get you up and running in no time. _name = 'business.trip' _inherit = ['mail.thread'] _description = 'Business Trip' - + name = fields.Char() partner_id = fields.Many2one('res.partner', 'Responsible') guest_ids = fields.Many2many('res.partner', 'Participants') - + In the form view: .. code-block:: xml @@ -78,10 +78,10 @@ to manage followers on your record: .. rubric:: Posting messages .. method:: message_post(self, body='', subject=None, message_type='notification', subtype=None, parent_id=False, attachments=None, **kwargs) - + Post a new message in an existing thread, returning the new mail.message ID. - + :param str body: body of the message, usually raw HTML that will be sanitized :param str message_type: see mail_message.message_type field @@ -95,20 +95,20 @@ to manage followers on your record: :rtype: int .. method:: message_post_with_view(views_or_xmlid, **kwargs): - + Helper method to send a mail / post a message using a view_id to render using the ir.qweb engine. This method is stand alone, because there is nothing in template and composer that allows to handle views in batch. This method will probably disappear when templates handle ir ui views. - + :param str or ``ir.ui.view`` record: external id or record of the view that should be sent .. method:: message_post_with_template(template_id, **kwargs) - + Helper method to send a mail with a template - + :param template_id: the id of the template to render to create the body of the message :param `\**kwargs`: parameter to create a mail.compose.message wizzard (which inherit from mail.message) @@ -121,7 +121,7 @@ on the thread's record depending on some values from the email itself (i.e. upda a date or an e-mail address, add CC's addresses as followers, etc.). .. method:: message_new(msg_dict, custom_values=None) - + Called by ``message_process`` when a new message is received for a given thread model, if the message did not belong to an existing thread. @@ -129,7 +129,7 @@ a date or an e-mail address, add CC's addresses as followers, etc.). The default behavior is to create a new record of the corresponding model (based on some very basic info extracted from the message). Additional behavior may be implemented by overriding this method. - + :param dict msg_dict: a map containing the email details and attachments. See ``message_process`` and ``mail.message.parse`` for details :param dict custom_values: optional dictionary of additional @@ -140,14 +140,14 @@ a date or an e-mail address, add CC's addresses as followers, etc.). :return: the id of the newly created thread object .. method:: message_update(msg_dict, update_vals=None) - + Called by ``message_process`` when a new message is received for an existing thread. The default behavior is to update the record with ``update_vals`` taken from the incoming email. - + Additional behavior may be implemented by overriding this method. - + :param dict msg_dict: a map containing the email details and attachments; see ``message_process`` and ``mail.message.parse()`` for details. :param dict update_vals: a dict containing values to update records given @@ -159,7 +159,7 @@ a date or an e-mail address, add CC's addresses as followers, etc.). .. method:: message_subscribe(partner_ids=None, channel_ids=None, subtype_ids=None, force=True) Add partners to the records followers. - + :param list(int) partner_ids: IDs of the partners that will be subscribed to the record :param list(int) channel_ids: IDs of the channels that will be subscribed @@ -175,7 +175,7 @@ a date or an e-mail address, add CC's addresses as followers, etc.). .. method:: message_unsubscribe(partner_ids=None, channel_ids=None) Remove partners from the record's followers. - + :param list(int) partner_ids: IDs of the partners that will be subscribed to the record :param list(int) channel_ids: IDs of the channels that will be subscribed @@ -211,12 +211,12 @@ to a field, simple set the tracking attribute to True. _name = 'business.trip' _inherit = ['mail.thread'] _description = 'Business Trip' - + name = fields.Char(tracking=True) partner_id = fields.Many2one('res.partner', 'Responsible', tracking=True) guest_ids = fields.Many2many('res.partner', 'Participants') - + From now on, every change to a trip's name or responsible will log a note on the record. The ``name`` field will be displayed in the notification as well to give more context about the notification (even if the name did not @@ -232,32 +232,32 @@ subtype of notifications they wish to receive. Subtypes are created as data in your module; the model has the following fields: -``name`` (mandatory) - :class:`~odoo.fields.Char` +``name`` (mandatory) - :class:`~odoo.fields.Char` name of the subtype, will be displayed in the notification customization popup -``description`` - :class:`~odoo.fields.Char` +``description`` - :class:`~odoo.fields.Char` description that will be added in the message posted for this subtype. If void, the name will be added instead -``internal`` - :class:`~odoo.fields.Boolean` +``internal`` - :class:`~odoo.fields.Boolean` messages with internal subtypes will be visible only by employees, aka members of the ``base.group_user`` group -``parent_id`` - :class:`~odoo.fields.Many2one` +``parent_id`` - :class:`~odoo.fields.Many2one` link subtypes for automatic subscription; for example project subtypes are linked to task subtypes through this link. When someone is subscribed to a project, he will be subscribed to all tasks of this project with subtypes found using the parent subtype -``relation_field`` - :class:`~odoo.fields.Char` +``relation_field`` - :class:`~odoo.fields.Char` as an example, when linking project and tasks subtypes, the relation field is the project_id field of tasks -``res_model`` - :class:`~odoo.fields.Char` +``res_model`` - :class:`~odoo.fields.Char` model the subtype applies to; if False, this subtype applies to all models -``default`` - :class:`~odoo.fields.Boolean` +``default`` - :class:`~odoo.fields.Boolean` wether the subtype is activated by default when subscribing -``sequence`` - :class:`~odoo.fields.Integer` +``sequence`` - :class:`~odoo.fields.Integer` used to order subtypes in the notification customization popup -``hidden`` - :class:`~odoo.fields.Boolean` +``hidden`` - :class:`~odoo.fields.Boolean` wether the subtype is hidden in the notification customization popup - + Interfacing subtypes with field tracking allows to subscribe to different kind of notifications depending on what might interest users. To do this, you @@ -301,7 +301,7 @@ can override the ``_track_subtype()`` function: _name = 'business.trip' _inherit = ['mail.thread'] _description = 'Business Trip' - + name = fields.Char(tracking=True) partner_id = fields.Many2one('res.partner', 'Responsible', tracking=True) @@ -392,7 +392,7 @@ yourself by overriding the function ``_notification_recipients``. :returns: a subtype's full external id or False if no subtype is triggered -The urls in the actions list can be generated automatically by calling the +The urls in the actions list can be generated automatically by calling the ``_notification_link_helper()`` function: @@ -402,7 +402,7 @@ The urls in the actions list can be generated automatically by calling the record if the kwargs ``model`` and ``res_id`` are set). :param str link_type: link type to be generated; can be any of these values: - + ``view`` link to form view of the record ``assign`` @@ -418,8 +418,8 @@ The urls in the actions list can be generated automatically by calling the ``new`` open an empty form view for a new record; you can specify a specific action by providing its id (database id or fully resolved - external id) in the kwarg ``action_id`` - + external id) in the kwarg ``action_id`` + :returns: link of the type selected for the record :rtype: str @@ -428,7 +428,7 @@ The urls in the actions list can be generated automatically by calling the Let's add a custom button to the Business Trip state change notification; this button will reset the state to Draft and will be only visible to a member of the (imaginary) group Travel Manager (``business.group_trip_manager``) - + .. code-block:: python class BusinessTrip(models.Model): @@ -437,10 +437,10 @@ The urls in the actions list can be generated automatically by calling the _description = 'Business Trip' # Pevious code goes here - + def action_cancel(self): self.write({'state': 'draft'}) - + def _notification_recipients(self, message, groups): """ Handle Trip Manager recipients that can cancel the trip at the last minute and kill all the fun. """ @@ -451,7 +451,7 @@ The urls in the actions list can be generated automatically by calling the app_action = self._notification_link_helper('method', method='action_cancel') trip_actions = [{'url': app_action, 'title': _('Cancel')}] - + new_group = ( 'group_trip_manager', lambda partner: bool(partner.user_ids) and @@ -462,11 +462,11 @@ The urls in the actions list can be generated automatically by calling the }) return [new_group] + groups - - Note that that I could have defined my evaluation function outside of this + + Note that that I could have defined my evaluation function outside of this method and define a global function to do it instead of a lambda, but for - the sake of being more brief and less verbose in these documentation files + the sake of being more brief and less verbose in these documentation files that can sometimes be boring, I choose the former instead of the latter. Overriding defaults @@ -483,7 +483,7 @@ Context keys: These context keys can be used to somewhat control ``mail.thread`` features like auto-subscription or field tracking during calls to ``create()`` or ``write()`` (or any other method where it may be useful). - + - ``mail_create_nosubscribe``: at create or message_post, do not subscribe the current user to the record thread - ``mail_create_nolog``: at create, do not log the automatic '<Document> @@ -496,7 +496,7 @@ Context keys: - ``mail_notify_force_send``: if less than 50 email notifications to send, send them directly instead of using the queue; True by default - ``mail_notify_user_signature``: add the current user signature in - email notifications; True by default + email notifications; True by default .. _reference/mixins/mail/alias: @@ -540,14 +540,14 @@ or issues, Sales Team have aliases to generate Leads. .. note:: The model that will be created by the alias **must** inherit the ``mail_thread`` model. - + Alias support is added by inheriting ``mail.alias.mixin``; this mixin will generate a new ``mail.alias`` record for each record of the parent class that gets created (for example, every ``project.project`` record having its ``mail.alias`` record initialized on creation). .. note:: Aliases can also be created manually and supported by a simple - :class:`~odoo.fields.Many2one` field. This guide assumes you wish a + :class:`~odoo.fields.Many2one` field. This guide assumes you wish a more complete integration with automatic creation of the alias, record-specific default values, etc. @@ -557,25 +557,25 @@ of the created alias, like the kind of record it must create and possibly some default values these records may have depending on the parent object: .. method:: get_alias_model_name(vals) - + Return the model name for the alias. Incoming emails that are not replies to existing records will cause the creation of a new record of this alias model. The value may depend on ``vals``, the dict of values passed to ``create`` when a record of this model is created. - + :param vals dict: values of the newly created record that will holding the alias :return: model name :rtype: str .. method:: get_alias_values() - + Return values to create an alias, or to write on the alias after its creation. While not completely mandatory, it is usually required to make sure that newly created records will be linked to the alias' parent (i.e. tasks getting created in the right project) by setting a dictionary of default values in the alias' ``alias_defaults`` field. - + :return: dictionnary of values that will be written to the new alias :rtype: dict @@ -583,24 +583,24 @@ The ``get_alias_values()`` override is particularly interesting as it allows you to modify the behaviour of your aliases easily. Among the fields that can be set on the alias, the following are of particular interest: -``alias_name`` - :class:`~odoo.fields.Char` +``alias_name`` - :class:`~odoo.fields.Char` name of the email alias, e.g. 'jobs' if you want to catch emails for <jobs@example.odoo.com> -``alias_user_id`` - :class:`~odoo.fields.Many2one` (``res.users``) +``alias_user_id`` - :class:`~odoo.fields.Many2one` (``res.users``) owner of records created upon receiving emails on this alias; if this field is not set the system will attempt to find the right owner based on the sender (From) address, or will use the Administrator account if no system user is found for that address -``alias_defaults`` - :class:`~odoo.fields.Text` +``alias_defaults`` - :class:`~odoo.fields.Text` Python dictionary that will be evaluated to provide default values when creating new records for this alias -``alias_force_thread_id`` - :class:`~odoo.fields.Integer` +``alias_force_thread_id`` - :class:`~odoo.fields.Integer` optional ID of a thread (record) to which all incoming messages will be attached, even if they did not reply to it; if set, this will disable the creation of new records completely -``alias_contact`` - :class:`~odoo.fields.Selection` +``alias_contact`` - :class:`~odoo.fields.Selection` Policy to post a message on the document using the mailgateway - + - *everyone*: everyone can post - *partners*: only authenticated partners - *followers*: only followers of the related document or members of following channels @@ -631,7 +631,7 @@ you to make your alias easily configurable from the record's form view. expense_ids = fields.One2many('business.expense', 'trip_id', 'Expenses') alias_id = fields.Many2one('mail.alias', string='Alias', ondelete="restrict", required=True) - + def get_alias_model_name(self, vals): """ Specify the model that will get created when the alias receives a message """ return 'business.expense' @@ -641,7 +641,7 @@ you to make your alias easily configurable from the record's form view. values = super(BusinessTrip, self).get_alias_values() # alias_defaults holds a dictionnary that will be written # to all records created by this alias - # + # # in this case, we want all expense records sent to a trip alias # to be linked to the corresponding business trip values['alias_defaults'] = {'trip_id': self.id} @@ -649,7 +649,7 @@ you to make your alias easily configurable from the record's form view. # by default values['alias_contact'] = 'followers' return values - + class BusinessExpense(models.Model): _name = 'business.expense' _inherit = ['mail.thread'] @@ -662,9 +662,9 @@ you to make your alias easily configurable from the record's form view. We would like our alias to be easily configurable from the form view of our business trips, so let's add the following to our form view: - + .. code-block:: xml - + <page string="Emails"> <group name="group_alias"> <label for="alias_name" string="Email Alias"/> @@ -684,7 +684,7 @@ you to make your alias easily configurable from the record's form view. string="Accept Emails From"/> </group> </page> - + Now we can change the alias address directly from the form view and change who can send e-mails to the alias. @@ -696,12 +696,12 @@ you to make your alias easily configurable from the record's form view. class BusinessExpense(models.Model): # Previous code goes here # ... - + def message_new(self, msg, custom_values=None): - """ Override to set values according to the email. - + """ Override to set values according to the email. + In this simple example, we simply use the email title as the name - of the expense, try to find a partner with this email address and + of the expense, try to find a partner with this email address and do a regex match to find the amount of the expense.""" name = msg_dict.get('subject', 'New Expense') # Match the last occurence of a float in the string @@ -728,7 +728,7 @@ Activities tracking ------------------- Activities are actions users have to take on a document like making a phone call -or organizing a meeting. Activities come with the mail module as they are +or organizing a meeting. Activities come with the mail module as they are integrated in the Chatter but are *not bundled with mail.thread*. Activities are records of the ``mail.activity`` class, which have a type (``mail.activity.type``), name, description, scheduled time (among others). Pending activities are visible @@ -798,16 +798,16 @@ campaigns through arguments in links to specified resources. The mixin adds * ``campaign_id``: :class:`~odoo.fields.Many2one` field to a ``utm.campaign`` object (i.e. Christmas_Special, Fall_Collection, etc.) -* ``source_id``: :class:`~odoo.fields.Many2one` field to a ``utm.source`` +* ``source_id``: :class:`~odoo.fields.Many2one` field to a ``utm.source`` object (i.e. Search Engine, mailing list, etc.) -* ``medium_id``: :class:`~odoo.fields.Many2one` field to a ``utm.medium`` +* ``medium_id``: :class:`~odoo.fields.Many2one` field to a ``utm.medium`` object (i.e. Snail Mail, e-Mail, social network update, etc.) These models have a single field ``name`` (i.e. they are simply there to distinguish campaigns but don't have any specific behaviour). Once a customer visits your website with these parameters set in the url -(i.e. http://www.odoo.com/?campaign_id=mixin_talk&source_id=www.odoo.com&medium_id=website), +(i.e. https://www.odoo.com/?campaign_id=mixin_talk&source_id=www.odoo.com&medium_id=website), three cookies are set in the visitor's website for these parameters. Once a object that inherits the utm.mixin is created from the website (i.e. lead form, job application, etc.), the utm.mixin code kicks in and fetches the values @@ -834,7 +834,7 @@ model should support the *quick create* (i.e. call to ``create()`` with a single _description = 'My Tracked Object' my_field = fields.Many2one('my_module.my_track', 'My Field') - + @api.model def tracking_fields(self): result = super(MyModel, self).tracking_fields() @@ -884,7 +884,7 @@ This mixin adds 2 fields on your model: the status of the publication * ``website_url``: :class:`~odoo.fields.Char` field which represents the URL through which the object is accessed - + Note that this last field is a computed field and must be implemented for your class: .. code-block:: python @@ -918,13 +918,13 @@ buttons to website visitors: </t> </div> -Note that you must pass your object as the variable ``object`` to the template; +Note that you must pass your object as the variable ``object`` to the template; in this example, the ``blog.post`` record was passed as the ``blog_post`` variable to the ``qweb`` rendering engine, it is necessary to specify this to the publish management template. The ``publish_edit`` variable allow the frontend button to link to the backend (allowing you to switch from frontend to backend and vice-versa easily); if set, you must specify the full external id of the action -you want to call in the backend in the ``action`` variable (note that a Form View +you want to call in the backend in the ``action`` variable (note that a Form View must exist for the model). The action ``website_publish_button`` is defined in the mixin and adapts its @@ -987,7 +987,7 @@ To add rating support, simply inherit the ``rating.mixin`` model: class MyModel(models.Models): _name = 'my_module.my_model' _inherit = ['rating.mixin', 'mail.thread'] - + user_id = fields.Many2one('res.users', 'Responsible') partner_id = fields.Many2one('res.partner', 'Customer') @@ -995,18 +995,18 @@ The behaviour of the mixin adapts to your model: * The ``rating.rating`` record will be linked to the ``partner_id`` field of your model (if the field is present). - + - this behaviour can be overridden with the function ``rating_get_partner_id()`` if you use another field than ``partner_id`` - + * The ``rating.rating`` record will be linked to the partner of the ``user_id`` field of your model (if the field is present) (i.e. the partner who is rated) - + - this behaviour can be overridden with the function ``rating_get_rated_partner_id()`` if you use another field than ``user_id`` (note that the function must return a ``res.partner``, for ``user_id`` the system automatically fetches the partner of the user) - + * The chatter history will display the rating event (if your model inherits from ``mail.thread``) @@ -1036,7 +1036,7 @@ links to the rating object. A very basic email template could look like this: </ul> ]]></field> </record> - + Your customer will then receive an e-mail with links to a simple webpage allowing them to provide a feedback on their interaction with your users (including a free-text feedback message). @@ -1074,4 +1074,3 @@ You can find concrete examples of integration in the following models: * ``project.task`` in the Project (*rating_project*) Application * ``helpdesk.ticket`` in the Helpdesk (*helpdesk* - Odoo Enterprise only) Application - diff --git a/doc/reference/module.rst b/doc/reference/module.rst index 3ab1b8c9b38..eb0abb3004f 100644 --- a/doc/reference/module.rst +++ b/doc/reference/module.rst @@ -106,7 +106,7 @@ Available manifest fields are: located in ``static/src/css`` inside the module. ``images`` (``list(str)``) Specify image files to be used by the module. -``installable`` (``bool`` default: ``False``) +``installable`` (``bool`` default: ``True``) Whether a user should be able to install the module from the Web UI or not. ``maintainer`` (``str``) Person or entity in charge of the maintenance of this module, by default @@ -128,6 +128,6 @@ Available manifest fields are: These hooks should only be used when setup/cleanup required for this module is either extremely difficult or impossible through the api. -.. _semantic versioning: http://semver.org +.. _semantic versioning: https://semver.org .. _existing categories: - https://github.com/odoo/odoo/blob/12.0/odoo/addons/base/data/ir_module_category_data.xml + https://github.com/odoo/odoo/blob/13.0/odoo/addons/base/data/ir_module_category_data.xml diff --git a/doc/reference/orm.rst b/doc/reference/orm.rst index 4cdbf78f65c..66f5b27f99a 100644 --- a/doc/reference/orm.rst +++ b/doc/reference/orm.rst @@ -608,7 +608,7 @@ Model Reference .. currentmodule:: odoo.models -.. autoclass:: odoo.models.Model +.. autoclass:: Model .. rubric:: Structural attributes @@ -697,6 +697,7 @@ Model Reference :type: bool + .. attribute:: _check_company_auto On write and create, call ``_check_company`` to ensure companies @@ -704,6 +705,33 @@ Model Reference as attribute. (default: ``False``) + .. attribute:: _parent_name + + Alternative field to use as parent, used by indexed storage of the tree structure of records + (default: ``'parent_id'``) + + :type: str + + .. attribute:: _date_name + + Alternative field to use for default calendar view (default: ``'date'``) + + :type: str + + .. attribute:: _fold_name + + Alternative field to determine folded groups in kanban views + (default: ``'fold'``) + + :type: str + + .. attribute:: _translate + + False disables translations export for this model + (default: ``True``) + + :type: bool + .. rubric:: CRUD .. automethod:: create @@ -840,7 +868,7 @@ Method decorators ================= .. automodule:: odoo.api - :members: model, depends, constrains, onchange, returns, + :members: model, depends, constrains, onchange, returns .. _reference/orm/fields: diff --git a/doc/reference/qweb.rst b/doc/reference/qweb.rst index 541788d508c..4bec9c900cf 100644 --- a/doc/reference/qweb.rst +++ b/doc/reference/qweb.rst @@ -42,7 +42,7 @@ will result in:: .. _reference/qweb/output: -data output +Data output =========== QWeb has a primary output directive which automatically HTML-escape its @@ -63,7 +63,7 @@ sanitized user-provided markup. .. _reference/qweb/conditionals: -conditionals +Conditionals ============ QWeb has a conditional directive ``if``, which evaluates an expression given @@ -107,7 +107,7 @@ available:: .. _reference/qweb/loops: -loops +Loops ===== QWeb has an iteration directive ``foreach`` which take an expression returning @@ -335,7 +335,7 @@ Python Exclusive directives -------------------- -asset bundles +Asset bundles ''''''''''''' .. todo:: have fme write these up because I've no idea how they work @@ -351,7 +351,7 @@ website's rich text edition. ``t-options`` can be used to customize fields, the most common option is ``widget``, other options are field- or widget-dependent. -debugging +Debugging --------- ``t-debug`` @@ -552,6 +552,8 @@ Helpers :js:func:`core.qweb.render <QWeb2.Engine.render>` can be used to easily render basic module templates +.. _reference/qweb/api: + API --- @@ -638,13 +640,13 @@ API use case. Odoo 9.0 still depends on Jinja_ and Mako_. .. _templating: - http://en.wikipedia.org/wiki/Template_processor + https://en.wikipedia.org/wiki/Template_processor .. _Jinja: http://jinja.pocoo.org -.. _Mako: http://www.makotemplates.org -.. _Genshi: http://genshi.edgewall.org -.. _XML namespaces: http://en.wikipedia.org/wiki/XML_namespace -.. _HTML: http://en.wikipedia.org/wiki/HTML -.. _XSS: http://en.wikipedia.org/wiki/Cross-site_scripting +.. _Mako: https://www.makotemplates.org +.. _Genshi: https://genshi.edgewall.org +.. _XML namespaces: https://en.wikipedia.org/wiki/XML_namespace +.. _HTML: https://en.wikipedia.org/wiki/HTML +.. _XSS: https://en.wikipedia.org/wiki/Cross-site_scripting .. _JSON: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON -.. _CSS selector: http://api.jquery.com/category/selectors/ +.. _CSS selector: https://api.jquery.com/category/selectors/ diff --git a/doc/reference/reports.rst b/doc/reference/reports.rst index f12efdcab07..696eabc5809 100644 --- a/doc/reference/reports.rst +++ b/doc/reference/reports.rst @@ -129,13 +129,13 @@ you need to define two templates: * The main report template * The translatable document -You can then call the translatable document from your main template with the attribute +You can then call the translatable document from your main template with the attribute ``t-lang`` set to a language code (for example ``fr`` or ``en_US``) or to a record field. You will also need to re-browse the related records with the proper context if you use fields that are translatable (like country names, sales conditions, etc.) .. warning:: - + If your report template does not use translatable record fields, re-browsing the record in another language is *not* necessary and will impact performances. @@ -169,10 +169,10 @@ For example, let's look at the Sale Order report from the Sale module:: </template> -The main template calls the translatable template with ``doc.partner_id.lang`` as a -``t-lang`` parameter, so it will be rendered in the language of the partner. This way, -each Sale Order will be printed in the language of the corresponding customer. If you wish -to translate only the body of the document, but keep the header and footer in a default +The main template calls the translatable template with ``doc.partner_id.lang`` as a +``t-lang`` parameter, so it will be rendered in the language of the partner. This way, +each Sale Order will be printed in the language of the corresponding customer. If you wish +to translate only the body of the document, but keep the header and footer in a default language, you could call the report's external layout this way:: <t t-call="web.external_layout" t-lang="en_US"> @@ -180,7 +180,7 @@ language, you could call the report's external layout this way:: .. tip:: Please take note that this works only when calling external templates, you will not be - able to translate part of a document by setting a ``t-lang`` attribute on an xml node other + able to translate part of a document by setting a ``t-lang`` attribute on an xml node other than ``t-call``. If you wish to translate part of a template, you can create an external template with this partial template and call it from the main one with the ``t-lang`` attribute. @@ -345,4 +345,4 @@ For example, you can access a Sale Order report in html mode by going to Or you can access the pdf version at \http://<server-address>/report/pdf/sale.report_saleorder/38 -.. _wkhtmltopdf: http://wkhtmltopdf.org +.. _wkhtmltopdf: https://wkhtmltopdf.org diff --git a/doc/reference/test-report.txt b/doc/reference/test-report.txt deleted file mode 100644 index 795bc044074..00000000000 --- a/doc/reference/test-report.txt +++ /dev/null @@ -1,25 +0,0 @@ -test_empty_find (odoo.addons.web.tests.test_dataset.TestDataSetController) ... ok -test_ids_shortcut (odoo.addons.web.tests.test_dataset.TestDataSetController) ... ok -test_regular_find (odoo.addons.web.tests.test_dataset.TestDataSetController) ... ok -web.testing.stack: direct, value, success ... ok -web.testing.stack: direct, deferred, success ... ok -web.testing.stack: direct, value, error ... ok -web.testing.stack: direct, deferred, failure ... ok -web.testing.stack: successful setup ... ok -web.testing.stack: successful teardown ... ok -web.testing.stack: successful setup and teardown ... ok - -[snip ~150 lines] - -test_convert_complex_context (odoo.addons.web.tests.test_view.DomainsAndContextsTest) ... ok -test_convert_complex_domain (odoo.addons.web.tests.test_view.DomainsAndContextsTest) ... ok -test_convert_literal_context (odoo.addons.web.tests.test_view.DomainsAndContextsTest) ... ok -test_convert_literal_domain (odoo.addons.web.tests.test_view.DomainsAndContextsTest) ... ok -test_retrieve_nonliteral_context (odoo.addons.web.tests.test_view.DomainsAndContextsTest) ... ok -test_retrieve_nonliteral_domain (odoo.addons.web.tests.test_view.DomainsAndContextsTest) ... ok - ----------------------------------------------------------------------- -Ran 181 tests in 15.706s - -OK - diff --git a/doc/reference/testing.rst b/doc/reference/testing.rst index 4175c709719..54c46da3b96 100644 --- a/doc/reference/testing.rst +++ b/doc/reference/testing.rst @@ -43,12 +43,6 @@ and ``__init__.py`` contains:: test modules which are not imported from ``tests/__init__.py`` will not be run -.. versionchanged:: 8.0 - - previously, the test runner would only run modules added to two lists - ``fast_suite`` and ``checks`` in ``tests/__init__.py``. In 8.0 it will - run all imported modules - The test runner will simply run any test case, as described in the official `unittest documentation`_, but Odoo provides a number of utilities and helpers related to testing Odoo content (modules, mainly): @@ -108,10 +102,7 @@ Tests are automatically run when installing or updating modules if :option:`--test-enable <odoo-bin --test-enable>` was enabled when starting the Odoo server. -As of Odoo 8, running tests outside of the install/update cycle is not -supported. - -.. _unittest documentation: https://docs.python.org/2/library/unittest.html +.. _unittest documentation: https://docs.python.org/3/library/unittest.html Test selection -------------- @@ -528,7 +519,7 @@ Two new command line arguments were added since Odoo 13.0 to control this behavi :option:`--screenshots <odoo-bin --screenshots>` and :option:`--screencasts <odoo-bin --screencasts>` -.. _qunit: http://qunitjs.com/ +.. _qunit: https://qunitjs.com/ .. _qunit_config.js: https://github.com/odoo/odoo/blob/51ee0c3cb59810449a60dae0b086b49b1ed6f946/addons/web/static/tests/helpers/qunit_config.js#L49 .. _web.js_tests_assets: https://github.com/odoo/odoo/blob/51ee0c3cb59810449a60dae0b086b49b1ed6f946/addons/web/views/webclient_templates.xml#L427 .. _web.qunit_suite: https://github.com/odoo/odoo/blob/51ee0c3cb59810449a60dae0b086b49b1ed6f946/addons/web/views/webclient_templates.xml#L509 @@ -537,4 +528,4 @@ Two new command line arguments were added since Odoo 13.0 to control this behavi .. _test_utils.js: https://github.com/odoo/odoo/blob/51ee0c3cb59810449a60dae0b086b49b1ed6f946/addons/web/static/tests/helpers/test_utils.js .. _mock server: https://github.com/odoo/odoo/blob/51ee0c3cb59810449a60dae0b086b49b1ed6f946/addons/web/static/tests/helpers/mock_server.js .. _qunit assertions: https://github.com/odoo/odoo/blob/51ee0c3cb59810449a60dae0b086b49b1ed6f946/addons/web/static/tests/helpers/qunit_asserts.js -.. _createView: https://github.com/odoo/odoo/blob/51ee0c3cb59810449a60dae0b086b49b1ed6f946/addons/web/static/tests/helpers/test_utils_create.js#L267
\ No newline at end of file +.. _createView: https://github.com/odoo/odoo/blob/51ee0c3cb59810449a60dae0b086b49b1ed6f946/addons/web/static/tests/helpers/test_utils_create.js#L267 diff --git a/doc/reference/translations.rst b/doc/reference/translations.rst index 23641f3b895..c7997e1e966 100644 --- a/doc/reference/translations.rst +++ b/doc/reference/translations.rst @@ -7,6 +7,11 @@ Translating Modules =================== +This section explains how to provide translation abilities to your module. + +.. note:: If you want to contribute to the translation of Odoo itself, please refer to the + `Odoo Wiki page <https://github.com/odoo/odoo/wiki/Translations>`_. + Exporting translatable term =========================== @@ -203,6 +208,6 @@ or **do** evaluate dynamically the translatable content:: }; -.. _PO File: http://en.wikipedia.org/wiki/Gettext#Translating -.. _msginit: http://www.gnu.org/software/gettext/manual/gettext.html#Creating -.. _POEdit: http://poedit.net/ +.. _PO File: https://en.wikipedia.org/wiki/Gettext#Translating +.. _msginit: https://www.gnu.org/software/gettext/manual/gettext.html#Creating +.. _POEdit: https://poedit.net/ diff --git a/doc/reference/views.rst b/doc/reference/views.rst index b67630bab93..bfa99ff0d94 100644 --- a/doc/reference/views.rst +++ b/doc/reference/views.rst @@ -197,6 +197,10 @@ root can have the following attributes: .. note:: if the ``edit`` attribute is set to ``false``, the ``editable`` option will be ignored. +``multi_edit`` + editable or not editable list can activate the multi-edition feature by defining + the multi_edit=1 + ``default_order`` overrides the ordering of the view, replacing the model's default order. The value is a comma-separated list of fields, postfixed by ``desc`` to @@ -219,7 +223,7 @@ root can have the following attributes: (``font-style: italic``), or any `bootstrap contextual color <https://getbootstrap.com/docs/3.3/components/#available-variations>`_ (``danger``, ``info``, ``muted``, ``primary``, ``success`` or ``warning``). -``create``, ``edit``, ``delete``, ``duplicate``, ``import`` +``create``, ``edit``, ``delete``, ``duplicate``, ``import``, ``export_xlsx`` allows *dis*\ abling the corresponding action in the view by setting the corresponding attribute to ``false`` ``limit`` @@ -1052,6 +1056,8 @@ attributes: whether it should be possible to create records without switching to the form view. By default, ``quick_create`` is enabled when the Kanban view is grouped by many2one, selection, char or boolean fields, and disabled when not. +``records_draggable`` + whether it should be possible to drag records when kanban is grouped. Default: true. Set to ``true`` to always enable it, and to ``false`` to always disable it. diff --git a/doc/setup/deploy.rst b/doc/setup/deploy.rst index f1926eca4ea..c626bc133bd 100644 --- a/doc/setup/deploy.rst +++ b/doc/setup/deploy.rst @@ -624,16 +624,16 @@ of the supported browsers is the following: environment than over the internet. .. _regular expression: https://docs.python.org/3/library/re.html -.. _ARP spoofing: http://en.wikipedia.org/wiki/ARP_spoofing +.. _ARP spoofing: https://en.wikipedia.org/wiki/ARP_spoofing .. _Nginx termination example: - http://nginx.com/resources/admin-guide/nginx-ssl-termination/ + https://nginx.com/resources/admin-guide/nginx-ssl-termination/ .. _Nginx proxying example: - http://nginx.com/resources/admin-guide/reverse-proxy/ + https://nginx.com/resources/admin-guide/reverse-proxy/ .. _socat: http://www.dest-unreach.org/socat/ .. _PostgreSQL connection settings: .. _listen to network interfaces: - http://www.postgresql.org/docs/9.6/static/runtime-config-connection.html + https://www.postgresql.org/docs/9.6/static/runtime-config-connection.html .. _use an SSH tunnel: - http://www.postgresql.org/docs/9.6/static/ssh-tunnels.html -.. _WSGI: http://wsgi.readthedocs.org/ + https://www.postgresql.org/docs/9.6/static/ssh-tunnels.html +.. _WSGI: https://wsgi.readthedocs.org/ .. _POSBox: https://www.odoo.com/page/point-of-sale-hardware#part_2 diff --git a/doc/setup/email_gateway.rst b/doc/setup/email_gateway.rst index 3567ad9c9bf..bc73535ab09 100644 --- a/doc/setup/email_gateway.rst +++ b/doc/setup/email_gateway.rst @@ -40,4 +40,4 @@ For Exim - `Exim <https://www.exim.org/docs.html>` -.. note:: If you don't have access/manage your email server, use `inbound messages<https://www.odoo.com/documentation/user/12.0/discuss/email_servers.html#how-to-manage-inbound-messages>`. +.. note:: If you don't have access/manage your email server, use `inbound messages<https://www.odoo.com/documentation/user/13.0/discuss/email_servers.html#how-to-manage-inbound-messages>`. diff --git a/doc/setup/install.rst b/doc/setup/install.rst index 7393292eb46..4b9d0735a26 100644 --- a/doc/setup/install.rst +++ b/doc/setup/install.rst @@ -1,5 +1,6 @@ :banner: banners/installing_odoo.jpg + .. _setup/install: =============== @@ -27,6 +28,7 @@ This documents attempts to describe most of the installation options. If you usually use docker_ for development or deployment, an official docker_ base image is available. + .. _setup/install/editions: Editions @@ -40,6 +42,7 @@ available to anyone. If you already use the Community version and wish to upgrade to Enterprise, please refer to :ref:`setup/enterprise` (except for :ref:`setup/install/source`). + .. _setup/install/online: Online @@ -67,6 +70,7 @@ Can be used for both testing Odoo and long-term production use. Like demo_ instances, SaaS_ instances require no local installation, a web browser is sufficient. + .. _setup/install/packaged: Packaged installers @@ -81,14 +85,14 @@ but may be difficult to keep up-to-date. Official Community packages with all relevant dependency requirements are available on our nightly_ server. Both Communtiy and Enterprise packages can -be downloaded from our Download_ page (you must to be logged in as a paying +be downloaded from our download_ page (you must to be logged in as a paying customer or partner to download the Enterprise packages). Windows ------- * Download the installer from our nightly_ server (Community only) - or the Windows installer from the Download_ page (any edition) + or the Windows installer from the download_ page (any edition) * Run the downloaded file .. warning:: on Windows 8, you may see a warning titled "Windows protected @@ -106,7 +110,7 @@ Linux Debian/Ubuntu ''''''''''''' -Odoo 12.0 'deb' package currently supports `Debian Stretch`_, `Ubuntu 18.04`_ or above. +Odoo 13.0 'deb' package currently supports `Debian Buster`_, `Ubuntu 18.04`_ or above. Prepare ^^^^^^^ @@ -139,7 +143,7 @@ following commands as root: .. code-block:: console # wget -O - https://nightly.odoo.com/odoo.key | apt-key add - - # echo "deb http://nightly.odoo.com/12.0/nightly/deb/ ./" >> /etc/apt/sources.list.d/odoo.list + # echo "deb http://nightly.odoo.com/13.0/nightly/deb/ ./" >> /etc/apt/sources.list.d/odoo.list # apt-get update && apt-get install odoo You can then use the usual ``apt-get upgrade`` command to keep your installation up-to-date. @@ -172,7 +176,7 @@ Or ``dpkg``: This will install Odoo as a service, create the necessary PostgreSQL_ user and automatically start the server. -.. warning:: The python3-xlwt Debian package does not exists in Debian Stretch nor Ubuntu 18.04. +.. warning:: The python3-xlwt Debian package does not exists in Debian Buster nor Ubuntu 18.04. This python module is needed to export into xls format. If you need the feature, you can install it manually. @@ -196,9 +200,9 @@ If you need this feature, you can install the python module like this: Fedora '''''' -Odoo 12.0 'rpm' package supports Fedora 26. +Odoo 13.0 'rpm' package supports Fedora 26. As of 2017, CentOS does not have the minimum Python requirements (3.5) for -Odoo 12.0. +Odoo 13.0. Prepare ^^^^^^^ @@ -230,7 +234,7 @@ commands: .. code-block:: console - $ sudo dnf config-manager --add-repo=https://nightly.odoo.com/12.0/nightly/rpm/odoo.repo + $ sudo dnf config-manager --add-repo=https://nightly.odoo.com/13.0/nightly/rpm/odoo.repo $ sudo dnf install -y odoo $ sudo systemctl enable odoo $ sudo systemctl start odoo @@ -248,329 +252,479 @@ Once downloaded, the package can be installed using the 'dnf' package manager: .. code-block:: console - $ sudo dnf localinstall odoo_12.0.latest.noarch.rpm + $ sudo dnf localinstall odoo_13.0.latest.noarch.rpm $ sudo systemctl enable odoo $ sudo systemctl start odoo + .. _setup/install/source: Source Install ============== -The source "installation" really is about not installing Odoo, and running -it directly from source instead. +The source "installation" is really about not installing Odoo, and running it directly from source +instead. -This can be more convenient for module developers as the Odoo source is -more easily accessible than using packaged installation (for information or -to build this documentation and have it available offline). +This can be more convenient for module developers as the Odoo source is more easily accessible +than using packaged installation (for information or to build this documentation and have it +available offline). -It also makes starting and stopping Odoo more flexible and explicit than the -services set up by the packaged installations, and allows overriding settings -using :ref:`command-line parameters <reference/cmdline>` without needing to -edit a configuration file. +It also makes starting and stopping Odoo more flexible and explicit than the services set up by the +packaged installations, and allows overriding settings using +:ref:`command-line parameters <reference/cmdline>` without needing to edit a configuration file. -Finally it provides greater control over the system's set up, and allows more -easily keeping (and running) multiple versions of Odoo side-by-side. +Finally it provides greater control over the system's set up, and allows to more easily keep +(and run) multiple versions of Odoo side-by-side. -Prepare +Windows ------- -Source installation requires manually installing dependencies: +Fetch the sources +''''''''''''''''' -* Python 3.5+. +There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**. - - on Linux and OS X, using your package manager if not installed by default +Archive +^^^^^^^ - .. note:: on some system, ``python`` command refers to Python 2 (outdated) - or to Python 3 (supported). Make sure you are using the right - version and that the alias ``python3`` is present in your - :envvar:`PATH` +Community Edition: - - on Windows, use `the official Python 3 installer - <https://www.python.org/downloads/windows/>`_. +* `Official download page <download_>`_ +* `GitHub repository <community-repository_>`_ +* `Nightly server <nightly_>`_ - .. warning:: select "add python.exe to Path" during installation, and - reboot afterwards to ensure the :envvar:`PATH` is updated +Enterprise Edition: - .. note:: if Python is already installed, make sure it is 3.5 or above, - previous versions are not compatible with Odoo. +* `Official download page <download_>`_ +* `GitHub repository <enterprise-repository_>`_ -* PostgreSQL, to use a local database +Git +^^^ - After installation you will need to create a postgres user: by default the - only user is ``postgres``, and Odoo forbids connecting as ``postgres``. +The following requires git_ to be installed on your machine and that you have basic knowledge of +git commands. - - on Linux, use your distribution's package, then create a postgres user - named like your login: +Community Edition: - .. code-block:: console +.. code-block:: doscon - $ sudo su - postgres -c "createuser -s $USER" + C:\> git clone https://github.com/odoo/odoo.git - Because the role login is the same as your unix login unix sockets can be - use without a password. - - on OS X, `postgres.app <http://postgresapp.com>`_ is the simplest way to - get started, then create a postgres user as on Linux +Enterprise Edition: (see :ref:`setup/install/editions` to get access) - - on Windows, use `PostgreSQL for windows`_ then +.. code-block:: doscon - - add PostgreSQL's ``bin`` directory (default: - ``C:\Program Files\PostgreSQL\9.4\bin``) to your :envvar:`PATH` - - create a postgres user with a password using the pg admin gui: open - pgAdminIII, double-click the server to create a connection, select - :menuselection:`Edit --> New Object --> New Login Role`, enter the - usename in the :guilabel:`Role Name` field (e.g. ``odoo``), then open - the :guilabel:`Definition` tab and enter the password (e.g. ``odoo``), - then click :guilabel:`OK`. + C:\> git clone https://github.com/odoo/enterprise.git - The user and password must be passed to Odoo using either the - :option:`-w <odoo-bin -w>` and :option:`-r <odoo-bin -r>` options or - :ref:`the configuration file <reference/cmdline/config>` +.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only + a collection of extra add-ons. The main server code is in the Community version. Running + the Enterprise version actually means running the server from the Community version with + the addons-path option set to the folder with the Enterprise version. You need to clone + both the Community and Enterprise repository to have a working Odoo Enterprise + installation. -* Python dependencies listed in the :file:`requirements.txt` file. +Prepare +''''''' - - on Linux, python dependencies may be installable with the system's package - manager or using pip. +Python +^^^^^^ - For libraries using native code (Pillow, lxml, greenlet, gevent, psycopg2, - ldap) it may be necessary to install development tools and native - dependencies before pip is able to install the dependencies themselves. - These are available in ``-dev`` or ``-devel`` packages for Python, - Postgres, libxml2, libxslt, libevent, libsasl2 and libldap2. Then the Python - dependecies can themselves be installed: +Odoo requires Python 3.5 or later to run. Use the the official `Python 3 installer +<https://www.python.org/downloads/windows/>`_ to download and install Python 3 on your machine. - .. code-block:: console +During installation, check **Add Python 3 to PATH**, then click **Customize Installation** and make +sure that **pip** is checked. - $ pip3 install -r requirements.txt +.. note:: If Python 3 is already installed, make sure that it is 3.5 or above, as previous versions + are not compatible with Odoo. - - on OS X, you will need to install the Command Line Tools - (``xcode-select --install``) then download and install a package manager - of your choice (homebrew_, macports_) to install non-Python dependencies. - pip can then be used to install the Python dependencies as on Linux: + .. code-block:: doscon - .. code-block:: console + C:\> python3 --version - $ pip3 install -r requirements.txt + Verify also that pip_ is installed for this version. - - on Windows you need to install some of the dependencies manually, tweak the - requirements.txt file, then run pip to install the remaning ones. + .. code-block:: doscon - Install ``psycopg`` using the installer here - http://www.stickpeople.com/projects/python/win-psycopg/ + C:\> pip3 --version - Then use pip to install the dependencies using the following - command from a cmd.exe prompt (replace ``\YourOdooPath`` by the actual - path where you downloaded Odoo): +PostgreSQL +^^^^^^^^^^ - .. code-block:: doscon +Odoo uses PostgreSQL as database management system. Download and install the `latest version of +PostgreSQL <https://www.postgresql.org/download/windows/>`_. - C:\> cd \YourOdooPath - C:\YourOdooPath> C:\Python35\Scripts\pip.exe install -r requirements.txt +By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need to +create a new PostgreSQL user: -* *RTLCSS* via nodejs +#. Add PostgreSQL's `bin` directory (by default: `C:\\Program Files\\PostgreSQL\\<version>\\bin`) to + your `PATH`. +#. Create a postgres user with a password using the pg admin gui: - For languages with right-to-left interface (such as Arabic or Hebrew), the - package ``rtlcss`` is needed. + * Open **pgAdminIII**. + * Double-click the server to create a connection. + * Select :menuselection:`Edit --> New Object --> New Login Role`. + * Enter the username in the **Role Name** field (e.g. `odoo`). + * Open the **Definition** tab and enter the password (e.g. ``odoo``), then click **OK**. - - on Linux, use your distribution's package manager to install nodejs and - npm. - Once npm is installed, use it to install rtlcss: +Dependencies +^^^^^^^^^^^^ - .. code-block:: console +Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo +community directory. Most of them can be installed with **pip**. - $ sudo npm install -g rtlcss +.. tip:: It can be preferable to not mix python modules packages between different instances of Odoo + or with your system. You can use virtualenv_ to create isolated Python environments. - - on OS X, install nodejs via your preferred package manager (homebrew_, - macports_) then install less: +Navigate to the path of your Odoo Community installation (`YourOdooCommunityPath`) and run **pip** +on the requirements file: - .. code-block:: console +.. code-block:: doscon - $ sudo npm install -g rtlcss + C:\> cd \YourOdooCommunityPath + C:\YourOdooCommunityPath> C:\Python35\Scripts\pip.exe install -r requirements.txt - - on Windows, `install nodejs <https://nodejs.org/en/download/>`_, reboot (to - update the :envvar:`PATH`) and install rtlcss: +.. warning:: Some dependencies cannot be installed through pip and require to be installed manually. + In particular: - .. code-block:: doscon + * `psycopg` must be installed with + `this installer <http://www.stickpeople.com/projects/python/win-psycopg/>`_. + * `wkhtmltopdf` must be installed in version `0.12.5 <the wkhtmltopdf download page_>`_ + for it to support headers and footers. See our + `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more details on the + various versions. - C:\> npm install -g rtlcss +For languages with right-to-left interface (such as Arabic or Hebrew), the package `rtlcss` is +needed: - It is then necessary to edit the System Environment's variable - :envvar:`PATH` and add the folder where `rtlcss.cmd` is located. Typically: +#. Download and install `nodejs <https://nodejs.org/en/download/>`_. +#. Install `rtlcss`: - .. code-block:: console + .. code-block:: doscon - C:\Users\<user>\AppData\Roaming\npm\ + C:\> npm install -g rtlcss +#. Edit the System Environment's variable `PATH` to add the folder where `rtlcss.cmd` is located + (typically: `C:\\Users\\<user>\\AppData\\Roaming\\npm\\`). -Fetch the sources ------------------ +Running Odoo +'''''''''''' + +Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the +command-line interface of the server. It is located at the root of the Odoo Community directory. + +To configure the server, you can either specify :ref:`command-line arguments <reference/cmdline/server>` or a +:ref:`configuration file <reference/cmdline/config>`. + +.. tip:: For the Enterprise edition, you must add the path to the `enterprise` addons to the + `addons-path` argument. Note that it must come before the other paths in `addons-path` for + addons to be loaded correctly. + +Common necessary configurations are: + +* PostgreSQL user and password. +* Custom addon paths beyond the defaults, to load your own modules. + +A typical way to run the server would be: -There are two ways to obtain the Odoo source code: zip or git. +.. code-block:: doscon + + C:\YourOdooCommunityPath> python3 odoo-bin -r dbuser -w dbpassword --addons-path=addons,../mymodules --db-filter=mydb$ -* Odoo zip can be downloaded from our nightly_ server or our Download_ page, - the zip file then needs to be uncompressed to use its content +Where `YourOdooCommunityPath` is the path of the Odoo Community installation, `dbuser` is the +PostgreSQL login, `dbpassword` is the PostgreSQL password, `../mymodules` is a directory with +additional addons and `mydb` is the default database to serve on `localhost:8069`. -* git allows simpler update and easier switching between different versions - of Odoo. It also simplifies maintaining non-module patches and - contributions. The primary drawback of git is that it is significantly - larger than a tarball as it contains the entire history of the Odoo project. +Linux +----- -Community Edition +Fetch the sources ''''''''''''''''' -The git repository is https://github.com/odoo/odoo.git for the Community -edition. +There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**. + +Archive +^^^^^^^ + +Community Edition: + +* `Official download page <download_>`_ +* `GitHub repository <community-repository_>`_ +* `Nightly server <nightly_>`_ + +Enterprise Edition: + +* `Official download page <download_>`_ +* `GitHub repository <enterprise-repository_>`_ + +Git +^^^ + +The following requires git_ to be installed on your machine and that you have basic knowledge of +git commands. -Downloading it requires a `git client <http://git-scm.com/download/>`_ -(which may be available via your distribution on linux) and can be performed -using the following command: +Community Edition: .. code-block:: console $ git clone https://github.com/odoo/odoo.git -Enterprise Edition -'''''''''''''''''' -If you have access to the Enterprise repository (see :ref:`setup/install/editions` -if you wish to get access), you can use this command to fetch the addons: +Enterprise Edition: (see :ref:`setup/install/editions` to get access) .. code-block:: console $ git clone https://github.com/odoo/enterprise.git -.. note:: The Enterprise git repository **does not contain the full Odoo - source code**. It is only a collection of extra add-ons. The main server - code is in the Community version. Running the Enterprise version actually - means running the server from the Community version with the addons-path option - set to the folder with the Enterprise version. +.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only + a collection of extra add-ons. The main server code is in the Community version. Running + the Enterprise version actually means running the server from the Community version with + the addons-path option set to the folder with the Enterprise version. You need to clone + both the Community and Enterprise repository to have a working Odoo Enterprise + installation. - You need to clone both the Community and Enterprise repository to have a working - Odoo installation +Prepare +''''''' -Running Odoo ------------- +Python +^^^^^^ -Once all dependencies are set up, Odoo can be launched by running ``odoo-bin``. +Odoo requires Python 3.5 or later to run. Use your package manager to download and install Python 3 +on your machine if it is not already done. -.. tip:: For the Enterprise edition, you must specify the :file:`enterprise` - addons folder when starting your server. You can do so by providing the path - to your :file:`enterprise` folder in the ``addons-path`` parameter. Please - note that the :file:`enterprise` folder must come before the default - :file:`addons` folder in the list for the addons to be loaded correctly. +.. note:: If Python 3 is already installed, make sure that it is 3.5 or above, as previous versions + are not compatible with Odoo. -:ref:`Configuration <reference/cmdline>` can be provided either through -:ref:`command-line arguments <reference/cmdline>` or through a -:ref:`configuration file <reference/cmdline/config>`. + .. code-block:: console -Common necessary configurations are: + $ python3 --version -* PostgreSQL host, port, user and password. + Verify also that pip_ is installed for this version. - Odoo has no defaults beyond - `psycopg2's defaults <http://initd.org/psycopg/docs/module.html>`_: connects - over a UNIX socket on port 5432 with the current user and no password. By - default this should work on Linux and OS X, but it *will not work* on - windows as it does not support UNIX sockets. + .. code-block:: console -* Custom addons path beyond the defaults, to load your own modules + $ pip3 --version -Under Windows a typical way to execute odoo would be: +PostgreSQL +^^^^^^^^^^ -.. code-block:: doscon +Odoo uses PostgreSQL as database management system. Use your package manager to download and install +the latest version of PostgreSQL. + +By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need to +create a new PostgreSQL user: + +.. code-block:: console + + $ sudo -u postgres createuser -s $USER + $ createdb $USER + +.. note:: Because your PostgreSQL user has the same name as your Unix login, you will be able to + connect to the database without password. + +Dependencies +^^^^^^^^^^^^ - C:\YourOdooPath> python3 odoo-bin -w odoo -r odoo --addons-path=addons,../mymodules --db-filter=mydb$ +Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo +community directory. Most of them can be installed with **pip**. -Where ``odoo``, ``odoo`` are the postgresql login and password, -``../mymodules`` a directory with additional addons and ``mydb`` the default -db to serve on localhost:8069 +.. tip:: It can be preferable to not mix python modules packages between different instances of Odoo + or with your system. You can use virtualenv_ to create isolated Python environments. -Under Unix a typical way to execute odoo would be: +Navigate to the path of your Odoo Community installation (`YourOdooCommunityPath`) and run **pip** +on the requirements file: .. code-block:: console - $ ./odoo-bin --addons-path=addons,../mymodules --db-filter=mydb$ + $ cd /YourOdooCommunityPath + /YourOdooCommunityPath$ pip3 install -r requirements.txt -Where ``../mymodules`` is a directory with additional addons and ``mydb`` the -default db to serve on localhost:8069 +.. warning:: For libraries using native code (Pillow, lxml, greenlet, gevent, psycopg2, ldap), it + may be necessary to install development tools and native dependencies before pip is + able to install the dependencies themselves. These are available in `-dev` or `-devel` + packages for Python, PostgreSQL, libxml2, libxslt, libevent, libsasl2 and libldap2. -Virtualenv ----------- +.. warning:: Some dependencies cannot be installed through pip and require to be installed manually. + In particular: -Virtualenv_ is a tool to create Python isolated environments because it's -sometimes preferable to not mix your distribution python modules packages -with globally installed python modules with pip. + * `wkhtmltopdf` must be installed in version `0.12.5 <the wkhtmltopdf download page_>`_ + for it to support headers and footers. See our + `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more details on the + various versions. -This section will explain how to run Odoo in a such isolated Python environment. +For languages with right-to-left interface (such as Arabic or Hebrew), the package `rtlcss` is +needed: -Here we are going to use virtualenvwrapper_ which is a set of shell scripts that -makes the use of virtualenv easier. +#. Download and install **nodejs** and **npm** with your package manager. +#. Install `rtlcss`: -The examples below are based on a Debian 9 distribution but could be adapted on -any platform where virtualenvwrapper_ and virtualenv_ are able to run. + .. code-block:: console -This section assumes that you obtained the Odoo sources from the zip file or the -git repository as explained above. The same apply for postgresql installation -and configuration. + $ sudo npm install -g rtlcss -Install virtualenvwrapper -''''''''''''''''''''''''' +Running Odoo +'''''''''''' -.. code-block:: console +Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the +command-line interface of the server. It is located at the root of the Odoo Community directory. + +To configure the server, you can either specify :ref:`command-line arguments <reference/cmdline/server>` or a +:ref:`configuration file <reference/cmdline/config>`. + +.. tip:: For the Enterprise edition, you must add the path to the `enterprise` addons to the + `addons-path` argument. Note that it must come before the other paths in `addons-path` for + addons to be loaded correctly. + +Common necessary configurations are: - $ sudo apt install virtualenvwrapper - $ source /usr/share/virtualenvwrapper/virtualenvwrapper.sh +* PostgreSQL user and password. Odoo has no defaults beyond + `psycopg2's defaults <http://initd.org/psycopg/docs/module.html>`_: connects over a UNIX socket on + port `5432` with the current user and no password. +* Custom addon paths beyond the defaults, to load your own modules. -This will install virtualenvwrapper_ and activate it immediately. -Now, let's install the tools required to build Odoo dependencies if needed: +A typical way to run the server would be: .. code-block:: console - $ sudo apt install build-essential python3-dev libxslt-dev libzip-dev libldap2-dev libsasl2-dev + /YourOdooCommunityPath$ python3 odoo-bin --addons-path=addons,../mymodules --db-filter=mydb$ -Create an isolated environment -'''''''''''''''''''''''''''''' +Where `YourOdooCommunityPath` is the path of the Odoo Community installation, `../mymodules` is a +directory with additional addons and `mydb` is the default database to serve on `localhost:8069`. -Now we can create a virtual environment for Odoo like this: +Mac OS +------ -.. code-block:: console +Fetch the sources +''''''''''''''''' + +There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**. + +Archive +^^^^^^^ - $ mkvirtualenv -p /usr/bin/python3 odoo-venv +Community Edition: -With this command, we ask for an isolated Python3 environment that will be named -"odoo-env". If the command works as expected, your shell is now using this -environment. Your prompt should have changed to remind you that you are using -an isolated environment. You can verify with this command: +* `Official download page <download_>`_ +* `GitHub repository <community-repository_>`_ +* `Nightly server <nightly_>`_ + +Enterprise Edition: + +* `Official download page <download_>`_ +* `GitHub repository <enterprise-repository_>`_ + +Git +^^^ + +The following requires git_ to be installed on your machine and that you have basic knowledge of +git commands. + +Community Edition: .. code-block:: console - $ which python3 + $ git clone https://github.com/odoo/odoo.git -This command should show you the path to the Python interpreter located in the -isolated environment directory. -Now let's install the Odoo required python packages: +Enterprise Edition: (see :ref:`setup/install/editions` to get access) .. code-block:: console - $ cd your_odoo_sources_path - $ pip install -r requirements.txt + $ git clone https://github.com/odoo/enterprise.git + +.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only + a collection of extra add-ons. The main server code is in the Community version. Running + the Enterprise version actually means running the server from the Community version with + the addons-path option set to the folder with the Enterprise version. You need to clone + both the Community and Enterprise repository to have a working Odoo Enterprise + installation. + +Prepare +''''''' + +Python +^^^^^^ + +Odoo requires Python 3.5 or later to run. Use your preferred package manager (homebrew_, macports_) +to download and install Python 3 on your machine if it is not already done. -After a little while, you should be ready to run odoo from the command line as -explained above. +.. note:: If Python 3 is already installed, make sure that it is 3.5 or above, as previous versions + are not compatible with Odoo. -When you you want to leave the virtual environment, just issue this command: + .. code-block:: console + + $ python3 --version + + Verify also that pip_ is installed for this version. + + .. code-block:: console + + $ pip3 --version + +PostgreSQL +^^^^^^^^^^ + +Odoo uses PostgreSQL as database management system. Use `postgres.app <https://postgresapp.com>`_ +to download and install the latest version of PostgreSQL. + +By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need to +create a new PostgreSQL user: .. code-block:: console - $ deactivate + $ sudo -u postgres createuser -s $USER + $ createdb $USER + +.. note:: Because your PostgreSQL user has the same name as your Unix login, you will be able to + connect to the database without password. + +Dependencies +^^^^^^^^^^^^ + +Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo +community directory. Most of them can be installed with **pip**. + +.. tip:: It can be preferable to not mix python modules packages between different instances of Odoo + or with your system. You can use virtualenv_ to create isolated Python environments. -Whenever you want to work again with your 'odoo-venv' environment: +Navigate to the path of your Odoo Community installation (`YourOdooCommunityPath`) and run **pip** +on the requirements file: .. code-block:: console - $ workon odoo-venv + $ cd /YourOdooCommunityPath + /YourOdooCommunityPath$ pip3 install -r requirements.txt + +.. warning:: Non-Python dependencies need to be installed with a package manager: + + #. Download and install the **Command Line Tools**: + + .. code-block:: console + + $ xcode-select --install + + #. Download and install the package manager of your choice (homebrew_, macports_). + #. Install non-python dependencies. + +.. warning:: Some dependencies cannot be installed through pip and require to be installed manually. + In particular: + + * `wkhtmltopdf` must be installed in version `0.12.5 <the wkhtmltopdf download page_>`_ + for it to support headers and footers. See our + `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more details on the + various versions. + +For languages with right-to-left interface (such as Arabic or Hebrew), the package `rtlcss` is +needed: + +#. Download and install **nodejs** with your preferred package manager (homebrew_, macports_). +#. Install `rtlcss`: + + .. code-block:: console + + $ sudo npm install -g rtlcss + .. _setup/install/docker: @@ -580,18 +734,16 @@ Docker The full documentation on how to use Odoo with Docker can be found on the official Odoo `docker image <https://registry.hub.docker.com/_/odoo/>`_ page. +.. _Debian Buster: https://www.debian.org/releases/buster/ .. _demo: https://demo.odoo.com .. _docker: https://www.docker.com -.. _Download: https://www.odoo.com/page/download -.. _Debian Stretch: https://www.debian.org/releases/stretch/ +.. _download: https://www.odoo.com/page/download .. _Ubuntu 18.04: http://releases.ubuntu.com/18.04/ .. _EPEL: https://fedoraproject.org/wiki/EPEL .. _PostgreSQL: http://www.postgresql.org .. _the official installer: .. _install pip: https://pip.pypa.io/en/latest/installing.html#install-pip -.. _PostgreSQL for windows: - http://www.enterprisedb.com/products-services-training/pgdownload .. _Quilt: http://en.wikipedia.org/wiki/Quilt_(software) .. _saas: https://www.odoo.com/page/start .. _the wkhtmltopdf download page: https://github.com/wkhtmltopdf/wkhtmltopdf/releases/tag/0.12.5 @@ -604,8 +756,9 @@ official Odoo `docker image <https://registry.hub.docker.com/_/odoo/>`_ page. .. _virtualenv: https://pypi.python.org/pypi/virtualenv .. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/en/latest/ .. _pywin32: http://sourceforge.net/projects/pywin32/files/pywin32/ -.. _the repository: https://github.com/odoo/odoo -.. _git: http://git-scm.com +.. _community-repository: https://github.com/odoo/odoo +.. _enterprise-repository: https://github.com/odoo/enterprise +.. _git: https://git-scm.com/ .. _Editions: https://www.odoo.com/pricing#pricing_table_features -.. _nightly: https://nightly.odoo.com/12.0/nightly/ +.. _nightly: https://nightly.odoo.com/ .. _extra: https://nightly.odoo.com/extra/ diff --git a/doc/setup/update.rst b/doc/setup/update.rst index b036837ca65..9438b1ab884 100644 --- a/doc/setup/update.rst +++ b/doc/setup/update.rst @@ -20,7 +20,7 @@ definitions: Updating (an Odoo installation) Refers to the process of obtaining the latest revision of the source code for - your current Odoo Edition. For example, updating your Odoo Enterprise 12.0 to the + your current Odoo Edition. For example, updating your Odoo Enterprise 13.0 to the latest revision. This does not directly cause any change to the contents of your Odoo database, and can be undone by reinstalling the previous revision of the source code. @@ -110,7 +110,7 @@ to replace the installation directory with a newer version. First download the l from Odoo.com. They are updated daily and include the latest security fixes (see step #1) After downloading the package, extract it to a temporary location on your server. -You will get a folder labelled with the version of the source code, for example "odoo-12.0+e.20180719", +You will get a folder labelled with the version of the source code, for example "odoo-13.0+e.20190719", that contains a folder "odoo.egg-info" and the actual source code folder named "odoo" (for Odoo 10 and later) or "openerp" for older versions. You can ignore the odoo.egg-info folder. Locate the folder where your current installation is deployed, diff --git a/doc/webservices/iap.rst b/doc/webservices/iap.rst index 1265f67652b..5af45ef7ae3 100644 --- a/doc/webservices/iap.rst +++ b/doc/webservices/iap.rst @@ -75,7 +75,7 @@ Overview service directly, or you can delegate the actual service acting as a bridge/translator between an Odoo system and the actual service. - + .. figure:: images/credits.jpg :align: center @@ -94,7 +94,7 @@ Overview * for a postage service: 1 credit = 1 post stamp. A credit can also simply be associated with a fixed amount of money - to palliate the variations of price (e.g. the prices of sms and stamps + to palliate the variations of price (e.g. the prices of sms and stamps may vary following the countries). The value of the credits is fixed with the help of prepaid credit packs @@ -158,15 +158,15 @@ Register the service on Odoo .. todo:: complete this part with screenshots -The first step is to register your service on the IAP endpoint (production +The first step is to register your service on the IAP endpoint (production and/or test) before you can actually query user accounts. To create a service, go to your *Portal Account* on the IAP endpoint (https://iap.odoo.com for production, https://iap-sandbox.odoo.com for testing, the endpoints are *independent* and *not synchronized*). Alternatively, you can go to your portal on Odoo (https://iap.odoo.com/my/home) and select *In-App Services*. -.. note:: - +.. note:: + On production, there is a manual validation step before the service can be used to manage real transactions. This step is automatically passed when on sandbox to ease the tests. @@ -187,7 +187,7 @@ The service has *seven* important fields: .. warning:: - Both the :class:`ServiceName` and :class:`Label` are unique. As good practice, the + Both the :class:`ServiceName` and :class:`Label` are unique. As good practice, the :class:`ServiceName` should usually match the name of your Odoo Client App. * :samp:`icon` - :class:`Icon`: A generic icon that will serve as default for your @@ -241,8 +241,8 @@ A credit pack is essentially a product with five characteristics: * Amount: amount of credits the client is entitled to when buying the pack, * Price: price in EUR (for the time being, USD support is planned). -.. note:: - +.. note:: + Odoo takes a 25% commission on all pack sales. Adjust your selling price accordingly. @@ -300,7 +300,7 @@ In that call, we will need to provide: * the :class:`token <UserToken>` of the current client that is provided by the ``iap.account`` model's ``account_token`` field. You can retrieve the account for your service by calling :samp:`env['iap.account'].get({service_name})` - where :class:`service_name <ServiceName>` is the name of the service registered + where :class:`service_name <ServiceName>` is the name of the service registered on IAP endpoint. .. patch:: @@ -465,7 +465,7 @@ Capture .. code-block:: python :emphasize-lines: 8 - + r2 = requests.post(ODOO + '/iap/1/capture', json={ 'jsonrpc': '2.0', 'id': None, @@ -550,6 +550,7 @@ care how they are implemented. pending transactions/existing holds). .. exception:: odoo.exceptions.AccessError + :noindex: Raised by: @@ -557,8 +558,9 @@ care how they are implemented. * any failure in an inter-server call. (typically, in :func:`~odoo.addons.iap.jsonrpc`). .. exception:: odoo.exceptions.UserError + :noindex: - Raised by any unexpeted behaviour at the discretion of the App developer (*you*). + Raised by any unexpected behaviour at the discretion of the App developer (*you*). Test the API @@ -687,7 +689,7 @@ Cancel ------ .. class:: odoo.addons.iap.models.iap.cancel(env, transaction_token, key) - + Will cancel an authorized transaction. :param odoo.api.Environment env: used to retrieve the ``iap.endpoint`` @@ -761,5 +763,5 @@ Capture capture(env,transaction_token, key, min(credits, 2)) -.. _JSON-RPC2: http://www.jsonrpc.org/specification +.. _JSON-RPC2: https://www.jsonrpc.org/specification .. _Odoo App: https://www.odoo.com/apps diff --git a/doc/webservices/localization.rst b/doc/webservices/localization.rst index 38cb6c0947c..e957f18b11c 100644 --- a/doc/webservices/localization.rst +++ b/doc/webservices/localization.rst @@ -138,7 +138,7 @@ Each ``account.account.template`` is able to create an ``account.account`` for e Some of the described fields above deserve a bit more explanation. The ``user_type_id`` field requires a value of type ``account.account.type``. -Although some additional types could be created in a localization module, we encourage the usage of the existing types in the `account/data/data_account_type.xml <https://github.com/odoo/odoo/blob/12.0/addons/account/data/data_account_type.xml>`_ file. +Although some additional types could be created in a localization module, we encourage the usage of the existing types in the `account/data/data_account_type.xml <https://github.com/odoo/odoo/blob/13.0/addons/account/data/data_account_type.xml>`_ file. The usage of these generic types ensures the generic reports working correctly in addition to those that you could create in your localization module. .. warning:: diff --git a/doc/webservices/odoo.rst b/doc/webservices/odoo.rst index 459da784ecb..288659c95da 100644 --- a/doc/webservices/odoo.rst +++ b/doc/webservices/odoo.rst @@ -184,13 +184,13 @@ database: These examples use the `Ripcord <https://code.google.com/p/ripcord/>`_ library, which provides a simple XML-RPC API. Ripcord requires that `XML-RPC support be enabled - <http://php.net/manual/en/xmlrpc.installation.php>`_ in your PHP + <https://php.net/manual/en/xmlrpc.installation.php>`_ in your PHP installation. Since calls are performed over - `HTTPS <http://en.wikipedia.org/wiki/HTTP_Secure>`_, it also requires that + `HTTPS <https://en.wikipedia.org/wiki/HTTP_Secure>`_, it also requires that the `OpenSSL extension - <http://php.net/manual/en/openssl.installation.php>`_ be enabled. + <https://php.net/manual/en/openssl.installation.php>`_ be enabled. .. case:: Java @@ -219,7 +219,7 @@ database: Logging in ---------- -Odoo requires users of the API to be authenticated before they can query most +Odoo requires users of the API to be authenticated before they can query most data. The ``xmlrpc/2/common`` endpoint provides meta-calls which don't require @@ -414,31 +414,31 @@ available to only retrieve a subset of all matched records. .. container:: doc-aside .. switcher:: - + .. code-block:: python3 - + models.execute_kw(db, uid, password, 'res.partner', 'search', [[['is_company', '=', True], ['customer', '=', True]]], {'offset': 10, 'limit': 5}) - + .. code-block:: ruby - + models.execute_kw(db, uid, password, 'res.partner', 'search', [[['is_company', '=', true], ['customer', '=', true]]], {offset: 10, limit: 5}) - + .. code-block:: php - + $models->execute_kw($db, $uid, $password, 'res.partner', 'search', array(array(array('is_company', '=', true), array('customer', '=', true))), array('offset'=>10, 'limit'=>5)); - + .. code-block:: java - + asList((Object[])models.execute("execute_kw", asList( db, uid, password, "res.partner", "search", @@ -447,9 +447,9 @@ available to only retrieve a subset of all matched records. asList("customer", "=", true))), new HashMap() {{ put("offset", 10); put("limit", 5); }} ))); - + .. code-block:: json - + [13, 20, 30, 22, 29] Count records @@ -464,28 +464,28 @@ only the number of records matching the query. It takes the same .. container:: doc-aside .. switcher:: - + .. code-block:: python3 - + models.execute_kw(db, uid, password, 'res.partner', 'search_count', [[['is_company', '=', True], ['customer', '=', True]]]) - + .. code-block:: ruby - + models.execute_kw(db, uid, password, 'res.partner', 'search_count', [[['is_company', '=', true], ['customer', '=', true]]]) - + .. code-block:: php - + $models->execute_kw($db, $uid, $password, 'res.partner', 'search_count', array(array(array('is_company', '=', true), array('customer', '=', true)))); - + .. code-block:: java - + (Integer)models.execute("execute_kw", asList( db, uid, password, "res.partner", "search_count", @@ -493,9 +493,9 @@ only the number of records matching the query. It takes the same asList("is_company", "=", true), asList("customer", "=", true))) )); - + .. code-block:: json - + 19 .. warning:: @@ -514,11 +514,11 @@ fetch. By default, it will fetch all the fields the current user can read, which tends to be a huge amount. .. container:: doc-aside - + .. switcher:: - + .. code-block:: python3 - + ids = models.execute_kw(db, uid, password, 'res.partner', 'search', [[['is_company', '=', True], ['customer', '=', True]]], @@ -527,9 +527,9 @@ which tends to be a huge amount. 'res.partner', 'read', [ids]) # count the number of fields fetched by default len(record) - + .. code-block:: ruby - + ids = models.execute_kw(db, uid, password, 'res.partner', 'search', [[['is_company', '=', true], ['customer', '=', true]]], @@ -538,9 +538,9 @@ which tends to be a huge amount. 'res.partner', 'read', [ids]).first # count the number of fields fetched by default record.length - + .. code-block:: php - + $ids = $models->execute_kw($db, $uid, $password, 'res.partner', 'search', array(array(array('is_company', '=', true), @@ -550,9 +550,9 @@ which tends to be a huge amount. 'res.partner', 'read', array($ids)); // count the number of fields fetched by default count($records[0]); - + .. code-block:: java - + final List ids = asList((Object[])models.execute( "execute_kw", asList( db, uid, password, @@ -570,9 +570,9 @@ which tends to be a huge amount. ))[0]; // count the number of fields fetched by default record.size(); - + .. code-block:: json - + 121 Conversedly, picking only three fields deemed interesting. @@ -910,7 +910,7 @@ a record). Delete records -------------- -Records can be deleted in bulk by providing their ids to +Records can be deleted in bulk by providing their ids to :meth:`~odoo.models.Model.unlink`. .. container:: doc-aside @@ -1296,6 +1296,6 @@ activated as actual fields on the model. ] -.. _PostgreSQL: http://www.postgresql.org -.. _XML-RPC: http://en.wikipedia.org/wiki/XML-RPC -.. _base64: http://en.wikipedia.org/wiki/Base64 +.. _PostgreSQL: https://www.postgresql.org +.. _XML-RPC: https://en.wikipedia.org/wiki/XML-RPC +.. _base64: https://en.wikipedia.org/wiki/Base64 diff --git a/doc/webservices/upgrade.rst b/doc/webservices/upgrade.rst index 25310f0e70e..13f7e8472ce 100644 --- a/doc/webservices/upgrade.rst +++ b/doc/webservices/upgrade.rst @@ -55,7 +55,7 @@ The ``create`` method :param str contract: (required) your enterprise contract reference :param str email: (required) your email address - :param str target: (required) the Odoo version you want to upgrade to. Valid choices: 10.0, 11.0, 12.0 + :param str target: (required) the Odoo version you want to upgrade to. Valid choices: 11.0, 12.0, 13.0 :param str aim: (required) the purpose of your upgrade database request. Valid choices: test, production. :param str filename: (required) a purely informative name for you database dump file :param str timezone: (optional) the timezone used by your server. Only for Odoo source version < 6.1 @@ -96,9 +96,9 @@ See a sample output aside. "failures": [ { "expected": [ - "10.0", "11.0", "12.0", + "13.0", ], "message": "Invalid value \"5.0\"", "reason": "TARGET:INVALID", @@ -135,7 +135,7 @@ Sample script Here are 2 examples of database upgrade request creation using: * one in the python programming language using the requests library -* one in the bash programming language using `curl <http://curl.haxx.se>`_ (tool +* one in the bash programming language using `curl <https://curl.haxx.se>`_ (tool for transfering data using http) and `jq <https://stedolan.github.io/jq>`_ (JSON processor): .. rst-class:: setup doc-aside |