Skip to content

Commit 1ec5017

Browse files
guillaume gallant (guga)xpl-odoo
authored andcommitted
[ADD] website: new visibility page
task-4644973 closes #13040 Signed-off-by: Xavier Platteau (xpl) <[email protected]>
1 parent 4eaea7b commit 1ec5017

File tree

6 files changed

+108
-14
lines changed

6 files changed

+108
-14
lines changed

content/applications/websites/website/reporting/link_tracker.rst

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,20 +38,9 @@ Fill in the following information and click :guilabel:`Get tracked link` to gene
3838
The :guilabel:`Campaign`, :guilabel:`Medium`, and :guilabel:`Source` are called :abbr:`UTM (Urchin
3939
Tracking Module)` parameters. They are incorporated in the tracked URL.
4040

41-
Website visibility
42-
------------------
43-
44-
You can use the :abbr:`UTM (Urchin Tracking Module)` parameters to hide or show building blocks for
45-
specific audiences. To achieve this, click the :guilabel:`Edit` button on your website, select a
46-
building block, go to the :guilabel:`Customize` tab, scroll down to :guilabel:`Visibility`, and
47-
click :guilabel:`Conditionally`.
48-
49-
.. image:: link_tracker/conditional-visibility.png
50-
:alt: Use the conditional visibility to display site elements to specific audiences.
51-
52-
For each parameter available in the :ref:`Visibility <building_blocks/visibility>` section, you can
53-
choose :guilabel:`Visible for` or :guilabel:`Hidden for` and select the record you want from the
54-
dropdown list.
41+
.. tip::
42+
You can customize the :ref:`visibility <website/visibility/conditions>` of building blocks
43+
using the :abbr:`UTM (Urchin Tracking Module)` parameters, amongst other conditions.
5544

5645
Tracked links overview
5746
======================

content/applications/websites/website/web_design.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@ Web design
1010
web_design/building_blocks
1111
web_design/themes
1212
web_design/elements
13+
web_design/visibility
Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
==========
2+
Visibility
3+
==========
4+
5+
You can choose to display or hide building blocks based on a visitor's:
6+
7+
- device type (mobile or computer),
8+
- country (IP-based geolocation),
9+
- website language,
10+
- :doc:`UTM parameters <../reporting/link_tracker>`, and
11+
- login state.
12+
13+
.. _website/visibility/mobile-and-computer:
14+
15+
Mobile/computer
16+
===============
17+
18+
.. role:: raw-html(raw)
19+
:format: html
20+
21+
.. |desktop icon| replace:: :raw-html:`<svg viewBox="0 0 465 462" xmlns="http://www.w3.org/2000/svg" width="18" height="18"><path d="M456.969 9.84743L454.026 6.90425C444.956 -2.16512 429.098 -1.01124 418.605 9.48152L10.8984 417.188C0.405681 427.681 -0.748186 443.539 8.32118 452.609L11.2644 455.552C20.3337 464.621 36.1919 463.467 46.6847 452.975L454.392 45.2678C464.884 34.775 466.038 18.9168 456.969 9.84743Z"></path><path d="M346.673 26.269H39.1908C17.8303 26.269 0.5 43.6036 0.5 64.9695V322.973C0.5 336.409 7.35309 348.251 17.752 355.19L114.47 258.472H62.9696C56.9597 258.472 52.0878 253.601 52.0878 247.591V88.7515C52.0878 82.7417 56.9597 77.8697 62.9696 77.8697H295.072L346.673 26.269Z"></path><path d="M296.331 258.472H402.32C408.33 258.472 413.202 253.601 413.202 247.591V141.602L464.79 90.0139V322.973C464.79 344.339 447.46 361.674 426.099 361.674H271.336L284.233 400.375H342.269C352.949 400.375 361.614 409.042 361.614 419.725C361.614 430.408 352.949 439.075 342.269 439.075H123.021C120.837 439.075 118.734 438.708 116.771 438.033L154.429 400.375H181.057L193.954 361.674H193.13L226.244 328.56C228.268 329.181 230.417 329.516 232.645 329.516C244.665 329.516 254.409 319.772 254.409 307.753C254.409 305.525 254.074 303.376 253.452 301.352L296.331 258.472Z"></path></svg>`
22+
23+
.. |mobile icon| replace:: :raw-html:`<svg viewBox="0 0 566.93 566.93" xmlns="http://www.w3.org/2000/svg" width="18" height="18"><rect transform="translate(283.46 -117.41) rotate(45)" x="255.56" y="-16.93" width="55.81" height="600.8" rx="25.61"></rect><path d="m395.46 399.46a12 12 0 0 1-12 12h-128.4l-115.68 115.69a47.8 47.8 0 0 0 32.08 12.31h224a48 48 0 0 0 48-48v-268.4l-48 48zm-112 108a32 32 0 1 1 32-32 32 32 0 0 1-32 32z"></path><path d="m171.46 87.46a12 12 0 0 1 12-12h200a11.89 11.89 0 0 1 6.48 1.93l37.61-37.61a47.82 47.82 0 0 0-32.09-12.32h-224a48 48 0 0 0-48 48v268.41l48-48z"></path></svg>`
24+
25+
To toggle the visibility of a building block based on the visitor's device type:
26+
27+
- Open the website editor and select a block.
28+
- In the :guilabel:`Customize` tab, under the block's customization options, look for
29+
:guilabel:`Visibility`.
30+
31+
- Click the |desktop icon| (:guilabel:`Show/Hide on Desktop`) button to hide
32+
the block for users visiting your website from a computer.
33+
- Click the |mobile icon| (:guilabel:`Show/Hide on Mobile`) button to hide the block
34+
for users visiting your website from a mobile device.
35+
36+
- Click :guilabel:`Save` to apply the changes.
37+
38+
It is also sometimes possible to hide elements within blocks. It is mostly used to hide specific
39+
elements inside blocks that may be too wide to be correctly displayed on mobile devices. To see if
40+
the option is available, select an element within a block and look for the :guilabel:`Visibility`
41+
option under the element's customization option.
42+
43+
.. example::
44+
The selected image is hidden on mobile devices.
45+
46+
.. image:: visibility/element-visibility.png
47+
:alt: Example of an column element hidden on mobile devices
48+
49+
.. _website/visibility/conditions:
50+
51+
Conditions
52+
==========
53+
54+
To access the country, website language, UTM parameters, and login state conditions:
55+
56+
- Open the website editor and select a building block.
57+
- In the :guilabel:`Customize` tab, look for :guilabel:`Visibility`.
58+
- Click :guilabel:`No condition` and select :guilabel:`Conditionally` instead to display the
59+
different options:
60+
61+
- :guilabel:`Country`: the country of the visitor's IP address.
62+
- :guilabel:`Languages`: the website language used by the visitor.
63+
64+
.. note::
65+
This option is only available if more than one :doc:`language is installed
66+
<../configuration/translate>`.
67+
68+
- :guilabel:`UTM Campaign`: the selected campaign.
69+
- :guilabel:`UTM Medium`: the selected medium of any campaign.
70+
- :guilabel:`UTM Source`: the selected source of any campaign.
71+
- :guilabel:`Users`: select whether the visitor should be :guilabel:`Logged In` or
72+
:guilabel:`Logged Out` to view the block. By default, the option is set to :guilabel:`Visible
73+
for Everyone`.
74+
75+
- For one or more of the first five options, choose if the block should be :guilabel:`Visible for`
76+
or :guilabel:`Hidden for`, then click :guilabel:`Choose a record...` and select it.
77+
78+
.. tip::
79+
- You can select multiple records for each option by clicking :guilabel:`Choose a record...`
80+
again.
81+
- Click the :icon:`fa-minus` (:guilabel:`remove`) button to remove an option.
82+
83+
Click :guilabel:`Save` to apply the changes.
84+
85+
.. example::
86+
A block with the following configuration will only be displayed to visitors with a Belgian IP
87+
address, for which the website is displayed in French, unless they visit the page using the
88+
`Sales` campaign tracked URL.
89+
90+
.. image:: visibility/visibility-conditions.png
91+
:alt: Example of a block configured with several visibility conditions
92+
93+
.. _website/visibility/invisible-elements:
94+
95+
Invisible elements
96+
==================
97+
98+
Blocks and elements with custom visibility settings are listed at the bottom of the website editor
99+
sidebar. You can preview how the page would look like by clicking the :icon:`fa-eye`
100+
(:guilabel:`visible`) button to hide a block or element, or the :icon:`fa-eye-slash`
101+
(:guilabel:`hidden`) to show it in the website editor.
102+
103+
.. image:: visibility/invisible-elements.png
104+
:alt: Blocks and elements with custom visibility settings displayed at the bottom of the editor
Loading
Loading
Loading

0 commit comments

Comments
 (0)