User guide to creating, editing, accessing, importing, exporting, and translating content in AtoM; includes administering the system via the :term:`user interface`.
This section provides an overview of the technical architecture and requirements.
- :doc:`What is AtoM? <user-manual/overview/intro>`
- :doc:`Technical requirements <user-manual/overview/technical-requirements>`
- :doc:`Entity types <user-manual/overview/entity-types>`
- :doc:`Descriptive standards <user-manual/overview/descriptive-standards>`
This section describes how to start using AtoM once it has been installed. It provides a quick orientation to the home page, how to log in and log out, the various user roles in the system, the main page types a user will encounter, and how to switch languages.
- :ref:`Home page <home-page>`
- :ref:`Log in <log-in>`
- :ref:`User roles <user-roles>`
- :ref:`Page types <page-types>`
- :ref:`Choose language <choose-language>`
- :ref:`Change password <change-password>`
This section describes how to add, edit, and delete content in AtoM.
- :ref:`Accession records <accession-records>`
- :ref:`Archival descriptions <archival-descriptions>`
- :ref:`Authority records <authority-records>`
- :ref:`Archival institutions <archival-institutions>`
- :ref:`Deaccession records <deaccessions>`
- :ref:`Donors <donors>`
- :ref:`Functions <functions>`
- :ref:`Rights <rights>`
- :ref:`Control area <control-area>`
- :ref:`Terms <terms>`
- :ref:`Physical storage <physical-storage>`
- :ref:`formatting`
- :ref:`Exit edit mode <exit-edit-mode>`
This section provides guidelines for searching, browsing, and navigating. Most of the functions discussed are available to all :ref:`user roles <user-roles>`, including :ref:`researchers <user-researcher>` with read only access. However, some navigation features (e.g. edit mode), are only available to users with edit :term:`access privileges <access privilege>`.
- :ref:`Search <search-atom>`
- :ref:`Advanced search <advanced-search>`
- :ref:`Browse <browse>`
- :ref:`Navigate <navigate>`
- :ref:`Context menu <context-menu>`
- :ref:`clipboard`
This section describes how to translate both database content and :term:`user interface` elements in AtoM.
- :ref:`multilingual-design-principles`
- :ref:`Translate content <translate-content>`
- :ref:`Translate interface <translate-interface>`
- :ref:`translate-static-pages`
This section describes how to create and print different types of reports using AtoM:
This section describes automated methods for getting data in and out of an AtoM application.
- :ref:`Upload digital objects <upload-digital-object>`
- :ref:`import-xml`
- :ref:`export-xml`
- :ref:`csv-validation`
- :ref:`csv-import`
- :ref:`csv-export`
- :ref:`import-export-skos`
- :ref:`oai-pmh`
This section describes how to administer AtoM, whether for a single institution or for a :term:`network`.
- :ref:`Manage user accounts and user groups <manage-user-accounts>`
- :ref:`Manage digital object storage <manage-digital-object-storage>`
- :ref:`Edit user permissions <edit-user-permissions>`
- :ref:`manage-jobs`
- :ref:`Manage static pages <manage-static-pages>`
- :ref:`Manage menus <manage-menus>`
- :ref:`Manage plugins <manage-plugins>`
- :ref:`Settings <settings>`
- :ref:`Themes and theming <themes>`
- :ref:`Default language <default-language>`
- :ref:`Site logo <site-logo>`
- :ref:`Search for updates <search-updates>`
- :ref:`Visible elements <visible-elements>`
This section includes specific instructions on working with AtoM's standards-based edit templates. Data entry guidance is provided based on guidance from the relevant standard, notes on each :term:`field's <field>` use in AtoM, and more.
- Archival description templates
- Authority record templates
- Archival institution templates
- Archival function templates
- Rights record templates
Glossary of terms used throughout this user manual.
Instructions for installing, upgrading, importing and more; includes administering the system via the command-line interface.
- :ref:`installation-intended-audience`
- :ref:`installation-requirements`
- :ref:`installation-ubuntu`
- :ref:`installation-windows`
- :ref:`installation-macosx`
- :ref:`installation-ansible`
- :ref:`installation-upgrading`
- :ref:`installation-execution-limits`
- :ref:`maintenance-cli-tools`
- :ref:`cli-import-export`
- :ref:`maintenance-clear-cache`
- :ref:`maintenance-web-analytics`
- :ref:`maintenance-logging`
- :ref:`maintenance-monitoring`
- :ref:`maintenance-populate-search-index`
- :ref:`maintenance-data-backup`
- :ref:`common-atom-queries`
- :ref:`maintenance-asynchronous-jobs`
- :ref:`maintenance-troubleshooting`
- :ref:`debug-mode`
- :ref:`maintenance-elasticsearch`
- :ref:`customization-config-files`
- :ref:`customization-theming`
- :ref:`customization-watermarking`
- :ref:`customization-authentication`
- :ref:`customization-localization`
- :ref:`security-application`
- :ref:`security-csp-headers`
- :ref:`security-firewall`
- :ref:`security-backups`
Guidelines for developers interested in customizing AtoM, developing new modules, and working with the application's API.
We provide two developer-friendly environments for AtoM.
Overview of the application programming interface available in AtoM. Includes sample requests and responses for available endpoints.