.. include:: vars.rst

.. _section-project-management:

Project Management
------------------

The Projects menu in the toolbar helps you with all operations related
to project management.

With this menu you can perform the actions described in the following
sections.

Create a New Project
^^^^^^^^^^^^^^^^^^^^

To create a brand new project, select “Create New...” from the Projects
Menu:

.. figure:: static/projects_create_new.png
    :alt: Creating a new project   
    :name: Figure_projects_create_new
    :align: center
    :figwidth: 30%

A pop-up will be presented where you can choose the name of the project
and select where the project will be saved on your filesystem. You can
select if you want to create an XML file now or load/create one later.

You can also choose to autosave the project, see information like the
time and date of the last time the project was saved, and view the
*System Designer* version and the *Connect DDS* version you are creating a
file for.

.. figure:: static/new_project.png
    :alt: Setting new project details   
    :name: Figure_new_project
    :align: center
    :figwidth: 100%

Open an Existing Project
^^^^^^^^^^^^^^^^^^^^^^^^

To open an existing project, select the **Open…** option in the Project
menu:

.. figure:: static/projects_open.png
    :alt: Opening a project   
    :name: Figure_projects_open
    :align: center
    :figwidth: 30%

A file browser will be presented. You can use it to find your
``.rtisdproj`` file.

Open a Recent Project
^^^^^^^^^^^^^^^^^^^^^

To open a recent project, select **Open Recent** from the Projects Menu:

.. figure:: static/projects_open_recent.png
    :alt: Opening a list of recent projects   
    :name: Figure_projects-open-recent
    :align: center
    :figwidth: 30%

You will see a list of recently opened projects. 
Select one and click **Open Selected**:

.. figure:: static/open_recent_project.png
    :alt: Seeing recent projects   
    :name: Figure_open_recent_project
    :align: center
    :figwidth: 90%

Import a Project from a Zip File
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To import a project from a Zip file, select **Import Zip...** from the
Projects menu:

.. figure:: static/projects_import_zip.png
    :alt: Importing a zipped project   
    :name: Figure_projects_import_zip
    :align: center
    :figwidth: 30%

Then use the file browser to find the Zip file:

.. figure:: static/find_zip_file.png
    :alt: Finding a zipped project to import 
    :name: Figure_find_zip_file
    :align: center
    :figwidth: 100%

Once you find it, select and open the file. A new dialog will 
ask you to select a destination directory in which to unzip
the file and save the imported project:

.. figure:: static/destination_imported_project.png
    :alt: Selecting a destination for the imported project 
    :name: Figure_destination_imported_project
    :align: center
    :figwidth: 90%

Press **OK** to import and open the project in *System Designer*.

Export a Project to a Zip File
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To export a project to a Zip file, select **Export Zip...** 
from the Projects menu:

.. figure:: static/projects_export_zip.png
    :alt: Exporting a project to a zip file 
    :name: Figure_projects_export_zip
    :align: center
    :figwidth: 30%

A Zip file will be downloaded in your default download directory. The
Zip file will contain the project file and all the XML files used in
that project.

Note: Some browsers (such as Safari) automatically unzip the folder. 
Disable this behavior or zip the directory again for sharing.

Remove a Project from the List of Recent Projects
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To remove a project from the list of recent projects, select 
**Remove...** from the Projects menu:

.. figure:: static/projects_remove.png
    :alt: Removing a project from recent projects 
    :name: Figure_projects_remove
    :align: center
    :figwidth: 30%

Then select the project you want to remove from the list and select
**Delete**:

.. figure:: static/remove_project.png
    :alt: Selecting a project to remove from the list of recent projects 
    :name: Figure_remove_project
    :align: center
    :figwidth: 90%

.. Note: 

  This only deletes the project from the list of recent projects in
  |SD|, not in your filesystem. For example, if this list becomes 
  too long, you may no longer want to see some projects listed here, 
  yet they are still saved in your filesystem.

Validate Project
^^^^^^^^^^^^^^^^

Two validation tests are currently available:

-   **Validate XSD** |br|
    This test uses the tool **xmllint**. The tool must already be 
    installed; it is available for the major 
    operating systems here: <http://xmlsoft.org/>.
-   **Check for unbounded strings/sequences** |br| 
    This test looks in the current project to see if there are any
    data types that are being used (in Topics used by DataReaders or
    DataWriters) that use unbounded sequences or strings. If so, this
    test prints a warning reminding you of the limitations (and
    potential problems) of using unbounded sequences or strings. In
    future releases, *System Designer* will also analyze each Entity's 
    QoS to ensure the required resources are correctly declared.

To validate a project, select **Validate...** from the Projects Menu.

.. figure:: static/projects_validate.png
    :alt: Choosing a project to validate 
    :name: Figure_projects_validate
    :align: center
    :figwidth: 90%

This will open a Validate dialog. You can run some or all of the
available tests:

.. figure:: static/validate_current_model.png
    :alt: Validating a project 
    :name: Figure_validate_current_model
    :align: center
    :figwidth: 90%

Project Properties
^^^^^^^^^^^^^^^^^^

To see the properties of the current project, select Properties from the
Projects menu:

.. figure:: static/projects_properties.png
    :alt: Selecting project properties 
    :name: Figure_projects_properties
    :align: center
    :figwidth: 30%

This will show a window with four tabs.

- The **General** tab shows the name of the project, where it is 
  saved, if autosave is enabled or not, the last time the project 
  was saved, and the |SD| and *Connext DDS* version numbers:

  .. figure:: static/project_properties.png
      :alt: Seeing general project properties 
      :name: Figure_project_properties
      :align: center
      :figwidth: 90%
- The **Notes** tab allows you to add a free-form 
  comment for the current project:

  .. figure:: static/project_properties_notes.png
      :alt: Adding a note to project properties 
      :name: Figure_project_properties_notes
      :align: center
      :figwidth: 90%
- The **Advanced** tab allows you to fine-tune some 
  of *System Designer's* behavior. 
  
  .. figure:: static/project_properties_advanced.png
      :alt: Setting advanced project properties 
      :name: Figure_project_properties_advanced
      :align: center
      :figwidth: 90%

  Click |help_icon| for more details on each setting.

  .. |help_icon| image:: static/help_icon.png
   :scale: 50 

- The **Open Files** tab shows which files are in use:

  .. figure:: static/project_properties_open_files.png
      :alt: Seeing what files are open
      :name: Figure_project_properties_open_files
      :align: center
      :figwidth: 90%


.. TO DO get above screenshot for open files