From cb8cd2099c498fbc0381212ae1f9580069903b29 Mon Sep 17 00:00:00 2001 From: eviau-artefactual Date: Mon, 18 Dec 2023 14:38:51 -0500 Subject: [PATCH] changes made to generate a pdf --- admin-manual/index.rst | 8 +- conf.py | 2 +- dev-manual/index.rst | 12 +- index.rst | 285 +---------------------------------------- user-manual/index.rst | 76 ++--------- 5 files changed, 27 insertions(+), 356 deletions(-) diff --git a/admin-manual/index.rst b/admin-manual/index.rst index f43e0a88..8ad12e64 100644 --- a/admin-manual/index.rst +++ b/admin-manual/index.rst @@ -3,8 +3,6 @@ Administrator manual ==================== .. toctree:: - - installation/index - maintenance/index - customization/index - security/index + :glob: + + */* diff --git a/conf.py b/conf.py index e22574d7..430b12ff 100644 --- a/conf.py +++ b/conf.py @@ -87,7 +87,7 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ["_build", ".env"] +exclude_patterns = ["_build", ".env", ".venv"] # The reST default role (used for this markup: `text`) to use for all documents. # default_role = None diff --git a/dev-manual/index.rst b/dev-manual/index.rst index 80e633ed..9c5b6cc0 100644 --- a/dev-manual/index.rst +++ b/dev-manual/index.rst @@ -8,13 +8,9 @@ Below you'll find an outline of the chapters in the Developer's manual, and a set of links to each chapter's main sections. .. toctree:: - - env/vagrant - env/compose - api/api-intro - api/browse-taxonomies - api/browse-io - api/read-io - api/download-do + :glob: + + api/* + env/* :ref:`Back to top ` diff --git a/index.rst b/index.rst index 9ccb8215..58cc88da 100644 --- a/index.rst +++ b/index.rst @@ -4,282 +4,9 @@ AtoM documentation ================== -.. _user-manual-home: - -User manual -=========== - -User guide to creating, editing, accessing, importing, exporting, and -translating content in AtoM; includes administering the system via the -:term:`user interface`. - -.. _overview: - -Overview --------- - -This section provides an overview of the technical architecture and -requirements. - -* :doc:`What is AtoM? ` -* :doc:`Technical requirements ` -* :doc:`Entity types ` -* :doc:`Descriptive standards ` - -.. _getting-started: - -Getting started ----------------- - -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 ` -* :ref:`Log in ` -* :ref:`User roles ` -* :ref:`Page types ` -* :ref:`Choose language ` -* :ref:`Change password ` - -.. _add-edit-content: - -Add/edit content ----------------- - -This section describes how to add, edit, and delete content in AtoM. - -* :ref:`Accession records ` -* :ref:`Archival descriptions ` -* :ref:`Authority records ` -* :ref:`Archival institutions ` -* :ref:`Deaccession records ` -* :ref:`Donors ` -* :ref:`Functions ` -* :ref:`Rights ` -* :ref:`Control area ` -* :ref:`Terms ` -* :ref:`Physical storage ` -* :ref:`formatting` -* :ref:`Exit edit mode ` - -.. _access-content: - -Access content --------------- - -This section provides guidelines for searching, browsing, and navigating. Most -of the functions discussed are available to all :ref:`user roles `, -including :ref:`researchers ` with read only access. However, -some navigation features (e.g. edit mode), are only available to users with -edit :term:`access privileges `. - -* :ref:`Search ` -* :ref:`Advanced search ` -* :ref:`Browse ` -* :ref:`Navigate ` -* :ref:`Context menu ` -* :ref:`clipboard` - -.. _translate: - -Translate ---------- - -This section describes how to translate both database content and -:term:`user interface` elements in AtoM. - -* :ref:`multilingual-design-principles` -* :ref:`Translate content ` -* :ref:`Translate interface ` -* :ref:`translate-static-pages` - - -.. _reports-printing: - -Reports/printing ----------------- - -This section describes how to create and print different types of reports using -AtoM: - -* :ref:`file-item-reports` -* :ref:`create-physical-storage-report` -* :ref:`print-finding-aids` - - -.. _import-export: - -Import/export -------------- - -This section describes automated methods for getting data in and out of an AtoM -application. - -* :ref:`Upload digital objects ` -* :ref:`import-xml` -* :ref:`export-xml` -* :ref:`csv-validation` -* :ref:`csv-import` -* :ref:`csv-export` -* :ref:`import-export-skos` -* :ref:`oai-pmh` - -.. _administer: - -Administer ----------- - -This section describes how to administer AtoM, whether for a single institution -or for a :term:`network`. - -* :ref:`Manage user accounts and user groups ` -* :ref:`Manage digital object storage ` -* :ref:`Edit user permissions ` -* :ref:`manage-jobs` -* :ref:`Manage static pages ` -* :ref:`Manage menus ` -* :ref:`Manage plugins ` -* :ref:`Settings ` -* :ref:`Themes and theming ` -* :ref:`Default language ` -* :ref:`Site logo ` -* :ref:`Search for updates ` -* :ref:`Visible elements ` - -.. _data-entry: - -Data entry / templates ------------------------ - -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 ` use -in AtoM, and more. - -* **Archival description templates** - - * :ref:`ISAD(G) template ` - * :ref:`RAD template ` - * :ref:`DACS template ` - * :ref:`Dublin Core template ` - * :ref:`MODS template ` - -* **Authority record templates** - - * :ref:`ISAAR-CPF template ` - -* **Archival institution templates** - - * :ref:`ISDIAH template ` - -* **Archival function templates** - - * :ref:`ISDF template ` - -* **Rights record templates** - - * :ref:`PREMIS template ` - -Glossary --------- - -Glossary of terms used throughout this user manual. - -* :doc:`Glossary ` - -.. _admin-manual-home: - -Administrator manual -==================== - -Instructions for installing, upgrading, importing and more; includes -administering the system via the command-line interface. - -.. _admin-installation: - -Installation ------------- - -* :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` - - -.. _admin-maintenance: - -Maintenance ------------ - -* :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-tuning` -* :ref:`maintenance-asynchronous-jobs` -* :ref:`maintenance-troubleshooting` -* :ref:`debug-mode` -* :ref:`maintenance-elasticsearch` - -.. _admin-customization: - -Customization -------------- - -* :ref:`customization-config-files` -* :ref:`customization-theming` -* :ref:`customization-watermarking` -* :ref:`customization-authentication` -* :ref:`customization-localization` - -.. _admin-security: - -Security --------- - -* :ref:`security-application` -* :ref:`security-firewall` -* :ref:`security-backups` - -.. _dev-manual-home: - -Developer's manual -================== - -Guidelines for developers interested in customizing AtoM, developing new -modules, and working with the application's API. - -.. _dev-env-home: - -Environments ------------- - -We provide two developer-friendly environments for AtoM. - -* :ref:`dev-env-vagrant` -* :ref:`dev-env-compose` - -.. _dev-api-home: - -API ---- - -Overview of the application programming interface available in AtoM. Includes -sample requests and responses for available endpoints. - -* :ref:`api-intro` -* :ref:`api-browse-taxonomies` -* :ref:`api-browse-io` -* :ref:`api-read-io` -* :ref:`api-download-do` +.. toctree:: + :glob: + + admin-manual/* + user-manual/* + dev-manual/* diff --git a/user-manual/index.rst b/user-manual/index.rst index 69a69645..832bb36c 100644 --- a/user-manual/index.rst +++ b/user-manual/index.rst @@ -8,66 +8,16 @@ Below you'll find an outline of the chapters in the user manual, and a set of links to each chapter's main sections. .. toctree:: - - overview/intro - overview/technical-requirements - overview/entity-types - overview/descriptive-standards - getting-started/getting-started - add-edit-content/accessions - add-edit-content/archival-descriptions - add-edit-content/authority-records - add-edit-content/archival-institutions - add-edit-content/deaccessions - add-edit-content/donors - add-edit-content/functions - add-edit-content/rights - add-edit-content/control-area - add-edit-content/terms - add-edit-content/physical-storage - add-edit-content/formatting - add-edit-content/exit-edit-mode - access-content/search-atom - access-content/advanced-search - access-content/browse - access-content/navigate - access-content/context-menu - access-content/clipboard - translate/multilingual-design-principles - translate/translate-content - translate/translate-interface - translate/translate-static-pages - reports-printing/file-item-reports - reports-printing/create-physical-storage-report - reports-printing/print-finding-aid - import-export/upload-digital-object - import-export/import-xml - import-export/export-xml - import-export/csv-import - import-export/csv-export - import-export/csv-validation - import-export/import-export-skos - import-export/oai-pmh - administer/manage-user-accounts - administer/manage-digital-object-storage - administer/edit-permissions - administer/manage-jobs - administer/static-pages - administer/manage-menus - administer/manage-plugins - administer/settings - administer/themes - administer/default-language - administer/site-logo - administer/search-updates - administer/visible-elements - data-templates/isad-template - data-templates/rad-template - data-templates/dacs-template - data-templates/dc-template - data-templates/mods-template - data-templates/isaar-template - data-templates/isdiah-template - data-templates/isdf-template - data-templates/premis-template - glossary/glossary + :glob: + + * + overview/* + add-edit-content/* + access-content/* + translate/* + reports-printing/* + import-export/* + administer/* + data-templates/* + glossary/* + getting-started/*