Skip to content
Snippets Groups Projects
Commit a4c8ad4c authored by Brendan Masson's avatar Brendan Masson
Browse files

README.rst fixed

parent 490c4a52
No related branches found
No related tags found
No related merge requests found
......@@ -149,8 +149,8 @@
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.
......@@ -153,8 +153,8 @@
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.
......@@ -158,6 +158,6 @@
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.
......@@ -162,4 +162,4 @@
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,
......@@ -165,3 +165,3 @@
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``.
......@@ -167,5 +167,5 @@
`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.
......@@ -169,7 +169,7 @@
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``.
......@@ -175,7 +175,7 @@
`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.
......@@ -177,7 +177,7 @@
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.
......@@ -183,3 +183,3 @@
`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.
......@@ -185,3 +185,3 @@
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.
......@@ -187,5 +187,5 @@
`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.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment