[REF] stock: refactoring of recompute stock operation links
[odoo/odoo.git] / doc / 03_module_dev_01.rst
index adc32c4..0fbca9d 100644 (file)
@@ -172,73 +172,40 @@ is as follows:
      </data>
    </openerp>
 
-``<record>``
-////////////
-
-Defines a new record in a specified OpenERP model.
-
-``@model`` (required)
-
-    Name of the model in which this record will be created/inserted.
-
-``@id`` (optional)
-
-    :term:`external ID` for the record, also allows referring to this record in
-    the rest of this file or in other files (through ``field/@ref`` or the
-    :py:func:`ref() <openerp.tools.convert._ref>` function)
-
-A record tag generally contains multiple ``field`` tags specifying the values
-set on the record's fields when creating it. Fields left out will be set to
-their default value unless required.
-
-``<field>``
-///////////
+Record Tag
+//////////
 
-In its most basic use, the ``field`` tag will set its body (as a string) as
-the value of the corresponding ``record``'s ``@name`` field.
+**Description**
 
-Extra attributes can either preprocess the body or replace its use entirely:
+The addition of new data is made with the record tag. This one takes a
+mandatory attribute : model. Model is the object name where the insertion has
+to be done. The tag record can also take an optional attribute: id. If this
+attribute is given, a variable of this name can be used later on, in the same
+file, to make reference to the newly created resource ID.
 
-``@name`` (mandatory)
+A record tag may contain field tags. They indicate the record's fields value.
+If a field is not specified the default value will be used.
 
-    Name of the field in the containing ``record``'s model
+The Record Field tag
+////////////////////
 
-``@type`` (optional)
+The attributes for the field tag are the following:
 
-    One of ``char``, ``int``, ``float``, ``list``, ``tuple``, ``xml`` or
-    ``html`` or ``file``. Converts the ``field``'s body to the specified type
-    (or validates the body's content)
-
-    * ``xml`` will join multiple XML nodes under a single ``<data>`` root
-    * in ``xml`` and ``html``, external ids can be referenced using
-      ``%(id_name)s``
-    * ``list`` and ``tuple``'s element are specified using ``<value>``
-      sub-nodes with the same attributes as ``field``.
-    * ``file`` expects a module-local path and will save the path prefixed with
-      the current module's name, separated by a ``,`` (comma). For use with
-      :py:func:`~openerp.modules.module.get_module_resource`.
-
-``@model``
-
-    Model used for ``@search``'s search, or registry object put in context for
-    ``@eval``. Required if ``@search`` but optional if ``@eval``.
-
-``@eval`` (optional)
-
-    A Python expression evaluated to obtain the value to set on the record
-
-``@ref`` (optional)
+name : mandatory
+  the field name
 
-    Links to an other record through its :term:`external id`. The module prefix
-    may be ommitted to link to a record defined in the same module.
+eval : optional
+  python expression that indicating the value to add
+  
+ref
+  reference to an id defined in this file
 
-``@search`` (optional)
+model
+  model to be looked up in the search
 
-    Search domain (evaluated Python expression) into ``@model`` to get the
-    records to set on the field.
+search
+  a query
 
-    Sets all the matches found for m2m fields, the first id for other field
-    types.
 
 **Example**