.. _Shelf:

=====
Shelf
=====

The shelf is a toolbar where you can store scripts. It is shared between all the users logged in a same project.

.. image:: _images/shelf.jpg
  :width: 1200
  :alt: Alternative text

-------------------
Create a shelf tool
-------------------

To create a new shelf tool, click on the |create_shelf_tool| button and choose `Tool` in the list.

.. |create_shelf_tool| image:: _images/create_shelf_tool_button.png
  :width: 20
  :alt: Alternative text

.. image:: _images/create_shelf_tool.gif
  :width: 1200
  :alt: Alternative text

Then choose an icon by clicking on the |choose_icon| button, enter a tool name, the tool script and a short help for users.

.. |choose_icon| image:: _images/shelf_choose_icon_button.png
  :width: 30
  :alt: Alternative text

.. image:: _images/create_shelf_tool_example.png
  :width: 1000
  :alt: Alternative text

.. warning::
  If the tool script contain a loop or could be long to execute, you should check `Only execute as subtask` to avoid freezing wizard.

.. note::
  If you choose an icon from you drive, wizard will copy it in `<project_path>/shared_files/` to allow access for all users.

-----------------
Edit a shelf tool
-----------------

To edit a shelf tool, right click on it and select `Edit`.

.. image:: _images/edit_shelf_tool.gif
  :width: 1200
  :alt: Alternative text

-------------------
Delete a shelf tool
-------------------

To delete a shelf tool, right click on it and select `Delete`.

.. image:: _images/delete_shelf_tool.gif
  :width: 1200
  :alt: Alternative text

------------------
Create a separator
------------------

To create a new separator, click on the |create_shelf_tool| button and choose `Separator` in the list.

.. image:: _images/create_shelf_separator.gif
  :width: 1200
  :alt: Alternative text

------------------
Delete a separator
------------------

To delete a shelf separator, right click on it and select `Delete`.

.. image:: _images/delete_shelf_separator.gif
  :width: 1200
  :alt: Alternative text

----------------
Edit the toolbar
----------------

To edit the toolbar, click on the |edit_shelf| button. You will enter to the `Edit mode`.

.. |edit_shelf| image:: _images/edit_shelf_button.png
  :width: 30
  :alt: Alternative text

.. image:: _images/shelf_edit_mode.jpg
  :width: 1200
  :alt: Alternative text

To move one or multiple items, select them and click on the |shelf_move_left_button| or |shelf_move_right_button| buttons.

.. |shelf_move_left_button| image:: _images/shelf_move_left_button.png
  :width: 30
  :alt: Alternative text

.. |shelf_move_right_button| image:: _images/shelf_move_right_button.png
  :width: 30
  :alt: Alternative text

.. image:: _images/move_shelf_items.gif
  :width: 1200
  :alt: Alternative text

.. note::
  You need to click again on the |edit_shelf| button to leave the `Edit mode` and apply modifications.


-----------------------
Open the scripts folder
-----------------------

The shelf tools scripts are stored in the file system ( in `<project_path>/scripts/` ). You can open this folder by clicking on the |open_shelf_scripts_folder| button.

.. |open_shelf_scripts_folder| image:: _images/open_shelf_scripts_folder.png
  :width: 30
  :alt: Alternative text