Community documentation

From AtoM wiki
Revision as of 09:09, 19 December 2018 by Katrina cp (talk | contribs)


Main Page > Community > Community/Community resources > Community/Community resources/Documentation

This page includes examples of community generated documentation - style guides, install instructions, institutional descriptive policies for AtoM use, User guide translations, and more. Have a resource to add, or one that you know about which is publicly available? Please help us by adding it!

Seealso

Instructions for installing AtoM using RedHat or CentOS

Created by community user Stefano Bortolato, this guide offers instructions for installing and configuring AtoM (release 2.2) using either CentOS or RedHat as the default server, instead of Ubuntu 14.04, as the default installation instructions outline (found here for 2.2). It also uses Apache server instead of Nginx, and MariaDB instead of MySQL.

Stefano has posted the instructions in the AtoM user forum, here:

SFU AtoM - Data entry guidelines

At Simon Fraser University, the SFU Archives and SFU Library's Special Collections and Rare Books share an AtoM instance known as SFU AtoM, using AtoM's multi-institutional functionality. The archivists have created a comprehensive data entry guide for project archivists, students, and volunteers working in SFU AtoM:

Archeion for Archivists data entry guidelines

Archeion is the Ontario (Canada) provincial archival portal maintained by the Archives Association of Ontario (AAO), with archival descriptions contributed by over 170 different institutions in Ontario. To assist participating institutions, the AAO has created some data entry documentation, in English and French, entitled Archeion for Archivists, and covering topics such as how to create authority records, archival descriptions, and repository records in AtoM. See the guides here:

AtoM RAD CSV notes

Created by community user Katrina Cohen-Palacios, these notes were compiled from the documentation as a cheat sheet while embarking on my first CSV imports and exports. The notes as kept in a publicly-viewable Google spreadsheet.

AtoM installation instructions on CentOS 6.5

Created by community user Ivan Rivera, this tutorial will help you get AtoM 2x installed using CentOS 6, instead of Ubuntu 12.04/14.04, as documented by Artefactual. Titled "Step by Step Tutorial: Install Atom (ICA-AtOM) 2.0 in a CentOS 6.5 x86-x64 over VirtualBox", the tutorial is kept in a publicly-viewable Google Doc at the moment, available here.

Originally shared in this AtoM User Forum thread - if you find any problems, or have any suggestions for improvement, we suggest posting them there!

ICA-AtoM User Manual in Spanish, from Vidimus

Created by Blanca Biarge Gallardo for Vidimus, a Barcelona-based company specializing in archival and document management services, this User Manual was first created in 2012, and then updated to its current version 2 status in April of 2014. Instructions are based on ICA-AtoM release 1.3.

Intstalling ICA-AtoM using XAMPP

Created by Lucía Fernández Granados, this Spanish-language guide outlines how to install ICA-AtoM (1.x) using XAMPP for a Windows-based virtual installation. Created as part of a 2013/2014 course, the guide can be found here:

ICA-AtoM Finding Aid Style Guide and AtoM FAQ - Dumbarton Oaks

In June 2014, The Image Collections and Fieldwork Archives (ICFA) of Dumbarton Oaks Research Library and Collection announced the release of its AtoM Finding Aid Style Guide. "Developed by ICFA staff to document local practices for internal reference and training, the Guide addresses all aspects of description: from collection-level details such as creation and acquisition information to providing file-specific storage locations. In addition, there are sections on developing an intellectual arrangement and devising titles for each record group in a collection."

The landing page also notes: "In advance of the department’s conversion of their legacy finding aids, ICFA staff also produced a workflow to help guide staff to the system. The Workflow provides step-by-step instructions on how to develop new collections in ICA-AtoM based on existing Word finding aids, and is intended to be used in conjunction with the Guide, a more comprehensive reference resource for description." The Workflow is available upon request (icfa@doaks.org).

Dumbarton Oaks also maintains an online FAQ about using AtoM@DO, the AtoM installation used by the Image Collections and Fieldwork Archives (ICFA) and the Dumbarton Oaks Archives (DOA).

Upgrading from ICA-AtoM 1.0.x

Artefactual developer José Raddaoui Marin created this documentation for users upgrading from ICA-AtoM 1.0.x to AtoM 2.x. If you are upgrading from AtoM 1.1.x or newer, please see the Upgrading page in the documentation. The guide for upgrading from ICA-AtoM 1.0.x can be found here:

AtoM documentation in Brazilian Portuguese

Produced via a collaboration between the Comissão Nacional da Verdade (CNV - National Truth Commission) and the Instituto Brasileiro de Informação em Ciência e Tecnologia (IBICT - Brazilian Institute of Information in Science and Technology) and with support from the Brazilian Arquivo Nacional (National Archives), this manual captures both the User manual and the Administrator's manual for installation and maintenance of AtoM. Based on version 2.2.

There is also a previous version of the ICA-AtoM (v. 1.2) User Manual available. Prepared by Neiva Pavezi of the Federal University of Santa Maria (Universidad Federal de Santa Maria), this guide translates the 1.2 version of the ICA-AtoM online User Guide into Brazilian Portuguese. It was prepared in 2013.

AtoM 2.3 Installation instructions for Ubuntu 16.04 in Brazilian Portuguese

With translation work overseen by Sérgio Rodrigues, member of a Digital Documents group based at the Federal University of Santa Maria (UFSM), this document translates the AtoM 2.3 installation guide into Brazilian Portuguese: