odoo-forge-bundle 0.1.0

package/payload/skills/odoo18-docs/references/docs/developer/howtos/website_themes/pages.md

@@ -0,0 +1,373 @@
+---
+title: "Pages"
+source_url: "https://docs.odoo.sbggai.top/developer/howtos/website_themes/pages.html"
+---
+
+=====
+# Pages
+
+In this chapter, you will learn how to declare static pages.
+
+.. _website_themes/pages/default :
+
+# Default pages
+
+In Odoo, websites come with a few default static pages (Home, Contact us, 404, ...). They are built
+the following way.
+
+```xml
+   :caption: `/website/data/website_data.xml`
+
+   <template id="website.homepage" name="Home">
+      <t t-call="website.layout">
+         <t t-set="pageName" t-value="'homepage'"/>
+         <div id="wrap" class="oe_structure oe_empty" />
+      </t>
+   </template>
+
+Each default page is a template with its own content saved into a record. This is the reason why,
+:ref:`custom pages are created within a record <website_themes/pages/theme_pages>`.
+
+The `<t-call='website.layout'>` has some variables that can be set:
+
+Define the meta title.
+
+```xml
+
+   <t t-set="additional_title">My Page Title</t>
+
+> **tip**:
+>    The `t-set` here does not pass the value into a `t-value` or a `t-valuef` attribute.
+   This is for translation purpose. The content of a `t-value` or a `t-valuef` is not explicitly
+   exported for translation. Beside that, as it's written in XML, a string located between an opening
+   and a closing tag is considered translatable by default.
+
+   .. example::
+      **Good example:**
+
+      ```xml
+
+         <t t-set="additional_title">My title</t>
+
+      **Bad example:**
+
+      ```xml
+
+         <t t-set="additional_title" t-valuef="My title"/>
+
+Define the meta description.
+
+```xml
+
+   <t t-set="meta_description">This is the description of the page that will appear on Search
+   Engines.</t>
+
+Add a CSS class to the page.
+
+```xml
+
+   <t t-set="pageName" t-valuef="..."/>
+
+Hide the header.
+
+```xml
+
+   <t t-set="no_header" t-value="true"/>
+
+Hide the footer.
+
+```xml
+
+   <t t-set="no_footer" t-value="true"/>
+
+If needed, deactivate default pages.
+
+```xml
+   :caption: `/website_airproof/data/pages/home.xml`
+
+   <record id="website.homepage" model="ir.ui.view">
+       <field name="active" eval="False"/>
+   </record>
+
+```xml
+   :caption: `/website_airproof/data/pages/contactus.xml`
+
+   <record id="website.contactus" model="ir.ui.view">
+       <field name="active" eval="False"/>
+   </record>
+
+Alternatively, replace the default content of these pages using XPath.
+
+```xml
+   :caption: `/website_airproof/data/pages/404.xml`
+
+   <template id="404" inherit_id="http_routing.404">
+       <xpath expr="//*[@id='wrap']" position="replace">
+           <t t-set="additional_title" t-value="'404 - Not found'"/>
+
+           <div id="wrap" class="oe_structure">
+               <!-- Content -->
+           </div>
+       </xpath>
+   </template>
+
+.. seealso::
+   - :doc:`Odoo Documentation on SEO <../../../applications/websites/website/pages/seo>`
+
+.. _website_themes/pages/theme_pages :
+
+# Theme pages
+
+You can add as many pages as you want to your website. Instead of defining a `<template>`, create a
+page object.
+
+**Declaration**
+
+```xml
+   :caption: `/website_airproof/data/pages/about_us.xml`
+
+   <odoo noupdate="1">
+        <record id="page_about_us" model="website.page">
+            <field name="name">About us</field>
+            <field name="is_published" eval="True"/>
+            <field name="key">website_airproof.page_about_us</field>
+            <field name="url">/about-us</field>
+            <field name="website_id" eval="1" />
+            <field name="type">qweb</field>
+            <field name="arch" type="xml">
+                <t t-name="website_airproof.page_about_us">
+                    <t t-call="website.layout">
+                    <div id="wrap" class="oe_structure">
+                        <!-- Content -->
+                    </div>
+                    </t>
+                </t>
+            </field>
+        </record>
+   </odoo>
+
+.. admonition:: Multiwebsite and `website_id`
+
+   In a module context, the record created above is available, by default, on every website
+   available on the database. It's preferable to specify the `website_id` of the website where the
+   page will be findable.
+
+.. list-table::
+   :header-rows: 1
+   :stub-columns: 1
+   :widths: 20 80
+
+   * - Field
+     - Description
+   * - name
+     - Page name (human-readable).
+   * - is_published
+     - Define if the page is published (visible to visitors).
+   * - key
+     - View key (must be unique)
+   * - url
+     - Relative path where the page is reachable.
+   * - type
+     - View type
+   * - arch
+     - View architecture (the markup of your page)
+
+With `<t t-call="website.layout">` you use the Odoo default page layout with your code.
+
+.. _website_themes/pages/theme_pages/noupdate :
+
+## `noupdate` attribute
+
+This attribute prevents data overwriting. It can be added either on a `data` tag wrapping some
+records to protect or on the `odoo`tag` in order to protect all records declared into the file.
+
+Protect all records of the file:
+
+```xml
+
+   <?xml version="1.0" encoding="utf-8"?>
+   <odoo noupdate="1">
+      <record id="menu_company" model="website.menu">
+         <!-- Fields -->
+      </record>
+      <record id="menu_faq" model="website.menu">
+         <!-- Fields -->
+      </record>
+   </odoo>
+
+Protect specific records in the file:
+
+```xml
+
+   <?xml version="1.0" encoding="utf-8"?>
+   <odoo>
+      <record id="menu_company" model="website.menu">
+         <!-- Fields -->
+      </record>
+
+      <data noupdate="1">
+         <record id="menu_faq" model="website.menu">
+            <!-- Fields -->
+         </record>
+         <record id="menu_legal" model="website.menu">
+            <!-- Fields -->
+         </record>
+      </data>
+   </odoo>
+
+**Use case**
+
+There are several static pages created in the module. This one has been installed on the database
+and the end-user has updated some of those pages. Some bug fixes must be applied on the
+static pages while avoiding any loss of changes made by the end-user.
+
+**Problem**
+
+In case of a module update on the database, every record declared into the module will overwrite
+those existing in the database even if the end-user has changed some of these records.
+
+**Solution**
+
+By wrapping the record (or all records declared in the file) into a `<data noupdate="1"></data>`
+tag, the record declared is created at the first module installation but not updated after a module
+update.
+
+.. spoiler:: What happens if the record has been manually deleted (e.g.: a menu item) ?
+
+   The system detects that this record doesn't exist and will re-create it.
+
+.. spoiler:: Is this method only valid on static page records?
+
+   Of course not. It's technically usable for every type of records.
+
+.. _website_themes/pages/theme_pages/header_overlay :
+
+## Header overlay
+
+Make the header background transparent and stand on top of the page content.
+
+```xml
+
+   <field name="header_overlay" eval="True"/>
+
+.. image:: pages/header-overlay.png
+   :alt: Header overlay
+
+> **note**:
+>    To create the content of a static page, use the Odoo way of doing things in order to remain
+   editable by the Website Builder. Please note that Odoo takes advantage of Bootstrap framework (5.1.3).
+
+   Find the available classes and components:
+
+   - [Bootstrap cheat sheet ](https://getbootstrap.com/docs/5.3/examples/cheatsheet/)
+   - [Bootstrap documentation ](https://getbootstrap.com/docs/5.3/getting-started/introduction/)
+
+.. _website_themes/pages/theme_pages/page_templates :
+
+## Page templates
+
+Create preset static page templates available from the New Page dialog window.
+
+**Declaration**
+
+The page templates has to be defined into the :file:`__manifest__.py` of the module through
+`new_page_templates`:
+
+```python
+   :caption: `/website_airproof/__manifest__.py`
+   :emphasize-lines: 15-18
+
+   {
+      'name': 'Airproof Theme',
+      'description': '...',
+      'category': 'Website/Theme',
+      'version': '{BRANCH}.0.0',
+      'author': '...',
+      'license': '...',
+      'depends': ['website'],
+      'data': [
+         # ...
+      ],
+      'assets': {
+         # ...
+      },
+      'new_page_templates': {
+         'airproof': {
+            'faq': ['s_airproof_text_block_h1', 's_title', 's_faq_collapse', 's_call_to_action']
+      }
+   }
+
+**Templates**
+
+Then you have to create the template using a specific naming convention based on the hierarchy into
+the :file:`__manifest__.py`. In this case, the name is `new_page_template_sections_airproof_faq`.
+The building blocks called in this template are exactly the same as the standard ones except for
+the first that has been adapted "on the fly".
+
+Create a new instance of the standard `s_text_block` (`primary` attribute is important) and apply some
+adaptations:
+
+```xml
+   :caption: `/website_airproof/views/new_page_template_templates.xml`
+
+   <template id="s_airproof_text_block_h1" inherit_id="website.s_text_block" primary="True">
+      <xpath expr="//div[hasclass('container')]|//div[hasclass('o_container_small')]" position="replace">
+         <div class="container s_allow_columns">
+               <h1 class="display-1">FAQ - Help</h1>
+         </div>
+      </xpath>
+   </template>
+
+Instantiate each building block (modified or not) for the page template:
+
+```xml
+   :caption: `/website_airproof/views/new_page_template_templates.xml`
+
+   <template id="new_page_template_s_airproof_text_block_h1" inherit_id="website_airproof.s_airproof_text_block_h1" primary="True"/>
+   <template id="new_page_template_airproof_faq_s_title" inherit_id="website.s_title" primary="True"/>
+
+Then, create your page template with some `t-snippet-call` within an '#wrap' as explained above:
+
+```xml
+   :caption: `/website_airproof/views/new_page_template_templates.xml`
+
+   <div id="wrap">
+      <t t-snippet-call="website_airproof.new_page_template_airproof_faq_s_text_block_h1"/>
+      <t t-snippet-call="website_airproof.new_page_template_airproof_faq_s_title"/>
+      <t t-snippet-call="website_airproof.new_page_template_airproof_faq_s_faq_collapse"/>
+      <t t-snippet-call="website_airproof.new_page_template_airproof_faq_s_call_to_action"/>
+   </div>
+
+Once the page template is created, it can be added to an existing group. Find below a list of the
+existing group:
+
+```xml
+   :caption: `/website/views/new_page_template_templates.xml`
+
+   <template id="new_page_template_groups">
+      <div id="basic">Basic</div>
+      <div id="about">About</div>
+      <div id="landing">Landing Pages</div>
+      <div id="gallery">Gallery</div>
+      <div id="services">Services</div>
+      <div id="pricing">Pricing Plans</div>
+      <div id="team">Team</div>
+   </template>
+
+Feel free to add custom groups to the list:
+
+```xml
+   :caption: `/website_airproof/views/new_page_template_templates.xml`
+
+   <template id="new_pages_template_groups" inherit_id="website.new_pages_template_groups" name="Airproof - New Page Template Groups">
+      <xpath expr="//div[@id='custom']" position="after">
+         <div id="airproof">Airproof</div>
+      </xpath>
+   </template>
+
+.. image:: pages/new-page-template.png
+   :width: 520
+   :alt: List of existing static page templates
+
+.. seealso::
+   [Go further by altering the building blocks of a custom template ](https://github.com/odoo/odoo/blob/64971a0b1b2f8c063def5846f6029d5bb3a574cd/addons/website/views/new_page_template_templates.xml#L38)

package/payload/skills/odoo18-docs/references/docs/developer/howtos/website_themes/setup.md

@@ -0,0 +1,297 @@
+---
+title: "Setup"
+source_url: "https://docs.odoo.sbggai.top/developer/howtos/website_themes/setup.html"
+---
+
+=====
+# Setup
+
+In this chapter, you will learn:
+
+- To set up your local development environment.
+- The outline of the Odoo database structure.
+- To export and import an Odoo database in your local environment.
+- To have an Odoo instance up and running.
+
+.. _website_themes/setup/install :
+
+# Install
+
+There are multiple ways to :doc:`install Odoo </administration/on_premise>`, depending on the
+intended use case. This documentation assumes you use the :doc:`source install
+</administration/on_premise/source>` (running Odoo from the source code), which is best suited
+for Odoo designers and developers.
+
+.. _website_themes/setup/databases :
+
+# Databases
+
+.. _website_themes/setup/databases/structure :
+
+## Structure
+
+Every Odoo application works similarly; they are built with the same logic. A model contains fields
+and relational fields that link to other models. Each model has views representing all its fields,
+with backend and frontend views.
+
+.. _website_themes/setup/databases/models :
+
+### Models
+
+The basis of Odoo is models. Models use fields to record the data. Records are stored in a database:
+they are therefore linked to a model. In Odoo, you can find the different models in the
+backend by enabling the :ref:`developer mode <developer-mode>` and then going to
+:menuselection:`Settings --> Technical --> Database Structure: Models`.
+
+.. image:: setup/models-page.png
+   :alt: Models page
+
+.. _website_themes/setup/databases/fields :
+
+### Fields
+
+In a model, we will centralize fields (field names we need to target in our code).
+
+.. seealso::
+   :doc:`/applications/studio/fields`
+
+.. _website_themes/setup/databases/fields/classic :
+
+Classic fields
+**************
+
+- Date
+- Char
+- Selection
+- …
+
+.. _website_themes/setup/databases/fields/relational :
+
+Relational fields
+*****************
+
+Relational fields call a field from another model. They allow you to link models together and make
+them interact easily. In other words, when you use a relational field, you link a record with
+another one (located on another model), enabling you to retrieve the content of the fields located
+on this linked record.
+
+- **Many2one** fields are filled in by choosing one record from a list of records on another model
+  (from *many* records, you select *one*). For example, the *customer* field on a quotation makes
+  you choose one customer from a list of several customers on the *contact* model.
+- **One2many** fields are reverse searches of existing many2one relations. For example, you could
+  list on a contact all their existing quotations (from *one* record, you display *many*).
+- **Many2many** fields are filled in by choosing one or several records from a list of records on
+  another model. For example, you can put several tags on one product, and several products can use
+  the same tags (from *many* records, you can select *many*).
+
+.. _website_themes/setup/databases/views :
+
+### Views
+
+Views define how records should be displayed to end-users. They are specified in XML, meaning they
+can be edited independently from the models they represent. They are flexible and allow deep
+customization of the screens they control.
+
+.. _website_themes/setup/databases/views/backend_vs_frontend :
+
+Backend vs. Frontend
+********************
+
+- **Backend views**: Kanban, List, Form, etc.
+- **Frontend view**: QWeb
+
+.. _website_themes/setup/databases/views/static_vs_dynamic :
+
+Static vs. Dynamic
+******************
+
+- **Static pages** have stable content, such as the homepage. You can define their URL and set some
+  properties like published, indexed, etc.
+- **Dynamic pages** are dynamically generated, such as the product page. Their URL is dynamic
+  and is accessible to all by default (this can be changed by configuring access rights).
+
+.. _website_themes/setup/databases/views/standard_vs_inherited :
+
+Standard vs. Inherited
+**********************
+
+- **Standard views** are base views implemented by Odoo. They are directly derived from their model.
+  You should never change them as they allow updating an Odoo database without overwriting a
+  client's modifications.
+- **Inherited views** are duplicated views. Modifications always take place in an inherited view. If
+  there is a duplicate view, there will be two views with the same name in the database, but the
+  duplicated view will not have an ID like for standard view.
+
+.. _website_themes/setup/databases/import :
+
+## Import an existing database
+
+> **note**:
+>    You can directly go to the :doc:`theming` chapter if you do not need to import an existing
+   database.
+
+.. _website_themes/setup/databases/import/dump :
+
+### Dump
+
+.. _website_themes/setup/databases/import/saas :
+
+Odoo SaaS
+*********
+
+Go to `<database_url>/saas_worker/dump`.
+
+.. _website_themes/setup/databases/import/sh :
+
+Odoo.sh
+*******
+
+#. Connect to Odoo.sh.
+#. Select the branch you want to back up.
+#. Choose the :guilabel:`BACKUPS` tab.
+#. Click the :guilabel:`Create Backup` button.
+#. When the process is over, a notification appears. Open it and click the :guilabel:`Go to Backup`
+   button.
+#. Click the :guilabel:`Download` icon. Select :guilabel:`Testing` under
+   :guilabel:`Purpose` and :guilabel:`With filestore` under :guilabel:`Filestore`.
+
+   .. image:: setup/download-backup.png
+     :alt: Download backup
+
+#. You will receive a notification when the dump is ready to be downloaded. Open it and click on
+   :guilabel:`Download` to get your dump.
+
+   .. image:: setup/database-backup.png
+     :alt: Database backup
+
+.. _website_themes/setup/databases/import/filestore :
+
+### Move filestore
+
+Copy all the folders included in the filestore folder and paste them to the following location on
+your computer:
+
+- macOS: `/Users/<User>/Library/Application Support/Odoo/filestore/<database_name>`
+- Linux: `/home/<User>/.local/share/Odoo/filestore/<database_name>`
+
+> **note**:
+>    `/Library` is a hidden folder.
+
+.. _website_themes/setup/databases/import/database_setup :
+
+### Database setup
+
+Create an empty database.
+
+```bash
+
+   createdb <database_name>
+
+Import the SQL file in the database that you just created.
+
+```bash
+
+   psql <database_name> < dump.sql
+
+Reset the admin user password.
+
+```bash
+
+   psql \c
+   <database_name>
+   update res_users set login='admin', password='admin' where id=2;
+
+If necessary, disable the two-factor authentication enforcing policy option.
+
+```bash
+
+    psql <database-name>
+    update res_users set top_secret='' where id=2;
+
+.. _website_themes/setup/getting_started :
+
+# Getting started
+
+.. _website_themes/setup/getting_started/running_odoo :
+
+## Running Odoo
+
+Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the command-line
+interface of the server. It is located at the root of the Odoo Community directory.
+
+- :ref:`Running Odoo <install/source/running_odoo>`
+- [Docker ](https://hub.docker.com/_/odoo/)
+
+To configure the server, you can specify command-line arguments or a configuration file. The first
+method is presented below.
+
+The :ref:`CLI <reference/cmdline>` offers several functionalities related to Odoo. You can use it to
+:ref:`run the server <reference/cmdline/server>`, scaffold an Odoo theme, populate a database, or
+count the number of lines of code.
+
+.. _website_themes/setup/getting_started/shell_script :
+
+## Shell script
+
+A typical way to :ref:`run the server <reference/cmdline/server>` would be to add all command line arguments to a `.sh` script.
+
+.. example::
+   ```xml
+
+      ./odoo-bin --addons-path=../enterprise,addons --db-filter=<database> -d <database> --without-demo=all -i website --dev=xml
+
+.. list-table::
+   :header-rows: 1
+   :stub-columns: 1
+   :widths: 20 80
+
+   * - Folder
+     - Description
+   * - :option:`--addons-path <odoo-bin --addons-path>`
+     - Comma-separated list of directories in which modules are stored. These directories are
+       scanned for modules.
+   * - :option:`-d <odoo-bin --database>`
+
+       :option:`--database <odoo-bin --database>`
+     - database(s) used when installing or updating modules.
+   * - :option:`--db-filter <odoo-bin --db-filter>`
+     - Hides databases that do not match the filter.
+   * - :option:`-i <odoo-bin --init>`
+
+       :option:`--init <odoo-bin --init>`
+     - Comma-separated list of modules to install before running the server. (requires `-d`)
+   * - :option:`-u <odoo-bin --update>`
+
+       :option:`--update <odoo-bin --update>`
+     - Comma-separated list of modules to update before running the server. (requires `-d`)
+   * - :option:`--without-demo <odoo-bin --without-demo>`
+     - Disables demo data loading for modules installed comma-separated; use `all` for all modules.
+       (requires `-d` and `-i`)
+   * - :option:`--dev <odoo-bin --dev>`
+     - Comma-separated list of features. For development purposes only. :ref:`More info
+       <reference/cmdline/dev>`
+
+.. _website_themes/setup/getting_started/signin :
+
+## Sign in
+
+After the server has started (the INFO log `odoo.modules.loading: Modules loaded.` is printed), open
+http://localhost:8069 in your web browser and log in with the base administrator account.
+
+Type **admin** for the email and **admin** for the password.
+
+.. image:: setup/welcome-homepage.png
+   :alt: Welcome homepage
+
+> **tip**:
+>    Hit *CTRL+C* to stop the server. Do it twice if needed.
+
+.. _website_themes/setup/getting_started/developer_mode :
+
+## Developer mode
+
+The developer mode, also known as debug mode, is useful for development as it gives access to
+additional tools. In the next chapters, it is assumed that you have enabled the developer mode.
+
+.. seealso::
+   :doc:`/applications/general/developer_mode`