.. _archive_list:

The Archive List
================

The Archive List on the right hand side of the smartCollector window includes all Nukescripts to archive.

.. image:: img/archive_list.jpg

To add a Nukescript to the
Archive list drag and drop it from the :ref:`Nukescripts list <nukescripts_list>`
or right click one element and choose :ref:`Add to Archive List <nukescripts_elements>`.

Right click menu
----------------
Right clicking the Archive List in an empty space shows the context menu as seen below.

.. image:: img/archive_list_right_click_menu.jpg

The context menu contains the following commands:

|    **1) Batch archive All:** Clicking this command will archive all Nukescripts in the Archive List. In the settings we can control how many archives to run simultaneously.
|    **2) Collapse all:** Hides all archive element's details.
|    **3) Flush Archive list:** Removes all Archive Elements from the Archive list. This will not delete them from the hard drive but simply remove them from the list.
|


Archive Element
---------------
The Nukescripts in the Archive List are called **Archive Element**.
Double clicking one of the Nukescripts in the archive list will show/ hide its details.

.. image:: img/archive_element.jpg

The Archive Element contains several elements:

|    **1) Nukescript name:** If we hover over it, the absolute path of the Nukescript will be displayed as a tooltip.
|    **2) Archive progress** Once we archive the Nukescript, the progress will show the current archiving progress. 100% means that the Nukescript is fully archived.
|    **3) Output path:** Here we can set the absolute path to archive to. By default smartCollect archives shots next to their original Nukescript. However, in the settings this behaviour can be changed and we can set a default archiving path. We can then always click the folder icon to change the path afterwards if required.
|    **4) Get Sources:** Clicking this button lets will display all used sources for the current Nukescript prior to archiving. Please have a look at the :ref:`Get Sources <get_sources>` section for more information.
|    **5) Comment:** Clicking this button toggles the textarea to an input area that lets us write a comment for the archive which will be included in the archive report. Please have a look at the :ref:`Comment <comment>` section for more information.
|    **6) Archive:** Clicking this button starts the archive for the current Nukescript. Please have a look at the :ref:`Archive <archive>` section for more information.
|    **7) Textarea:** Displays the arching output and serves as input for writing comments.
|


.. _get_sources:

Get Sources
```````````
Each Archive element includes a **Get Sources** button that lets will display the Nukescript's sources.
Using that button we can get a sense of the size of number of use sources prior to archiving.

Let's click the **Get Sources** Button  **(1)**. The textarea below will show all used sources of the Nukescript **(2)**.

.. image:: img/archive_element_get_sources.jpg

.. _comment:

Comment
```````
smartCollect lets us append a personal comment for the archive if required.
The comment will be included in the archive's output report once the archive is finished.

Let's click the **Comment** button.

.. image:: img/comment_startup.jpg

The comment button tints blue and the textarea below becomes editable. Let's append our comment **(1)**.
When we are finished writing our comment we can press the blue **Save Comment** button **(2)**.

.. image:: img/comment.jpg

.. _archive:

Archive
```````

When we are ready to archive our Nukescript let's hit the **Archive** Button.
smartCollect will archive the Nukescript to the set path. The progress displays
the archiving progress. The textarea and the statusbar at the bottom display the archived sources.

.. image:: img/archiving.jpg

Once the rendering is finished we will get the following archive output:

.. image:: img/archive_output.jpg

Our archive contains the following elements:

    - The footage directory that includes all archived sources.
    - An archive report which includes information about the archive settings and the archived sources.
    - A copy of our shot.

Please note that the :ref:`settings <settings>` section lets you further define the archive output and change the way the Nukescripts get archived.

Right click menu
````````````````
Right clicking the archive element will show the archive element's context menu as seen below.

.. image:: img/archive_element_right_click_menu.jpg

The context menu contains the following commands:

|    **1) Archive** Starts the archiving process. This has the same effect as clicking the blue **Archive** button.
|    **2) Reveal** This sub menu contains the following commands:
|        **Archive (5):** Reveals the archive in the explorer.
|        **Log (6):** Reveals the log in the explorer.
|        **Source Nuke script (7):** Reveals the source Nuke script in the explorer.
|    **3) Collapse all:** Collapses all archive elements in the Archive List.
|    **4) Remove:** Removes the selected archive elements from the Archive List. This will not delete the Nukescripts but simply removes the Nukescript from the list.
|
|