Skip to content

Commit

Permalink
Small syntax fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@sevein
sevein committed Sep 15, 2016
1 parent 40aa02e commit fd89d1e
Show file tree
Hide file tree
Showing 7 changed files with 109 additions and 122 deletions.
Empty file added _static/.gitkeep
View file
Empty file.
2 changes: 1 addition & 1 deletion conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
#source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'
master_doc = 'contents'

# General information about the project.
project = u'Archivematica'
Expand Down
2 changes: 1 addition & 1 deletion user-manual/access/access.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ information and credentials in the Administration tab. See :ref:`Administrator m
.. tip::

The permalink is the "slug" from the AtoM target description.
See :ref:`slug <atom:slug>` in the AtoM glossary.
See ``slug`` in the AtoM glossary.

3. Click the blue "Upload" button. Digital objects are uploaded as items within the description to which the DIP is being uploaded. If you want to create a child level of description under the target description, you must add the title of that level of description using the DC metadata template prior to normalization.

Expand Down
61 changes: 35 additions & 26 deletions user-manual/appraisal/appraisal.rst
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _appraisal:

======
=========
Appraisal
======
=========

The Appraisal tab provides a space between Transfer and Ingest for archivists to make decisions about what files from transfers should become SIPs and how these files should be arranged within the SIP. It includes features for examining the characteristics and contents of the files as well as for connecting files to finding aids created in ArchivesSpace. The Arrange a SIP from Backlog feature, found in previous versions of Archivematica, also has moved to the Appraisal tab (see :ref:`Arrangement <arrangement>`).

Expand All @@ -18,7 +18,8 @@ The Appraisal tab provides a space between Transfer and Ingest for archivists to
.. _backlog_pane:

Transfers in the Backlog
------------
------------------------

Transfers that have been sent to the backlog can be found in the Backlog pane of the Appraisal tab. Search the backlog by entering search terms and parameters in the search box at the top of the page.

.. image:: images/search_backlog.*
Expand All @@ -27,7 +28,8 @@ Transfers that have been sent to the backlog can be found in the Backlog pane of
:alt: Search box for searching the backlog in the Appraisal tab

Adding Tags
=========
===========

Tags can be added to selected files in the backlog by entering a tag name and clicking the “Add tag to selected files” button at the top of the Backlog pane.

.. image:: images/tags_backlog.*
Expand All @@ -45,12 +47,13 @@ Tags that have already been created appear in the Tags drop-down menu. Choosing
.. _analysis_pane:

Analysis
------------
--------

The analysis pane allows the user to explore files in transfers sent to the backlog. Files selected in the Backlog pane populate the Analysis pane and can be analyzed through four tabs: Objects, Tags, Examine Contents, and Preview File.

1) Objects
=========
==========

In the Objects tab, information about selected files can be viewed in the form of a report or a visualization. The Report view provides information about the files’ format, PUID, group, number of files, and size. Files can also be analyzed through visualizations with options for representing the total number of files in each format and for representing the total size of files for each format represented in the list.

.. figure:: images/analysis_report.*
Expand All @@ -73,7 +76,8 @@ In the Objects tab, information about selected files can be viewed in the form o
Files listed in Analysis can also be filtered by Format, PUID, and Group through selecting values for these facets in the Report view. For instance, if the user clicks on the Group “Portable Document Format” listed for one of the files, this filter is added and only PDF files remain listed in the Analysis pane. Filters appear under the Tags drop-down menu and can be removed by clicking the “x” beside the name.

2) Tags
=========
=======

The Tags tab lists any tags that have been added and how many of each tag are present in the selected files.

.. image:: images/analysis_tags.*
Expand All @@ -82,7 +86,8 @@ The Tags tab lists any tags that have been added and how many of each tag are pr
:alt: Tags tab in the analysis pane

3) Examine Contents
=========
===================

If Examine Contents (using the tool Bulk Extractor) was used during transfer, the Examine Contents tab provides the reports created during this micro-service. This tab includes options for listing files that potentially contain personally identifiable information (PII) or credit card numbers. Examine Contents also includes an option for adding tags to these files.

.. figure:: images/analysis_examine_contents.*
Expand All @@ -94,13 +99,15 @@ If Examine Contents (using the tool Bulk Extractor) was used during transfer, th
Examine contents tab showing a selected transfer where no files with PII were found

4) Preview File
=========
===============

Files selected in the File List pane (see below) can be previewed in the Preview File tab.

.. _File_list_pane:

File List
------------
---------

The File List pane is also populated through selecting files in the Backlog pane. File List provides information about the filenames, sizes, dates files were last modified (if available), and any tags that have been added to the selected files.

Any filters that have been applied in the Analysis pane or through the Tags drop-down menu will affect what files appear in File List. In addition, a date range can be added to filter files by the date they were last modified.
Expand All @@ -118,7 +125,6 @@ This pane also provides an option for adding tags. Files can be selected by chec

Clicking on the name of the file opens a preview in the Analysis pane.


.. image:: images/analysis_preview_file.*
:align: center
:width: 80%
Expand All @@ -128,15 +134,18 @@ Clicking on the name of the file opens a preview in the Analysis pane.
.. _archivesspace_pane:

ArchivesSpace Resources
-----------------
-----------------------

The ArchivesSpace pane in the Appraisal tab allows for retrieving and adding to resources that have been created in an ArchivesSpace repository. Settings for ArchivesSpace DIP upload should be configured in the :ref:`Dashboard administration tab <dashboard-admin>` to associate the ArchivesSpace repository. In the ArchivesSpace pane, files transferred into Archivematica can be associated with resources created in ArchivesSpace and SIPs can be sent to Ingest.

ArchivesSpace Terms
=========
===================

Finding aids in ArchivesSpace are called “resources” (i.e. fonds, collection, record group, etc.). Lower levels of description nested under resources are “archival objects” (series, files, items, etc.). Metadata about digital files is managed separately as “digital objects” which can be associated with resources/archival objects at any level of description. More information on ArchivesSpace can be found at http://archivesspace.org/

Searching for ArchivesSpace Resources
=============
=====================================

The search box at the top of the ArchivesSpace panel allows for searching for resources within an ArchivesSpace repository. A user can search by the title or identifier of a resource.

ArchivesSpace resources can be expanded to show lower levels of description. Folder icons indicate ArchivesSpace resources and archival objects which have child records nested under them. Page icons indicate resources and archival objects that do not have child records. Digital object components are designated by the parallel lines icon.
Expand All @@ -147,7 +156,8 @@ ArchivesSpace resources can be expanded to show lower levels of description. Fol
:alt: ArchivesSpace pane with an ArchivesSpace resource expanded to show levels of heirarchy

Creating Archival Description
========
=============================

Options at the top of the ArchivesSpace pane allow for adding to and changing an existing ArchivesSpace resource, such as adding new archival objects and digital object components.

Selecting a resource or archival object and using “Add New Child Record” adds a new archival object nested underneath the selected level of description. Clicking this button brings up a dialog box for entering metadata. At a minimum, a new archival object must have a title and a level of description, otherwise “save” is not available.
Expand All @@ -162,7 +172,8 @@ The new archival object will appear in the ArchivesSpace pane and the change wil
“Add New Digital Object Component” similarly allows for adding digital object components to ArchivesSpace resources/archival objects.

.. note::
Digital object components will not appear in the ArchivesSpace repository until later in the workflow when the AIP for the digital object is stored.

Digital object components will not appear in the ArchivesSpace repository until later in the workflow when the AIP for the digital object is stored.

Both archival objects and digital object components can be created in the ArchivesSpace pane at any level of description; however, new resources can only be created in ArchivesSpace.

Expand All @@ -173,43 +184,40 @@ Basic metadata for existing archival objects and digital object components can b
:width: 60%
:alt: Edit metadata dialog box


“Edit Rights Metadata” leads to a form for adding PREMIS rights information.

.. figure:: images/archivesspace_add_rights_metadata1.*
.. figure:: images/archivesspace_edit_rights_metadata1.*
:align: center
:figwidth: 70%
:width: 100%
:alt: Form for adding rights information

Click "Add" to add rights.

.. figure:: images/archivesspace_add_rights_metadata2.*
.. figure:: images/archivesspace_edit_rights_metadata2.*
:align: center
:figwidth: 70%
:width: 100%
:alt: Adding PREMIS rights information

Specify the type of rights information from the drop-down menu and fill out the relevant fields.


The form for adding rights includes two pages of fields. Once added, acts can be edited or deleted and further acts can be added.


.. image:: images/archivesspace_add_rights metadata3.*
.. image:: images/archivesspace_edit_rights_metadata3.*
:align: center
:width: 70%
:alt: Added rights in Archivematica


.. note::
Rights can only be added at the SIP level.

Rights can only be added at the SIP level.

.. _adding_files_archivesspace:

Adding Files to ArchivesSpace Resources and Starting SIPs
-----------
---------------------------------------------------------

Files from transfers in the Backlog pane can be associated with ArchivesSpace resources by dragging files from the backlog to digital object components.

.. image:: images/backlog_and_archivesspace.*
Expand All @@ -226,7 +234,8 @@ Once all files have been added to their place in the arrangement, SIPs can be st
.. _arrangement:

Arrangement
---------
-----------

The Arrangement pane replaces the Arrange a SIP from Backlog feature from previous versions of Archivematica. This pane provides options for appraising and arranging files from the backlog for users not using ArchivesSpace.

Files from the Backlog pane can be dragged to the Arrangement pane to arrange the files and create SIPs.
Expand Down
6 changes: 3 additions & 3 deletions user-manual/getting-started/configuration.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@ Integration settings
Archivematica integrates with a number of different access and storage systems.
Please see:

* :ref:`AtoM <dashboard-atom>`
* :ref:`ContentDM <dashboard-CDM>`
* :ref:`AtoM <admin-dashboard-atom>`
* :ref:`ContentDM <contentdm>`
* :ref:`Archivist's Toolkit <dashboard-AT>`
* :ref:`DSpace <dspace>`
* :ref:`LOCKSS <storageService:lockss>` (Administrator documentation)
* :ref:`LOCKSS <storageService:admin-lockss>` (Administrator documentation)
* Duracloud (coming soon)
* Arkivum (coming soon)

Expand Down
47 changes: 13 additions & 34 deletions user-manual/ingest/ingest.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,7 @@ Arrange a SIP from backlog

Transfer backlog search results in populating Originals pane

Archivematica will display the directories in Transfer backlog including the
number of objects in each directory. To hide directories from the Originals pane, click on the
directory and click Hide.
Archivematica will display the directories in Transfer backlog including the number of objects in each directory. To hide directories from the Originals pane, click on the directory and click Hide.

2. Drag and drop the transfer directory(ies) and/or object(s) you wish to arrange and ingest as a SIP from the Originals pane to the Arrange pane, or create an arrangement structure for your SIP (see step 4, below).

Expand Down Expand Up @@ -104,7 +102,6 @@ directory and click Hide.

Create a new directory in Arrange pane


5. Click and drag files from the Originals pane into your desired directory in the arrange panel. You can move either individual files or entire directories. Note: All files must be in a directory inside of Arrange. “Arrange” cannot be used as the top directory.

6. When you have completed moving files and directories into the Arrange pane, click on the top level directory which you wish to include in your SIP. Click on Create SIP. Any files or directories which are not inside the directory you chose will remain in the Arrange pane until you create a SIP using these files and directories.
Expand All @@ -127,35 +124,29 @@ selected by the user.
Add metadata
------------

In Archivematica, metadata can be added either prior to the normalization step
or after. Archivematica will prompt you with a reminder to add metadata if
desired during the Process metadata directory micro-service. See
:ref:`AtoM Dublin Core <atom:dc-template>`_
for information about the Dublin Core elements available.
In Archivematica, metadata can be added either prior to the normalization step or after. Archivematica will prompt you with a reminder to add metadata if desired during the Process metadata directory micro-service. See :ref:`AtoM Dublin Core <atom:dc-template>` for information about the Dublin Core elements available.

.. seealso::

If you are importing lower-level metadata (i.e. metadata to be attached to subdirectories and files within a SIP) see also:

* :ref:`Transfer <transfer>`
If you are importing lower-level metadata (i.e. metadata to be attached to subdirectories and files within a SIP) see also:

* :ref:`Import metadata <import-metadata>`
* :ref:`Transfer <transfer>`
* :ref:`Import metadata <import-metadata>`

.. note::
If you plan to create a DIP to :ref:`Upload to AtoM<dip-upload-atom>`, you may wish to add levels of description to your directories and/or objects. Archivematica will add a logical structMAP to the METS file, which AtoM will use to create information objects, applying the chosen levels of description. Note that if you do not apply a level of description to a digital object, AtoM will automatically assign it the level of item.

This functionality is supported in AtoM 2.2 and higher.
If you plan to create a DIP to :ref:`Upload to AtoM <upload-atom>`, you may wish to add levels of description to your directories and/or objects. Archivematica will add a logical structMAP to the METS file, which AtoM will use to create information objects, applying the chosen levels of description. Note that if you do not apply a level of description to a digital object, AtoM will automatically assign it the level of item.

Click to select a directory or object, then click Edit metadata to choose the
level of description.
This functionality is supported in AtoM 2.2 and higher.

Click to select a directory or object, then click Edit metadata to choose the level of description.

.. image:: images/choose_lod.*
:align: center
:width: 80%
:alt: Choosing the AtoM level of description

As you add levels of description they will be shown in the arrange pane for you
to review before finalizing your SIP.
As you add levels of description they will be shown in the arrange pane for you to review before finalizing your SIP.

.. image:: images/view_arrangement.*
:align: center
Expand All @@ -175,12 +166,6 @@ to review before finalizing your SIP.
If you choose not to assign levels of description to directories in SIP arrange,
AtoM will flatten the DIP so that all digital objects are child-level descriptions
of the target description.
ower-level metadata (i.e. metadata to be attached to
subdirectories and files within a SIP) see also:

* :ref:`Metadata import <import-metadata>`
* :ref:`Transfer <transfer>`


1. Click on the template icon.

Expand All @@ -192,13 +177,10 @@ ower-level metadata (i.e. metadata to be attached to

To add metadata, click on the template icon


2. This will take you to the SIP detail panel. On the left-hand side, under metadata click Add.

.. figure:: images/SIPDetailPanel1.*
:align: center* :ref:`Upload DIP to AtoM <dip-upload-atom>`
* :ref:`Upload DIP to ArchivesSpace <dip-upload-AS>`
* :ref:`Upload DIP to Archivists' Toolkit <dip-upload-AT>`
:align: center
:figwidth: 80%
:width: 100%
:alt: SIP detail panel
Expand All @@ -217,9 +199,7 @@ ower-level metadata (i.e. metadata to be attached to

.. important::

If you would like to upload your DIP to AtoM as a child of an existing
target description, you must add at least a Title in the Dublin Core
template.
If you would like to upload your DIP to AtoM as a child of an existing target description, you must add at least a Title in the Dublin Core template

4. When you click Create, you will see the metadata entry in the list page. To edit it further, click Edit on the right-hand side. To delete it, click Delete. To add more DC metadata, click the Add button below the list.

Expand All @@ -245,7 +225,6 @@ PREMIS rights fields, see :ref:`PREMIS template <premis-template>`

1. Click on the template icon.


.. figure:: images/MetadataIcon1.*
:align: center
:figwidth: 80%
Expand Down Expand Up @@ -407,7 +386,7 @@ Store AIP

1. After normalization is approved, the SIP runs through a number of micro-services, including processing of the submission documentation, generation of the METS file, indexing, generation of the DIP and packaging of the AIP.

2. When these micro-services are complete, the user can upload the DIP and store the AIP. See below for :ref:`ArchivesSpace <dip-upload-AS>` and Archivists' Toolkit DIP upload
2. When these micro-services are complete, the user can upload the DIP and store the AIP. See below for :ref:`ArchivesSpace <upload-as>` and Archivists' Toolkit DIP upload


.. figure:: images/StoreAIPUpDIP1.*
Expand Down
Loading

0 comments on commit fd89d1e

Please sign in to comment.