summaryrefslogtreecommitdiff
path: root/doc/reference
AgeCommit message (Collapse)Author
2021-05-04[MOV] doc: move documentation to a dedicated repositoryVictor Feyens
In odoo/documentation-user#945, the developer documentation is merged with the user documentation in a single repository and build config. This commit then removes source files for the developer documentation from the odoo/odoo repository. DOC PR: https://github.com/odoo/documentation-user/pull/945 task-2351938 task-2352371 task-2205684 task-2352544 Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
2021-03-08[FIX] web: FieldMany2Many: link/unlink optionsAaron Bohy
Commit [1] altered the way the FieldMany2Many behaves with respect to 'create' and 'delete' options. Indeed, for many2many fields, adding or removing records doesn't mean "creating" or "deleting" records, as it is only about adding/removing records to/from a relation. This is completely fine and correct. Unfortunately, a feature has been lost in the process: it is no longer possible to state that a many2many field should be editable but should not allow to add (or remove) record to the relation. This commit fixes the issue by adding two new options: 'link' and 'unlink' for that purpose. [1] https://github.com/odoo/odoo/commit/c98579d25af01c14df4baf57fb4652f3e7469096 opw~2466213 closes odoo/odoo#67358 Signed-off-by: Lucas Perais (lpe) <lpe@odoo.com>
2021-03-05[FIX] web: correctly edit Many2ManyCheckboxes with 100+ valuesAaron Bohy
The Many2ManyCheckboxes widget displays all values that could be in the many2many relation, with a checkbox indicating whether each value is in the relation or not. It is designed to be set on fields where the comodel contains a few records (typically, we don't want to see dozens of checkboxes in the form view). This widget shouldn't be used on many2manys with a large comodel, as we have better tools to handle them (like a tree view). We deal with extreme cases (when the widget is, by mistake, set on a field where the comodel is huge) by using the name_search limit of 100: at most 100 checkboxes are displayed. Before this commit, this extreme situation wasn't correctly handled. If there were in the relation records that weren't displayed (because they weren't inside the 100 limit), then, editing the value by (un)selecting a checkbox would automatically remove all non displayed values from the relation. This commit ensures that we keep in the relation all values that aren't displayed. Issue spotted when working on opw~2439041 closes odoo/odoo#67373 X-original-commit: fa324ef071952d749f635f878bee0fa462cfa011 Signed-off-by: Géry Debongnie (ged) <ged@openerp.com> Signed-off-by: Aaron Bohy (aab) <aab@odoo.com>
2021-03-05[ADD] doc: section on Escaping vs SanitizingMartin Trigaux
Source https://github.com/odoo/enterprise/pull/15297#issuecomment-768985663 closes odoo/odoo#67363 X-original-commit: d767e01ca02b702dbef22451fc1c72c996192708 Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2020-12-28[IMP] doc: add link to tutorial in client actions reference docAntoine Vandevenne (anv)
The doc for client actions is currently too minimalistic to be of much use. This commit adds a seealso linking to the related tutorial. task-2423824 closes odoo/odoo#63827 X-original-commit: 386e57cf48298162cd4c3bedfa6eb83d6ba4f6bd Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com> Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
2020-11-16[FIX] *: rephrase, correct typosMartin Trigaux
Courtesy of Transifex's translators for reporting bad/unclear sentences. closes odoo/odoo#61785 Related: odoo/enterprise#14751 Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2020-10-23[FIX] doc: fix broken anchorAntoine Vandevenne (anv)
closes odoo/odoo#60601 Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
2020-10-16[FIX] web, doc: remaining_days widgetNicolas Martinelli
The `remaining_days` widget is intended to be used for informative purpose, hence it should not be editable. opw-2362276
2020-10-19[FIX] *: update document linksSwapnesh Shah
Before this commit, links to the documentation were referenced the previous version, 13.0, instead of the current one, 14.0. Eventhough there is a redirection done by NGINX of a "versionless" URL to the latest one (e.g. /documentation/user/general/auth/google.html -> /documentation/user/14.0/general/auth/google.html as of today), the goal is to keep links owrking for users that will still be using the 14.0 in three years (and should not endup on the 17.0 doc). closes odoo/odoo#59554 Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2020-10-15[FIX] doc: unclear report actions fields and report tag attributes.Victor Feyens
FW-change: remove report section in data.rst since report xml tag usage is now deprecated (#54564) closes odoo/odoo#60129 X-original-commit: 3fdc64062eb9eaf1a345115da08dec3d69873330 Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2020-10-15[FIX] doc: warn about pitfalls of inverse batchingAdrian Torres
This commit updates the documentation surrounding compute and inverse methods for fields, explicitly warning API consumers that grouping multiple compute fields under a single inverse method is error-prone and could not work at all (it can still work under specific conditions but henceforth it shall be considered bad practice). This case was found at https://github.com/odoo/enterprise/pull/13815/commits/a651413df915f166697d26a83084582207405858 closes odoo/odoo#60103 X-original-commit: 1d21924c1da0bed59cd105a3d9bf9b60fa2d7bc4 Signed-off-by: Raphael Collet (rco) <rco@openerp.com> Signed-off-by: Adrian Torres (adt) <adt@odoo.com>
2020-10-13[FIX] doc: active is auto installedAdrien Horgnies
-- I confirm I have signed the CLA and read the PR guidelines at www.odoo.com/submit-pr closes odoo/odoo#59911 X-original-commit: 89c301b445cc415140367314bc5a858b4431b922 Signed-off-by: Martin Trigaux (mat) <mat@odoo.com> Signed-off-by: Adrien Horgnies <AdrienHorgnies@users.noreply.github.com>
2020-09-24[FIX] doc: fix some typing mistakes in guidelinesKaushalya Mandaliya
closes odoo/odoo#58322 closes odoo/odoo#58434 X-original-commit: 7ceb73d324cd90038c80a5c7d65d9f43fd4b264a Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2020-09-18[ADD] doc: sescurity pitfallsMartin Trigaux
Write guidelines on how to write secure code and avoid commons mistakes. Update outdated information and move existing security guidelines to the same section. closes odoo/odoo#58060 X-original-commit: 10184274fb6be1639d2047e863654ed5c7bef9f0 Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2020-09-16[FIX] doc: formatting/rendering issuesRaf Geens
This commits solves different rendering issues in the javascript reference documentation, following the work done in #57270, but for issues added in further versions and missed in the forward-port. Forward-port of #57758 Forward-port of #57775 closes odoo/odoo#57829 X-original-commit: 8885cf578468d34e740bada95440f092f10c6268 Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2020-09-16[IMP] doc: related fields do not support chained x2m dependenciesVictor Feyens
The behavior isn't exactly undefined: it will appear to work if the relation refers to only 1 instance. If there are multiple it will give results for 1 instance and ignore the others. This behavior should not be relied upon, hence I'm documenting it as undefined. I confirmed this with mat from the ORM team. Even better would be to raise an error or warning if `related` is used in this context. closes odoo/odoo#57270 closes odoo/odoo#57797 Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com> Signed-off-by: Raf Geens <raf-odoo@users.noreply.github.com> Co-authored-by: Raf Geens <raf@odoo.com>
2020-09-16[IMP] doc: Add example for `inherit_id` + `mode`Raf Geens
Added an example because it's non-trivial to realize why you would want to set `mode` to `primary` together with `inherit_id`. Another way to look at it is that the view matching doesn't understand delegation inheritance. If it did there would be no need to override `mode` because it would be able to see that the parent and derived views refer to related models. But since that feature might not be worth the effort, it's ok for me to just document the current situation.
2020-09-16[IMP] doc: Mention inherit_id needs a ref attributeRaf Geens
Also added an example.
2020-09-16[FIX] doc: Formatting issue with some bullet list linesRaf Geens
Some line items in a bulleted list would span a paragraph but the first line of the paragraph would be in bold and the rest would be indented and not bold below it. You would end up with sentences that broke off half in bold and half in the regular font. This was due to wrong indentation in the source. The pattern was also used for more legitimate cases (field descriptions), as well as borderline cases (where a section might have also worked). I've updated the borderline cases to have consistent formatting across the document and removed the bullet points that were prefixing description lists in both cases.
2020-09-16[REM] doc: Removed dead Javascript API doc and linkRaf Geens
MAT confirmed the Javascript API is currently not being built due to repeated compatibility problems between ES6 and the docstring output with no clear solution in sight.
2020-09-16[FIX] doc: Truncate 680-line example dataRaf Geens
The page shows the first 15 lines of a CSV in raw form as an example. Next it shows the same data rendered as a table. However, it was displaying the entire 680-line source data. `csv-table` doesn't have a `:lines:` directive. I copied and truncated the original file for use in the documentation.
2020-09-10[FIX] doc: 'nusery' typo in examplesRaf Geens
closes odoo/odoo#57451 X-original-commit: 3b4a0ab81a667c75ce11b8eec0cbf2469bc76f61 Signed-off-by: Richard Mathot (rim) <rim@openerp.com>
2020-09-10[IMP] doc: How to add a print action on a report recordRaf Geens
If you define a report using `<report>` it will implicitly add that action to a Print menu in the model's views. If you use ``<record>`` to do the same, that won't happen unless you also set `binding_model_id`. In older versions that wasn't really an issue because people mainly used `<report>`, but it was deprecated in 13.5, hence this update. And it applies to versions older than 13.5 as well, I tested until 11.0. X-original-commit: 6768d4190993e95b50785ac4ebf3be7213ef5e3f
2020-09-09[FIX] doc: binding_model_id isn't mandatory on actions.Victor Feyens
Remove this incoherent comment, and move the interesting information in the dedicated section. closes odoo/odoo#57382 X-original-commit: 1be2806045a6d92416a63364391e035ed36589f0 Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2020-09-08[FIX] doc: wrong list indentationNicolas Martinelli
closes odoo/odoo#57225 Signed-off-by: Nicolas Martinelli (nim) <nim@odoo.com>
2020-08-25[IMP] hw_*,point_of_sale: Cleaning IoT BoxAntoine Prieels
- Split driver.py to multiple files - Remove hw_proxy module as most of its routes were not used and move remaingin routes to a controller in hw_drivers - Add missing coding and license lines at the beginning of files - Reorder imports and remove unused ones - Rename device_id to device_identifier for clarity - Rename screen to display for consistency - Other minors improvements TaskID: 1973956
2020-08-21[FIX] doc: correct typos including a parameter nameRaf Geens
closes odoo/odoo#56232 Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2020-08-18[IMP] web: manage invisible fields in graph and pivot viewJérémy Hennecart
PURPOSE Be able to remove some measures from graph / pivot views. Currently fields are automatically added but some of them make no sense. SPECIFICATIONS Add the possibility to not display some fields in the measures dropdown for the graph and pivot views. When a field is not displayed in the measures of a pivot views we remove them also from the list of groupable fields. LINKS Task ID-2288381 Community PR #54774 Enterprise PR odoo/enterprise#11970 Upgrade PR odoo/upgrade#1519
2020-08-17[IMP] doc: add limit parameter to map viewMichael Mattiello (mcm)
This commit adds some doc for the new `limit` parameter of map view. Task id: 2150548 closes odoo/odoo#55856 Related: odoo/enterprise#10882 Signed-off-by: Vincent Schippefilt (vsc) <vsc@odoo.com>
2020-08-12[IMP] doc: update doc on view attribute 'sample'Mathieu Duckerts-Antoine
The attribute 'sample' is now also available for the reporting views (the cohort, dashboard, graph, and pivot views). Here, we simply extend the existing doc on the attribute. Task ID: 2282196
2020-08-11[FIX] web: Filter with domain disables category countersJulien Mougenot
Before this commit, the search panel was subject to some inconsistencies when dealing with a category having enabled counters and with a filter defining a "domain" attribute. Indeed, the counters could be in an incorrect state if the right filters/categories were not loaded first, with no simple way in doing so. The search panel being complex enough as it is, we decided to disable all categories' counters in the presence of a filter having a "domain" attribute regardless of said domain. closes odoo/odoo#55734 X-original-commit: e78f777bd8ccb314b85451cbc8d1dd9109997d7a Related: odoo/enterprise#12341 Signed-off-by: Aaron Bohy (aab) <aab@odoo.com>
2020-08-11[IMP] base,web: add scales param to calendarMichael Mattiello (mcm)
This commit adds the parameter `scales` in the calendar view's template. This parameter can be used to choose which mode(s) is/are allowed. This commit also refactors the way we manage calendar scales. Before scales were defined in model and renderer, now it's defined in the view and given to model, controller and renderer by params. Task: 2193921
2020-08-11[IMP] base,web: add year scale to calendarMichael Mattiello (mcm)
This commit adds a new year scale to the calendar view. It comes with a new view in the calendar, this view displays a 4x3 grid which cells are month views. Task: 2193921
2020-08-04[DOC] doc: Document "today" and "now" in contextJulien Mougenot
Documentation of the affected blocks have been updated to inform about the contents of the "today" and "now" context values. closes odoo/odoo#54438 Related: odoo/enterprise#11831 Signed-off-by: Aaron Bohy (aab) <aab@odoo.com>
2020-07-28[FIX] doc: remove <act_window> and <report>Xavier Morel
* remove <report> and <act_window> form the backend tutorial * remove documentation for <report> in the report doc Also various fixes and improvements: * add ACL to the wizard in the tutorial, as transients now require ACLs * fix indentation & spacing in rST * reword a few bits * improve styling of footnote references (and recompile stylesheet with recent lessc which apparently changes its output formatting quite a bit)
2020-07-28[IMP] core: orm docXavier Morel
* fix link from backend tutorial to log_access section * flesh out log access documentation * add documentation for log_access itself & improve doc for a few other model-level attributes
2020-07-27[FIX] doc/views: header should be outside of sheet tag.Victor Feyens
Forward-Port-Of: #54984 Original commit: d5e807e47edc641c8d9d97fe59d8d9eba40bd5af closes odoo/odoo#55015 X-original-commit: e2c358adc7de11de28f18dbe36963ba71f95dd19 Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2020-07-27[FIX] doc/views: templates attribute isn't supported in calendar views.Victor Feyens
Since https://github.com/odoo/odoo/commit/369c20a99bd25172f72f4efde870172a4729aadc: event cards cannot be customized anymore, only the popover is adapted depending on <field> attributes inside the calendar tag. Forward-Port-Of: #54984 original commit: 920599a46e1221c03a20e005a7ad5c61fa9107a0 X-original-commit: ef18d482a58bbff24ce1217619df603ec4670002
2020-07-27[IMP] web: Drop widget support in search viewJulien Mougenot
Until now the "widget" attribute used in the search view was meant to force the type of a field regardless of its definition. This system was implemented quite a long time ago and is now useful in only one case: searching for "reference" fields (we want them considered as char fields else it is impossible to search on them). This is why this commit completely removes the "widget" attribute support in search views while consistently casting the "reference" fields as "char" fields in the search bar. Task 2061795
2020-07-23[IMP] doc: _inherits usage warningsVictor Feyens
The delegation inheritance is very useful in some cases, but its usage shouldn't be encouraged. Furthermore, chained _inherits may result in unexpected behavior/results, and really shouldn't be used. closes odoo/odoo#54864 X-original-commit: 4a06a4c79e962906832f98147fe87a2c19efaa75 Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2020-07-22[FIX] doc: fix typo in guidelinesIvan Yelizariev
You can see on example below the updated line that it's module_name and not model_name <!-- security --> <record id="module_name_group_user" model="res.groups"> ... </record> closes odoo/odoo#54756 X-original-commit: 56de03befa16eeaaec211b5fc08116ce778b52b7 Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2020-07-20[FIX] doc: rST definition lists must be preceded by an empty lineXavier Morel
Otherwise the reStructuredText parser thinks the first definition title is part of the preceding paragraph, and the definition item is interpreted as a quote due to the indentation. closes odoo/odoo#54709 Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com>
2020-07-16[FIX] doc: update cloc documentationThibault Francois
After the commit 2a57a156c7b8e81c01afa095b3291361d208611f Cloc excluded by default one more folder, it should appear in the documentation of the tools closes odoo/odoo#54609 X-original-commit: 93261c787d1152c94856ef31a1600a4cdab8b83b Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2020-07-02[IMP] web: form: labels of several occurrences of a fieldAaron Bohy
Before this commit, when the same field occurred multiple times in a form view, all occurrences were associated with the same id, and all occurrences of the corresponding label (if any) had the same 'for' attribute. As a consequence, besides the fact that there were warnings in the chrome console, clicking on any occurrence of the duplicated label focuses the first occurrence of the field. This commit generates a unique id for each pair label/field, when possible. However, there is a case that can't be handled automatically: when the label isn't automatically generated (field located outside a group, or with nolabel attribute set to "1"). Typically, in this case, there is a <label> node with "for" attribute referencing the associated field. In this situation, the id must be defined in the arch, and used in the "for" attribute: <form> <label for="phone"/><field name="phone"/> <label for="phone_2"/><field name="phone" id="phone_2"/> </form> Task 2261697
2020-07-01[IMP] doc: added doc for static templates inheritanceJulien Mougenot
closes odoo/odoo#53923 X-original-commit: b22e71097c0382f5153825792c5283380f22a821 Signed-off-by: Aaron Bohy (aab) <aab@odoo.com> Signed-off-by: Julien Mougenot (jum) <jum@odoo.com>
2020-07-01[REF] doc: remove link to js APIMathieu Duckerts-Antoine
The page with the documentation on all js docstrings is regularly broken. We remove here the link referencing it. closes odoo/odoo#53911 Signed-off-by: Aaron Bohy (aab) <aab@odoo.com>
2020-06-22[IMP] web: add support of "sample" attribute in viewsJérémy Hennecart
With this commit, it is now possible to display sample (fake) data in empty views, in the hope of easing user onboarding. This can be enabled (in list and kanban views) with attribute sample="1" on the arch root element. In this case, if there is no data to display, sample data will be generated based on heuristics (depending on field types and names). This can be used in addition to the no content helper. Task 2232801 X-original-commit: 7c8e627ff5029cb539d702705e5ce53d658c76ed Co-authored-by: Aaron Bohy <aab@odoo.com> Co-authored-by: Mathieu Duckerts-Antoine <dam@odoo.com> Co-authored-by: Jérémy Hennecart <jeh@odoo.com> Co-authored-by: Julien Mougenot <jum@odoo.com>
2020-06-18[IMP] tools: add placeholder support to _Martin Trigaux
Mimic the syntax of logging to use placeholders in translatable message. The main advantage is to be able to fallback on the source term if the translation can not be formatted properly. It is very common to have errors in translations with missing placeholders or badly translated (ie. the source "%(subject)s" -> "%(sujet)s"). Instead of blocking the execution of the code, fallback on source string. Task-id: 1853119
2020-06-12[IMP] *: limit in search panelMathieu Duckerts-Antoine
This commit introduces a new attribute 'limit' for search panel fields that allows to avoid performance issues. That integer attribute (with default 200) allows to fix a maximal number of values to display for the fields. When the number of field values to display reaches the limit, no values will be displayed. Instead, a warning message will be shown in the corresponding search panel section. Note it is possible to have no limit using limit="0" on a field. This commit reintroduces in a better way the principle brought by the fix 8d57153b34c04952a85f6642951cb2697016da84. Task ID: 2154749
2020-06-12[IMP] *: expand and hierarchize in search panelMathieu Duckerts-Antoine
The commit introduces two new attributes for search panel fields: - hierarchize: boolean attribute (default True) available for many2one fields with select="one". It allows to choose whether to hierarchize the field values using the _parent_name (if set) on the field comodel. Note that a sanitization of the parent hierarchy takes place. Basically, it ensures that parent chains are completely in the domain (on comodel) accessible by the user. See _search_panel_sanitized_parent_hierarchy documentation for more information. - expand: boolean attribute (default False) available for many2one and many2many fields. If set to true, all field values are fetched and displayed in the search panel. If set to false, only the values that have at least one corresponding value in the field model (and in some domain) are fetched. An exception in the case of an hierarchized field (hierarchize=True and _parent_name set): more/less values can be displayed in order to have a good representation of the parent hierarchy. That means we complete and sanitize the set of initial field image values. Note that the fix 8d57153b34c04952a85f6642951cb2697016da84 bringing the notion of limit in search panel has been reverted in the present commit. An upcomming commit will reintroduce the limit principle in a better way. Task ID: 2154749 Co-authored-by: Mathieu Duckerts-Antoine <dam@odoo.com> Co-authored-by: Julien Mougenot <jum@odoo.com>