.. _widgets_user_guide:

==========
User guide
==========

This user guide will describe the functions of each button of the toolbar in [Home] > [Custom views], it is not meant to describe the parameters of each widget.


********
Add view
********

.. image:: /_static/images/extending/widgets/add_view_btn.png
   :align: center

You can define multiple views.


.. image:: /_static/images/extending/widgets/add_view.png 
   :align: center

Pick a layout and give a name to your view.


***********
Set default
***********

.. image:: /_static/images/extending/widgets/add_view_btn.png
   :align: center

The default view will be displayed when user directed to the [Home] > [Custom views].

*********
Edit view
*********

.. image:: /_static/images/extending/widgets/edit_view_btn.png
   :align: center

You can change the name and the layout of your view at any given time.


.. image:: /_static/images/extending/widgets/add_view.png
   :align: center

Pick a layout and give a name to your view.
You can change the name and the layout of your view at any given time.


**********
Share view
**********

.. image:: /_static/images/extending/widgets/share_view_btn.png
   :align: center

You can share your views with other users or user groups.

.. image:: /_static/images/extending/widgets/share_view.png
   :align: center

.. note::
   Only owners can share their views.

.. note::
   When a view is locked, the other users will not be able to add, remove, or reposition widgets on that very view. Obviously, they will not be able to edit/delete the view either.


***********
Delete view
***********

.. image:: /_static/images/extending/widgets/delete_view_btn.png
   :align: center

This cannot be undone, so be sure that other users do not need a view before discarding it.

**********
Add widget
**********

.. image:: /_static/images/extending/widgets/add_widget_btn.png
   :align: center

.. image:: /_static/images/extending/widgets/add_widget.png
   :align: center

Select the type of widget to add into the view and give it a name.

For more information regarding the installation of a widget, refer to this :ref:`guide <widget_installation>`.

********
Rotation
********

.. image:: /_static/images/extending/widgets/rotation_btn.png
   :align: center

When rotation mode is enabled, views will switch from one to another automatically every *x* seconds.

.. image:: /_static/images/extending/widgets/rotation.png
   :align: center

Specify the frequency in seconds.

