Merge 68ea850491
into 0287a4b629
This commit is contained in:
commit
338ce57429
@ -1,3 +1,5 @@
|
|||||||
|
.. _howtos/website/theming:
|
||||||
|
|
||||||
=======
|
=======
|
||||||
Theming
|
Theming
|
||||||
=======
|
=======
|
||||||
@ -10,6 +12,8 @@ theme module. In this chapter, you will discover how to:
|
|||||||
- Get the most out of Bootstrap variables.
|
- Get the most out of Bootstrap variables.
|
||||||
- Add custom styles and JavaScript.
|
- Add custom styles and JavaScript.
|
||||||
|
|
||||||
|
.. _theming/module:
|
||||||
|
|
||||||
Theme module
|
Theme module
|
||||||
============
|
============
|
||||||
|
|
||||||
@ -19,6 +23,8 @@ theme, you are extending the default theme.
|
|||||||
Remember to add the directory containing your module to the `addons-path` command-line argument
|
Remember to add the directory containing your module to the `addons-path` command-line argument
|
||||||
when running Odoo in your development environment.
|
when running Odoo in your development environment.
|
||||||
|
|
||||||
|
.. _theming/module/naming:
|
||||||
|
|
||||||
Technical naming
|
Technical naming
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@ -33,6 +39,8 @@ The first step is to create a new directory.
|
|||||||
|
|
||||||
In this documentation, we will use **Airproof** (a fictional project) as an example.
|
In this documentation, we will use **Airproof** (a fictional project) as an example.
|
||||||
|
|
||||||
|
.. _theming/module/structure:
|
||||||
|
|
||||||
File structure
|
File structure
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
@ -44,18 +52,17 @@ package its theme like a module.
|
|||||||
website_airproof
|
website_airproof
|
||||||
├── data
|
├── data
|
||||||
├── i18n
|
├── i18n
|
||||||
├── lib
|
|
||||||
├── static
|
├── static
|
||||||
│ ├── description
|
│ ├── description
|
||||||
│ ├── fonts
|
│ ├── fonts
|
||||||
│ ├── image_shapes // Shapes for images
|
│ ├── lib
|
||||||
│ ├── shapes // Shapes for background
|
│ ├── shapes // Shapes for background
|
||||||
│ └── src
|
│ └── src
|
||||||
│ ├── img
|
│ ├── img
|
||||||
│ │ ├── content // For those used in the pages of your website
|
│ │ ├── content // For those used in the pages of your website
|
||||||
│ │ └── wbuilder // For those used in the builder
|
│ │ └── wbuilder // For those used in the builder
|
||||||
│ ├── js
|
│ ├── js
|
||||||
│ ├── scss
|
│ ├── scss // Theme specific styles
|
||||||
│ └── snippets // custom snippets
|
│ └── snippets // custom snippets
|
||||||
├── views
|
├── views
|
||||||
├── __init__.py
|
├── __init__.py
|
||||||
@ -79,12 +86,17 @@ package its theme like a module.
|
|||||||
* - views
|
* - views
|
||||||
- Custom views and templates (`*.xml`)
|
- Custom views and templates (`*.xml`)
|
||||||
|
|
||||||
|
.. _theming/module/initialization:
|
||||||
|
|
||||||
Initialization
|
Initialization
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
An Odoo module is also a Python package with a :file:`__init__.py` file containing import
|
An Odoo module is also a Python package with a :file:`__init__.py` file containing import
|
||||||
instructions for various Python files in the module. This file can remain empty for now.
|
instructions for various Python files in the module. This file can remain empty for now.
|
||||||
|
|
||||||
|
|
||||||
|
.. _theming/module/declaration:
|
||||||
|
|
||||||
Declaration
|
Declaration
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
@ -143,6 +155,8 @@ always required. It usually contains much more information.
|
|||||||
To create a website theme, you only need to install the Website app. If you need other apps
|
To create a website theme, you only need to install the Website app. If you need other apps
|
||||||
(Blogs, Events, eCommerce, ...), you can also add them.
|
(Blogs, Events, eCommerce, ...), you can also add them.
|
||||||
|
|
||||||
|
.. _theming/options:
|
||||||
|
|
||||||
Default options
|
Default options
|
||||||
===============
|
===============
|
||||||
|
|
||||||
@ -164,6 +178,8 @@ First, try to construct your theme by using Odoo's default options. This ensures
|
|||||||
.. seealso::
|
.. seealso::
|
||||||
:doc:`Odoo coding guidelines <../../../contributing/development/coding_guidelines>`
|
:doc:`Odoo coding guidelines <../../../contributing/development/coding_guidelines>`
|
||||||
|
|
||||||
|
.. _theming/module/variables:
|
||||||
|
|
||||||
Odoo variables
|
Odoo variables
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
@ -436,6 +452,8 @@ The colors used in a color combination are accessible and can be overridden thro
|
|||||||
The Website Builder automatically generates a page to view the color combinations of the theme
|
The Website Builder automatically generates a page to view the color combinations of the theme
|
||||||
color palette: http://localhost:8069/website/demo/color-combinations
|
color palette: http://localhost:8069/website/demo/color-combinations
|
||||||
|
|
||||||
|
.. _theming/module/bootstrap:
|
||||||
|
|
||||||
Bootstrap variables
|
Bootstrap variables
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
@ -492,6 +510,8 @@ values and *not* the :file:`primary_variables.scss` file.
|
|||||||
|
|
||||||
http://localhost:8069/website/demo/bootstrap
|
http://localhost:8069/website/demo/bootstrap
|
||||||
|
|
||||||
|
.. _theming/module/views:
|
||||||
|
|
||||||
Views
|
Views
|
||||||
-----
|
-----
|
||||||
|
|
||||||
@ -541,6 +561,8 @@ By reading the source code, templates related to options are easily found.
|
|||||||
<field name="active" eval="False"/>
|
<field name="active" eval="False"/>
|
||||||
</record>
|
</record>
|
||||||
|
|
||||||
|
.. _theming/assets:
|
||||||
|
|
||||||
Assets
|
Assets
|
||||||
======
|
======
|
||||||
|
|
||||||
@ -548,6 +570,8 @@ For this part, we will refer to the `assets_frontend` bundle located in the web
|
|||||||
specifies the list of assets loaded by the Website Builder, and the goal is to add your SCSS and JS
|
specifies the list of assets loaded by the Website Builder, and the goal is to add your SCSS and JS
|
||||||
files to the bundle.
|
files to the bundle.
|
||||||
|
|
||||||
|
.. _theming/assets/styles:
|
||||||
|
|
||||||
Styles
|
Styles
|
||||||
------
|
------
|
||||||
|
|
||||||
@ -579,6 +603,8 @@ Feel free to reuse the variables from your Bootstrap file and the ones used by O
|
|||||||
font-family: o-website-value('headings-font');
|
font-family: o-website-value('headings-font');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.. _theming/assets/interactivity:
|
||||||
|
|
||||||
Interactivity
|
Interactivity
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user