diff --git a/content/applications/essentials/reporting.rst b/content/applications/essentials/reporting.rst index 7fcea074a..224dbc361 100644 --- a/content/applications/essentials/reporting.rst +++ b/content/applications/essentials/reporting.rst @@ -50,9 +50,9 @@ edit it, click :guilabel:`Measures` and choose one or, only for pivots, multiple .. note:: When you select a measure, Odoo aggregates the values recorded on that field for the filtered - records. Only numerical fields (:ref:`integer `, - :ref:`decimal `, :ref:`monetary - `) can be measured. In addition, the :guilabel:`Count` + records. Only numerical fields (:ref:`integer `, + :ref:`decimal `, :ref:`monetary + `) can be measured. In addition, the :guilabel:`Count` option is used to count the total number of filtered records. After choosing what you want to measure, you can define how the data should be :ref:`grouped diff --git a/content/applications/studio/automated_actions.rst b/content/applications/studio/automated_actions.rst index 4bd9d0d42..196713b86 100644 --- a/content/applications/studio/automated_actions.rst +++ b/content/applications/studio/automated_actions.rst @@ -214,7 +214,7 @@ This action allows to update one of the record's (related) fields. Click the :gu field and, in the list that opens, select or search for the field to be updated; click the right arrow next to the field name to access the list of related fields if needed. -If you selected a :ref:`many2many field `, choose whether +If you selected a :ref:`many2many field `, choose whether the field must be updated by :guilabel:`Adding`, :guilabel:`Removing`, or :guilabel:`Setting it to` the selected value or by :guilabel:`Clearing it`. @@ -230,7 +230,7 @@ the selected value or by :guilabel:`Clearing it`. Alternatively, you can also set a record's field dynamically using Python code. To do so, select :guilabel:`Compute` instead of :guilabel:`Update`, then enter the code to be used for computing the field's value. For example, if you want the automation rule to compute a custom - :ref:`datetime field ` when a task's priority is set to + :ref:`datetime field ` when a task's priority is set to `High` (by starring the task), you can define the trigger :guilabel:`Priority is set to` to `High` and define the :guilabel:`Update Record` action as follows: @@ -307,8 +307,8 @@ triggered the creation of the new record. .. note:: The dropdown list related to the :guilabel:`Link Field` field only contains :ref:`one2many fields - ` existing on the current model that are linked to a - :ref:`many2one field ` on the target model. + ` existing on the current model that are linked to a + :ref:`many2one field ` on the target model. .. tip:: You can create another automation rule with :ref:`studio/automated-actions/action/update-record` diff --git a/content/applications/studio/fields.rst b/content/applications/studio/fields.rst index e27df09de..d92b0fd8c 100644 --- a/content/applications/studio/fields.rst +++ b/content/applications/studio/fields.rst @@ -23,9 +23,9 @@ Simple fields Simple fields contain basic values, such as text, numbers, files, etc. .. note:: - Non-default widgets, when available, are presented as bullet points below. + Non-default widgets, when available, are presented as bullet points or sub-headings below. -.. _studio/fields/simple-fields/text: +.. _studio/fields/simple-fields-text: Text (`char`) ------------- @@ -42,7 +42,7 @@ displayed when filling out the field. .. note:: This works differently than selecting the :ref:`Image field - ` directly, as the image is not stored in Odoo when using a + ` directly, as the image is not stored in Odoo when using a :guilabel:`Text` field with the :guilabel:`Image` widget. For example, it can be useful if you want to save disk space. @@ -57,10 +57,9 @@ displayed when filling out the field. .. example:: .. image:: fields/text-examples.png - :align: center :alt: Examples of Text fields with different widgets -.. _studio/fields/simple-fields/multiline-text: +.. _studio/fields/simple-fields-multiline-text: Multiline Text (`text`) ----------------------- @@ -73,10 +72,9 @@ text lines are displayed on the UI when filling out the field. .. example:: .. image:: fields/multiline-text-examples.png - :align: center :alt: Examples of Multiline Text fields with different widgets -.. _studio/fields/simple-fields/integer: +.. _studio/fields/simple-fields-integer: Integer (`integer`) ------------------- @@ -94,10 +92,9 @@ without a decimal`). .. example:: .. image:: fields/integer-examples.png - :align: center :alt: Examples of Integer fields with different widgets -.. _studio/fields/simple-fields/decimal: +.. _studio/fields/simple-fields-decimal: Decimal (`float`) ----------------- @@ -110,7 +107,7 @@ with a decimal`). stored in the database with more precision. - :guilabel:`Monetary`: it is similar to using the :ref:`Monetary field - `. It is recommended to use the later as it offers more + `. It is recommended to use the latter as it offers more functionalities. - :guilabel:`Percentage`: displays a percent character `%` after the value. - :guilabel:`Percentage Pie`: displays the value inside a percentage circle, usually for a computed @@ -122,10 +119,9 @@ with a decimal`). .. example:: .. image:: fields/decimal-examples.png - :align: center :alt: Examples of Decimal fields with different widgets -.. _studio/fields/simple-fields/monetary: +.. _studio/fields/simple-fields-monetary: Monetary (`monetary`) --------------------- @@ -140,10 +136,9 @@ The :guilabel:`Monetary` field is used for all monetary values. .. example:: .. image:: fields/monetary-example.png - :align: center :alt: Example of a Monetary field along with its Currency field -.. _studio/fields/simple-fields/html: +.. _studio/fields/simple-fields-html: Html (`html`) ------------- @@ -155,10 +150,9 @@ The :guilabel:`Html` field is used to add text that can be edited using the Odoo .. example:: .. image:: fields/html-example.png - :align: center :alt: Examples of Html fields with different widgets -.. _studio/fields/simple-fields/date: +.. _studio/fields/simple-fields-date: Date (`date`) ------------- @@ -166,15 +160,14 @@ Date (`date`) The :guilabel:`Date` field is used to select a date on a calendar. - :guilabel:`Remaining Days`: the remaining number of days before the selected date is displayed - (e.g., *In 5 days*), based on the current date. + (e.g., *In 5 days*), based on the current date. This field should be set to :guilabel:`Read only`. .. example:: .. image:: fields/date-examples.png - :align: center :alt: Examples of Date fields with different widgets -.. _studio/fields/simple-fields/date-time: +.. _studio/fields/simple-fields-date-time: Date & Time (`datetime`) ------------------------ @@ -182,17 +175,63 @@ Date & Time (`datetime`) The :guilabel:`Date & Time` field is used to select a date on a calendar and a time on a clock. The user's current time is automatically used if no time is set. -- :guilabel:`Date`: used to record the time without displaying it on the UI. -- :guilabel:`Remaining days`: displays the remaining number of days before the selected date (e.g., - *In 5 days*), based on the current date and time. +.. tip:: + + As well as :ref:`general properties `, some + :ref:`specific properties ` are available for + :guilabel:`Date & Time` fields that have the :guilabel:`Date & Time` or :guilabel:`Date Range` + widget set. + +Date Range (`daterange`) +~~~~~~~~~~~~~~~~~~~~~~~~ + +The :guilabel:`Date Range` widget is used to display a period of time defined by a start date and an +end date in a single line. A date range can have a mandatory start and end date, e.g., for a +multi-day event, or allow an optional start or end date, e.g., for a field service intervention or a +project task. + +Adding a date range requires two fields: a :guilabel:`Date & Time` field with the +:guilabel:`Date Range` widget set and another field that is selected as the start date *or* end +date. This underlying field can be an existing :ref:`Date ` +or :guilabel:`Date & Time` field, or one created specifically for this purpose. + +To add a date range: + +#. Identify an existing :guilabel:`Date` or :guilabel:`Date & Time` field that can be used as the + underlying start/end date field, or add a new one. If the date range: + + - has a mandatory start date and end date, this field can be either the start date or end date; + the outcome is the same. + - allows an optional start or end date, this field is the start date or end date, respectively. + + .. tip:: + To avoid displaying the same information twice, the underlying start/end date field can be + made invisible by enabling :guilabel:`Invisible` or removed from the view by clicking + :guilabel:`Remove from view`. + +#. Add a :guilabel:`Date & Time` field and set the :guilabel:`Widget` field to + :guilabel:`Date Range`. +#. Enter an appropriate :guilabel:`Label`. +#. Select the underlying start/end date field from the :guilabel:`Start date field` or + :guilabel:`End date field` dropdown, as relevant. +#. If the date range should have a mandatory start and end date, enable :guilabel:`Always range`. +#. Update any other :ref:`general properties ` or specific + :ref:`properties for Date & Time fields ` as needed, then + click :guilabel:`Close` in the upper right corner of the screen. .. example:: .. image:: fields/date-time-examples.png - :align: center :alt: Examples of Date & Time fields with different widgets -.. _studio/fields/simple-fields/checkbox: +Remaining Days (`remaining_days`) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The :guilabel:`Remaining Days` widget displays the remaining number of days before the selected date +(e.g., *In 5 days*), based on the current date and time. This field should be set to :guilabel:`Read +only`. + +.. _studio/fields/simple-fields-checkbox: Checkbox (`boolean`) -------------------- @@ -206,10 +245,9 @@ checking or unchecking a checkbox. .. example:: .. image:: fields/checkbox-examples.png - :align: center :alt: Examples of Checkbox fields with different widgets -.. _studio/fields/simple-fields/selection: +.. _studio/fields/simple-fields-selection: Selection (`selection`) ----------------------- @@ -223,31 +261,36 @@ predefined values. organized horizontally. - :guilabel:`Priority`: displays star symbols instead of values, which can be used to indicate an importance or satisfaction level, for example. This has the same effect as selecting the - :ref:`Priority field `, although, for the latter, four + :ref:`Priority field `, although, for the latter, four priority values are already predefined. - :guilabel:`Radio`: displays all selectable values at the same time as radio buttons. .. tip:: - By default, radio buttons are organized vertically. Tick :guilabel:`display horizontally` to + By default, radio buttons are organized vertically. Enable :guilabel:`Display horizontally` to switch the way they are displayed. +- :guilabel:`Status Bar`: displays all selectable values at the same time as an arrow progress bar. + + .. tip:: + By default, values on the status bar are selectable. Disable :guilabel:`Clickable` to prevent + the value being edited on the UI. + .. example:: .. image:: fields/selection-examples.png - :align: center :alt: Examples of Selection fields with different widgets -.. _studio/fields/simple-fields/priority: +.. _studio/fields/simple-fields-priority: Priority (`selection`) ---------------------- The :guilabel:`Priority` field is used to display a three-star rating system, which can be used to indicate importance or satisfaction level. This field type is a :ref:`Selection field -` with the :guilabel:`Priority` widget selected by default +` with the :guilabel:`Priority` widget selected by default and four priority values predefined. Consequently, the :guilabel:`Badge`, :guilabel:`Badges`, :guilabel:`Radio`, and :guilabel:`Selection` widgets have the same effects as described under -:ref:`Selection `. +:ref:`Selection `. .. tip:: To change the number of available stars by adding or removing values, click :guilabel:`Edit @@ -257,10 +300,9 @@ and four priority values predefined. Consequently, the :guilabel:`Badge`, :guila .. example:: .. image:: fields/priority-example.png - :align: center :alt: Example of a Priority field -.. _studio/fields/simple-fields/file: +.. _studio/fields/simple-fields-file: File (`binary`) --------------- @@ -270,48 +312,47 @@ widget). - :guilabel:`Image`: users can upload an image file, which is then displayed in :ref:`Form view `. This has the same effect as using the :ref:`Image field - `. + `. - :guilabel:`PDF Viewer`: users can upload a PDF file, which can be then browsed from the :ref:`Form view `. - :guilabel:`Sign`: users can electronically sign the form. This has the same effect as selecting - the :ref:`Sign field `. + the :ref:`Sign field `. .. example:: .. image:: fields/file-examples.png - :align: center :alt: Examples of File fields with different widgets -.. _studio/fields/simple-fields/image: +.. _studio/fields/simple-fields-image: Image (`binary`) ---------------- The :guilabel:`Image` field is used to upload an image and display it in :ref:`Form view `. This field type is a :ref:`File field -` with the :guilabel:`Image` widget selected by default. +` with the :guilabel:`Image` widget selected by default. Consequently, the :guilabel:`File`, :guilabel:`PDF Viewer`, and :guilabel:`Sign` widgets have the -same effects as described under :ref:`File `. +same effects as described under :ref:`File `. .. tip:: To change the display size of uploaded images, select :guilabel:`Small`, :guilabel:`Medium`, or :guilabel:`Large` under the :guilabel:`Size` option. -.. _studio/fields/simple-fields/sign: +.. _studio/fields/simple-fields-sign: Sign (`binary`) --------------- The :guilabel:`Sign` field is used to sign the form electronically. This field type is a :ref:`File -field ` with the :guilabel:`Sign` widget selected by default. +field ` with the :guilabel:`Sign` widget selected by default. Consequently, the :guilabel:`File`, :guilabel:`Image`, and :guilabel:`PDF Viewer` widgets have the -same effects as described under :ref:`File `. +same effects as described under :ref:`File `. .. tip:: To give users the :guilabel:`Auto` option when having to draw their signature, select one of the - available :guilabel:`Auto-complete with` fields (:ref:`Text `, - :ref:`Many2One `, and :ref:`Related Field - ` on the model only). The signature is + available :guilabel:`Auto-complete with` fields (:ref:`Text `, + :ref:`Many2One `, and :ref:`Related Field + ` on the model only). The signature is automatically generated using the data from the selected field. .. _studio/fields/relational-fields: @@ -324,7 +365,7 @@ Relational fields are used to link and display the data from records on another .. note:: Non-default widgets, when available, are presented as bullet points below. -.. _studio/fields/relational-fields/many2one: +.. _studio/fields/relational-fields-many2one: Many2One (`many2one`) --------------------- @@ -338,7 +379,6 @@ being edited. The record's name from the other model is then displayed on the re contact (customer). .. image:: fields/many2one-diagram.png - :align: center :alt: Diagram showing a many2one relationship .. tip:: @@ -351,7 +391,7 @@ being edited. The record's name from the other model is then displayed on the re be edited on the UI. - :guilabel:`Radio`: displays all selectable values at the same time as radio buttons. -.. _studio/fields/relational-fields/one2many: +.. _studio/fields/relational-fields-one2many: One2Many (`one2many`) --------------------- @@ -364,15 +404,14 @@ current model and multiple records from another model. **many** sales orders. .. image:: fields/one2many-diagram.png - :align: center :alt: Diagram showing a one2many relationship .. note:: To use a :guilabel:`One2Many` field, the two models must have been linked already using a - :ref:`Many2One field `. One2Many relations do not exist + :ref:`Many2One field `. One2Many relations do not exist independently: a reverse-search of existing Many2One relations is performed. -.. _studio/fields/relational-fields/lines: +.. _studio/fields/relational-fields-lines: Lines (`one2many`) ------------------ @@ -388,10 +427,9 @@ products on a sales order). .. example:: .. image:: fields/lines-example.png - :align: center :alt: Example of a Lines field -.. _studio/fields/relational-fields/many2many: +.. _studio/fields/relational-fields-many2many: Many2Many (`many2many`) ----------------------- @@ -399,7 +437,7 @@ Many2Many (`many2many`) The :guilabel:`Many2Many` field is used to link multiple records from another model to multiple records on the current model. Many2Many fields can use :guilabel:`Disable creation`, :guilabel:`Disable opening`, :guilabel:`Domain`, just like :ref:`Many2One fields -`. +`. .. example:: On the *Task* model, the :guilabel:`Assignees` field is a :guilabel:`Many2Many` field pointing at @@ -407,24 +445,23 @@ records on the current model. Many2Many fields can use :guilabel:`Disable creati users to be assigned to a single task. .. image:: fields/many2many-diagram.png - :align: center :alt: Diagram showing many2many relationships - :guilabel:`Checkboxes`: users can select several values using checkboxes. - :guilabel:`Tags`: users can select several values appearing in rounded shapes, also known as *tags*. This has the same effect as selecting the :ref:`Tags field - `. + `. -.. _studio/fields/relational-fields/tags: +.. _studio/fields/relational-fields-tags: Tags (`many2many`) ------------------ The :guilabel:`Tags` field is used to display several values from another model appearing in rounded shapes, also known as *tags*. This field type is a :ref:`Many2Many field -` with the :guilabel:`Tags` widget selected by default. +` with the :guilabel:`Tags` widget selected by default. Consequently, the :guilabel:`Checkboxes` and :guilabel:`Many2Many` widgets have the same effects as -described under :ref:`Many2Many `. +described under :ref:`Many2Many `. .. tip:: To display tags with different background colors, tick :guilabel:`Use colors`. @@ -432,10 +469,9 @@ described under :ref:`Many2Many `. .. example:: .. image:: fields/tags-example.png - :align: center :alt: Example of a Tags field -.. _studio/fields/relational-fields/related-field: +.. _studio/fields/relational-fields-related-field: Related Field (`related`) ------------------------- @@ -452,42 +488,84 @@ models. It uses an existing relationship to fetch and display information from a Properties ========== -- :guilabel:`Invisible`: When it is not necessary for users to view a field on the UI, tick - :guilabel:`Invisible`. It helps clear the UI by only showing the essential fields depending on a - specific situation. +General properties +------------------ + +- :guilabel:`Invisible`: Enable this property when it is not necessary for users to view a field on + the UI. This helps declutter the UI by only showing the essential fields depending on a specific + situation. + + The :guilabel:`Invisible` attribute also applies inside Studio. To view hidden fields in Studio, + click on a view's :guilabel:`View` tab and enable :guilabel:`Show Invisible Elements`. + +- :guilabel:`Required`: Enable this property if a field should always be completed by the user + before being able to proceed. + +- :guilabel:`Readonly`: Enable this property if users should not be able to modify a field. + +.. note:: + You can choose to enable :guilabel:`Invisible`, :guilabel:`Required` and :guilabel:`Readonly` + for specific records only by clicking on :guilabel:`Conditional` and creating a filter. .. example:: On the *Form* view of the *Contact* model, the :guilabel:`Title` field only appears when :guilabel:`Individual` is selected, as that field would not be helpful for a :guilabel:`Company` contact. - .. note:: - The :guilabel:`Invisible` attribute also applies to Studio. To view hidden fields inside - Studio, click on a view's :guilabel:`View` tab and tick :guilabel:`Show Invisible - Elements`. +- :guilabel:`Label`: the field's name on the UI. This is not the name used in the PostgreSQL + database. To view and change the latter, activate the :ref:`developer mode ` and + edit the :guilabel:`Technical Name`. -- :guilabel:`Required`: If a field should always be completed by the user before being able to - proceed, tick :guilabel:`Required`. -- :guilabel:`Read only`: If users should not be able to modify a field, tick :guilabel:`Read only`. +- :guilabel:`Help Tooltip`: To explain the purpose of a field, add a description. The text is + displayed inside a tooltip box when hovering with your mouse over the question mark beside the + field's label. - .. note:: - You can choose to apply these three properties only for specific records by clicking on - :guilabel:`Conditional` and creating a filter. - -- :guilabel:`Label`: The :guilabel:`Label` is the field's name on the UI. - - .. note:: - This is not the same name as used in the PostgreSQL database. To view and change the latter, - activate the :ref:`Developer mode `, and edit the :guilabel:`Technical Name`. - -- :guilabel:`Help Tooltip`: To explain the purpose of a field, write a description under - :guilabel:`Help Tooltip`. It is displayed inside a tooltip box when hovering with your mouse over - the field's label. -- :guilabel:`Placeholder`: To provide an example of how a field should be completed, write it under - :guilabel:`Placeholder`. It appears in light gray as a placeholder until a value is entered. - :guilabel:`Widget`: To change the default appearance or functionality of a field, select one of the available widgets. -- :guilabel:`Default value`: To add a default value to a field when a record is created, use - :guilabel:`Default value`. -- :guilabel:`Limit visibility to groups`: To limit which users can see the field, select a user - access group. + +- :guilabel:`Placeholder`: To provide an example of how a field should be completed, add placeholder + text. The text appears in light gray until a value is entered. + +- :guilabel:`Default value`: To display a default value in a field when a record is created, add a + value. + +- :guilabel:`Allow visibility to groups`: To limit which users can view the field, select one or + more user access :ref:`groups `. +- :guilabel:`Forbid visibility to groups`: To prevent certain users from seeing the field, select + one or more user access :ref:`groups `. + +.. _studio/fields/properties-date-datetime: + +Properties for Date & Time fields +--------------------------------- + +For :guilabel:`Date & Time` fields that have the :guilabel:`Date & Time` or :guilabel:`Date Range` +widget set, some specific properties are available: + +- :guilabel:`Minimal precision`: Determine the smallest date unit that must be selected in the date + selector. The possible values are :guilabel:`Day`, :guilabel:`Month`, :guilabel:`Year` or + :guilabel:`Decade`. If no value is selected, the user must select a day in the date selector. +- :guilabel:`Maximal precision`: Determine the largest date unit that can be used to navigate the + date selector. The possible values are :guilabel:`Day`, :guilabel:`Month`, :guilabel:`Year` or + :guilabel:`Decade`. If no value is selected, the user can navigate the date selector by decade. +- :guilabel:`Warning for future dates`: Enable this property to display a warning icon if a future + date is selected. +- :guilabel:`Condensed display`: Enable this property to show days, months and hours with no leading + zeros, e.g., `4/2/2025 8:05:00` instead of `04/02/2025 08:05:00`. +- :guilabel:`Show time`: This property is enabled by default for :guilabel:`Date & Time` fields. On + a read-only field, disable the property to show only the date. This can keep a list view less + cluttered, for example. +- :guilabel:`Show seconds`: This property is enabled by default for :guilabel:`Date & Time` fields. + Disable the property to show only hours and minutes. +- :guilabel:`Time interval`: Enter a value to determine the minute intervals shown in the time + selector. For example, enter 15 to allow quarter-hour intervals. The default value is set to 5 + minutes. +- :guilabel:`Earliest accepted date`: Enter the earliest date that can be selected in the date + selector in ISO-format, i.e., `YYYY-MM-DD`. If the current date is always the earliest accepted + date, enter `today`. On the date selector, dates prior to the earliest accepted date are grayed + out. +- :guilabel:`Latest accepted date`: Enter the latest date that can be selected in the date + selector in ISO-format, i.e., `YYYY-MM-DD`. If the current date is always the latest accepted + date, enter `today`. On the date selector, dates later than the latest accepted date are grayed + out. + diff --git a/content/applications/studio/fields/date-time-examples.png b/content/applications/studio/fields/date-time-examples.png index 77b86201e..d6b8bc72b 100644 Binary files a/content/applications/studio/fields/date-time-examples.png and b/content/applications/studio/fields/date-time-examples.png differ diff --git a/content/applications/studio/fields/selection-examples.png b/content/applications/studio/fields/selection-examples.png index c94b01c06..4e887f3d6 100644 Binary files a/content/applications/studio/fields/selection-examples.png and b/content/applications/studio/fields/selection-examples.png differ diff --git a/content/applications/studio/models_modules_apps.rst b/content/applications/studio/models_modules_apps.rst index af2dbdf87..9c02fa2b4 100644 --- a/content/applications/studio/models_modules_apps.rst +++ b/content/applications/studio/models_modules_apps.rst @@ -39,8 +39,8 @@ Contact details --------------- Selecting :guilabel:`Contact details` adds to the :ref:`Form view ` a -:ref:`Many2One field ` linked to the *Contact* model and -two of its :ref:`Related Fields `: :guilabel:`Phone` +:ref:`Many2One field ` linked to the *Contact* model and +two of its :ref:`Related Fields `: :guilabel:`Phone` and :guilabel:`Email`. The :guilabel:`Contact` field is also added to the :ref:`List view `, and the :ref:`Map view ` is activated. @@ -57,7 +57,7 @@ User assignment --------------- Selecting :guilabel:`User assignment` adds to the :ref:`Form view ` a -:ref:`Many2One field ` linked to the *Contact* model, with +:ref:`Many2One field ` linked to the *Contact* model, with the following :guilabel:`Domain`: `Share User is not set` to only allow the selection of *Internal Users*. In addition, the :guilabel:`many2one_avatar_user` widget is used to display the user's avatar. The :guilabel:`Responsible` field is also added to the :ref:`List view @@ -75,7 +75,7 @@ Date & Calendar --------------- Selecting :guilabel:`Date & Calendar` adds to the :ref:`Form view ` a -:ref:`Date field ` and activates the :ref:`Calendar view +:ref:`Date field ` and activates the :ref:`Calendar view `. .. _studio/models-modules-apps/suggested-features/date-range-gantt: @@ -84,7 +84,7 @@ Date range & Gantt ------------------ Selecting :guilabel:`Date range & Gantt` adds to the :ref:`Form view ` -two :ref:`Date fields ` next to each other: one to set a start +two :ref:`Date fields ` next to each other: one to set a start date, the other to set an end date, using the :guilabel:`daterange` widget, and activates the :ref:`Gantt view `. @@ -95,7 +95,7 @@ Pipeline stages Selecting :guilabel:`Pipeline stages` activates the :ref:`Kanban view `, adds several fields such as :ref:`Priority -` and :guilabel:`Kanban State`, and three stages: +` and :guilabel:`Kanban State`, and three stages: :guilabel:`New`, :guilabel:`In Progress`, and :guilabel:`Done`. The :guilabel:`Pipeline status bar` and the :guilabel:`Kanban State` field are added to the :ref:`Form view `. The :guilabel:`Color` field is added to the :ref:`List view @@ -111,7 +111,7 @@ Tags Selecting :guilabel:`Tags` adds to the :ref:`studio/views/general/form` and :ref:`studio/views/multiple-records/list` views a :ref:`Tags field -`, creating a *Tag* model with preconfigured access rights in +`, creating a *Tag* model with preconfigured access rights in the process. .. _studio/models-modules-apps/suggested-features/picture: @@ -120,7 +120,7 @@ Picture ------- Selecting :guilabel:`Picture` adds to the top-right of the :ref:`Form view -` an :ref:`Image field `. +` an :ref:`Image field `. .. note:: The :guilabel:`Picture` feature can be added at a later stage. @@ -131,7 +131,7 @@ Lines ----- Selecting :guilabel:`Lines`: adds to the :ref:`Form view ` a :ref:`Lines -field ` inside a :guilabel:`Tab` component. +field ` inside a :guilabel:`Tab` component. .. _studio/models-modules-apps/suggested-features/notes: @@ -139,7 +139,7 @@ Notes ----- Selecting :guilabel:`Notes` adds to the :ref:`Form view ` an :ref:`Html -field ` using the full width of the form. +field ` using the full width of the form. .. _studio/models-modules-apps/suggested-features/monetary-value: @@ -148,7 +148,7 @@ Monetary value Selecting :guilabel:`Monetary value` adds to the :ref:`studio/views/general/form` and :ref:`studio/views/multiple-records/list` views a :ref:`Monetary field -`. The :ref:`studio/views/reporting/graph` and +`. The :ref:`studio/views/reporting/graph` and :ref:`studio/views/reporting/pivot` views are also activated. .. note:: @@ -161,7 +161,7 @@ Company Selecting :guilabel:`Company` adds to the :ref:`studio/views/general/form` and :ref:`studio/views/multiple-records/list` views a :ref:`Many2One field -` linked to the *Company* model. +` linked to the *Company* model. .. note:: This is only useful if you work in a multi-company environment. diff --git a/content/applications/studio/views.rst b/content/applications/studio/views.rst index 62d015208..cff09f087 100644 --- a/content/applications/studio/views.rst +++ b/content/applications/studio/views.rst @@ -56,7 +56,7 @@ contacts, sales orders, products, etc. :guilabel:`Class` (either `btn-primary` or `btn-secondary`) in the :guilabel:`Properties` tab. - To add a smart button, click the :icon:`fa-plus-square` (:guilabel:`plus`) icon in the top-right corner of the form. Enter a :guilabel:`Label`, choose an :guilabel:`Icon`, and select a - :ref:`related field `. + :ref:`related field `. .. example:: @@ -158,7 +158,7 @@ records, and edit simple records. .. tip:: To add a :icon:`oi-draggable` (:guilabel:`drag handle`) icon to reorder records manually, add an - :ref:`Integer field ` with the :guilabel:`Handle` widget. + :ref:`Integer field ` with the :guilabel:`Handle` widget. .. image:: views/list-drag-handle.png :alt: Drag handle icon enabling to sort records manually in List view @@ -177,7 +177,7 @@ The :guilabel:`Map` :icon:`fa-map-marker` view is used to display records on a m is used in the Field Service app to plan an itinerary between different tasks. .. note:: - A :ref:`Many2One field ` linked to the *Contact* model + A :ref:`Many2One field ` linked to the *Contact* model is required to activate the view, as the contact address is used to position records on the map. - To select which kind of contact should be used on the map, select it under :guilabel:`Contact @@ -200,8 +200,8 @@ Timeline views .. note:: - When you first activate one of the timeline views, you need to select which :ref:`Date - ` or :ref:`Date & Time - ` fields on your model should be used to define when the + ` or :ref:`Date & Time + ` fields on your model should be used to define when the records start and stop in order to display them on the view. You can modify the :guilabel:`Start Date Field` and :guilabel:`Stop Date Field` after activating the view. - The settings described below are found under the view's :guilabel:`View` tab unless specified @@ -231,15 +231,15 @@ calendar. values. - To display events lasting the whole day at the top of the calendar, select a :ref:`Checkbox field - ` that specifies if the event lasts the whole day. + ` that specifies if the event lasts the whole day. - To choose the default time scale used to display events, select :guilabel:`Day`, :guilabel:`Week`, :guilabel:`Month`, or :guilabel:`Year` under :guilabel:`Default Display Mode`. .. note:: You can also use a :guilabel:`Delay Field` to display the duration of the event in hours by - selecting a :ref:`Decimal ` or :ref:`Integer - ` field on the model which specifies the duration of the + selecting a :ref:`Decimal ` or :ref:`Integer + ` field on the model which specifies the duration of the event. However, if you set an :guilabel:`End Date Field`, the :guilabel:`Delay Field` will not be taken into account.