khanh.pndc/odoo-docs
1
0
Fork 0
mirror of https://github.com/odoo/documentation.git synced 2026-01-02 09:49:17 +07:00
Code Issues Packages Projects Releases Wiki Activity

[IMP] Website themes - Pages

Browse Source 
[IMP] Website themes - Pages
[FIX] Website Themes - Pages: Anchors
[FIX] Website Themes - Pages: anchors
[FIX] Anchors patterns + code review modifications
This commit is contained in:
Brandon Mercier
2025-02-25 13:30:28 +01:00
parent 0044a6bb09
commit ab52aaf3e4
3 changed files with 116 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
content/developer/howtos/website_themes/layout.rst
View File

@@ -431,7 +431,7 @@ Navbar toggler
</t>
.. seealso::
You can add a :ref:`header overlay <header_overlay>` to position your header over the content of
You can add a :ref:`header overlay <website_themes/pages/theme_pages/header_overlay>` to position your header over the content of
your page. It has to be done on each page individually.
Footer

158
content/developer/howtos/website_themes/pages.rst
View File

@@ -4,6 +4,8 @@ Pages
In this chapter, you will learn how to declare static pages.
.. _website_themes/pages/default :
Default pages
=============
@@ -11,39 +13,57 @@ In Odoo, websites come with a few default static pages (Home, Contact us, 404, .
the following way.
.. code-block:: xml
:caption: `/website/data/website_data.xml`
<template id="website.homepage" name="Homepage">
<t t-call="website.layout">
<!-- Variables -->
<t t-set="additional_title" t-value="'Home'" />
<div id="wrap" class="oe_structure oe_empty">
<!-- Content -->
</div>
</t>
<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.
.. code-block:: xml
<t t-set="additional_title" t-value="'...'"/>
<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:**
.. code-block:: xml
<t t-set="additional_title">My title</t>
**Bad example:**
.. code-block:: xml
<t t-set="additional_title" t-valuef="My title"/>
Define the meta description.
.. code-block:: xml
<t t-set="meta_description" t-value="'...'"/>
<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.
.. code-block:: xml
<t t-set="pageName" t-value="'...'"/>
<t t-set="pageName" t-valuef="..."/>
Hide the header.
@@ -80,21 +100,19 @@ Alternatively, replace the default content of these pages using XPath.
<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::
- `Odoo eLearning: Search Engine Optimization (SEO)
<https://www.odoo.com/slides/slide/search-engine-optimization-seo-648>`_
- :doc:`Odoo Documentation on SEO <../../../applications/websites/website/pages/seo>`
.. _website_themes/pages/theme_pages :
Theme pages
===========
@@ -106,28 +124,33 @@ page object.
.. code-block:: xml
:caption: ``/website_airproof/data/pages/about_us.xml``
<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="type">qweb</field>
<field name="arch" type="xml">
<t t-name="website_airproof.page_about_us">
<odoo>
<data 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>
</data>
</odoo>
<t t-call="website.layout">
<div id="wrap" class="oe_structure">
.. admonition:: Multiwebsite and `website_id`
<!-- Content -->
</div>
</t>
</t>
</field>
</record>
.. todo:: Missing description in table ...
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
@@ -137,21 +160,59 @@ page object.
* - Field
- Description
* - name
- Page name.
- Page name (human-readable).
* - is_published
- Define if the page is published (visible to visitors).
* - key
- View key (must be unique)
* - url
- URL where the page is reachable.
- Relative path where the page is reachable.
* - type
- View type
* - arch
- View architecture
- View architecture (the markup of your page)
With `<t t-call="website.layout">` you use the Odoo default page layout with your code.
.. _header_overlay:
.. _website_themes/pages/theme_pages/noupdate :
`noupdate` attribute
--------------------
This attribute prevents data overwriting.
.. code-block:: xml
<data noupdate="1">
<!-- Your record -->
</data>
**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
--------------
@@ -164,3 +225,12 @@ Make the header background transparent and stand on top of the page content.
.. 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.1/examples/cheatsheet/>`_
- `Bootstrap documentation <https://getbootstrap.com/docs/5.1/getting-started/introduction/>`_

2
locale/sources/developer.pot
View File

@@ -3187,7 +3187,7 @@ msgid "Navbar toggler"
msgstr ""
#: ../../content/developer/howtos/website_themes/layout.rst:434
msgid "You can add a :ref:`header overlay <header_overlay>` to position your header over the content of your page. It has to be done on each page individually."
msgid "You can add a :ref:`header overlay <howto/website_themes/pages_theme_header_overlay>` to position your header over the content of your page. It has to be done on each page individually."
msgstr ""
#: ../../content/developer/howtos/website_themes/layout.rst:438