# HG changeset patch # User Brendan Masson <brendan.masson@xcg-consulting.fr> # Date 1457713018 0 # Fri Mar 11 16:16:58 2016 +0000 # Branch odoo8 # Node ID a4c8ad4c8958d40c84b883e5ad94c3152a453e11 # Parent 490c4a52dff260fa72d54423f770c360a4c34c92 README.rst fixed diff --git a/README.rst b/README.rst --- a/README.rst +++ b/README.rst @@ -149,43 +149,43 @@ key (default value): description -`name` (= `_description` or `_name`): The name of the analytic dimension. +``name`` (= ``_description`` or ``_name``): The name of the analytic dimension. This name is only used when creating the dimension in the database. column (analytic_id): The field that links each record to an analytic code. -`ref_id` (= `_name` + `analytic_dimension_id`): The external ID that will +``ref_id`` (= ``_name`` + ``analytic_dimension_id``): The external ID that will be used by the analytic dimension. By setting this value, you can allow two models to use the same dimension, or a model to use an already existing one. -`ref_module` (empty string): The name of the module associated with the dimension +``ref_module`` (empty string): The name of the module associated with the dimension record. Change this value in order to use a dimension defined in a data file. -`sync_parent` (`False`): Controls the synchronization of the codes' parent-child +``sync_parent`` (``False``): Controls the synchronization of the codes' parent-child hierarchy with that of the model. When using an inherited, renamed parent field, -you must give the parent field name rather than simply `True`. +you must give the parent field name rather than simply ``True``. -`use_inherits` (special): Determines whether the analytic codes should be bound +``use_inherits`` (special): Determines whether the analytic codes should be bound to the records by inheritance, or through a simple many2one field. Inheritance allows for better synchronization, but can only be used if there are no duplicate fields between the two objects. -The default value is `True` if the model has no 'name' and 'code_parent_id' field -as well as no inheritance of any kind, and `False` otherwise. If the object has -inheritances that do not cause conflicts, you can set it to `True`. +The default value is ``True`` if the model has no 'name' and 'code_parent_id' field +as well as no inheritance of any kind, and ``False`` otherwise. If the object has +inheritances that do not cause conflicts, you can set it to ``True``. -`rel_active` (`False`): Create a related field in the model, targeting the +``rel_active`` (``False``): Create a related field in the model, targeting the analytic code field 'active' and with an appropriate store parameter. This is useful when the model doesn't inherit analytic_code and/or when it already has a field named 'active'. Can take a pair of string values: (field label, field name). If given a string, the default field name 'active' will be used. -If given `True`, the default field label 'Active' will also be used. +If given ``True``, the default field label 'Active' will also be used. -`rel_description` (`False`): Same as rel_active for the code field 'description'. +``rel_description`` (``False``): Same as rel_active for the code field 'description'. If given a string, the default field name 'description' will be used. -If given `True`, the default field label 'Description' will also be used. +If given ``True``, the default field label 'Description' will also be used. -`use_code_name_methods` (`False`): Set to `True` in order to override the methods +``use_code_name_methods`` (``False``): Set to ``True`` in order to override the methods name_get and name_search, using those of analytic code. This allows the analytic code's description to be displayed (and searched) along with the entry's name in many2one fields targeting the model.