.. _OpenCOR-helpplugin:

===========
Help plugin
===========

The **Help** plugin provides some user documentation which looks as follows:

.. image:: /OpenCOR/images/HelpScreenshot01.png
    :align: center
    :width: 360px
    :height: 270px
    :alt: Help plugin: default view

The documentation includes a menu which gets shown whenever you move your mouse pointer over the information icon (top right):

.. image:: /OpenCOR/images/HelpScreenshot02.png
    :align: center
    :width: 360px
    :height: 270px
    :alt: Help plugin: context menu

The Help plugin also displays special links which when clicked send a command to OpenCOR. For example, open the documentation for the Help plugin page in OpenCOR. Now, if you check the bold text below, you will see that its contents is slightly different, depending on whether you are reading this in OpenCOR or from here:

.. centered:: To open the About box, select the ``Help`` | ``About...`` menu...

Tool bar
--------

.. |go-home|
    image:: images/oxygen/actions/go-home.png
        :width: 24px
        :height: 24px

.. |go-previous|
    image:: images/oxygen/actions/go-previous.png
        :width: 24px
        :height: 24px

.. |go-next|
    image:: images/oxygen/actions/go-next.png
        :width: 24px
        :height: 24px

.. |edit-copy|
    image:: images/oxygen/actions/edit-copy.png
        :width: 24px
        :height: 24px

.. |zoom-original|
    image:: images/oxygen/actions/zoom-original.png
        :width: 24px
        :height: 24px

.. |zoom-in|
    image:: images/oxygen/actions/zoom-in.png
        :width: 24px
        :height: 24px

.. |zoom-out|
    image:: images/oxygen/actions/zoom-out.png
        :width: 24px
        :height: 24px

.. |document-print|
    image:: images/oxygen/actions/document-print.png
        :width: 24px
        :height: 24px

================ ========================================
|go-home|        Go to the home page
|go-previous|    Go back
|go-next|        Go forward
|edit-copy|      Copy the selection to the clipboard
|zoom-original|  Reset the size of the help page contents
|zoom-in|        Zoom in the help page contents
|zoom-out|       Zoom out the help page contents
|document-print| Print the help page contents
================ ========================================