.. _project-wizard:

Project Wizard
==============

The project wizard is the dialog used for creating a new project.

Creating a *local* project is done by clicking on the **New Project** button after starting the application.

.. tip:: When creating a project, none of the settings are final. They can all be modified later.

.. image:: img/new-project.png

To create a *remote* project, click on the **Remote Project** button, enter the URL of your server, enter your credentials and click on the **Create New Project** button.

.. image:: img/new-remote-project.png

Modifying a project is done by clicking on the settings button after opening a project

.. tip:: When modifying an existing project, the wizard will warn if any of the changes are destructive (for example, removing a label name).

.. image:: img/settings-button.png

After Project Creation
----------------------

After the project settings are defined, clicking the **Accept** button will create the project and its file structure.

Once the project is created, the Database tab is active, showing an empty database. The next step is to import datasets into the project, following the process described in the :ref:`import` page.

.. _project-instructions:

Project Instructions
--------------------

After creating a project, optional instructions can be added.
This can be useful to log how the annotations have been performed, or to instruct other annotators.
Those instructions are displayed in a side panel on the left, which can also be collapsed:

.. image:: img/instructions-panel.png

The instructions are defined by placing a ``instructions.html`` next to the ``project.xml`` in the project folder.
ImFusion Labels only supports a subset of HTML. This includes headings, lists and images. All supported elements are listed `here <https://doc.qt.io/qt-5/richtext-html-subset.html>`_.
Images are always loaded relative to the ``instructions.html`` file and must reside in the project folder.
External images are not supported.

The above screenshot uses the following html file:

.. code-block:: html

   <!DOCTYPE html>
   <html>
   <body>
     <h1>Pick a dataset</h1>
     <p>Please only label datasets which are assigned to you.</p>
     <p>Also notify the project lead when you want to re-label a completed dataset</p>
     
     <h1>Segmenting lungs</h1>
     <p>When segmenting the lungs please make sure that the Tracheobronchial Tree is included.</p>
     <p>For example the final segmentation should look like this:</p>
     <br>
     <img width="200" src="good.png" />
     <br>
     <p>and <strong>not</strong> like this:</p>
     <br>
     <img width="200" src="bad.png" />
   </body>
   </html>

If no ``instructions.html`` is present (the default), the sidebar won't be visible.