AtoM wiki - User contributions [en]

Development/Functional testing/Single sign-on (CAS) tests

2025-07-01T12:18:35Z

Dan: Add category and navigation footer

{{#pagetitle: Single sign-on (CAS) tests }}
[[Main Page]] > [[Development]] > [[Development/Functional testing]] > Development/Functional testing/Single sign-on (CAS) tests

==About==
Centralized Authentication Service (CAS) is an enterprise single sign-on protocol that can be implemented in AtoM by enabling the arCasPlugin and by registering user accounts with a CAS server. For more about CAS see https://www.apereo.org/projects/cas.

For testing purposes, a public CAS demo server can be used. See https://python-cas-flask-example.herokuapp.com/. The username ''admin'' and the password ''django-cas-ng'' can be used to authenticate on the demo server.

The arCasPlugin also provides an optional mechanism for dynamically setting AclUserGroup membership on each login, based on the presence or absence of expected values in the attributes returned from the CAS server during p3/serviceValidate (CAS version 3.0 only).

==Single sign-on login==

Test scenario: A user is authenticated through a Central Authentication Service (CAS) single sign-on form and is automatically logged in to an AtoM session.

Given: The institution hosting AtoM is running a CAS server.

And: The user has an active CAS account.

And: The user account is present in the AtoM group member list on the CAS server.

When: The user starts a new session on the institution’s domain and navigates to an AtoM page that requires authentication.

----

Then: The unauthenticated user is redirected to the CAS login form where they enter their CAS username and password.

And: The CAS server successfully authenticates the user, assigns them a session service ticket, and redirects them to the AtoM server.

And: AtoM sends the service ticket to the CAS server over HTTPS for validation.

And: The CAS server sends a success response to AtoM which includes the user attributes set on the CAS server.

And: AtoM creates a new user account if one matching the CAS account doesn’t already exist.

And: AtoM sets the user session cookie (with the service ticket stripped off) and redirects the user to a new, authenticated AtoM session.

And: AtoM checks its configuration file to see if there are expected CAS attributes for user groups. If so, AtoM checks whether the user has the appropriate attribute for a given group and elevates their user authorization to become an authenticated member of one or more of these groups if this is the case (e.g. editor, translator, administrator).
And: When the user logs out of AtoM, they will also be automatically logged out of CAS.

----

Given: A user account is created on the CAS server and the user has logged into AtoM

When: An AtoM administrator user deletes that user account in AtoM

Then: The user is still able to log-in using their CAS account and their AtoM account is re-created

------

* [[Development/Functional_testing|Back to Functional testing]]
* [[Development|Back to Development]]
* [[Main Page|AtoM wiki home]]

[[Category:Development documentation]]

Community/Groups/NA

2025-07-01T12:17:02Z

Dan: Add page category and navigation footer

{{#pagetitle: Joint US Canada Users group}}
[[Main Page]] > [[Community]] > [[Community/Groups]] > Community/Groups/NA

'''Background'''

The Joint US-Canada AtoM Users Group began in 2020. We discuss issues of interest identified in surveys carried out of group members. To date, we have 100 members on our mailing list from the US, Canada, and a small number from Europe. Originally, we held quarterly meetings, but now we meet twice yearly using Zoom. We also have a subgroup, the New Users Group, which makes training videos for our YouTube channel. We also have a subgroup, the New Users Group, which makes training videos for our YouTube channel.

'''Who is it for?'''

Membership is open to anyone who is interested.

'''Contact'''
To join, send an email with your name, institution, and email address to mkosta (at) uwo (dot) ca. Indicate whether you are willing to share your contact information with other Users Group members. You will then be added to the mailing list.

'''Past presentations include'''

November 2023: Presentations on how we use AtoM with:
Sr. Rebecca Abel, Sisters of St. Benedict, Indiana, John Thiesen, Bethel College, Kansas, Stephen Logsdon, Bernard Becker Medical Library, Washington University School of Medicine, Missouri, Sandra Yates, McGovern Historical Research Center, Texas Medical Center Library, Texas

November 2023: AtoM Foundation Update with:
Anna Dysert, McGill University, Quebec

March 2023: Social Networks and Archival Context (SNAC) with:
Dina Herbert and Jerry Simmons of NARA

March 2023: National Finding Aid Network (NAFAN) with:
Adrian Turner of the California Digital Library.

January 2023: AtoM Import Tool for Formatting Bulk Descriptions at Simon Fraser University Archives with:
Kelsey Poloney

October 2022: IIIF and digital images in AtoM with:
Kelli Babcock, The University of Toronto

October 2022: Archives Canada with:
Joanna Aiton-Kerr and Yves Lapointe, Canada Council of Archives

June 2022 Using metadata from AtoM in Wikidata with:
Anna Dysert, McGill University

March 2022 AtoM Foundation Update with:
Brett Lougheed, Anna McNally, Cliff Hight

September 2021 CAAIS Study with:
Melissa McCarthy, Archivist, City of Edmonton, Edmonton, Alberta

May 2021 Bulk Uploads with CSV with:
Jody Robinson, Archivist of the Eastern Townships Resource Centre, Bishops University. Sherbrooke, Québec

-----

* [[Community/Groups|Back to regional user groups]]
* [[Community|Back to Community]]
* [[Main Page|AtoM wiki home]]

[[Category:Community]]

Community/Camps

2025-04-14T12:06:51Z

Dan: /* Upcoming AtoM Camps */ remove "2019"

{{#pagetitle:AtoM Camps}}
[[Main Page]] > [[Community]] > Community/Camps

Inspired by similar events like Hydra Camp, Islandora Camp and Fedora Camp, this event is intended to provide a space for anyone interested in or currently using AtoM, to come together, learn about the platform, and share their experiences.

<admonition type="tip">
'''Want an AtoM Camp in your area?''' We'd love to partner with you and your institution to help make it happen. See this page for more information!

* [[Community/Camps/Organize|Organizing an AtoM Camp near you]]
</admonition>

==Upcoming AtoM Camps==

Currently we have no upcoming Camps planned - we're taking this opportunity to learn from all the feedback we've gotten! We'll be planning more Camps for 2020 and onwards. If you are interested potentially hosting a Camp, check out this page!

* [[Community/Camps/Organize|Organizing an AtoM Camp near you]]

==Previous AtoM Camps==

'''[[Community/Camps/London2019|July 15-17, 2019 - University of Westminster; London, UK]]'''

* We returned to the United Kingdom for our fourth AtoM Camp, organized in partnership with the University of Westminster!

'''[[Community/Camps/UofT2018|August 2018 - University of Toronto; Toronto, ON, Canada]]'''

* Our third AtoM Camp was hosted by the University of Toronto, from Wednesday August 29th, to Friday, August 31st, 2018.

'''[[Community/Camps/SJC2017|May 2017 - St. John's College; Cambridge, UK]]'''

* Our second AtoM Camp, and the first in the United Kingdom, was hosted by St. John's College at the University of Cambridge, in Cambridge, UK from Tuesday, May 9th to Thursday, May 11th, 2017.

'''[[Community/Camps/SFU2017|March 2017 - Simon Fraser University; Vancouver, BC, Canada]]'''

* The first ever AtoM Camp, which was hosted by the Simon Fraser University Archives, in Vancouver, British Columbia from Monday, March 20 to Wednesday, March 22, 2017.

-----
* [[Community|Back to Community]]
* [[Main Page|AtoM wiki home]]

[[Category:Community]]

Community/Contributors

2025-03-12T12:02:47Z

Dan:

{{#pagetitle:Code contributors}}
[[Main Page]] > [[Community]] > Community/Contributors

On this page we'll try to gather up all the information we can about anyone who has contributed code to the AtoM project. If you've shared code that has been incorporated into a public AtoM release, we want to acknowledge your contributions! Have we missed you or someone else you know? Help us fill this page in and keep it up to date!

<admonition type="seealso">
'''NOTE:''' The AtoM Maintainers now track and acknowledge community code contributors in the [https://github.com/artefactual/atom/releases GitHub release notes]. The list below has not been updated since the 2.8.1 release, but is maintained here to acknowledge previous release contributors.

Interested in contributing code to the public AtoM project? Here are some helpful links!

* [[Development/Contribute code|Contribute code]]
* [[Development#Development_resources|Development resources]]
</admonition>

==Artefactual contributors==

Here's a list of Artefactual code contributors, past and present.

{| class="wikitable" style="background-color:#ffffff;"
|+ style="caption-side:top; color:#e76700;"|''Artefactual code contributors''
! Name || AtoM version(s)
|-
| Peter Van Garderen|| ICA-AtoM beta - [[Releases/Release_announcements/Release_2.0.0|Release 2.0.0]]
|-
| David Juhasz|| ICA-AtoM beta -
|-
| Jack Bates|| ICA-AtoM beta - [[Releases/Release_announcements/Release_1.1|Release 1.1]]
|-
| MJ Suhonos|| ICA-AtoM beta - [[Releases/Release_announcements/Release_1.1|Release 1.1]]
|-
| Jesús García Crespo|| ICA-AtoM beta - [[Releases/Release_announcements/Release_2.4|Release 2.4]]
|-
| Mike Cantelon|| [[Releases/Release_announcements/Release_1.2|Release 1.2]] -
|-
| Mike Gale|| [[Releases/Release_announcements/Release_1.3|Release 1.3]] - [[Releases/Release_announcements/Release_2.5|Release 2.5]]
|-
| Misty De Meo|| [[Releases/Release_announcements/Release_2.0.0|Release 2.0.0]] - [[Releases/Release_announcements/Release_2.2|Release 2.2]]
|-
| Justin Simpson|| [[Releases/Release_announcements/Release_2.0.0|Release 2.0.0]] - [[Releases/Release_announcements/Release_2.0.1|Release 2.0.1]]
|-
| José Raddaoui Marín|| [[Releases/Release_announcements/Release_2.1|Release 2.1]] -
|-
| Steve Breker|| [[Releases/Release_announcements/Release_2.3|Release 2.3]] -
|-
| Douglas Cerna|| [[Releases/Release_announcements/Release_2.6|Release 2.6]] - [[Releases/Release_announcements/Release_2.7|Release 2.7]]
|-
| Tessa Walsh|| [[Releases/Release_announcements/Release_2.7|Release 2.7]]
|-
| Melanie Kung|| [[Releases/Release_announcements/Release_2.7|Release 2.7]] -
|-
| Anvit Srivastav|| [[Releases/Release_announcements/Release_2.7.2|Release 2.7.2]] -
|-
| TJ Taylor-James|| [[Releases/Release_announcements/Release_2.7.2|Release 2.7.2]]
|-
| Sara Allain|| [[Releases/Release_announcements/Release_2.8.1|Release 2.8.1]]
|}

==Community contributors==

Community developers who have submitted pull requests or patches to AtoM, which have been incorporated into a subsequent public release.

<admonition type="important">
Since the AtoM 2.8.2 release, we are now tracking and acknowledging community code contributors in the [https://github.com/artefactual/atom/releases GitHub release notes]. The list below is no longer being updated.
</admonition>

{| class="wikitable" style="background-color:#ffffff;"
|+ style="caption-side:top; color:#e76700;"|''Community code contributors''
! Name || AtoM version(s) || Notes
|-
|Kehan Harman || [[Releases/Release announcements/Release 2.0.0|Release 2.0.0]], [[Releases/Release announcements/Release 2.1|Release 2.1]] || [https://github.com/artefactual/atom/commits?author=kehh 3 commits]
|-
| Edgar Rossil || [[Releases/Release announcements/Release 2.1|Release 2.1]]|| [https://github.com/artefactual/atom/commits?author=edgarrodsil 1 commit]
|-
| Jen Whitney || [[Releases/Release announcements/Release 2.1|Release 2.1]] || [https://github.com/artefactual/atom/commits?author=jwhitney 2 commits]
|-
| Séamus O'Connor || [[Releases/Release announcements/Release 2.1|Release 2.1]] || [https://github.com/artefactual/atom/commits?author=seamus-oconnor 3 commits]
|-
| Tim Hutchinson || [[Releases/Release announcements/Release 2.1|Release 2.1]] || [https://github.com/artefactual/atom/commits?author=timhutch 5 commits]
|-
| Steve Breker || [[Releases/Release announcements/Release 2.1|Release 2.1]], [[Releases/Release announcements/Release 2.2|Release 2.2]] || [https://github.com/artefactual/atom/commits?author=sbreker 3 commits]
|-
| Gioele Barabucci || [[Releases/Release announcements/Release 2.1|Release 2.1]], [[Releases/Release announcements/Release 2.2|Release 2.2]] || [https://github.com/artefactual/atom/commits?author=gioele 4 commits]
|-
| Zachary Howarth || [[Releases/Release announcements/Release 2.2|Release 2.2]] || [https://github.com/artefactual/atom/commits?author=zacho 2 commits]
|-
| Mark Triggs || [[Releases/Release announcements/Release 2.2|Release 2.2]] ||3 commits ([https://github.com/artefactual/atom/commit/7d7cf2d0374183a0402de304120093c066cfef38 1], [https://github.com/artefactual/atom/commit/8d72f57ad5b6e4988016a49c35ee56c8180ebc60 2], [https://github.com/artefactual/atom/commit/f129fb01c8d80dcb4ffa6fcc33416d6645a0563b 3])
|-
| Damian Bauder || [[Releases/Release announcements/Release 2.3|Release 2.3]] || [https://github.com/artefactual/atom/commits?author=drbauder 1 commit]
|-
| Andrew Foster || [[Releases/Release announcements/Release 2.3|Release 2.3]] || [https://github.com/artefactual/atom/commits?author=afoster 1 commit]
|-
| David Lung || [[Releases/Release announcements/Release 2.3|Release 2.3]] ||3 commits ([https://github.com/artefactual/atom/commit/f51c666d6378bbc0f448bc0c755faa77b564ff24 1], [https://github.com/artefactual/atom/commit/311b7a293fa045a0fd65d2dfc83b545f41966000 2], [https://github.com/artefactual/atom/commit/f8581ee3db95d84d7495f7ee75fd7a9ee0c0adf3 3])
|-
| Pierre Mancini || [[Releases/Release announcements/Release 2.3|Release 2.3]] || [https://github.com/artefactual/atom/commit/d45cefcb4e85a1fa483bf25a945e9f1c5cca27a6 1 commit]
|-
| Margaret Vail || [[Releases/Release announcements/Release 2.4|Release 2.4]] || [https://github.com/artefactual/atom/commit/5f83110a92acbfb0af7b58fdfb76f71357a39d0a 1 commit]
|-
| Martin Malmsten || [[Releases/Release announcements/Release 2.4|Release 2.4]] || [https://github.com/artefactual/atom/commit/62123f4c3b85e731e87d7e756a1a9249e240b2391 commit]
|-
| Darryl Friesen || [[Releases/Release announcements/Release 2.4|Release 2.4]] || 2 commits ([https://github.com/artefactual/atom/commits?author=g011um 1], [https://github.com/artefactual/atom/commit/9c71043cf2e8a1fdd300c5bbb9c7526efb721b86 2])
|-
| Jason Hildebrand || [[Releases/Release announcements/Release 2.4|Release 2.4]], [[Releases/Release announcements/Release 2.6.2|Release 2.6.2]] || 2 commits ([https://github.com/artefactual/atom/commits?author=jasonhildebrand 1], [https://github.com/artefactual/atom/pull/1219 2])
|-
| Kenji Kobayashi || [[Releases/Release announcements/Release 2.4.1|Release 2.4.1]] || [https://github.com/artefactual/atom/commits?author=knjko 1 commit]
|-
| Rohan Ferris || [[Releases/Release announcements/Release 2.6|Release 2.6]], [[Releases/Release announcements/Release 2.7.2|Release 2.7.2]] || [https://github.com/artefactual/atom/commits?author=rferris 2 commits]
|-
| Matt Innes|| [[Releases/Release announcements/Release 2.6.2|Release 2.6.2]], [[Releases/Release announcements/Release 2.7|Release 2.7]], [[Releases/Release announcements/Release 2.8.0|Release 2.8.0]] || [https://github.com/artefactual/atom/commits?author=mInnes-archives 12 commits]
|-
| Sunny Lee || [[Releases/Release_announcements/Release 2.7.2|Release 2.7.2]] || [https://github.com/artefactual/atom/commits?author=sunnywd 1 commit]
|-
| Marcelo Alencar || [[Releases/Release_announcements/Release 2.8.1|Release 2.8.1]] || [https://github.com/artefactual/atom/commits?author=marceloalencar 1 commit]
|-
|}

-----

* [[Community|Back to the Community landing page]]
* [[Main Page|Back to the AtoM wiki home]]

[[Category:Community]]

Community/Contributors

2025-03-12T12:02:29Z

Dan: mention page maintenance changes in opening admonition

{{#pagetitle:Code contributors}}
[[Main Page]] > [[Community]] > Community/Contributors

On this page we'll try to gather up all the information we can about anyone who has contributed code to the AtoM project. If you've shared code that has been incorporated into a public AtoM release, we want to acknowledge your contributions! Have we missed you or someone else you know? Help us fill this page in and keep it up to date!

<admonition type="seealso">
'''NOTE: The AtoM Maintainers now track and acknowledge community code contributors in the [https://github.com/artefactual/atom/releases GitHub release notes]. The list below has not been updated since the 2.8.1 release, but is maintained here to acknowledge previous release contributors.

Interested in contributing code to the public AtoM project? Here are some helpful links!

* [[Development/Contribute code|Contribute code]]
* [[Development#Development_resources|Development resources]]
</admonition>

==Artefactual contributors==

Here's a list of Artefactual code contributors, past and present.

{| class="wikitable" style="background-color:#ffffff;"
|+ style="caption-side:top; color:#e76700;"|''Artefactual code contributors''
! Name || AtoM version(s)
|-
| Peter Van Garderen|| ICA-AtoM beta - [[Releases/Release_announcements/Release_2.0.0|Release 2.0.0]]
|-
| David Juhasz|| ICA-AtoM beta -
|-
| Jack Bates|| ICA-AtoM beta - [[Releases/Release_announcements/Release_1.1|Release 1.1]]
|-
| MJ Suhonos|| ICA-AtoM beta - [[Releases/Release_announcements/Release_1.1|Release 1.1]]
|-
| Jesús García Crespo|| ICA-AtoM beta - [[Releases/Release_announcements/Release_2.4|Release 2.4]]
|-
| Mike Cantelon|| [[Releases/Release_announcements/Release_1.2|Release 1.2]] -
|-
| Mike Gale|| [[Releases/Release_announcements/Release_1.3|Release 1.3]] - [[Releases/Release_announcements/Release_2.5|Release 2.5]]
|-
| Misty De Meo|| [[Releases/Release_announcements/Release_2.0.0|Release 2.0.0]] - [[Releases/Release_announcements/Release_2.2|Release 2.2]]
|-
| Justin Simpson|| [[Releases/Release_announcements/Release_2.0.0|Release 2.0.0]] - [[Releases/Release_announcements/Release_2.0.1|Release 2.0.1]]
|-
| José Raddaoui Marín|| [[Releases/Release_announcements/Release_2.1|Release 2.1]] -
|-
| Steve Breker|| [[Releases/Release_announcements/Release_2.3|Release 2.3]] -
|-
| Douglas Cerna|| [[Releases/Release_announcements/Release_2.6|Release 2.6]] - [[Releases/Release_announcements/Release_2.7|Release 2.7]]
|-
| Tessa Walsh|| [[Releases/Release_announcements/Release_2.7|Release 2.7]]
|-
| Melanie Kung|| [[Releases/Release_announcements/Release_2.7|Release 2.7]] -
|-
| Anvit Srivastav|| [[Releases/Release_announcements/Release_2.7.2|Release 2.7.2]] -
|-
| TJ Taylor-James|| [[Releases/Release_announcements/Release_2.7.2|Release 2.7.2]]
|-
| Sara Allain|| [[Releases/Release_announcements/Release_2.8.1|Release 2.8.1]]
|}

==Community contributors==

Community developers who have submitted pull requests or patches to AtoM, which have been incorporated into a subsequent public release.

<admonition type="important">
Since the AtoM 2.8.2 release, we are now tracking and acknowledging community code contributors in the [https://github.com/artefactual/atom/releases GitHub release notes]. The list below is no longer being updated.
</admonition>

{| class="wikitable" style="background-color:#ffffff;"
|+ style="caption-side:top; color:#e76700;"|''Community code contributors''
! Name || AtoM version(s) || Notes
|-
|Kehan Harman || [[Releases/Release announcements/Release 2.0.0|Release 2.0.0]], [[Releases/Release announcements/Release 2.1|Release 2.1]] || [https://github.com/artefactual/atom/commits?author=kehh 3 commits]
|-
| Edgar Rossil || [[Releases/Release announcements/Release 2.1|Release 2.1]]|| [https://github.com/artefactual/atom/commits?author=edgarrodsil 1 commit]
|-
| Jen Whitney || [[Releases/Release announcements/Release 2.1|Release 2.1]] || [https://github.com/artefactual/atom/commits?author=jwhitney 2 commits]
|-
| Séamus O'Connor || [[Releases/Release announcements/Release 2.1|Release 2.1]] || [https://github.com/artefactual/atom/commits?author=seamus-oconnor 3 commits]
|-
| Tim Hutchinson || [[Releases/Release announcements/Release 2.1|Release 2.1]] || [https://github.com/artefactual/atom/commits?author=timhutch 5 commits]
|-
| Steve Breker || [[Releases/Release announcements/Release 2.1|Release 2.1]], [[Releases/Release announcements/Release 2.2|Release 2.2]] || [https://github.com/artefactual/atom/commits?author=sbreker 3 commits]
|-
| Gioele Barabucci || [[Releases/Release announcements/Release 2.1|Release 2.1]], [[Releases/Release announcements/Release 2.2|Release 2.2]] || [https://github.com/artefactual/atom/commits?author=gioele 4 commits]
|-
| Zachary Howarth || [[Releases/Release announcements/Release 2.2|Release 2.2]] || [https://github.com/artefactual/atom/commits?author=zacho 2 commits]
|-
| Mark Triggs || [[Releases/Release announcements/Release 2.2|Release 2.2]] ||3 commits ([https://github.com/artefactual/atom/commit/7d7cf2d0374183a0402de304120093c066cfef38 1], [https://github.com/artefactual/atom/commit/8d72f57ad5b6e4988016a49c35ee56c8180ebc60 2], [https://github.com/artefactual/atom/commit/f129fb01c8d80dcb4ffa6fcc33416d6645a0563b 3])
|-
| Damian Bauder || [[Releases/Release announcements/Release 2.3|Release 2.3]] || [https://github.com/artefactual/atom/commits?author=drbauder 1 commit]
|-
| Andrew Foster || [[Releases/Release announcements/Release 2.3|Release 2.3]] || [https://github.com/artefactual/atom/commits?author=afoster 1 commit]
|-
| David Lung || [[Releases/Release announcements/Release 2.3|Release 2.3]] ||3 commits ([https://github.com/artefactual/atom/commit/f51c666d6378bbc0f448bc0c755faa77b564ff24 1], [https://github.com/artefactual/atom/commit/311b7a293fa045a0fd65d2dfc83b545f41966000 2], [https://github.com/artefactual/atom/commit/f8581ee3db95d84d7495f7ee75fd7a9ee0c0adf3 3])
|-
| Pierre Mancini || [[Releases/Release announcements/Release 2.3|Release 2.3]] || [https://github.com/artefactual/atom/commit/d45cefcb4e85a1fa483bf25a945e9f1c5cca27a6 1 commit]
|-
| Margaret Vail || [[Releases/Release announcements/Release 2.4|Release 2.4]] || [https://github.com/artefactual/atom/commit/5f83110a92acbfb0af7b58fdfb76f71357a39d0a 1 commit]
|-
| Martin Malmsten || [[Releases/Release announcements/Release 2.4|Release 2.4]] || [https://github.com/artefactual/atom/commit/62123f4c3b85e731e87d7e756a1a9249e240b2391 commit]
|-
| Darryl Friesen || [[Releases/Release announcements/Release 2.4|Release 2.4]] || 2 commits ([https://github.com/artefactual/atom/commits?author=g011um 1], [https://github.com/artefactual/atom/commit/9c71043cf2e8a1fdd300c5bbb9c7526efb721b86 2])
|-
| Jason Hildebrand || [[Releases/Release announcements/Release 2.4|Release 2.4]], [[Releases/Release announcements/Release 2.6.2|Release 2.6.2]] || 2 commits ([https://github.com/artefactual/atom/commits?author=jasonhildebrand 1], [https://github.com/artefactual/atom/pull/1219 2])
|-
| Kenji Kobayashi || [[Releases/Release announcements/Release 2.4.1|Release 2.4.1]] || [https://github.com/artefactual/atom/commits?author=knjko 1 commit]
|-
| Rohan Ferris || [[Releases/Release announcements/Release 2.6|Release 2.6]], [[Releases/Release announcements/Release 2.7.2|Release 2.7.2]] || [https://github.com/artefactual/atom/commits?author=rferris 2 commits]
|-
| Matt Innes|| [[Releases/Release announcements/Release 2.6.2|Release 2.6.2]], [[Releases/Release announcements/Release 2.7|Release 2.7]], [[Releases/Release announcements/Release 2.8.0|Release 2.8.0]] || [https://github.com/artefactual/atom/commits?author=mInnes-archives 12 commits]
|-
| Sunny Lee || [[Releases/Release_announcements/Release 2.7.2|Release 2.7.2]] || [https://github.com/artefactual/atom/commits?author=sunnywd 1 commit]
|-
| Marcelo Alencar || [[Releases/Release_announcements/Release 2.8.1|Release 2.8.1]] || [https://github.com/artefactual/atom/commits?author=marceloalencar 1 commit]
|-
|}

-----

* [[Community|Back to the Community landing page]]
* [[Main Page|Back to the AtoM wiki home]]

[[Category:Community]]

Community/Contributors

2025-03-12T12:00:10Z

Dan: /* Community contributors */

{{#pagetitle:Code contributors}}
[[Main Page]] > [[Community]] > Community/Contributors

On this page we'll try to gather up all the information we can about anyone who has contributed code to the AtoM project. If you've shared code that has been incorporated into a public AtoM release, we want to acknowledge your contributions! Have we missed you or someone else you know? Help us fill this page in and keep it up to date!

<admonition type="seealso">
We're also tracking our volunteer community translators on this page: [[Community/Translators|Translators]]

Interested in contributing code to the public AtoM project? Here are some helpful links!
* [[Development/Contribute code|Contribute code]]
* [[Development#Development_resources|Development resources]]
</admonition>

==Artefactual contributors==

Here's a list of Artefactual code contributors, past and present.

{| class="wikitable" style="background-color:#ffffff;"
|+ style="caption-side:top; color:#e76700;"|''Artefactual code contributors''
! Name || AtoM version(s)
|-
| Peter Van Garderen|| ICA-AtoM beta - [[Releases/Release_announcements/Release_2.0.0|Release 2.0.0]]
|-
| David Juhasz|| ICA-AtoM beta -
|-
| Jack Bates|| ICA-AtoM beta - [[Releases/Release_announcements/Release_1.1|Release 1.1]]
|-
| MJ Suhonos|| ICA-AtoM beta - [[Releases/Release_announcements/Release_1.1|Release 1.1]]
|-
| Jesús García Crespo|| ICA-AtoM beta - [[Releases/Release_announcements/Release_2.4|Release 2.4]]
|-
| Mike Cantelon|| [[Releases/Release_announcements/Release_1.2|Release 1.2]] -
|-
| Mike Gale|| [[Releases/Release_announcements/Release_1.3|Release 1.3]] - [[Releases/Release_announcements/Release_2.5|Release 2.5]]
|-
| Misty De Meo|| [[Releases/Release_announcements/Release_2.0.0|Release 2.0.0]] - [[Releases/Release_announcements/Release_2.2|Release 2.2]]
|-
| Justin Simpson|| [[Releases/Release_announcements/Release_2.0.0|Release 2.0.0]] - [[Releases/Release_announcements/Release_2.0.1|Release 2.0.1]]
|-
| José Raddaoui Marín|| [[Releases/Release_announcements/Release_2.1|Release 2.1]] -
|-
| Steve Breker|| [[Releases/Release_announcements/Release_2.3|Release 2.3]] -
|-
| Douglas Cerna|| [[Releases/Release_announcements/Release_2.6|Release 2.6]] - [[Releases/Release_announcements/Release_2.7|Release 2.7]]
|-
| Tessa Walsh|| [[Releases/Release_announcements/Release_2.7|Release 2.7]]
|-
| Melanie Kung|| [[Releases/Release_announcements/Release_2.7|Release 2.7]] -
|-
| Anvit Srivastav|| [[Releases/Release_announcements/Release_2.7.2|Release 2.7.2]] -
|-
| TJ Taylor-James|| [[Releases/Release_announcements/Release_2.7.2|Release 2.7.2]]
|-
| Sara Allain|| [[Releases/Release_announcements/Release_2.8.1|Release 2.8.1]]
|}

==Community contributors==

Community developers who have submitted pull requests or patches to AtoM, which have been incorporated into a subsequent public release.

<admonition type="important">
Since the AtoM 2.8.2 release, we are now tracking and acknowledging community code contributors in the [https://github.com/artefactual/atom/releases GitHub release notes]. The list below is no longer being updated.
</admonition>

{| class="wikitable" style="background-color:#ffffff;"
|+ style="caption-side:top; color:#e76700;"|''Community code contributors''
! Name || AtoM version(s) || Notes
|-
|Kehan Harman || [[Releases/Release announcements/Release 2.0.0|Release 2.0.0]], [[Releases/Release announcements/Release 2.1|Release 2.1]] || [https://github.com/artefactual/atom/commits?author=kehh 3 commits]
|-
| Edgar Rossil || [[Releases/Release announcements/Release 2.1|Release 2.1]]|| [https://github.com/artefactual/atom/commits?author=edgarrodsil 1 commit]
|-
| Jen Whitney || [[Releases/Release announcements/Release 2.1|Release 2.1]] || [https://github.com/artefactual/atom/commits?author=jwhitney 2 commits]
|-
| Séamus O'Connor || [[Releases/Release announcements/Release 2.1|Release 2.1]] || [https://github.com/artefactual/atom/commits?author=seamus-oconnor 3 commits]
|-
| Tim Hutchinson || [[Releases/Release announcements/Release 2.1|Release 2.1]] || [https://github.com/artefactual/atom/commits?author=timhutch 5 commits]
|-
| Steve Breker || [[Releases/Release announcements/Release 2.1|Release 2.1]], [[Releases/Release announcements/Release 2.2|Release 2.2]] || [https://github.com/artefactual/atom/commits?author=sbreker 3 commits]
|-
| Gioele Barabucci || [[Releases/Release announcements/Release 2.1|Release 2.1]], [[Releases/Release announcements/Release 2.2|Release 2.2]] || [https://github.com/artefactual/atom/commits?author=gioele 4 commits]
|-
| Zachary Howarth || [[Releases/Release announcements/Release 2.2|Release 2.2]] || [https://github.com/artefactual/atom/commits?author=zacho 2 commits]
|-
| Mark Triggs || [[Releases/Release announcements/Release 2.2|Release 2.2]] ||3 commits ([https://github.com/artefactual/atom/commit/7d7cf2d0374183a0402de304120093c066cfef38 1], [https://github.com/artefactual/atom/commit/8d72f57ad5b6e4988016a49c35ee56c8180ebc60 2], [https://github.com/artefactual/atom/commit/f129fb01c8d80dcb4ffa6fcc33416d6645a0563b 3])
|-
| Damian Bauder || [[Releases/Release announcements/Release 2.3|Release 2.3]] || [https://github.com/artefactual/atom/commits?author=drbauder 1 commit]
|-
| Andrew Foster || [[Releases/Release announcements/Release 2.3|Release 2.3]] || [https://github.com/artefactual/atom/commits?author=afoster 1 commit]
|-
| David Lung || [[Releases/Release announcements/Release 2.3|Release 2.3]] ||3 commits ([https://github.com/artefactual/atom/commit/f51c666d6378bbc0f448bc0c755faa77b564ff24 1], [https://github.com/artefactual/atom/commit/311b7a293fa045a0fd65d2dfc83b545f41966000 2], [https://github.com/artefactual/atom/commit/f8581ee3db95d84d7495f7ee75fd7a9ee0c0adf3 3])
|-
| Pierre Mancini || [[Releases/Release announcements/Release 2.3|Release 2.3]] || [https://github.com/artefactual/atom/commit/d45cefcb4e85a1fa483bf25a945e9f1c5cca27a6 1 commit]
|-
| Margaret Vail || [[Releases/Release announcements/Release 2.4|Release 2.4]] || [https://github.com/artefactual/atom/commit/5f83110a92acbfb0af7b58fdfb76f71357a39d0a 1 commit]
|-
| Martin Malmsten || [[Releases/Release announcements/Release 2.4|Release 2.4]] || [https://github.com/artefactual/atom/commit/62123f4c3b85e731e87d7e756a1a9249e240b2391 commit]
|-
| Darryl Friesen || [[Releases/Release announcements/Release 2.4|Release 2.4]] || 2 commits ([https://github.com/artefactual/atom/commits?author=g011um 1], [https://github.com/artefactual/atom/commit/9c71043cf2e8a1fdd300c5bbb9c7526efb721b86 2])
|-
| Jason Hildebrand || [[Releases/Release announcements/Release 2.4|Release 2.4]], [[Releases/Release announcements/Release 2.6.2|Release 2.6.2]] || 2 commits ([https://github.com/artefactual/atom/commits?author=jasonhildebrand 1], [https://github.com/artefactual/atom/pull/1219 2])
|-
| Kenji Kobayashi || [[Releases/Release announcements/Release 2.4.1|Release 2.4.1]] || [https://github.com/artefactual/atom/commits?author=knjko 1 commit]
|-
| Rohan Ferris || [[Releases/Release announcements/Release 2.6|Release 2.6]], [[Releases/Release announcements/Release 2.7.2|Release 2.7.2]] || [https://github.com/artefactual/atom/commits?author=rferris 2 commits]
|-
| Matt Innes|| [[Releases/Release announcements/Release 2.6.2|Release 2.6.2]], [[Releases/Release announcements/Release 2.7|Release 2.7]], [[Releases/Release announcements/Release 2.8.0|Release 2.8.0]] || [https://github.com/artefactual/atom/commits?author=mInnes-archives 12 commits]
|-
| Sunny Lee || [[Releases/Release_announcements/Release 2.7.2|Release 2.7.2]] || [https://github.com/artefactual/atom/commits?author=sunnywd 1 commit]
|-
| Marcelo Alencar || [[Releases/Release_announcements/Release 2.8.1|Release 2.8.1]] || [https://github.com/artefactual/atom/commits?author=marceloalencar 1 commit]
|-
|}

-----

* [[Community|Back to the Community landing page]]
* [[Main Page|Back to the AtoM wiki home]]

[[Category:Community]]

Community/Contributors

2025-03-12T11:59:30Z

Dan: /* Community contributors */ add admonition noting that this page is no longer active

{{#pagetitle:Code contributors}}
[[Main Page]] > [[Community]] > Community/Contributors

On this page we'll try to gather up all the information we can about anyone who has contributed code to the AtoM project. If you've shared code that has been incorporated into a public AtoM release, we want to acknowledge your contributions! Have we missed you or someone else you know? Help us fill this page in and keep it up to date!

<admonition type="seealso">
We're also tracking our volunteer community translators on this page: [[Community/Translators|Translators]]

Interested in contributing code to the public AtoM project? Here are some helpful links!
* [[Development/Contribute code|Contribute code]]
* [[Development#Development_resources|Development resources]]
</admonition>

==Artefactual contributors==

Here's a list of Artefactual code contributors, past and present.

{| class="wikitable" style="background-color:#ffffff;"
|+ style="caption-side:top; color:#e76700;"|''Artefactual code contributors''
! Name || AtoM version(s)
|-
| Peter Van Garderen|| ICA-AtoM beta - [[Releases/Release_announcements/Release_2.0.0|Release 2.0.0]]
|-
| David Juhasz|| ICA-AtoM beta -
|-
| Jack Bates|| ICA-AtoM beta - [[Releases/Release_announcements/Release_1.1|Release 1.1]]
|-
| MJ Suhonos|| ICA-AtoM beta - [[Releases/Release_announcements/Release_1.1|Release 1.1]]
|-
| Jesús García Crespo|| ICA-AtoM beta - [[Releases/Release_announcements/Release_2.4|Release 2.4]]
|-
| Mike Cantelon|| [[Releases/Release_announcements/Release_1.2|Release 1.2]] -
|-
| Mike Gale|| [[Releases/Release_announcements/Release_1.3|Release 1.3]] - [[Releases/Release_announcements/Release_2.5|Release 2.5]]
|-
| Misty De Meo|| [[Releases/Release_announcements/Release_2.0.0|Release 2.0.0]] - [[Releases/Release_announcements/Release_2.2|Release 2.2]]
|-
| Justin Simpson|| [[Releases/Release_announcements/Release_2.0.0|Release 2.0.0]] - [[Releases/Release_announcements/Release_2.0.1|Release 2.0.1]]
|-
| José Raddaoui Marín|| [[Releases/Release_announcements/Release_2.1|Release 2.1]] -
|-
| Steve Breker|| [[Releases/Release_announcements/Release_2.3|Release 2.3]] -
|-
| Douglas Cerna|| [[Releases/Release_announcements/Release_2.6|Release 2.6]] - [[Releases/Release_announcements/Release_2.7|Release 2.7]]
|-
| Tessa Walsh|| [[Releases/Release_announcements/Release_2.7|Release 2.7]]
|-
| Melanie Kung|| [[Releases/Release_announcements/Release_2.7|Release 2.7]] -
|-
| Anvit Srivastav|| [[Releases/Release_announcements/Release_2.7.2|Release 2.7.2]] -
|-
| TJ Taylor-James|| [[Releases/Release_announcements/Release_2.7.2|Release 2.7.2]]
|-
| Sara Allain|| [[Releases/Release_announcements/Release_2.8.1|Release 2.8.1]]
|}

==Community contributors==

Community developers who have submitted pull requests or patches to AtoM, which have been incorporated into a subsequent public release.

<admonition type="important">
Since the AtoM 2.8.2 release, we are now tracking and acknowledging community code contributors in the [GitHub release notes](https://github.com/artefactual/atom/releases). The list below is no longer being updated.
</admonition>

{| class="wikitable" style="background-color:#ffffff;"
|+ style="caption-side:top; color:#e76700;"|''Community code contributors''
! Name || AtoM version(s) || Notes
|-
|Kehan Harman || [[Releases/Release announcements/Release 2.0.0|Release 2.0.0]], [[Releases/Release announcements/Release 2.1|Release 2.1]] || [https://github.com/artefactual/atom/commits?author=kehh 3 commits]
|-
| Edgar Rossil || [[Releases/Release announcements/Release 2.1|Release 2.1]]|| [https://github.com/artefactual/atom/commits?author=edgarrodsil 1 commit]
|-
| Jen Whitney || [[Releases/Release announcements/Release 2.1|Release 2.1]] || [https://github.com/artefactual/atom/commits?author=jwhitney 2 commits]
|-
| Séamus O'Connor || [[Releases/Release announcements/Release 2.1|Release 2.1]] || [https://github.com/artefactual/atom/commits?author=seamus-oconnor 3 commits]
|-
| Tim Hutchinson || [[Releases/Release announcements/Release 2.1|Release 2.1]] || [https://github.com/artefactual/atom/commits?author=timhutch 5 commits]
|-
| Steve Breker || [[Releases/Release announcements/Release 2.1|Release 2.1]], [[Releases/Release announcements/Release 2.2|Release 2.2]] || [https://github.com/artefactual/atom/commits?author=sbreker 3 commits]
|-
| Gioele Barabucci || [[Releases/Release announcements/Release 2.1|Release 2.1]], [[Releases/Release announcements/Release 2.2|Release 2.2]] || [https://github.com/artefactual/atom/commits?author=gioele 4 commits]
|-
| Zachary Howarth || [[Releases/Release announcements/Release 2.2|Release 2.2]] || [https://github.com/artefactual/atom/commits?author=zacho 2 commits]
|-
| Mark Triggs || [[Releases/Release announcements/Release 2.2|Release 2.2]] ||3 commits ([https://github.com/artefactual/atom/commit/7d7cf2d0374183a0402de304120093c066cfef38 1], [https://github.com/artefactual/atom/commit/8d72f57ad5b6e4988016a49c35ee56c8180ebc60 2], [https://github.com/artefactual/atom/commit/f129fb01c8d80dcb4ffa6fcc33416d6645a0563b 3])
|-
| Damian Bauder || [[Releases/Release announcements/Release 2.3|Release 2.3]] || [https://github.com/artefactual/atom/commits?author=drbauder 1 commit]
|-
| Andrew Foster || [[Releases/Release announcements/Release 2.3|Release 2.3]] || [https://github.com/artefactual/atom/commits?author=afoster 1 commit]
|-
| David Lung || [[Releases/Release announcements/Release 2.3|Release 2.3]] ||3 commits ([https://github.com/artefactual/atom/commit/f51c666d6378bbc0f448bc0c755faa77b564ff24 1], [https://github.com/artefactual/atom/commit/311b7a293fa045a0fd65d2dfc83b545f41966000 2], [https://github.com/artefactual/atom/commit/f8581ee3db95d84d7495f7ee75fd7a9ee0c0adf3 3])
|-
| Pierre Mancini || [[Releases/Release announcements/Release 2.3|Release 2.3]] || [https://github.com/artefactual/atom/commit/d45cefcb4e85a1fa483bf25a945e9f1c5cca27a6 1 commit]
|-
| Margaret Vail || [[Releases/Release announcements/Release 2.4|Release 2.4]] || [https://github.com/artefactual/atom/commit/5f83110a92acbfb0af7b58fdfb76f71357a39d0a 1 commit]
|-
| Martin Malmsten || [[Releases/Release announcements/Release 2.4|Release 2.4]] || [https://github.com/artefactual/atom/commit/62123f4c3b85e731e87d7e756a1a9249e240b2391 commit]
|-
| Darryl Friesen || [[Releases/Release announcements/Release 2.4|Release 2.4]] || 2 commits ([https://github.com/artefactual/atom/commits?author=g011um 1], [https://github.com/artefactual/atom/commit/9c71043cf2e8a1fdd300c5bbb9c7526efb721b86 2])
|-
| Jason Hildebrand || [[Releases/Release announcements/Release 2.4|Release 2.4]], [[Releases/Release announcements/Release 2.6.2|Release 2.6.2]] || 2 commits ([https://github.com/artefactual/atom/commits?author=jasonhildebrand 1], [https://github.com/artefactual/atom/pull/1219 2])
|-
| Kenji Kobayashi || [[Releases/Release announcements/Release 2.4.1|Release 2.4.1]] || [https://github.com/artefactual/atom/commits?author=knjko 1 commit]
|-
| Rohan Ferris || [[Releases/Release announcements/Release 2.6|Release 2.6]], [[Releases/Release announcements/Release 2.7.2|Release 2.7.2]] || [https://github.com/artefactual/atom/commits?author=rferris 2 commits]
|-
| Matt Innes|| [[Releases/Release announcements/Release 2.6.2|Release 2.6.2]], [[Releases/Release announcements/Release 2.7|Release 2.7]], [[Releases/Release announcements/Release 2.8.0|Release 2.8.0]] || [https://github.com/artefactual/atom/commits?author=mInnes-archives 12 commits]
|-
| Sunny Lee || [[Releases/Release_announcements/Release 2.7.2|Release 2.7.2]] || [https://github.com/artefactual/atom/commits?author=sunnywd 1 commit]
|-
| Marcelo Alencar || [[Releases/Release_announcements/Release 2.8.1|Release 2.8.1]] || [https://github.com/artefactual/atom/commits?author=marceloalencar 1 commit]
|-
|}

-----

* [[Community|Back to the Community landing page]]
* [[Main Page|Back to the AtoM wiki home]]

[[Category:Community]]

Community/Community resources/Development

2024-09-10T12:12:29Z

Dan: /* PeaceWorks MAID plugins */ fix formatting

{{#pagetitle:Community development}}
[[Main Page]] > [[Community]] > [[Community/Community resources]] > Community/Community resources/Development

In this section of the wiki, we'll add links to custom patches, plugins, themes, images, forks, and other resources developed by community users and publicly available for developers to explore and work with.

<admonition type="warning">
'''PLEASE NOTE''': Artefactual does '''not''' test these features and modules developed by AtoM community members. As such, we cannot offer support for them, nor can we speak as to their security, quality, performance, or compatibility with the latest public releases. If you intend to make use of these features, do so at your own risk. We strongly recommend studying the code prior to use, and deploying any community-developed features in a test environment where they can be properly evaluated.
</admonition>

<admonition type="tip">
Have you developed custom code for your AtoM installation? Let us know! And... why not consider contributing your code to the public project? That way, we maintain the code for you through future releases, and the entire community benefits from your work! Here are some links to get you started:
* [[Development/Contribute code]]
* [[Development#Development_resources|Other developer resources in our wiki]]
</admonition>

__TOC__

==AtoM 2.7 Drupal 9 feed module==

Developed by members of the University of Toronto (U of T) Libraries, this AtoM Drupal importer is a Drupal 9 module based on the AtoM API. The module is used at U of T to facilitate publishing archival description once, in U of T's [https://discoverarchives.library.utoronto.ca/ Discover Archives (AtoM)] finding aid database, after which it pulls description data into Drupal as Nodes and Taxonomies. This data can then generate a searchable collections list (A-Z) in Drupal as well as a Drupal page per top-level fonds/collections. When data in the linked AtoM instance is updated or new data is added, the module can also fetch and update the Drupal data at a designated frequency.

The goal of the module is to reuse published AtoM description metadata in a more end-user-friendly Drupal website to facilitate "general user" browse/discovery of top-level descriptions on the University's Drupal-based departmental websites, where users may not normally encounter the archival AtoM instance.

You can see an example of the module in use on the U of T's [https://media-archives.library.utoronto.ca/archival-collections Media Commons Archives Drupal website ], displaying data from their [https://discoverarchives.library.utoronto.ca/index.php/university-of-toronto-media-commons AtoM descriptions].

You can find this plugin at:

* https://github.com/utlib/drupal_atom

 

It has been confirmed to work with AtoM 2.7.x.

This work was originally shared in the AtoM User Forum on November 16, 2023:

* https://groups.google.com/g/ica-atom-users/c/aCAdGKdFgNQ/m/E14KAUOKBAAJ

 

Initial module planning, creation, and development included:

* Rachel Beattie, Assistant Media Archivist
* Gordon Belray, Information Architect
* Andy Foster, Senior Software Engineer
* Lillian Hogendoorn, Curator of Digital Experience
* Bilal Khalid, Manager of Digital Library Applications
* Sunny Lee, Digital Initiatives Programmer Analyst
* Christina Stewart, Assistant Media Archivist
* Chul Hee Yoon, Project Application Programmer Analyst
* Kelli Babcock, Digital Initiatives Librarian

==AtoM 2.4 Drupal front-end display bridge==

[https://github.com/andreaem Michael Andreae] of the University of Toronto has created a fork of Drupal's Views Database Connector that has been modified to work as a bridge for AtoM, so that Drupal can be used as a public-facing front-end. From the README on the GitHub project:

''Views Database Connector is a powerful module that gives Views full access to external database tables found in the settings for your Drupal installation. With this module, you can setup a view around any table in any database configuration. This can be extremely useful to pull external data from a database to show to your users in a view.''

''The Drupal AtoM connector is a non generalized version of Views Database Connector, VDC was just used as a template. In Drupal you can create blocks and add whatever sections you need based on an object.''

''For example adding in a fonds you can link another view in fields of notes types and then link based on id. Because there can be multiple notes etc... on one record it was easier to add the relations in the Drupal View rather than in the Database Connector.''

According to notes on the README, this bridge has only been tested with AtoM version 2.4.0 - 156.

The code, along with basic installation instructions, can be found on GitHub, here:

* https://github.com/Vic-Lib/DrupalAtoMViewer

==AtoM Linux Installer scripts==

Community user Guillermo Castellano Casas has developed some automated bash installation scripts that can be used to install AtoM 2.4, 2.5, or 2.6. Below are the GNU/Linux distributions currently supported for each AtoM version:

* 2.6: Ubuntu 18.04, Debian 10.
* 2.5: Ubuntu 16.04/18.04, Debian 9.
* 2.4: Ubuntu 16.04.

* The GitLab repository where the scripts and basic usage instructions can be found: [https://gitlab.com/guillearch/atom-installer here]
* A [https://gitlab.com/guillearch/atom-installer/blob/master/contributing.md contributor's guide] if you'd like to help improve the installers!
* The AtoM [https://groups.google.com/d/msg/ica-atom-users/xy4Fha_OUe4/gVJBlHSWBgAJ user forum post] where these were first shared with the AtoM community (September 2019)

==AtoM virtual machines==

Community user [https://github.com/ricardodepinho Ricardo Pinho] has prepared a webite, [https://atom-vm.com/store atom-vm.com], where he is sharing production-ready virtual machine (VM) images of AtoM releases. Intended for use either as local development environments or in production for small to medium archives, these VMs are built using the recommended AtoM [https://www.accesstomemory.org/docs/latest/admin-manual/installation/linux/ubuntu-bionic/ installation instructions].

As of November 2023 the site currently hosts Virtual Machines for:

[[Releases/Release_announcements/Release_2.5.4|(Release 2.5.4)]] - [https://atom-vm.com/atom-vm-2-5-4/ AtoM-VM 2.5.4];

[[Releases/Release_announcements/Release_2.6.4|(Release 2.6.4)]] - [https://atom-vm.com/atom-vm-2-6-4/ AtoM-VM 2.6.4];

Other versions will be added in the future.

Ricardo asks for a small donation to support the site and future releases. To run the VMs you will first need to install any Virtual Machine player able to import the standard ovf and vmdk file format or run directly from a vmx file - examples include [https://www.virtualbox.org/wiki/Downloads Virtualbox] or the free [https://www.vmware.com/go/downloadplayer VMWare Player]. At this time, the current release of AtoM-VM runs only on 64-bit computers (x86-amd64). For more information, see:

* [https://atom-vm.com atom-vm.com]

==CENDARI Shibboleth authentication plugin==

CENDARI (Collaborative European Digital Archive Infrastructure) is a research collaboration aimed at integrating digital archives and resources for research on medieval and modern European history. They have chosen AtoM for use as their collaborative Archival Directory (site [https://archives.cendari.dariah.eu/ here], more information [http://www.cendari.eu/archival-directories/ here]), and have done some custom development, including a plugin to integrate with [http://shibboleth.net/ Shibboleth], an "''open-source project that provides Single Sign-On capabilities and allows sites to make informed authorization decisions for individual access of protected online resources in a privacy-preserving manner.''"

The plugin was developed against AtoM 2.1, and has had compatibility updates for 2.3. In 2019, a community user has also reported success in the [https://groups.google.com/d/msg/ica-atom-users/xZeV1VAvJuM/rhvI7n_GBwAJ User forum] using this plugin with a 2.4.1 release. Another user forked the plugin, added a few additional commit (details [https://github.com/CENDARI/sfDariahShibUserPlugin/compare/master...kstatelibraries:sfDariahShibUserPlugin:ksul-shibconfig here] and [https://github.com/CENDARI/sfDariahShibUserPlugin/pulls here]), and reports it working with those changes in a 2.6.4 release. Status of testing against other releases is unknown.

The original plugin development was done by [https://github.com/schildwaechter Carsten Thiel], primarily between November and December of 2014.

* [https://github.com/CENDARI/sfDariahShibUserPlugin GitHub repository]
* [http://www.cendari.eu/sites/default/files/CENDARI%20technical%20documentation.pdf Plugin documentation]

==PeaceWorks MAID plugins ==

'''NOTE: As of 2024-09, these plugins have been upgraded to work with 2.8.x AtoM installations'''

In March of 2015, [http://www.peaceworks.ca/ PeaceWorks Technology Solutions] helped to launch [http://archives.mhsc.ca/ MAID] (Mennonite Archival Image Database), a collaborative project of the Mennonite Historical Society of Canada which includes Mennonite archival partners in British Columbia, Alberta, Saskatchewan, Manitoba, and Ontario, with images held in a shared AtoM instance. Over the course of the 2-year design and development project leading up to the launch, PeaceWorks developed several custom features and plugins for use in MAID, including an eCommerce "shopping cart" plugin for purchasing prints of images available in MAID; an image carousel for the home page; integration with [http://www.tinymce.com/ TinyMCE] to add a [https://en.wikipedia.org/wiki/WYSIWYG WYSIWYG] set of editing tools to AtoM's static pages (e.g. so users did not need to know basic HTML to style static pages); and the ability to upload a different watermark (to be applied to digital object derivatives) for each institution. More details on each below.

===eCommerce plugin===

This plugin has been developed by [https://github.com/jasonhildebrand Jason Hildebrand] of [http://www.peaceworks.ca/ PeaceWorks Technology Solutions], primarily between July 2014 and March 2015.

According to the [https://github.com/PeaceWorksTechnologySolutions/atom/blob/ecommerce/plugins/sfEcommercePlugin/README.md plugin documentation's] Overview section, "This plugin allows website visitors to select and purchase individual photos. Payment for the photos happens via PayPal. E-Commerce admins review each order and may approve or reject (remove) photos from the order. After approval, the customer is sent an email containing a link which they can use to download the image(s).

Users have access to a shopping cart, where photos from multiple repositories can be added as users browse the site, and then ordered/checked out via PayPal. The shopping cart has basic integration with AtoM's PREMIS rights module, so when Dissemination = "Disallow," a message about restrictions is supplied instead. Other features include a vacation setting and a sales report.

* [https://github.com/PeaceWorksTechnologySolutions/atom/tree/ecommerce PeaceWorks GitHub AtoM fork, eCommerce branch]
* [https://github.com/PeaceWorksTechnologySolutions/atom/blob/ecommerce/plugins/sfEcommercePlugin/README.md eCommerce plugin documentation]
* [http://archives.mhsc.ca/ MAID], where you can see the shopping cart in action

MAID has also prepared a summary description of the plugin's functionality, available as a PDF here:

* [[File:Ecommerce-MAID.pdf]] (PDF, approx 431KB)

===Home page carousel plugin===

This plugin has been developed by [https://github.com/jasonhildebrand Jason Hildebrand] of [http://www.peaceworks.ca/ PeaceWorks Technology Solutions], primarily between July 2014 and March 2015.

This plugin adds a slideshow to the AtoM front page which displays up to 30 of the most recently added/updated photos in the system. Photos and their captions (if available) are displayed. Users may click a photo to go to its archival description.

* [https://github.com/PeaceWorksTechnologySolutions/atom/tree/carousel PeaceWorks GitHub AtoM fork, Carousel branch]
* [https://github.com/PeaceWorksTechnologySolutions/atom/blob/carousel/plugins/sfCarouselPlugin/README.md Carousel README documentation]
* [http://archives.mhsc.ca/ MAID] homepage, where you can see the carousel in action

===TinyMCE visual editor integration for editing static pages===

This integration has been developed by [https://github.com/jasonhildebrand Jason Hildebrand] of [http://www.peaceworks.ca/ PeaceWorks Technology Solutions], primarily between April 2014 and March 2015. At this time, this integration has not been packaged as a plugin.

[http://www.tinymce.com/ TinyMCE] is "'' a platform independent web based Javascript HTML [https://en.wikipedia.org/wiki/WYSIWYG WYSIWYG] editor control released as Open Source under LGPL,''" that, when integrated with AtoM, allows users unfamiliar with HTML to style static pages using familiar buttons, tools, and other user interface elements. The integration includes basic text styling (bold, underline, italics), table creation, image and file upload, link creation, and more.

* [https://github.com/PeaceWorksTechnologySolutions/atom/tree/tinymce PeaceWorks GitHub AtoM fork, TinyMCE branch]
* [https://github.com/PeaceWorksTechnologySolutions/atom/blob/tinymce/README_tinymce.md TinyMCE README documentation]

===Per-institution watermarks for digital objects===

This integration has been developed by [https://github.com/jasonhildebrand Jason Hildebrand] of [http://www.peaceworks.ca/ PeaceWorks Technology Solutions], between July 2014 and March 2015 (primarily in July 2014). At this time, this integration has not been packaged as a plugin.

AtoM includes the little-known ability to apply a watermark to uploaded photos. However there is only provision for a single global watermark which is applied to all images. This customization allows each institution to have their own watermark, and institutional watermarks can be uploaded and managed via the user interface, in the archival institution's "Edit theme" page. Uploading a new watermark will not affect photos already present in AtoM, but AtoM does provide a way for a developer to cause all watermarks to be re-applied (see “Regenerating Derivatives” in the Command-line tools section of the Administrator's Manual of the [https://www.accesstomemory.org/docs AtoM documentation] for more details).

* [https://github.com/PeaceWorksTechnologySolutions/atom/tree/multiple-watermarks Peaceworks GitHub AtoM fork, multiple-watermarks branch]
* [https://github.com/PeaceWorksTechnologySolutions/atom/commit/6e1e9e9e4bd4c2df5bf4da7b4063e4c739031fb4 the commit with the changes]
* [https://github.com/PeaceWorksTechnologySolutions/atom/blob/multiple-watermarks/README_watermarks.md Multiple watermarks README documentation]

==Docker and AtoM==

Two different community developers have combined AtoM with [https://www.docker.com/ Docker], an open, container-based virtualization platform for distributed applications. Details below.

<admonition type="tip">
Did you know? As of the AtoM 2.3 release, the AtoM project now has its own officially supported Docker Compose development environment! See:
* https://www.accesstomemory.org/docs/latest/dev-manual/env/compose/
</admonition>

===AtoM Docker Files===

Created by Dominic Boisvert ([https://github.com/DominicBoisvert @DominicBoisvert]) for use in an archival course taught at the University of Montreal, Boisvert has shared Docker files for [[Releases/Release_announcements/Release_2.1.2|AtoM 2.1.2]], and [[Releases/Release_announcements/Release_2.1.1,_2.0.2,_1.3.2|ICA-AtoM 1.3.2]], including simple installation instructions (written in French):

* [https://github.com/ARV3054/docker-atom AtoM 2.1.2 Dockerfile]
* [https://github.com/ARV3054/docker-ica-atom ICA-AtoM 1.3.2 Dockerfile]

===AtoM Docker Compose recipe===

Created by John Fink ([https://github.com/jbfink @jbfink]), this is a Docker [https://docs.docker.com/compose/ Compose] recipe for AtoM. Compose is described by Docker as "''a tool for defining and running multi-container applications with Docker. With Compose, you define a multi-container application in a single file, then spin your application up in a single command which does everything that needs to be done to get it running.''"

The developer adds, "''Note that I've only tested this on 64bit native Linux using Docker directly, so if you're using boot2docker or a VM things might be different.''" For further configuration information and troubleshooting, see the [https://github.com/jbfink/docker-atom/blob/master/README.md README] provided.

* [https://github.com/jbfink/docker-atom Docker Compose recipe for AtoM - GitHub repository]
* [https://github.com/jbfink/docker-atom/blob/master/README.md README file for configuration and troubleshooting]
* [https://groups.google.com/d/topic/ica-atom-users/p7ACO3jKZv8/discussion Related AtoM User Forum thread]

===AtoM Docker Image===

Created by the Governo Regional Azores, this is a Docker image of AtoM 2.2.0. Note that it does not currently include the MySQL database required for AtoM, which needs to be linked.

* [https://hub.docker.com/r/governoregionalazores/atom-accesstomemory/ Link on the DockerHub page]
* [https://github.com/GovernoRegionalAcores/atom-accesstomemory GitHub repository for the Docker image]

==AtoM 2.3 ISO image - ready for use on a flash drive==

A group of archivists in Brazil, the [http://documentosarquivisticosdigitais.blogspot.com.br/ Grupo de Pesquisa do CNPq GED/A e Patrimônio Documental Arquivístico], have used the [https://launchpad.net/systemback SystemBack] backup management tool to prepare an ISO image of AtoM 2.3 that can be launched from a flash drive. From the related blog post:

* Operating System: Ubuntu 16.04 - 64 Bits;
* Size: 3GBs
* Format: sblive
* Remasterer: SystemBack

"''After Download, use SystemBack to write to the flash drive, and use with a system boot that is persistent - your data stored in the session will remain available in the next.'"

* Ubuntu Linux password: <code>icaatom99</code>
* User in AtoM (ICA-AtoM): <code>GrupoCNPqDocsDigitais@gmail.com</code>
* Password in AtoM (ICA-AtoM): <code>icaatom</code>

* Blog post here (Brazilian Portuguese): http://documentosarquivisticosdigitais.blogspot.com.br/2017/01/o-grupo-de-pesquisa-cnpq-ufsm-geda.html
* Download link: https://drive.google.com/file/d/0BwBRoubj23bpNWZLSVhtSmNoN00/view?usp=sharing

==HTML scrub scripts for other entities==

<admonition type="important">
'''UPDATE''': Thanks to collaboration among several community members, this work has now been added to the existing AtoM task, and merged into the 2.4 release. For more information, see:

* Source pull request: https://github.com/artefactual/atom/pull/568

Thank you to Clara Rosales and Darryl Friesen for this collaborative enhancement!

</admonition>

In [[Releases/Release_announcements/Release_2.2|Release 2.2]] we introduced [[Releases/Release_announcements/Release_2.2#Security_enhancement:_HTML_escaping_to_prevent_XSS_exploits|HTML escaping]] as part of the security enhancements included in the release. Since some users might have legacy HTML content in their descriptions, we also included a command-line task that would allow users to scrub legacy HTML from archival descriptions - see the related documentation [https://www.accesstomemory.org/docs/latest/admin-manual/maintenance/cli-tools/#remove-html-content-from-archival-description-fields here].

However, this task '''only''' currently works for archival descriptions. To help clean up other entities, users from Brazil have adapted versions of the original task that can be run for actors, notes, repository records, and rights records. These were posted in the AtoM user forum on 2017-05-22:

* https://groups.google.com/d/msg/ica-atom-users/_xdBK0ucegg/RQnNM5DKBAAJ

Artefactual has not tested these scripts. To run them:

# Download and unzip the rar file attached to the message in the user forum.
# Place the scripts in a directory accessible from the root directory of your AtoM instance, such as a new tmp directory.
# Use the tools:run command to run each script. For example, for the script to clean up HTML in authority records:

<pre>
php symfony tools:run tmp/actor_i18n.php
</pre>

The effects will be similar to what is described for the command-line task:

* https://www.accesstomemory.org/docs/latest/admin-manual/maintenance/cli-tools/#remove-html-content-from-archival-description-fields

==Custom theme plugins==

This section will be a place for community members to share any theme plugins they have developed! Note that we have [https://www.accesstomemory.org/docs/latest/admin-manual/customization/theming/ documentation] and [https://www.slideshare.net/accesstomemory/creating-custom-themes-in-atom slides] to help developers get started with theming - be sure to check them out, as well as our general [[Development#Development_resources|Development resources]]!

===Alberto Pereira's custom theme===

Developed against AtoM 2.5, this custom theme by [https://github.com/albertopereira Alberto Pereira] includes a number of customizations, including the following change notes from the developer:

* The "Popular this week" box gets a bigger highlight;
* The first element of the "Popular this week" also shows its thumbnail (if it exists);
* Overall style changes (including new icons);
* A Blog! (well, sort of), it uses static pages to mimic a blog. You just have to create a page called "Blog", and any other page that has a title that starts with "_X-", will automatically be listed in the blog page (e.g. "_X-A post title");
* You don't have to chose between the sidebar treeview and the full width treeview. You can have both. There's a new link, right below the sidebar treeview, that opens a popup with the full width treeview.

[[File:arAPPlugin-theme.jpg|center|700px|thumb| An image of the arAPPlugin theme]]

You can find the theme and more details at the following links:

* [https://github.com/albertopereira/arAPPlugin Theme code, images, and installation instructions on GitHub]
* [https://groups.google.com/d/msg/ica-atom-users/OpX9CvU0pAY/3sOgeJavBAAJ AtoM user forum announcement] (2019-02-27)

-----

* [[Community/Community resources|Back to Community resources]]
* [[Community|Back to Community landing page]]
* [[Main Page|Main AtoM wiki page]]

[[Category:Community]]

Community/Community resources/Development

2024-09-10T12:12:04Z

Dan: /* PeaceWorks MAID plugins */ Add note about recent updates to 2.8.x

{{#pagetitle:Community development}}
[[Main Page]] > [[Community]] > [[Community/Community resources]] > Community/Community resources/Development

In this section of the wiki, we'll add links to custom patches, plugins, themes, images, forks, and other resources developed by community users and publicly available for developers to explore and work with.

<admonition type="warning">
'''PLEASE NOTE''': Artefactual does '''not''' test these features and modules developed by AtoM community members. As such, we cannot offer support for them, nor can we speak as to their security, quality, performance, or compatibility with the latest public releases. If you intend to make use of these features, do so at your own risk. We strongly recommend studying the code prior to use, and deploying any community-developed features in a test environment where they can be properly evaluated.
</admonition>

<admonition type="tip">
Have you developed custom code for your AtoM installation? Let us know! And... why not consider contributing your code to the public project? That way, we maintain the code for you through future releases, and the entire community benefits from your work! Here are some links to get you started:
* [[Development/Contribute code]]
* [[Development#Development_resources|Other developer resources in our wiki]]
</admonition>

__TOC__

==AtoM 2.7 Drupal 9 feed module==

Developed by members of the University of Toronto (U of T) Libraries, this AtoM Drupal importer is a Drupal 9 module based on the AtoM API. The module is used at U of T to facilitate publishing archival description once, in U of T's [https://discoverarchives.library.utoronto.ca/ Discover Archives (AtoM)] finding aid database, after which it pulls description data into Drupal as Nodes and Taxonomies. This data can then generate a searchable collections list (A-Z) in Drupal as well as a Drupal page per top-level fonds/collections. When data in the linked AtoM instance is updated or new data is added, the module can also fetch and update the Drupal data at a designated frequency.

The goal of the module is to reuse published AtoM description metadata in a more end-user-friendly Drupal website to facilitate "general user" browse/discovery of top-level descriptions on the University's Drupal-based departmental websites, where users may not normally encounter the archival AtoM instance.

You can see an example of the module in use on the U of T's [https://media-archives.library.utoronto.ca/archival-collections Media Commons Archives Drupal website ], displaying data from their [https://discoverarchives.library.utoronto.ca/index.php/university-of-toronto-media-commons AtoM descriptions].

You can find this plugin at:

* https://github.com/utlib/drupal_atom

 

It has been confirmed to work with AtoM 2.7.x.

This work was originally shared in the AtoM User Forum on November 16, 2023:

* https://groups.google.com/g/ica-atom-users/c/aCAdGKdFgNQ/m/E14KAUOKBAAJ

 

Initial module planning, creation, and development included:

* Rachel Beattie, Assistant Media Archivist
* Gordon Belray, Information Architect
* Andy Foster, Senior Software Engineer
* Lillian Hogendoorn, Curator of Digital Experience
* Bilal Khalid, Manager of Digital Library Applications
* Sunny Lee, Digital Initiatives Programmer Analyst
* Christina Stewart, Assistant Media Archivist
* Chul Hee Yoon, Project Application Programmer Analyst
* Kelli Babcock, Digital Initiatives Librarian

==AtoM 2.4 Drupal front-end display bridge==

[https://github.com/andreaem Michael Andreae] of the University of Toronto has created a fork of Drupal's Views Database Connector that has been modified to work as a bridge for AtoM, so that Drupal can be used as a public-facing front-end. From the README on the GitHub project:

''Views Database Connector is a powerful module that gives Views full access to external database tables found in the settings for your Drupal installation. With this module, you can setup a view around any table in any database configuration. This can be extremely useful to pull external data from a database to show to your users in a view.''

''The Drupal AtoM connector is a non generalized version of Views Database Connector, VDC was just used as a template. In Drupal you can create blocks and add whatever sections you need based on an object.''

''For example adding in a fonds you can link another view in fields of notes types and then link based on id. Because there can be multiple notes etc... on one record it was easier to add the relations in the Drupal View rather than in the Database Connector.''

According to notes on the README, this bridge has only been tested with AtoM version 2.4.0 - 156.

The code, along with basic installation instructions, can be found on GitHub, here:

* https://github.com/Vic-Lib/DrupalAtoMViewer

==AtoM Linux Installer scripts==

Community user Guillermo Castellano Casas has developed some automated bash installation scripts that can be used to install AtoM 2.4, 2.5, or 2.6. Below are the GNU/Linux distributions currently supported for each AtoM version:

* 2.6: Ubuntu 18.04, Debian 10.
* 2.5: Ubuntu 16.04/18.04, Debian 9.
* 2.4: Ubuntu 16.04.

* The GitLab repository where the scripts and basic usage instructions can be found: [https://gitlab.com/guillearch/atom-installer here]
* A [https://gitlab.com/guillearch/atom-installer/blob/master/contributing.md contributor's guide] if you'd like to help improve the installers!
* The AtoM [https://groups.google.com/d/msg/ica-atom-users/xy4Fha_OUe4/gVJBlHSWBgAJ user forum post] where these were first shared with the AtoM community (September 2019)

==AtoM virtual machines==

Community user [https://github.com/ricardodepinho Ricardo Pinho] has prepared a webite, [https://atom-vm.com/store atom-vm.com], where he is sharing production-ready virtual machine (VM) images of AtoM releases. Intended for use either as local development environments or in production for small to medium archives, these VMs are built using the recommended AtoM [https://www.accesstomemory.org/docs/latest/admin-manual/installation/linux/ubuntu-bionic/ installation instructions].

As of November 2023 the site currently hosts Virtual Machines for:

[[Releases/Release_announcements/Release_2.5.4|(Release 2.5.4)]] - [https://atom-vm.com/atom-vm-2-5-4/ AtoM-VM 2.5.4];

[[Releases/Release_announcements/Release_2.6.4|(Release 2.6.4)]] - [https://atom-vm.com/atom-vm-2-6-4/ AtoM-VM 2.6.4];

Other versions will be added in the future.

Ricardo asks for a small donation to support the site and future releases. To run the VMs you will first need to install any Virtual Machine player able to import the standard ovf and vmdk file format or run directly from a vmx file - examples include [https://www.virtualbox.org/wiki/Downloads Virtualbox] or the free [https://www.vmware.com/go/downloadplayer VMWare Player]. At this time, the current release of AtoM-VM runs only on 64-bit computers (x86-amd64). For more information, see:

* [https://atom-vm.com atom-vm.com]

==CENDARI Shibboleth authentication plugin==

CENDARI (Collaborative European Digital Archive Infrastructure) is a research collaboration aimed at integrating digital archives and resources for research on medieval and modern European history. They have chosen AtoM for use as their collaborative Archival Directory (site [https://archives.cendari.dariah.eu/ here], more information [http://www.cendari.eu/archival-directories/ here]), and have done some custom development, including a plugin to integrate with [http://shibboleth.net/ Shibboleth], an "''open-source project that provides Single Sign-On capabilities and allows sites to make informed authorization decisions for individual access of protected online resources in a privacy-preserving manner.''"

The plugin was developed against AtoM 2.1, and has had compatibility updates for 2.3. In 2019, a community user has also reported success in the [https://groups.google.com/d/msg/ica-atom-users/xZeV1VAvJuM/rhvI7n_GBwAJ User forum] using this plugin with a 2.4.1 release. Another user forked the plugin, added a few additional commit (details [https://github.com/CENDARI/sfDariahShibUserPlugin/compare/master...kstatelibraries:sfDariahShibUserPlugin:ksul-shibconfig here] and [https://github.com/CENDARI/sfDariahShibUserPlugin/pulls here]), and reports it working with those changes in a 2.6.4 release. Status of testing against other releases is unknown.

The original plugin development was done by [https://github.com/schildwaechter Carsten Thiel], primarily between November and December of 2014.

* [https://github.com/CENDARI/sfDariahShibUserPlugin GitHub repository]
* [http://www.cendari.eu/sites/default/files/CENDARI%20technical%20documentation.pdf Plugin documentation]

==PeaceWorks MAID plugins ==

''NOTE: 'As of 2024-09, these plugins have been upgraded to work with 2.8.x AtoM installations'''

In March of 2015, [http://www.peaceworks.ca/ PeaceWorks Technology Solutions] helped to launch [http://archives.mhsc.ca/ MAID] (Mennonite Archival Image Database), a collaborative project of the Mennonite Historical Society of Canada which includes Mennonite archival partners in British Columbia, Alberta, Saskatchewan, Manitoba, and Ontario, with images held in a shared AtoM instance. Over the course of the 2-year design and development project leading up to the launch, PeaceWorks developed several custom features and plugins for use in MAID, including an eCommerce "shopping cart" plugin for purchasing prints of images available in MAID; an image carousel for the home page; integration with [http://www.tinymce.com/ TinyMCE] to add a [https://en.wikipedia.org/wiki/WYSIWYG WYSIWYG] set of editing tools to AtoM's static pages (e.g. so users did not need to know basic HTML to style static pages); and the ability to upload a different watermark (to be applied to digital object derivatives) for each institution. More details on each below.

===eCommerce plugin===

This plugin has been developed by [https://github.com/jasonhildebrand Jason Hildebrand] of [http://www.peaceworks.ca/ PeaceWorks Technology Solutions], primarily between July 2014 and March 2015.

According to the [https://github.com/PeaceWorksTechnologySolutions/atom/blob/ecommerce/plugins/sfEcommercePlugin/README.md plugin documentation's] Overview section, "This plugin allows website visitors to select and purchase individual photos. Payment for the photos happens via PayPal. E-Commerce admins review each order and may approve or reject (remove) photos from the order. After approval, the customer is sent an email containing a link which they can use to download the image(s).

Users have access to a shopping cart, where photos from multiple repositories can be added as users browse the site, and then ordered/checked out via PayPal. The shopping cart has basic integration with AtoM's PREMIS rights module, so when Dissemination = "Disallow," a message about restrictions is supplied instead. Other features include a vacation setting and a sales report.

* [https://github.com/PeaceWorksTechnologySolutions/atom/tree/ecommerce PeaceWorks GitHub AtoM fork, eCommerce branch]
* [https://github.com/PeaceWorksTechnologySolutions/atom/blob/ecommerce/plugins/sfEcommercePlugin/README.md eCommerce plugin documentation]
* [http://archives.mhsc.ca/ MAID], where you can see the shopping cart in action

MAID has also prepared a summary description of the plugin's functionality, available as a PDF here:

* [[File:Ecommerce-MAID.pdf]] (PDF, approx 431KB)

===Home page carousel plugin===

This plugin has been developed by [https://github.com/jasonhildebrand Jason Hildebrand] of [http://www.peaceworks.ca/ PeaceWorks Technology Solutions], primarily between July 2014 and March 2015.

This plugin adds a slideshow to the AtoM front page which displays up to 30 of the most recently added/updated photos in the system. Photos and their captions (if available) are displayed. Users may click a photo to go to its archival description.

* [https://github.com/PeaceWorksTechnologySolutions/atom/tree/carousel PeaceWorks GitHub AtoM fork, Carousel branch]
* [https://github.com/PeaceWorksTechnologySolutions/atom/blob/carousel/plugins/sfCarouselPlugin/README.md Carousel README documentation]
* [http://archives.mhsc.ca/ MAID] homepage, where you can see the carousel in action

===TinyMCE visual editor integration for editing static pages===

This integration has been developed by [https://github.com/jasonhildebrand Jason Hildebrand] of [http://www.peaceworks.ca/ PeaceWorks Technology Solutions], primarily between April 2014 and March 2015. At this time, this integration has not been packaged as a plugin.

[http://www.tinymce.com/ TinyMCE] is "'' a platform independent web based Javascript HTML [https://en.wikipedia.org/wiki/WYSIWYG WYSIWYG] editor control released as Open Source under LGPL,''" that, when integrated with AtoM, allows users unfamiliar with HTML to style static pages using familiar buttons, tools, and other user interface elements. The integration includes basic text styling (bold, underline, italics), table creation, image and file upload, link creation, and more.

* [https://github.com/PeaceWorksTechnologySolutions/atom/tree/tinymce PeaceWorks GitHub AtoM fork, TinyMCE branch]
* [https://github.com/PeaceWorksTechnologySolutions/atom/blob/tinymce/README_tinymce.md TinyMCE README documentation]

===Per-institution watermarks for digital objects===

This integration has been developed by [https://github.com/jasonhildebrand Jason Hildebrand] of [http://www.peaceworks.ca/ PeaceWorks Technology Solutions], between July 2014 and March 2015 (primarily in July 2014). At this time, this integration has not been packaged as a plugin.

AtoM includes the little-known ability to apply a watermark to uploaded photos. However there is only provision for a single global watermark which is applied to all images. This customization allows each institution to have their own watermark, and institutional watermarks can be uploaded and managed via the user interface, in the archival institution's "Edit theme" page. Uploading a new watermark will not affect photos already present in AtoM, but AtoM does provide a way for a developer to cause all watermarks to be re-applied (see “Regenerating Derivatives” in the Command-line tools section of the Administrator's Manual of the [https://www.accesstomemory.org/docs AtoM documentation] for more details).

* [https://github.com/PeaceWorksTechnologySolutions/atom/tree/multiple-watermarks Peaceworks GitHub AtoM fork, multiple-watermarks branch]
* [https://github.com/PeaceWorksTechnologySolutions/atom/commit/6e1e9e9e4bd4c2df5bf4da7b4063e4c739031fb4 the commit with the changes]
* [https://github.com/PeaceWorksTechnologySolutions/atom/blob/multiple-watermarks/README_watermarks.md Multiple watermarks README documentation]

==Docker and AtoM==

Two different community developers have combined AtoM with [https://www.docker.com/ Docker], an open, container-based virtualization platform for distributed applications. Details below.

<admonition type="tip">
Did you know? As of the AtoM 2.3 release, the AtoM project now has its own officially supported Docker Compose development environment! See:
* https://www.accesstomemory.org/docs/latest/dev-manual/env/compose/
</admonition>

===AtoM Docker Files===

Created by Dominic Boisvert ([https://github.com/DominicBoisvert @DominicBoisvert]) for use in an archival course taught at the University of Montreal, Boisvert has shared Docker files for [[Releases/Release_announcements/Release_2.1.2|AtoM 2.1.2]], and [[Releases/Release_announcements/Release_2.1.1,_2.0.2,_1.3.2|ICA-AtoM 1.3.2]], including simple installation instructions (written in French):

* [https://github.com/ARV3054/docker-atom AtoM 2.1.2 Dockerfile]
* [https://github.com/ARV3054/docker-ica-atom ICA-AtoM 1.3.2 Dockerfile]

===AtoM Docker Compose recipe===

Created by John Fink ([https://github.com/jbfink @jbfink]), this is a Docker [https://docs.docker.com/compose/ Compose] recipe for AtoM. Compose is described by Docker as "''a tool for defining and running multi-container applications with Docker. With Compose, you define a multi-container application in a single file, then spin your application up in a single command which does everything that needs to be done to get it running.''"

The developer adds, "''Note that I've only tested this on 64bit native Linux using Docker directly, so if you're using boot2docker or a VM things might be different.''" For further configuration information and troubleshooting, see the [https://github.com/jbfink/docker-atom/blob/master/README.md README] provided.

* [https://github.com/jbfink/docker-atom Docker Compose recipe for AtoM - GitHub repository]
* [https://github.com/jbfink/docker-atom/blob/master/README.md README file for configuration and troubleshooting]
* [https://groups.google.com/d/topic/ica-atom-users/p7ACO3jKZv8/discussion Related AtoM User Forum thread]

===AtoM Docker Image===

Created by the Governo Regional Azores, this is a Docker image of AtoM 2.2.0. Note that it does not currently include the MySQL database required for AtoM, which needs to be linked.

* [https://hub.docker.com/r/governoregionalazores/atom-accesstomemory/ Link on the DockerHub page]
* [https://github.com/GovernoRegionalAcores/atom-accesstomemory GitHub repository for the Docker image]

==AtoM 2.3 ISO image - ready for use on a flash drive==

A group of archivists in Brazil, the [http://documentosarquivisticosdigitais.blogspot.com.br/ Grupo de Pesquisa do CNPq GED/A e Patrimônio Documental Arquivístico], have used the [https://launchpad.net/systemback SystemBack] backup management tool to prepare an ISO image of AtoM 2.3 that can be launched from a flash drive. From the related blog post:

* Operating System: Ubuntu 16.04 - 64 Bits;
* Size: 3GBs
* Format: sblive
* Remasterer: SystemBack

"''After Download, use SystemBack to write to the flash drive, and use with a system boot that is persistent - your data stored in the session will remain available in the next.'"

* Ubuntu Linux password: <code>icaatom99</code>
* User in AtoM (ICA-AtoM): <code>GrupoCNPqDocsDigitais@gmail.com</code>
* Password in AtoM (ICA-AtoM): <code>icaatom</code>

* Blog post here (Brazilian Portuguese): http://documentosarquivisticosdigitais.blogspot.com.br/2017/01/o-grupo-de-pesquisa-cnpq-ufsm-geda.html
* Download link: https://drive.google.com/file/d/0BwBRoubj23bpNWZLSVhtSmNoN00/view?usp=sharing

==HTML scrub scripts for other entities==

<admonition type="important">
'''UPDATE''': Thanks to collaboration among several community members, this work has now been added to the existing AtoM task, and merged into the 2.4 release. For more information, see:

* Source pull request: https://github.com/artefactual/atom/pull/568

Thank you to Clara Rosales and Darryl Friesen for this collaborative enhancement!

</admonition>

In [[Releases/Release_announcements/Release_2.2|Release 2.2]] we introduced [[Releases/Release_announcements/Release_2.2#Security_enhancement:_HTML_escaping_to_prevent_XSS_exploits|HTML escaping]] as part of the security enhancements included in the release. Since some users might have legacy HTML content in their descriptions, we also included a command-line task that would allow users to scrub legacy HTML from archival descriptions - see the related documentation [https://www.accesstomemory.org/docs/latest/admin-manual/maintenance/cli-tools/#remove-html-content-from-archival-description-fields here].

However, this task '''only''' currently works for archival descriptions. To help clean up other entities, users from Brazil have adapted versions of the original task that can be run for actors, notes, repository records, and rights records. These were posted in the AtoM user forum on 2017-05-22:

* https://groups.google.com/d/msg/ica-atom-users/_xdBK0ucegg/RQnNM5DKBAAJ

Artefactual has not tested these scripts. To run them:

# Download and unzip the rar file attached to the message in the user forum.
# Place the scripts in a directory accessible from the root directory of your AtoM instance, such as a new tmp directory.
# Use the tools:run command to run each script. For example, for the script to clean up HTML in authority records:

<pre>
php symfony tools:run tmp/actor_i18n.php
</pre>

The effects will be similar to what is described for the command-line task:

* https://www.accesstomemory.org/docs/latest/admin-manual/maintenance/cli-tools/#remove-html-content-from-archival-description-fields

==Custom theme plugins==

This section will be a place for community members to share any theme plugins they have developed! Note that we have [https://www.accesstomemory.org/docs/latest/admin-manual/customization/theming/ documentation] and [https://www.slideshare.net/accesstomemory/creating-custom-themes-in-atom slides] to help developers get started with theming - be sure to check them out, as well as our general [[Development#Development_resources|Development resources]]!

===Alberto Pereira's custom theme===

Developed against AtoM 2.5, this custom theme by [https://github.com/albertopereira Alberto Pereira] includes a number of customizations, including the following change notes from the developer:

* The "Popular this week" box gets a bigger highlight;
* The first element of the "Popular this week" also shows its thumbnail (if it exists);
* Overall style changes (including new icons);
* A Blog! (well, sort of), it uses static pages to mimic a blog. You just have to create a page called "Blog", and any other page that has a title that starts with "_X-", will automatically be listed in the blog page (e.g. "_X-A post title");
* You don't have to chose between the sidebar treeview and the full width treeview. You can have both. There's a new link, right below the sidebar treeview, that opens a popup with the full width treeview.

[[File:arAPPlugin-theme.jpg|center|700px|thumb| An image of the arAPPlugin theme]]

You can find the theme and more details at the following links:

* [https://github.com/albertopereira/arAPPlugin Theme code, images, and installation instructions on GitHub]
* [https://groups.google.com/d/msg/ica-atom-users/OpX9CvU0pAY/3sOgeJavBAAJ AtoM user forum announcement] (2019-02-27)

-----

* [[Community/Community resources|Back to Community resources]]
* [[Community|Back to Community landing page]]
* [[Main Page|Main AtoM wiki page]]

[[Category:Community]]

User:Daejin

2024-05-28T13:46:50Z

Dan: Creating user page for new user.

Ph.D. in Archives and Records Management
Founder of Archive Lab Inc. (South Korea)

User:Dcraze

2024-05-17T14:28:01Z

Dan: Creating user page for new user.

Artefactual technical support and deployment manager. 30 years experience in support and IT.

User:Sofibru86

2024-04-29T14:42:28Z

Dan: Creating user page for new user.

Licenciada en Archivología. Profesora Titular en la carrera de Archivología FFyH-UNC Córdoba, Argentina.

User:Doradorosa

2024-04-29T14:42:16Z

Dan: Creating user page for new user.

Bibliotecas Archivos Centros de documentación Sistema operativo formato MARC Digitalización Catalogación Clasificación

User:Bvasquez

2024-04-23T12:38:21Z

Dan: Creating user page for new user.

I am the current administrator of the technical managment of our AtoM Installation in Costa Rica's National Archives, we want to add our installation to the list of users in this page, that's the reason of this login request.

Thanks in advance!

User:GemmaGdlP

2024-04-23T12:38:11Z

Dan: Creating user page for new user.

Librarian and Archivist of Escola Massana, Centre d'Art i Disseny de Barcelona

User:CDC

2024-04-23T12:37:59Z

Dan: Creating user page for new user.

Estudiante de post-grado en Patrimonio Cultura y Tecnología desde la UNED

Community/Community resources/Development

2024-04-12T13:20:31Z

Dan: /* CENDARI Shibboleth authentication plugin */ Added updates about another user's forking

{{#pagetitle:Community development}}
[[Main Page]] > [[Community]] > [[Community/Community resources]] > Community/Community resources/Development

In this section of the wiki, we'll add links to custom patches, plugins, themes, images, forks, and other resources developed by community users and publicly available for developers to explore and work with.

<admonition type="warning">
'''PLEASE NOTE''': Artefactual does '''not''' test these features and modules developed by AtoM community members. As such, we cannot offer support for them, nor can we speak as to their security, quality, performance, or compatibility with the latest public releases. If you intend to make use of these features, do so at your own risk. We strongly recommend studying the code prior to use, and deploying any community-developed features in a test environment where they can be properly evaluated.
</admonition>

<admonition type="tip">
Have you developed custom code for your AtoM installation? Let us know! And... why not consider contributing your code to the public project? That way, we maintain the code for you through future releases, and the entire community benefits from your work! Here are some links to get you started:
* [[Development/Contribute code]]
* [[Development#Development_resources|Other developer resources in our wiki]]
</admonition>

__TOC__

==AtoM 2.7 Drupal 9 feed module==

Developed by members of the University of Toronto (U of T) Libraries, this AtoM Drupal importer is a Drupal 9 module based on the AtoM API. The module is used at U of T to facilitate publishing archival description once, in U of T's [https://discoverarchives.library.utoronto.ca/ Discover Archives (AtoM)] finding aid database, after which it pulls description data into Drupal as Nodes and Taxonomies. This data can then generate a searchable collections list (A-Z) in Drupal as well as a Drupal page per top-level fonds/collections. When data in the linked AtoM instance is updated or new data is added, the module can also fetch and update the Drupal data at a designated frequency.

The goal of the module is to reuse published AtoM description metadata in a more end-user-friendly Drupal website to facilitate "general user" browse/discovery of top-level descriptions on the University's Drupal-based departmental websites, where users may not normally encounter the archival AtoM instance.

You can see an example of the module in use on the U of T's [https://media-archives.library.utoronto.ca/archival-collections Media Commons Archives Drupal website ], displaying data from their [https://discoverarchives.library.utoronto.ca/index.php/university-of-toronto-media-commons AtoM descriptions].

You can find this plugin at:

* https://github.com/utlib/drupal_atom

 

It has been confirmed to work with AtoM 2.7.x.

This work was originally shared in the AtoM User Forum on November 16, 2023:

* https://groups.google.com/g/ica-atom-users/c/aCAdGKdFgNQ/m/E14KAUOKBAAJ

 

Initial module planning, creation, and development included:

* Rachel Beattie, Assistant Media Archivist
* Gordon Belray, Information Architect
* Andy Foster, Senior Software Engineer
* Lillian Hogendoorn, Curator of Digital Experience
* Bilal Khalid, Manager of Digital Library Applications
* Sunny Lee, Digital Initiatives Programmer Analyst
* Christina Stewart, Assistant Media Archivist
* Chul Hee Yoon, Project Application Programmer Analyst
* Kelli Babcock, Digital Initiatives Librarian

==AtoM 2.4 Drupal front-end display bridge==

[https://github.com/andreaem Michael Andreae] of the University of Toronto has created a fork of Drupal's Views Database Connector that has been modified to work as a bridge for AtoM, so that Drupal can be used as a public-facing front-end. From the README on the GitHub project:

''Views Database Connector is a powerful module that gives Views full access to external database tables found in the settings for your Drupal installation. With this module, you can setup a view around any table in any database configuration. This can be extremely useful to pull external data from a database to show to your users in a view.''

''The Drupal AtoM connector is a non generalized version of Views Database Connector, VDC was just used as a template. In Drupal you can create blocks and add whatever sections you need based on an object.''

''For example adding in a fonds you can link another view in fields of notes types and then link based on id. Because there can be multiple notes etc... on one record it was easier to add the relations in the Drupal View rather than in the Database Connector.''

According to notes on the README, this bridge has only been tested with AtoM version 2.4.0 - 156.

The code, along with basic installation instructions, can be found on GitHub, here:

* https://github.com/Vic-Lib/DrupalAtoMViewer

==AtoM Linux Installer scripts==

Community user Guillermo Castellano Casas has developed some automated bash installation scripts that can be used to install AtoM 2.4, 2.5, or 2.6. Below are the GNU/Linux distributions currently supported for each AtoM version:

* 2.6: Ubuntu 18.04, Debian 10.
* 2.5: Ubuntu 16.04/18.04, Debian 9.
* 2.4: Ubuntu 16.04.

* The GitLab repository where the scripts and basic usage instructions can be found: [https://gitlab.com/guillearch/atom-installer here]
* A [https://gitlab.com/guillearch/atom-installer/blob/master/contributing.md contributor's guide] if you'd like to help improve the installers!
* The AtoM [https://groups.google.com/d/msg/ica-atom-users/xy4Fha_OUe4/gVJBlHSWBgAJ user forum post] where these were first shared with the AtoM community (September 2019)

==AtoM virtual machines==

Community user [https://github.com/ricardodepinho Ricardo Pinho] has prepared a webite, [https://atom-vm.com/store atom-vm.com], where he is sharing production-ready virtual machine (VM) images of AtoM releases. Intended for use either as local development environments or in production for small to medium archives, these VMs are built using the recommended AtoM [https://www.accesstomemory.org/docs/latest/admin-manual/installation/linux/ubuntu-bionic/ installation instructions].

As of November 2023 the site currently hosts Virtual Machines for:

[[Releases/Release_announcements/Release_2.5.4|(Release 2.5.4)]] - [https://atom-vm.com/atom-vm-2-5-4/ AtoM-VM 2.5.4];

[[Releases/Release_announcements/Release_2.6.4|(Release 2.6.4)]] - [https://atom-vm.com/atom-vm-2-6-4/ AtoM-VM 2.6.4];

Other versions will be added in the future.

Ricardo asks for a small donation to support the site and future releases. To run the VMs you will first need to install any Virtual Machine player able to import the standard ovf and vmdk file format or run directly from a vmx file - examples include [https://www.virtualbox.org/wiki/Downloads Virtualbox] or the free [https://www.vmware.com/go/downloadplayer VMWare Player]. At this time, the current release of AtoM-VM runs only on 64-bit computers (x86-amd64). For more information, see:

* [https://atom-vm.com atom-vm.com]

==CENDARI Shibboleth authentication plugin==

CENDARI (Collaborative European Digital Archive Infrastructure) is a research collaboration aimed at integrating digital archives and resources for research on medieval and modern European history. They have chosen AtoM for use as their collaborative Archival Directory (site [https://archives.cendari.dariah.eu/ here], more information [http://www.cendari.eu/archival-directories/ here]), and have done some custom development, including a plugin to integrate with [http://shibboleth.net/ Shibboleth], an "''open-source project that provides Single Sign-On capabilities and allows sites to make informed authorization decisions for individual access of protected online resources in a privacy-preserving manner.''"

The plugin was developed against AtoM 2.1, and has had compatibility updates for 2.3. In 2019, a community user has also reported success in the [https://groups.google.com/d/msg/ica-atom-users/xZeV1VAvJuM/rhvI7n_GBwAJ User forum] using this plugin with a 2.4.1 release. Another user forked the plugin, added a few additional commit (details [https://github.com/CENDARI/sfDariahShibUserPlugin/compare/master...kstatelibraries:sfDariahShibUserPlugin:ksul-shibconfig here] and [https://github.com/CENDARI/sfDariahShibUserPlugin/pulls here]), and reports it working with those changes in a 2.6.4 release. Status of testing against other releases is unknown.

The original plugin development was done by [https://github.com/schildwaechter Carsten Thiel], primarily between November and December of 2014.

* [https://github.com/CENDARI/sfDariahShibUserPlugin GitHub repository]
* [http://www.cendari.eu/sites/default/files/CENDARI%20technical%20documentation.pdf Plugin documentation]

==PeaceWorks MAID plugins ==

In March of 2015, [http://www.peaceworks.ca/ PeaceWorks Technology Solutions] helped to launch [http://archives.mhsc.ca/ MAID] (Mennonite Archival Image Database), a collaborative project of the Mennonite Historical Society of Canada which includes Mennonite archival partners in British Columbia, Alberta, Saskatchewan, Manitoba, and Ontario, with images held in a shared AtoM instance. Over the course of the 2-year design and development project leading up to the launch, PeaceWorks developed several custom features and plugins for use in MAID, including an eCommerce "shopping cart" plugin for purchasing prints of images available in MAID; an image carousel for the home page; integration with [http://www.tinymce.com/ TinyMCE] to add a [https://en.wikipedia.org/wiki/WYSIWYG WYSIWYG] set of editing tools to AtoM's static pages (e.g. so users did not need to know basic HTML to style static pages); and the ability to upload a different watermark (to be applied to digital object derivatives) for each institution. More details on each below.

===eCommerce plugin===

This plugin has been developed by [https://github.com/jasonhildebrand Jason Hildebrand] of [http://www.peaceworks.ca/ PeaceWorks Technology Solutions], primarily between July 2014 and March 2015.

According to the [https://github.com/PeaceWorksTechnologySolutions/atom/blob/ecommerce/plugins/sfEcommercePlugin/README.md plugin documentation's] Overview section, "This plugin allows website visitors to select and purchase individual photos. Payment for the photos happens via PayPal. E-Commerce admins review each order and may approve or reject (remove) photos from the order. After approval, the customer is sent an email containing a link which they can use to download the image(s).

Users have access to a shopping cart, where photos from multiple repositories can be added as users browse the site, and then ordered/checked out via PayPal. The shopping cart has basic integration with AtoM's PREMIS rights module, so when Dissemination = "Disallow," a message about restrictions is supplied instead. Other features include a vacation setting and a sales report.

* [https://github.com/PeaceWorksTechnologySolutions/atom/tree/ecommerce PeaceWorks GitHub AtoM fork, eCommerce branch]
* [https://github.com/PeaceWorksTechnologySolutions/atom/blob/ecommerce/plugins/sfEcommercePlugin/README.md eCommerce plugin documentation]
* [http://archives.mhsc.ca/ MAID], where you can see the shopping cart in action

MAID has also prepared a summary description of the plugin's functionality, available as a PDF here:

* [[File:Ecommerce-MAID.pdf]] (PDF, approx 431KB)

===Home page carousel plugin===

This plugin has been developed by [https://github.com/jasonhildebrand Jason Hildebrand] of [http://www.peaceworks.ca/ PeaceWorks Technology Solutions], primarily between July 2014 and March 2015.

This plugin adds a slideshow to the AtoM front page which displays up to 30 of the most recently added/updated photos in the system. Photos and their captions (if available) are displayed. Users may click a photo to go to its archival description.

* [https://github.com/PeaceWorksTechnologySolutions/atom/tree/carousel PeaceWorks GitHub AtoM fork, Carousel branch]
* [https://github.com/PeaceWorksTechnologySolutions/atom/blob/carousel/plugins/sfCarouselPlugin/README.md Carousel README documentation]
* [http://archives.mhsc.ca/ MAID] homepage, where you can see the carousel in action

===TinyMCE visual editor integration for editing static pages===

This integration has been developed by [https://github.com/jasonhildebrand Jason Hildebrand] of [http://www.peaceworks.ca/ PeaceWorks Technology Solutions], primarily between April 2014 and March 2015. At this time, this integration has not been packaged as a plugin.

[http://www.tinymce.com/ TinyMCE] is "'' a platform independent web based Javascript HTML [https://en.wikipedia.org/wiki/WYSIWYG WYSIWYG] editor control released as Open Source under LGPL,''" that, when integrated with AtoM, allows users unfamiliar with HTML to style static pages using familiar buttons, tools, and other user interface elements. The integration includes basic text styling (bold, underline, italics), table creation, image and file upload, link creation, and more.

* [https://github.com/PeaceWorksTechnologySolutions/atom/tree/tinymce PeaceWorks GitHub AtoM fork, TinyMCE branch]
* [https://github.com/PeaceWorksTechnologySolutions/atom/blob/tinymce/README_tinymce.md TinyMCE README documentation]

===Per-institution watermarks for digital objects===

This integration has been developed by [https://github.com/jasonhildebrand Jason Hildebrand] of [http://www.peaceworks.ca/ PeaceWorks Technology Solutions], between July 2014 and March 2015 (primarily in July 2014). At this time, this integration has not been packaged as a plugin.

AtoM includes the little-known ability to apply a watermark to uploaded photos. However there is only provision for a single global watermark which is applied to all images. This customization allows each institution to have their own watermark, and institutional watermarks can be uploaded and managed via the user interface, in the archival institution's "Edit theme" page. Uploading a new watermark will not affect photos already present in AtoM, but AtoM does provide a way for a developer to cause all watermarks to be re-applied (see “Regenerating Derivatives” in the Command-line tools section of the Administrator's Manual of the [https://www.accesstomemory.org/docs AtoM documentation] for more details).

* [https://github.com/PeaceWorksTechnologySolutions/atom/tree/multiple-watermarks Peaceworks GitHub AtoM fork, multiple-watermarks branch]
* [https://github.com/PeaceWorksTechnologySolutions/atom/commit/6e1e9e9e4bd4c2df5bf4da7b4063e4c739031fb4 the commit with the changes]
* [https://github.com/PeaceWorksTechnologySolutions/atom/blob/multiple-watermarks/README_watermarks.md Multiple watermarks README documentation]

==Docker and AtoM==

Two different community developers have combined AtoM with [https://www.docker.com/ Docker], an open, container-based virtualization platform for distributed applications. Details below.

<admonition type="tip">
Did you know? As of the AtoM 2.3 release, the AtoM project now has its own officially supported Docker Compose development environment! See:
* https://www.accesstomemory.org/docs/latest/dev-manual/env/compose/
</admonition>

===AtoM Docker Files===

Created by Dominic Boisvert ([https://github.com/DominicBoisvert @DominicBoisvert]) for use in an archival course taught at the University of Montreal, Boisvert has shared Docker files for [[Releases/Release_announcements/Release_2.1.2|AtoM 2.1.2]], and [[Releases/Release_announcements/Release_2.1.1,_2.0.2,_1.3.2|ICA-AtoM 1.3.2]], including simple installation instructions (written in French):

* [https://github.com/ARV3054/docker-atom AtoM 2.1.2 Dockerfile]
* [https://github.com/ARV3054/docker-ica-atom ICA-AtoM 1.3.2 Dockerfile]

===AtoM Docker Compose recipe===

Created by John Fink ([https://github.com/jbfink @jbfink]), this is a Docker [https://docs.docker.com/compose/ Compose] recipe for AtoM. Compose is described by Docker as "''a tool for defining and running multi-container applications with Docker. With Compose, you define a multi-container application in a single file, then spin your application up in a single command which does everything that needs to be done to get it running.''"

The developer adds, "''Note that I've only tested this on 64bit native Linux using Docker directly, so if you're using boot2docker or a VM things might be different.''" For further configuration information and troubleshooting, see the [https://github.com/jbfink/docker-atom/blob/master/README.md README] provided.

* [https://github.com/jbfink/docker-atom Docker Compose recipe for AtoM - GitHub repository]
* [https://github.com/jbfink/docker-atom/blob/master/README.md README file for configuration and troubleshooting]
* [https://groups.google.com/d/topic/ica-atom-users/p7ACO3jKZv8/discussion Related AtoM User Forum thread]

===AtoM Docker Image===

Created by the Governo Regional Azores, this is a Docker image of AtoM 2.2.0. Note that it does not currently include the MySQL database required for AtoM, which needs to be linked.

* [https://hub.docker.com/r/governoregionalazores/atom-accesstomemory/ Link on the DockerHub page]
* [https://github.com/GovernoRegionalAcores/atom-accesstomemory GitHub repository for the Docker image]

==AtoM 2.3 ISO image - ready for use on a flash drive==

A group of archivists in Brazil, the [http://documentosarquivisticosdigitais.blogspot.com.br/ Grupo de Pesquisa do CNPq GED/A e Patrimônio Documental Arquivístico], have used the [https://launchpad.net/systemback SystemBack] backup management tool to prepare an ISO image of AtoM 2.3 that can be launched from a flash drive. From the related blog post:

* Operating System: Ubuntu 16.04 - 64 Bits;
* Size: 3GBs
* Format: sblive
* Remasterer: SystemBack

"''After Download, use SystemBack to write to the flash drive, and use with a system boot that is persistent - your data stored in the session will remain available in the next.'"

* Ubuntu Linux password: <code>icaatom99</code>
* User in AtoM (ICA-AtoM): <code>GrupoCNPqDocsDigitais@gmail.com</code>
* Password in AtoM (ICA-AtoM): <code>icaatom</code>

* Blog post here (Brazilian Portuguese): http://documentosarquivisticosdigitais.blogspot.com.br/2017/01/o-grupo-de-pesquisa-cnpq-ufsm-geda.html
* Download link: https://drive.google.com/file/d/0BwBRoubj23bpNWZLSVhtSmNoN00/view?usp=sharing

==HTML scrub scripts for other entities==

<admonition type="important">
'''UPDATE''': Thanks to collaboration among several community members, this work has now been added to the existing AtoM task, and merged into the 2.4 release. For more information, see:

* Source pull request: https://github.com/artefactual/atom/pull/568

Thank you to Clara Rosales and Darryl Friesen for this collaborative enhancement!

</admonition>

In [[Releases/Release_announcements/Release_2.2|Release 2.2]] we introduced [[Releases/Release_announcements/Release_2.2#Security_enhancement:_HTML_escaping_to_prevent_XSS_exploits|HTML escaping]] as part of the security enhancements included in the release. Since some users might have legacy HTML content in their descriptions, we also included a command-line task that would allow users to scrub legacy HTML from archival descriptions - see the related documentation [https://www.accesstomemory.org/docs/latest/admin-manual/maintenance/cli-tools/#remove-html-content-from-archival-description-fields here].

However, this task '''only''' currently works for archival descriptions. To help clean up other entities, users from Brazil have adapted versions of the original task that can be run for actors, notes, repository records, and rights records. These were posted in the AtoM user forum on 2017-05-22:

* https://groups.google.com/d/msg/ica-atom-users/_xdBK0ucegg/RQnNM5DKBAAJ

Artefactual has not tested these scripts. To run them:

# Download and unzip the rar file attached to the message in the user forum.
# Place the scripts in a directory accessible from the root directory of your AtoM instance, such as a new tmp directory.
# Use the tools:run command to run each script. For example, for the script to clean up HTML in authority records:

<pre>
php symfony tools:run tmp/actor_i18n.php
</pre>

The effects will be similar to what is described for the command-line task:

* https://www.accesstomemory.org/docs/latest/admin-manual/maintenance/cli-tools/#remove-html-content-from-archival-description-fields

==Custom theme plugins==

This section will be a place for community members to share any theme plugins they have developed! Note that we have [https://www.accesstomemory.org/docs/latest/admin-manual/customization/theming/ documentation] and [https://www.slideshare.net/accesstomemory/creating-custom-themes-in-atom slides] to help developers get started with theming - be sure to check them out, as well as our general [[Development#Development_resources|Development resources]]!

===Alberto Pereira's custom theme===

Developed against AtoM 2.5, this custom theme by [https://github.com/albertopereira Alberto Pereira] includes a number of customizations, including the following change notes from the developer:

* The "Popular this week" box gets a bigger highlight;
* The first element of the "Popular this week" also shows its thumbnail (if it exists);
* Overall style changes (including new icons);
* A Blog! (well, sort of), it uses static pages to mimic a blog. You just have to create a page called "Blog", and any other page that has a title that starts with "_X-", will automatically be listed in the blog page (e.g. "_X-A post title");
* You don't have to chose between the sidebar treeview and the full width treeview. You can have both. There's a new link, right below the sidebar treeview, that opens a popup with the full width treeview.

[[File:arAPPlugin-theme.jpg|center|700px|thumb| An image of the arAPPlugin theme]]

You can find the theme and more details at the following links:

* [https://github.com/albertopereira/arAPPlugin Theme code, images, and installation instructions on GitHub]
* [https://groups.google.com/d/msg/ica-atom-users/OpX9CvU0pAY/3sOgeJavBAAJ AtoM user forum announcement] (2019-02-27)

-----

* [[Community/Community resources|Back to Community resources]]
* [[Community|Back to Community landing page]]
* [[Main Page|Main AtoM wiki page]]

[[Category:Community]]

Community/Community resources/Development

2024-04-10T12:21:54Z

Dan: /* CENDARI Shibboleth authentication plugin */

{{#pagetitle:Community development}}
[[Main Page]] > [[Community]] > [[Community/Community resources]] > Community/Community resources/Development

In this section of the wiki, we'll add links to custom patches, plugins, themes, images, forks, and other resources developed by community users and publicly available for developers to explore and work with.

<admonition type="warning">
'''PLEASE NOTE''': Artefactual does '''not''' test these features and modules developed by AtoM community members. As such, we cannot offer support for them, nor can we speak as to their security, quality, performance, or compatibility with the latest public releases. If you intend to make use of these features, do so at your own risk. We strongly recommend studying the code prior to use, and deploying any community-developed features in a test environment where they can be properly evaluated.
</admonition>

<admonition type="tip">
Have you developed custom code for your AtoM installation? Let us know! And... why not consider contributing your code to the public project? That way, we maintain the code for you through future releases, and the entire community benefits from your work! Here are some links to get you started:
* [[Development/Contribute code]]
* [[Development#Development_resources|Other developer resources in our wiki]]
</admonition>

__TOC__

==AtoM 2.7 Drupal 9 feed module==

Developed by members of the University of Toronto (U of T) Libraries, this AtoM Drupal importer is a Drupal 9 module based on the AtoM API. The module is used at U of T to facilitate publishing archival description once, in U of T's [https://discoverarchives.library.utoronto.ca/ Discover Archives (AtoM)] finding aid database, after which it pulls description data into Drupal as Nodes and Taxonomies. This data can then generate a searchable collections list (A-Z) in Drupal as well as a Drupal page per top-level fonds/collections. When data in the linked AtoM instance is updated or new data is added, the module can also fetch and update the Drupal data at a designated frequency.

The goal of the module is to reuse published AtoM description metadata in a more end-user-friendly Drupal website to facilitate "general user" browse/discovery of top-level descriptions on the University's Drupal-based departmental websites, where users may not normally encounter the archival AtoM instance.

You can see an example of the module in use on the U of T's [https://media-archives.library.utoronto.ca/archival-collections Media Commons Archives Drupal website ], displaying data from their [https://discoverarchives.library.utoronto.ca/index.php/university-of-toronto-media-commons AtoM descriptions].

You can find this plugin at:

* https://github.com/utlib/drupal_atom

 

It has been confirmed to work with AtoM 2.7.x.

This work was originally shared in the AtoM User Forum on November 16, 2023:

* https://groups.google.com/g/ica-atom-users/c/aCAdGKdFgNQ/m/E14KAUOKBAAJ

 

Initial module planning, creation, and development included:

* Rachel Beattie, Assistant Media Archivist
* Gordon Belray, Information Architect
* Andy Foster, Senior Software Engineer
* Lillian Hogendoorn, Curator of Digital Experience
* Bilal Khalid, Manager of Digital Library Applications
* Sunny Lee, Digital Initiatives Programmer Analyst
* Christina Stewart, Assistant Media Archivist
* Chul Hee Yoon, Project Application Programmer Analyst
* Kelli Babcock, Digital Initiatives Librarian

==AtoM 2.4 Drupal front-end display bridge==

[https://github.com/andreaem Michael Andreae] of the University of Toronto has created a fork of Drupal's Views Database Connector that has been modified to work as a bridge for AtoM, so that Drupal can be used as a public-facing front-end. From the README on the GitHub project:

''Views Database Connector is a powerful module that gives Views full access to external database tables found in the settings for your Drupal installation. With this module, you can setup a view around any table in any database configuration. This can be extremely useful to pull external data from a database to show to your users in a view.''

''The Drupal AtoM connector is a non generalized version of Views Database Connector, VDC was just used as a template. In Drupal you can create blocks and add whatever sections you need based on an object.''

''For example adding in a fonds you can link another view in fields of notes types and then link based on id. Because there can be multiple notes etc... on one record it was easier to add the relations in the Drupal View rather than in the Database Connector.''

According to notes on the README, this bridge has only been tested with AtoM version 2.4.0 - 156.

The code, along with basic installation instructions, can be found on GitHub, here:

* https://github.com/Vic-Lib/DrupalAtoMViewer

==AtoM Linux Installer scripts==

Community user Guillermo Castellano Casas has developed some automated bash installation scripts that can be used to install AtoM 2.4, 2.5, or 2.6. Below are the GNU/Linux distributions currently supported for each AtoM version:

* 2.6: Ubuntu 18.04, Debian 10.
* 2.5: Ubuntu 16.04/18.04, Debian 9.
* 2.4: Ubuntu 16.04.

* The GitLab repository where the scripts and basic usage instructions can be found: [https://gitlab.com/guillearch/atom-installer here]
* A [https://gitlab.com/guillearch/atom-installer/blob/master/contributing.md contributor's guide] if you'd like to help improve the installers!
* The AtoM [https://groups.google.com/d/msg/ica-atom-users/xy4Fha_OUe4/gVJBlHSWBgAJ user forum post] where these were first shared with the AtoM community (September 2019)

==AtoM virtual machines==

Community user [https://github.com/ricardodepinho Ricardo Pinho] has prepared a webite, [https://atom-vm.com/store atom-vm.com], where he is sharing production-ready virtual machine (VM) images of AtoM releases. Intended for use either as local development environments or in production for small to medium archives, these VMs are built using the recommended AtoM [https://www.accesstomemory.org/docs/latest/admin-manual/installation/linux/ubuntu-bionic/ installation instructions].

As of November 2023 the site currently hosts Virtual Machines for:

[[Releases/Release_announcements/Release_2.5.4|(Release 2.5.4)]] - [https://atom-vm.com/atom-vm-2-5-4/ AtoM-VM 2.5.4];

[[Releases/Release_announcements/Release_2.6.4|(Release 2.6.4)]] - [https://atom-vm.com/atom-vm-2-6-4/ AtoM-VM 2.6.4];

Other versions will be added in the future.

Ricardo asks for a small donation to support the site and future releases. To run the VMs you will first need to install any Virtual Machine player able to import the standard ovf and vmdk file format or run directly from a vmx file - examples include [https://www.virtualbox.org/wiki/Downloads Virtualbox] or the free [https://www.vmware.com/go/downloadplayer VMWare Player]. At this time, the current release of AtoM-VM runs only on 64-bit computers (x86-amd64). For more information, see:

* [https://atom-vm.com atom-vm.com]

==CENDARI Shibboleth authentication plugin==

CENDARI (Collaborative European Digital Archive Infrastructure) is a research collaboration aimed at integrating digital archives and resources for research on medieval and modern European history. They have chosen AtoM for use as their collaborative Archival Directory (site [https://archives.cendari.dariah.eu/ here], more information [http://www.cendari.eu/archival-directories/ here]), and have done some custom development, including a plugin to integrate with [http://shibboleth.net/ Shibboleth], an "''open-source project that provides Single Sign-On capabilities and allows sites to make informed authorization decisions for individual access of protected online resources in a privacy-preserving manner.''"

The plugin was developed against AtoM 2.1, and has had compatibility updates for 2.3. In 2019, a community user has also reported success in the [https://groups.google.com/d/msg/ica-atom-users/xZeV1VAvJuM/rhvI7n_GBwAJ User forum] using this plugin with a 2.4.1 release. Status of testing against other releases is unknown. The development was done by [https://github.com/schildwaechter Carsten Thiel], primarily between November and December of 2014.

* [https://github.com/CENDARI/sfDariahShibUserPlugin GitHub repository]
* [http://www.cendari.eu/sites/default/files/CENDARI%20technical%20documentation.pdf Plugin documentation]

==PeaceWorks MAID plugins ==

In March of 2015, [http://www.peaceworks.ca/ PeaceWorks Technology Solutions] helped to launch [http://archives.mhsc.ca/ MAID] (Mennonite Archival Image Database), a collaborative project of the Mennonite Historical Society of Canada which includes Mennonite archival partners in British Columbia, Alberta, Saskatchewan, Manitoba, and Ontario, with images held in a shared AtoM instance. Over the course of the 2-year design and development project leading up to the launch, PeaceWorks developed several custom features and plugins for use in MAID, including an eCommerce "shopping cart" plugin for purchasing prints of images available in MAID; an image carousel for the home page; integration with [http://www.tinymce.com/ TinyMCE] to add a [https://en.wikipedia.org/wiki/WYSIWYG WYSIWYG] set of editing tools to AtoM's static pages (e.g. so users did not need to know basic HTML to style static pages); and the ability to upload a different watermark (to be applied to digital object derivatives) for each institution. More details on each below.

===eCommerce plugin===

This plugin has been developed by [https://github.com/jasonhildebrand Jason Hildebrand] of [http://www.peaceworks.ca/ PeaceWorks Technology Solutions], primarily between July 2014 and March 2015.

According to the [https://github.com/PeaceWorksTechnologySolutions/atom/blob/ecommerce/plugins/sfEcommercePlugin/README.md plugin documentation's] Overview section, "This plugin allows website visitors to select and purchase individual photos. Payment for the photos happens via PayPal. E-Commerce admins review each order and may approve or reject (remove) photos from the order. After approval, the customer is sent an email containing a link which they can use to download the image(s).

Users have access to a shopping cart, where photos from multiple repositories can be added as users browse the site, and then ordered/checked out via PayPal. The shopping cart has basic integration with AtoM's PREMIS rights module, so when Dissemination = "Disallow," a message about restrictions is supplied instead. Other features include a vacation setting and a sales report.

* [https://github.com/PeaceWorksTechnologySolutions/atom/tree/ecommerce PeaceWorks GitHub AtoM fork, eCommerce branch]
* [https://github.com/PeaceWorksTechnologySolutions/atom/blob/ecommerce/plugins/sfEcommercePlugin/README.md eCommerce plugin documentation]
* [http://archives.mhsc.ca/ MAID], where you can see the shopping cart in action

MAID has also prepared a summary description of the plugin's functionality, available as a PDF here:

* [[File:Ecommerce-MAID.pdf]] (PDF, approx 431KB)

===Home page carousel plugin===

This plugin has been developed by [https://github.com/jasonhildebrand Jason Hildebrand] of [http://www.peaceworks.ca/ PeaceWorks Technology Solutions], primarily between July 2014 and March 2015.

This plugin adds a slideshow to the AtoM front page which displays up to 30 of the most recently added/updated photos in the system. Photos and their captions (if available) are displayed. Users may click a photo to go to its archival description.

* [https://github.com/PeaceWorksTechnologySolutions/atom/tree/carousel PeaceWorks GitHub AtoM fork, Carousel branch]
* [https://github.com/PeaceWorksTechnologySolutions/atom/blob/carousel/plugins/sfCarouselPlugin/README.md Carousel README documentation]
* [http://archives.mhsc.ca/ MAID] homepage, where you can see the carousel in action

===TinyMCE visual editor integration for editing static pages===

This integration has been developed by [https://github.com/jasonhildebrand Jason Hildebrand] of [http://www.peaceworks.ca/ PeaceWorks Technology Solutions], primarily between April 2014 and March 2015. At this time, this integration has not been packaged as a plugin.

[http://www.tinymce.com/ TinyMCE] is "'' a platform independent web based Javascript HTML [https://en.wikipedia.org/wiki/WYSIWYG WYSIWYG] editor control released as Open Source under LGPL,''" that, when integrated with AtoM, allows users unfamiliar with HTML to style static pages using familiar buttons, tools, and other user interface elements. The integration includes basic text styling (bold, underline, italics), table creation, image and file upload, link creation, and more.

* [https://github.com/PeaceWorksTechnologySolutions/atom/tree/tinymce PeaceWorks GitHub AtoM fork, TinyMCE branch]
* [https://github.com/PeaceWorksTechnologySolutions/atom/blob/tinymce/README_tinymce.md TinyMCE README documentation]

===Per-institution watermarks for digital objects===

This integration has been developed by [https://github.com/jasonhildebrand Jason Hildebrand] of [http://www.peaceworks.ca/ PeaceWorks Technology Solutions], between July 2014 and March 2015 (primarily in July 2014). At this time, this integration has not been packaged as a plugin.

AtoM includes the little-known ability to apply a watermark to uploaded photos. However there is only provision for a single global watermark which is applied to all images. This customization allows each institution to have their own watermark, and institutional watermarks can be uploaded and managed via the user interface, in the archival institution's "Edit theme" page. Uploading a new watermark will not affect photos already present in AtoM, but AtoM does provide a way for a developer to cause all watermarks to be re-applied (see “Regenerating Derivatives” in the Command-line tools section of the Administrator's Manual of the [https://www.accesstomemory.org/docs AtoM documentation] for more details).

* [https://github.com/PeaceWorksTechnologySolutions/atom/tree/multiple-watermarks Peaceworks GitHub AtoM fork, multiple-watermarks branch]
* [https://github.com/PeaceWorksTechnologySolutions/atom/commit/6e1e9e9e4bd4c2df5bf4da7b4063e4c739031fb4 the commit with the changes]
* [https://github.com/PeaceWorksTechnologySolutions/atom/blob/multiple-watermarks/README_watermarks.md Multiple watermarks README documentation]

==Docker and AtoM==

Two different community developers have combined AtoM with [https://www.docker.com/ Docker], an open, container-based virtualization platform for distributed applications. Details below.

<admonition type="tip">
Did you know? As of the AtoM 2.3 release, the AtoM project now has its own officially supported Docker Compose development environment! See:
* https://www.accesstomemory.org/docs/latest/dev-manual/env/compose/
</admonition>

===AtoM Docker Files===

Created by Dominic Boisvert ([https://github.com/DominicBoisvert @DominicBoisvert]) for use in an archival course taught at the University of Montreal, Boisvert has shared Docker files for [[Releases/Release_announcements/Release_2.1.2|AtoM 2.1.2]], and [[Releases/Release_announcements/Release_2.1.1,_2.0.2,_1.3.2|ICA-AtoM 1.3.2]], including simple installation instructions (written in French):

* [https://github.com/ARV3054/docker-atom AtoM 2.1.2 Dockerfile]
* [https://github.com/ARV3054/docker-ica-atom ICA-AtoM 1.3.2 Dockerfile]

===AtoM Docker Compose recipe===

Created by John Fink ([https://github.com/jbfink @jbfink]), this is a Docker [https://docs.docker.com/compose/ Compose] recipe for AtoM. Compose is described by Docker as "''a tool for defining and running multi-container applications with Docker. With Compose, you define a multi-container application in a single file, then spin your application up in a single command which does everything that needs to be done to get it running.''"

The developer adds, "''Note that I've only tested this on 64bit native Linux using Docker directly, so if you're using boot2docker or a VM things might be different.''" For further configuration information and troubleshooting, see the [https://github.com/jbfink/docker-atom/blob/master/README.md README] provided.

* [https://github.com/jbfink/docker-atom Docker Compose recipe for AtoM - GitHub repository]
* [https://github.com/jbfink/docker-atom/blob/master/README.md README file for configuration and troubleshooting]
* [https://groups.google.com/d/topic/ica-atom-users/p7ACO3jKZv8/discussion Related AtoM User Forum thread]

===AtoM Docker Image===

Created by the Governo Regional Azores, this is a Docker image of AtoM 2.2.0. Note that it does not currently include the MySQL database required for AtoM, which needs to be linked.

* [https://hub.docker.com/r/governoregionalazores/atom-accesstomemory/ Link on the DockerHub page]
* [https://github.com/GovernoRegionalAcores/atom-accesstomemory GitHub repository for the Docker image]

==AtoM 2.3 ISO image - ready for use on a flash drive==

A group of archivists in Brazil, the [http://documentosarquivisticosdigitais.blogspot.com.br/ Grupo de Pesquisa do CNPq GED/A e Patrimônio Documental Arquivístico], have used the [https://launchpad.net/systemback SystemBack] backup management tool to prepare an ISO image of AtoM 2.3 that can be launched from a flash drive. From the related blog post:

* Operating System: Ubuntu 16.04 - 64 Bits;
* Size: 3GBs
* Format: sblive
* Remasterer: SystemBack

"''After Download, use SystemBack to write to the flash drive, and use with a system boot that is persistent - your data stored in the session will remain available in the next.'"

* Ubuntu Linux password: <code>icaatom99</code>
* User in AtoM (ICA-AtoM): <code>GrupoCNPqDocsDigitais@gmail.com</code>
* Password in AtoM (ICA-AtoM): <code>icaatom</code>

* Blog post here (Brazilian Portuguese): http://documentosarquivisticosdigitais.blogspot.com.br/2017/01/o-grupo-de-pesquisa-cnpq-ufsm-geda.html
* Download link: https://drive.google.com/file/d/0BwBRoubj23bpNWZLSVhtSmNoN00/view?usp=sharing

==HTML scrub scripts for other entities==

<admonition type="important">
'''UPDATE''': Thanks to collaboration among several community members, this work has now been added to the existing AtoM task, and merged into the 2.4 release. For more information, see:

* Source pull request: https://github.com/artefactual/atom/pull/568

Thank you to Clara Rosales and Darryl Friesen for this collaborative enhancement!

</admonition>

In [[Releases/Release_announcements/Release_2.2|Release 2.2]] we introduced [[Releases/Release_announcements/Release_2.2#Security_enhancement:_HTML_escaping_to_prevent_XSS_exploits|HTML escaping]] as part of the security enhancements included in the release. Since some users might have legacy HTML content in their descriptions, we also included a command-line task that would allow users to scrub legacy HTML from archival descriptions - see the related documentation [https://www.accesstomemory.org/docs/latest/admin-manual/maintenance/cli-tools/#remove-html-content-from-archival-description-fields here].

However, this task '''only''' currently works for archival descriptions. To help clean up other entities, users from Brazil have adapted versions of the original task that can be run for actors, notes, repository records, and rights records. These were posted in the AtoM user forum on 2017-05-22:

* https://groups.google.com/d/msg/ica-atom-users/_xdBK0ucegg/RQnNM5DKBAAJ

Artefactual has not tested these scripts. To run them:

# Download and unzip the rar file attached to the message in the user forum.
# Place the scripts in a directory accessible from the root directory of your AtoM instance, such as a new tmp directory.
# Use the tools:run command to run each script. For example, for the script to clean up HTML in authority records:

<pre>
php symfony tools:run tmp/actor_i18n.php
</pre>

The effects will be similar to what is described for the command-line task:

* https://www.accesstomemory.org/docs/latest/admin-manual/maintenance/cli-tools/#remove-html-content-from-archival-description-fields

==Custom theme plugins==

This section will be a place for community members to share any theme plugins they have developed! Note that we have [https://www.accesstomemory.org/docs/latest/admin-manual/customization/theming/ documentation] and [https://www.slideshare.net/accesstomemory/creating-custom-themes-in-atom slides] to help developers get started with theming - be sure to check them out, as well as our general [[Development#Development_resources|Development resources]]!

===Alberto Pereira's custom theme===

Developed against AtoM 2.5, this custom theme by [https://github.com/albertopereira Alberto Pereira] includes a number of customizations, including the following change notes from the developer:

* The "Popular this week" box gets a bigger highlight;
* The first element of the "Popular this week" also shows its thumbnail (if it exists);
* Overall style changes (including new icons);
* A Blog! (well, sort of), it uses static pages to mimic a blog. You just have to create a page called "Blog", and any other page that has a title that starts with "_X-", will automatically be listed in the blog page (e.g. "_X-A post title");
* You don't have to chose between the sidebar treeview and the full width treeview. You can have both. There's a new link, right below the sidebar treeview, that opens a popup with the full width treeview.

[[File:arAPPlugin-theme.jpg|center|700px|thumb| An image of the arAPPlugin theme]]

You can find the theme and more details at the following links:

* [https://github.com/albertopereira/arAPPlugin Theme code, images, and installation instructions on GitHub]
* [https://groups.google.com/d/msg/ica-atom-users/OpX9CvU0pAY/3sOgeJavBAAJ AtoM user forum announcement] (2019-02-27)

-----

* [[Community/Community resources|Back to Community resources]]
* [[Community|Back to Community landing page]]
* [[Main Page|Main AtoM wiki page]]

[[Category:Community]]

User:Flavio.belluomini

2024-04-09T11:50:47Z

Dan: Creating user page for new user.

nato a Lucca il 09/05/1971 archivista dell'Archivio Storico di Propaganda Fide

Resources/Documentation/Contribute

2024-03-28T12:17:31Z

Dan: /* Contribute documentation translations */ Update links to point to Weblate, not Transifex

{{#pagetitle:Contribute documentation}}
[[Main Page]] > [[Resources]] > [[Resources/Documentation]] > Resources/Documentation/Contribute

This page describes ways in which members of the AtoM community can contribute to our public documentation - the AtoM User and Administrator's Manuals available at https://www.accesstomemory.org/docs. For more information about the documentation platform we use, and why we chose it, see: [[Resources/Documentation/About|About our documentation]].

<admonition type="seealso">
* [[Development/Contribute code|Contribute code]]
* [[Resources/Wiki_contribution|Contribute to the AtoM wiki]]
* [[Resources/Translation|Contribute translations]]
* [[Resources/Documentation/Contribution guidelines|Documentation contribution guidelines]]
</admonition>

==Contributing documentation to the AtoM project==

'''Want to help us improve our documentation?''' All AtoM documentation is publicly available under a Creative Commons Attribution-ShareAlike 4.0 Unported licence ([https://creativecommons.org/licenses/by-sa/4.0/ CC BY SA]). We rely on our community of users to help us keep our documentation clear, comprehensive, and easy to use - if you see something missing or broken, or have an idea about how to improve or expand upon our existing documentation, please consider getting involved. There are several ways you can help AtoM improve its documentation:

If you just want to '''alert us to something you've noticed''' that you think we could improve, but don't have the time or inclination to fix it yourself, see:

* [[#Suggest minor fixes to Artefactual|Suggest minor fixes to Artefactual]]
* [[#File an issue in our documentation repository|File an issue in our documentation repository]]

We also welcome direct contributions! Is there a section missing from our documentation that you'd like to see? Or a section that you'd like to improve by adding clearer instructions, more screenshots, or alternative workflows? Help us improve our documentation by submitting new or revised content yourself!

If you'd like to '''contribute documentation fixes directly''', there are two main methods of contributing new documentation. For smaller changes, it's easier to make your edits via GitHub's user interface. If you a more technically proficient user and you're working on a bigger contribution or would like to be able to work locally in a text editor before contributing your changes, we also have instructions on how you can configure the AtoM Vagrant box for documentation contributions. See:

* [[#Contribute documentation yourself via GitHub|Contribute documentation yourself via GitHub]]
* [[#Contribute documentation using Vagrant|Contribute documentation using Vagrant]]
* [[#Contribute translations|Contribute translations]]

Also, check out our [[Resources/Documentation/Contribution guidelines|Documentation contribution guidelines]].

==Suggest minor fixes to Artefactual==

See a typo or a broken link? Have a question or a minor suggestion? If you've noticed something that can be improved in our documentation, but don't have the time or resources to fix the problem yourself, we want to hear from you!

'''Contact us at:''' [mailto:webmaster@accesstomemory.org webmaster@accesstomemory.org]

<admonition type="important">
AtoM documentation is freely maintained by [https://www.artefactual.com Artefactual Systems], lead developers of the AtoM project. We do our best to ensure that our documentation is comprehensive, but as an open-source company that freely gives away software, documentation, and user support in our [https://groups.google.com/forum/#!forum/ica-atom-users User Forum], please keep in mind that we have to prioritize our client assignments so that we can pay our bills and continue to provide free software and free community support. If you've submitted a suggestion for a fix to our documentation via [mailto:webmaster@accesstomemory.org webmaster@accesstomemory.org], thank you! If it takes us a bit of time to implement a fix, it may be because we are currently focused on a client project - we will address any reported issues as soon as we are able. As always with open-source projects, the best way to ensure a fix is implemented is to contribute the fix yourself - we encourage our community users to become active contributors to all aspects of our projects.
</admonition>

==File an issue in our documentation repository==

If you notice a problem in the documentation, start by filing an issue in the AtoM documentation [https://github.com/artefactual/atom-docs/ repository] with as much detail about the issue as possible. This is a good thing to do whether you're just reporting a typo, or about to submit a whole new section of documentation. Also, just because you file an issue doesn't mean you're committing yourself to addressing the requested fix yourself! We're happy to receive reports about how we can improve the AtoM docs.

<admonition type="tip">
You'll need a GitHub account to be able to file issues and contribute fixes. Signing up is free and easy - head over to:

* https://github.com/join
</admonition>

You can find the issues by navigating to the GitHub [https://github.com/artefactual/atom-docs/ atom-docs repository], and clicking on the Issues tab. You can look at any existing issues here for reference, and open a new issue by clicking the green button on the right side of the page:

[[File:docs-issues.png|center|600px|thumb|An image of the the issues in the AtoM documentation GitHub repository]]

Give your issue a descriptive title that gives us a sense at a glance what to expect. The body of the issue should mention, at a minimum:

* The page (and section, if possible) where the problem occurs
* The version of the documentation you are consulting
* A proposed solution

Here is an example issue requesting a minor fix in the Administrator's manual, that you can look at as a reference:

* https://github.com/artefactual/atom-docs/issues/48

==Contribute documentation yourself via GitHub==

The following instructions will show you how to contribute changes to our documentation straight from our GitHub repository ([https://github.com/artefactual/atom-docs here]), using GitHub's user interface (GitHub Flow), which provides all the tools you need - including a text editor! If you are a more advanced user, you can do this from your own computer using a text editor and the command-line - see [[#Contribute_documentation_using_Vagrant|our instructions below]] for guidance.

'''Useful reference resources'''

* [http://sphinx-doc.org/ Sphinx] documentation website
* [http://www.sphinx-doc.org/master/usage/restructuredtext/basics.html reStructured Text primer]
* [[Resources/Documentation/Contribution guidelines|AtoM documentation contribution guidelines]]
* [https://chris.beams.io/posts/git-commit/ How to write a commit message]
* [https://help.github.com/ GitHub Help pages]

<admonition type="important">
'''Before you begin, you should:'''
* Create a GitHub account if you don't have one already: go to https://github.com/ and sign up - it's easy!
* [[#File an issue in our documentation repository|File an issue in our documentation repository]]
* Read our [[Resources/Documentation/Contribution guidelines|Documentation contribution guidelines]]
* Familiarize yourself with [http://sphinx-doc.org/ Sphinx] and [http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html reStructuredText]
</admonition>

'''An overview of the steps''' (described below):

* [[#Find the document you want to edit|Find the document you want to edit]] (or the place to add a new one)
* [[#Use GitHub's editor to make changes or additions|Use GitHub's editor to make changes or additions]]
* [[#Commit the changes|Commit the changes]]
* [[#Submit a pull request to Artefactual|Submit a pull request to Artefactual]]
* Dance! You've helped!

===Find the document you want to edit===

''(Or the place to add a new one)''

'''1.''' First, sign into your GitHub account at https://github.com (if you don't have an account yet, you'll need to create one first. You can do this on the same page.)

'''2.''' Navigate to Artefactual's AtoM [https://github.com/artefactual/atom-docs Documentation repository]: you can do this through the user interface by typing <code>artefactual/atom-docs</code> into the search bar at the top of the GitHub page.

<admonition type="tip">
'''What is a git repository?'''

A repository, or "repo", is simply a directory which contains your project work, as well as a few files which are used to communicate with Git. Repositories can exist either locally on your computer or as a remote copy (such as on [https://github.com GitHub.com]). These instructions will show you how to create your own repository on [https://github.com GitHub.com], and then use this to submit changes to the AtoM documentation repository.
</admonition>

'''3.''' GitHub's user interface provides a graphical file-explorer to help you navigate through the text files in our documentation repository. The AtoM documentation repository's files are organized into folders that mimic the structure of the user manual found on the home page - for example, all files that relate to the User Manual section called "Add/Edit Content" are grouped together in a file called "add-edit-content". In GitHub, click on a folder to view its contents. Click on a .txt file to open it in-page.

[[File:git-view.png|center|600px|frameless|An image GitHub's repository browser]]

<admonition type="tip">
[[File:git-branch.png|right|150px|frameless| An image of the GitHub branch button]]
'''Can't find the right spot in GitHub?'''

Don't forget to check the "Branch" drop-down - atom-docs is organized into several different branches, with the About/Contribute and FAQ docs on a different branch than the User and Admin manuals. Additionally, as we create new versions of our documentation for each major release, we will create new branches (2.0, 2.1, 2.2, etc) - so make sure you are editing or adding to the correct branch! Ideally, you will add fixes to the most recent docs, so we can carry those improvements forward.
</admonition>

'''4.''' If you are '''adding a new page''', navigate into the correct folder, and click the "Create new file" button at the top of the page.

[[File:git-add-file.png|center|600px|frameless|An image of the GitHub "Create new file" button]]

'''5.''' If you are '''editing an existing page''', navigate to the correct reStructuredText file, so that you can see its contents previewed on GitHub's interface. Then, click the "Edit" button (a pencil icon) found above the file preview:

[[File:git-edit-button.png|center|600px|frameless|An image of the GitHub "Edit" button]]

'''6.''' GitHub will create a copy of the entire ''atom-docs'' repository in your chosen location (or in your own new repository if this is your first time using GitHub). Now you can edit to your heart's content without fear of breaking our production website or making the documents unavailable to other users. In git, this is known as "forking". At the top of the page, you'll see that now ''atom-docs'' is in your own repository (indicated by your chosen user name). You'll also see this message above the file editor, to remind you:

[[File:git-fork-msg.png|center|600px|frameless|An image of the GitHub header message after a successful forking]]

===Use GitHub's editor to make changes or additions===

'''7.''' When you click the "Edit" button above the text file preview, a copy of the atom-docs repository is made in your repository (associated with your GitHub account), and you'll be redirected to a web-based text editor, where you can make changes to the file via your web browser. If you are adding a new page, the text editor will be blank when it opens, and you can begin entering text. As you work, you can click on the "Preview changes" tab to see a rendered version

<admonition type="note">
'''About that preview...''' GitHub uses [https://en.wikipedia.org/wiki/Markdown Markdown], which is a different language than reStructuredText, which we use via Sphinx to maintain the AtoM documentation. This means that some elements (like section headers, bolding etc) will render properly in the Preview, but others (like code-blocks, hyperlinks, and glossary links, etc) will not. Don't worry if it doesn't look correct in GitHub's preview if you know the syntax is correct!
</admonition>

[[File:git-edit.png|center|600px|frameless|An image of the GitHub editor]]

'''8.''' Make the changes you want to the file. When you are done, scroll to the bottom of the page - next you will commit the changes.

<admonition type="important">
Please review our [[Resources/Documentation/Contribution guidelines|Documentation contribution guidelines]] '''before''' submitting any changes. Thanks!
</admonition>

===Commit the changes===

'''9.''' When you are finished editing and/or adding files in the text editor, scroll to the bottom of the page. You will see a box with several text fields to fill in before submitting your changes.

<admonition type="tip">
'''What is a commit?'''

A commit, or "revision", is an individual change to a file (or set of files). It's similar to when you save a file, except with Git, every time you save, a unique ID is created (a.k.a. the "SHA" or "hash") that allows you to keep record of what changes where made when and by whom. Commits usually contain a commit message which is a brief description of what changes were made. (from the [https://help.github.com/articles/github-glossary/#commit GitHub Glossary])
</admonition>

* '''Commit Summary''': This is a required field. [https://help.github.com GitHub Help] describes a "commit" as such: ''"Think of a commit as a snapshot of your project – code, files, everything — at a particular point in time"''. Your commit summary is a concise way to summarize the changes to the project that users will find in the commit. '''Commit summaries should be 50 characters or less''': this is more like a brief title so users can determine what has taken place at a glance. Keep it brief and to the point. Check out [http://git-scm.com/book/ch5-2.html#Commit-Guidelines these guidelines] in the Git documentation.

<admonition type="tip">
When writing your commit summary, please remember to:

* File an issue for your change first, and reference it in the summary - e.g. "Fix typo in Entity types, refs #XX"
* Use the present active voice and be direct - "Fix typo in Entity types," not "Fixed typo..."
* Try to keep the commit summary to 50 characters or less
* Capitalize the first word
* Do not end with a period

For further tips on writing great commit messages, see: https://chris.beams.io/posts/git-commit/
</admonition>

* '''Extended description''': This is an optional field, which we at Artefactual recommend using if you plan on editing our documentation. This is your chance to explain at greater length what the changes you made were, and why you felt you should make them. A concise message here will help us understand your work, and allow us to merge it into our documentation more quickly! Remember, you want to explain WHAT you did, more than why or how.

[[File:git-commit.png|center|600px|frameless|An image of the GitHub commit fields]]

'''10.''' Once you've added a commit summary (required) and an extended description (recommended), click the "Propose File Change" button. GitHub will branch your changes, and redirect you to a page where you can compare the changes to the original, as well as submit a "pull request" to the AtoM documentation repository.

<admonition type="tip">
'''What is a git branch?'''

If you're making an app, a website, or working on documentation collaboratively, you might have a bunch of different features, ideas, or revisions in progress at any given time - some of which are ready to go, and others which are not. By default, the main branch of a repository is usually named "master" - in the AtoM documentation repository, we name each main branch after the documentation version it represents (for example, 2.0, 2.1, 2.2, etc). By "branching" away from the main code, you create a separate instance in which you can work on your changes, and then, when they've been reviewed and tested, merge them back into the main project. This allows multiple people to collaborate at once, and a single person to work on multiple different revisions at the same time without having to finish them all on the same schedule.

With these instructions, GitHub is handling the branching automatically, so you don't have to worry! But now you know a bit more about how git (and GitHub) works. Find out more about git [http://git-scm.com/ here].
</admonition>

===Submit a pull request to Artefactual===

'''11.''' Once you've finished your changes and clicked the "Propose File Change" button, GitHub will redirect you to a new page. On the bottom half of the page, you'll see a "diff" - a graphical representation of the changes you've made - the red fields with the '''-''' minus symbol in the sidebar indicate content that was changed/removed, while the green fields with the '''+''' plus symbol in the sidebar indicate the new content that was added. When you submit your changes to Artefactual, we'll be able to see this too - it offers us a quick way to understand where you've made changes, what was changed, and why.

[[File:git-diff.png|center|600px|frameless|An image of the GitHub diff summary]]

'''12.''' At the top of the page, you'll see your commit summary and description, with a reminder above it from GitHub (in blue) that the changes are still only in your repository. To submit them to Artefactual for inclusion in the AtoM documentation, click the "Send pull request" button on the right- hand side of the page.

[[File:git-send-pull.png|center|600px|frameless|An image of the GitHub pull request button]]

<admonition type="tip">
'''What is a pull request?'''

Pull requests are proposed changes to a repository submitted by a user that will be accepted or rejected by a repository's collaborators (in this case, Artefactual, the maintainers of the AtoM documentation). You can see the GitHub Glossary's definition [https://help.github.com/articles/github-glossary/#pull-request here], and more information from GitHub on using pull requests [https://help.github.com/articles/using-pull-requests/ here].
</admonition>

'''13.''' The page will reload with information about your pull request - you can see a summary of what you want to merge where at the top of the page (i.e. your patch or fix into one of our documentation branches). Your commit message and summary will be below - we'll see a similar message on our end when we receive the request.

[[File:git-pull.png|center|600px|frameless|An image of a submitted pull request]]

'''14.''' Artefactual will receive your pull request, and one of our team members will review the changes. If there's a problem, we can send you a message via GitHub, or even [https://help.github.com/articles/using-pull-requests/#pull-request-discussion begin a discussion right on the code!] This way, if there's something we don't understand about the changes you've made, we can connect with you directly. This is very similar to the code review process we undertake on code submissions from developers - see our [[Development/Code review|Code review]] wiki page for more information.

You'll be able to see a summary of our changes and the status of the review on your pull request. We'll add comments if we have changes to request.

[[File:git-pull-review.png|center|600px|frameless|An image of the review process as seen on a pull request in GitHub]]

'''15.''' If you need to make changes, you can simply return to the files and edit them in place. Follow the same steps as above. When you submit your commit, GitHub will give you the option to submit it as part of your pull request. You can also reply on the PR comments thread to ask for clarification or help, or to let us know that the requested changes have been implemented.

[[File:git-pull-respond.png|center|600px|frameless|An image of the comments thread as seen on a pull request in GitHub]]

'''16.''' Once we've accepted the pull request and merged it into our repository, you'll get a notification (you'll probably get an email too, unless you've changed your default GitHub account settings). You'll be able to see the status of any changes right on the pull request.

[[File:git-pull-success.png|center|600px|frameless|An image of a PR being accepted and closed in GitHub]]

'''17. Success!''' Your contributions have been accepted, and merged into the AtoM documents. You should be able to go to our website and see them in the documentation. Thanks for helping out! We'll also close the related issue.

[[File:git-issue-closed.png|center|600px|frameless|An image of an issue being closed in GitHub]]

'''18. Finished!''' You did it! Thank you for helping to improve the AtoM documentation! It's time to dance!

==Contribute documentation using Vagrant==

For more technically proficient users who intend to work on larger changes, and/or simply prefer being able to work in a local text editor, the following instructions will guide you through the process of configuring the AtoM Vagrant box so that you are able to create pull requests against the public AtoM documentation repository.

<admonition type="important">
'''Before you begin, you will need: '''

* To have created a GitHub account - you can [https://github.com/join create one here] if you don't have one already; it's free!
* To have a local [https://en.wikipedia.org/wiki/Source-code_editor text editor] good for working with source code - if you don't, we recommend [https://atom.io atom.io], an open source text editor created by GitHub
* To have the AtoM Vagrant box installed - see our documentation [https://www.accesstomemory.org/docs/latest/dev-manual/env/vagrant/ here] and some detailed slides [https://www.slideshare.net/accesstomemory/atom-and-vagrant-installing-and-configuring-the-atom-vagrant-box-for-local-testing-and-development here]

Before you start making edits, you should also:

* [[#File an issue in our documentation repository|File an issue in our documentation repository]]
* Read our [[Resources/Documentation/Contribution guidelines|Documentation contribution guidelines]]
* Familiarize yourself with [http://sphinx-doc.org/ Sphinx] and [http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html reStructuredText]
</admonition>

'''Jump to:'''

* [[#Generate an SSH key and configure a forwarding agent|Generate an SSH key and configure a forwarding agent]]
* [[#Add your public key to GitHub|Add your public key to GitHub]]
* [[#Fork the AtoM documentation project|Fork the AtoM documentation project]]
* [[#Change the AtoM vagrant box to track your new fork|Change the AtoM vagrant box to track your new fork]]
* [[#Add the files to your local text editor|Add the files to your local text editor]]
* [[#Make changes and commit them to your fork|Make changes and commit them to your fork]]
* [[#Keep your fork up to date|Keep your fork up to date]]
* [[#Open a pull request|Open a pull request]]
* [[#Add fixes and squash your commits|Add fixes and squash your commits]]
* [[#Celebrate|Celebrate!]]

<admonition type="tip">
The following instructions assume some basic familiarity with the unix/Linux command-line interface, and working with git or similar distributed version control systems. It also assumes that you have already set up the AtoM Vagrant box. If these things are new to you, you can still give it a go! Some additional suggestions:

* We have some basic [ Command-line 101] slides to help familiarize you with basic tasks and navigation in the command-line interface
* The section above, on [[#Contribute_documentation_yourself_via_GitHub| contributing via GitHub]], includes many helpful explainers on git and GitHub terminology if it's new to you
* We have [https://www.accesstomemory.org/docs/latest/dev-manual/env/vagrant/ documentation] and [https://www.slideshare.net/accesstomemory/atom-and-vagrant-installing-and-configuring-the-atom-vagrant-box-for-local-testing-and-development slides] to help you get the AtoM Vagrant box set up!
</admonition>

Let's begin!

===Generate an SSH key and configure a forwarding agent===

We're going to be creating a fork of the AtoM documentation repository into your GitHub account, and we want to be able to commit our local changes to your repository. To be able to do so remotely from the Vagrant command-line, we first need to create an SSH key and link it to your account, so you can authenticate and interact with your GitHub repositories remotely.

<admonition type="tip">
'''What is an SSH key?'''

Secure Shell ('''SSH''') is a cryptographic network protocol for operating network services securely over an unsecured network. The best known example application is for remote login to computer systems by users. SSH provides a secure channel over an unsecured network in a client-server architecture, connecting an SSH client application with an SSH server. Common applications include remote command-line login and remote command execution, but any network service can be secured with SSH.

An '''SSH key''' is a form of password management for SSH connections, that uses [https://en.wikipedia.org/wiki/Public-key_cryptography public-key cryptography] to provide a more secure way of logging into a server with SSH than using a password alone. While a password can eventually be cracked with a brute force attack, SSH keys are nearly impossible to decipher by brute force alone. Additionally, you can be authenticated by the server without ever having to send your password over the network - anyone eavesdropping on your connection will not be able to intercept and crack your password because it is never actually transmitted.

Generating a key pair provides you with two long string of characters: a public and a private key. You can place the public key on any server, and then unlock it by connecting to it with a client that already has the private key. When the two match up, the system unlocks without the need for a password. You can increase security even more by protecting the private key with a passphrase. This public/private key pair accomplishes two functions: authentication, where the public key verifies that a holder of the paired private key sent the message, and encryption, where only the paired private key holder can decrypt the message encrypted with the public key. This means that you can share your public key broadly, but '''your private key should never be shared'''.

As well as offering additional security, SSH key authentication can be more convenient than the more traditional password authentication. By default, using an SSH key requires unlocking your private key with a secret passphrase upon each connection. However, when used with a program known as an '''SSH agent''', SSH keys can allow you to connect to a server, or multiple servers, without having to remember or enter your password for each system. Instead, the SSH agent will securely hold your key in memory and present it when needed - so you only need to enter your private key master password once, when you first load the key.
</admonition>

An SSH key pair can be generated on your local computer. For Mac and Linux users, we can use the built-in SSH agent functionality included with the O/S to manage this. For Windows, Microsoft does not currently include an SSH client by default, so we'll use a third-party tool for generating and managing our key, as well as connecting to the Artefactual Vagrant box environments.

'''Jump to:'''

* [[#SSH keys - Mac and Linux users|SSH keys - Mac and Linux users]]
* [[#SSH keys - Windows users|SSH keys - Windows users]]

====SSH keys - Mac and Linux users====

If you are using a Mac or a Linux based computer, here are instructions for generating a password protected key, and adding it to your keychain:

* [https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/#platform-linux Linux SSH instructions]
* [https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/#platform-mac Mac SSH instructions]

Keep a password-protected copy of your key somewhere secure on your local computer. Make sure the private key password is unique and secure!

'''Your process for starting up your Vagrant box - Mac and Linux users'''

Open terminal and using your command line interface, navigate to the folder where you have initialized your [https://www.accesstomemory.org/docs/latest/dev-manual/env/vagrant/ Vagrant box]. Check to see if your SSH key is loaded by typing <code>ssh-add -l</code>. If it is, you can now run <code>vagrant up</code>. If it is not, you can load it with <code>ssh add</code>, or if you have more than one SSH key, to ensure you load the right key, <code>ssh add ~/.ssh/id_rsa</code>, where "~/.ssh/id_rsa" is the file path to your SSH key.

When your key is loaded, run <code>vagrant up</code>, and then SSH into the Vagrant environment using your key with <code>vagrant ssh -- -A</code>. This will allow you to link to your github account.

<admonition type="note">
If you run <code>vagrant ssh</code> you will access the Vagrant environment as the generic user 'vagrant', and any commits you make will be attributed to 'vagrant' and not to you.
</admonition>

Once you are connected to the Vagrant environment, you can access the atom-docs with <code>cd atom-docs</code>, and continue from [[#Add_your_public_key_to_GitHub|Add your public key to GitHub]].

====SSH keys - Windows users====

Because Microsoft does not include an SSH client by default with Windows, our Vagrant instructions recommend that Windows users use [https://putty.org/ PuTTY] to SSH into the Vagrant environment. PuTTY can be downloaded with a suite of other tools, which includes PuTTYgen, a tool to generate SSH key pairs, and Pageant, an SSH forwarding agent (similar to <code>ssh-agent</code> in Linux environments). Since we are going to use PuTTY for SSH, we can use PuTTYGen and Pageant to create and manage our keys as well.

You can download PuTTY, PuTTYgen, and Pageant here:

* https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html

<admonition type="note">
The first option on the page is a package download, that includes all 3 utilities we need. However, if you've already downloaded PuTTY without Pageant and PuTTYgen, there are separate downloads available for these utilities lower on the same page.
</admonition>

Once you've downloaded and installed the utilities we are going to use PuTTYGen to generate our SSH key pair. To do so:

'''1.''' Launch PuTTYgen on your computer.

'''2.''' Configure the settings for your new SSH key. Let's use RSA, with 4096 bits:

[[File:puttygen-ssh-keygen.png|center|600px|thumb|An image of using PuTTYGen to create an SSH key]]

'''3.''' Once you've configured the settings, click "Generate"

'''4.''' PuTTYgen will ask you to move your mouse over the blank area of the dialog. This is used to generate randomness in how the cryptographic key is generated.

'''5.''' When complete, you will be shown the public key, and given the option to save both the public and private keys:

[[File:puttygen-save-keys.png|center|600px|thumb|An image of using PuTTYGen to create an SSH key]]

'''6. Make sure you save the private key!''' We recommend saving the public key as well for the next step (but if you don't there is a way we can use PuTTYgen to get it later). We also recommend following the naming conventions of keys generated in linux - call your public key <code>id_rsa-pub</code> and your private key <code>id_rsa</code>. PuTTYgen will save the key in a <code>.ppk</code> format, which can be used by Pageant for SSH agent.

We're now ready to configure Pageant to manage our key and act as a forwarding agent!

Pageant is an SSH authentication agent designed for use with PuTTY. It holds your private keys in memory, already decoded, so that you can use them often without needing to type a passphrase.

'''Pageant documentation''':

* http://the.earth.li/~sgtatham/putty/0.67/htmldoc/Chapter9.html#pageant
* See also this helpful [https://www.digitalocean.com/community/tutorials/how-to-use-pageant-to-streamline-ssh-key-authentication-with-putty Digital Ocean summary tutorial]

Pageant can load your SSH key, and then pass it to PuTTY when authentication is requested. To enable this, you will need to change one setting on your saved AtoM Vagrant PuTTY configuration. To do so:

'''1.''' Open up PuTTY, and then click on your saved AtoM Vagrant profile. If you haven't created one yet, let's do so now:

* In the "Host name (or IP address)" field, enter the Vagrant box IP, which is 10.10.10.10
* Make sure the Port field is set to 22
* Give the session a name in the "Saved Sessions" field below - I've callled mine "AtoM Vagrant"
* Using the navigation menu on the left, go to Window > Translation, and make sure that the Remote character set is set to use UTF-8
* Click on "Session" at the top of the sidebar menu to return to the main page, and click "Save" to ensure these credentials are saved!

'''2.''' Now let's make sure that PuTTY can retrieve the key from Pageant. Using the sidebar menu again, navigate to Connection > SSH > Auth. Make sure the following options are checked:

* Attempt authentication using Pageant
* Allow agent forwarding

'''3.''' Leave any other boxes already checked/unchecked as you found them. Remember to click on the top menu item, "Session," to return to the main page, and then click Save!

Now Pageant will be able to pass your SSH key when required. See also:

* https://www.howtogeek.com/125364/how-to-ssh-hop-with-key-forwarding-from-windows/

'''4. Your process for starting up your Vagrant box''' and using Pageant to handle your SSH key will now look something like this:

* Launch Pageant
* Double-click the Pageant icon in your task bar to open it, and then click "Add"
* Pageant will open a file explorer. Navigate to your saved .ppk file - AKA your password-protected private key - and double-click to open it.
* If your key is password protected (as it should be!) then you will be prompted to enter your password now
* When successfully entered, you'll see a bunch of characters representing your key in Pageant's main window. You can now close this window - it will not close Pageant, but merely minimize it to the tray
* Launch the vagrant box via Windows cmd and PuTTY
* Once you have a password-protected key stored locally for use with Vagrant via Pageant, you can re-use the key for multiple boxes.

===Add your public key to GitHub===

Next we want to link your public key to your GitHub account, so that we can authenticate remotely using the private key that our SSH agent will forward whenever we submit commands to your remote repository.

Follow these instructions:

* https://help.github.com/en/articles/adding-a-new-ssh-key-to-your-github-account

We've also included some instructions below on how you can copy your local public key, so you can add it to GitHub.

'''Jump to:'''

* [[#Copying the public key - Mac and Linux|Copying the public key - Mac and Linux]]
* [[#Copying the public key - Windows users|Copying the public key - Windows users]]

====Copying the public key - Mac and Linux====

If you have generated your key in your host computer (e.g. your local laptop, rather than inside the vagrant box), then we can access your SSH key in your local <code>.ssh</code> directory.

Open a new terminal window - but '''do not''' SSH into the vagrant box. Instead, stay in, or change to your home directory. Remember, you can use <code>pwd</code> to show your current directory, and <code>cd</code> to change directories - <code>cd ..</code> will move up one directory, etc. For more basic navigation tips, see our [https://www.slideshare.net/accesstomemory/commandline-101 Command-line 101 slides].

Once in your home directory, run <code>ls -al</code> to see all hidden files. There should an <code>.ssh</code> hidden directory - let's change into it, and look around:

<pre>
cd .ssh
ls -al
</pre>

You should see something returned like the following, if your key is present:

<pre>
drwx------ 4 myusername staff 128 10 Sep 09:49 .
drwxr-xr-x+ 20 myusername staff 640 5 Sep 14:39 ..
-rw------- 1 myusername staff 3326 10 Sep 09:49 id_rsa
-rw-r--r-- 1 myusername staff 749 10 Sep 09:49 id_rsa.pub
</pre>

Note the 2 <code>id_rsa</code> files. The first one is your private key, which should be password protected. The second is your corresponding public key. This is what we will need to add to GitHub, and what we should copy. Let's access the contents of the file now, using the nano CLI text editor:

<pre>
sudo nano id_rsa.pub
</pre>

The text editor should show you something that looks a bit like this:

<pre>
ssh-rsa AAFAB3NzaC1yc2EAAAADAQABAAACAQDY7NPAkTC135zk/CxP1cIdlP7ePK0+eLqROfVeLR/lCu+l5kYw/RzpPh2kShLF9CiLtr32z77L8Ik/wFFbnyECw+GSE8Q1+JSPsfzJfCHYU93Dlu3Dg0Lckg3/wfvlaczouK6rRB1HHhAvsWQot/DkvXtKGGaZyhH2QMMnUjb5FqsNNzp715CdJzGpKKnOQFrUL8+F2tg0jmLvABUtsbGGkgvkRzec1ql22lRdX9nkPRLP66G54kKPjlrzP7Qu6hGNibA03ZQSG7nDX0yc/+Ug731iLMgHfwY6x4AwdCxyQJjMrPSnUMOCihKvMUIqzVRlqPNGzMTKnkwTJJljDy5wK+9513FV+nCc8mpBorat9ewK4vghTReqrIS2SG+Tl0miw3OC2MafACoIN+RqqEi9+FS1yovyxcMKn26HBaXfkJVaN4dG2QongSZD8VWBk44t6tyXQPPkJI4+ifHUTcLD/WjF6CGhTsy4lYyXzfHcWDQqXuPy0a99TbU6S29eA3Co3CzSK+zn8xkOpTl+tDXH0S8g6CPtXdLvO9bSiduTDcRqTKUy2QaGr/nTxl7IbLY+p3NMmrOHpKu9BW9bbDtz5cOJv0cEs8z7NV6wTp7PJ6T/zhG5tS102vkTBCy5AsmOKE1I2u7qX0l0Ay3TPox9f9xDaybGkxrlmTstRQqX4t== youremail@example.com
</pre>

Copy this text, and continue following the GitHub instructions for [https://help.github.com/en/articles/adding-a-new-ssh-key-to-your-github-account adding an SSH key to your account].

====Copying the public key - Windows users====

If, when generating your key with PuTTYgen, you saved a local copy of your public key, then you should be able to open this with a text editor (such as atom.io, Sublime Text, Notepad++, etc.) It should look something like this:

[[File:windows-public-key.png|center|400px|thumb|An image of a public SSH key shown in a text editor]]

Note that the part we want to copy is the hash code in the middle - we don't need the header/footer.

If you didn't make a local copy of your public key, that's okay! PuTTYgen allows you to load an existing private key file into memory. If you do this, you can then change the passphrase and comment before saving it again; you can also make extra copies of the public key.

To load an existing key in PuTTYgen, launch PuTTYgen and then press the "Load" button. PuTTYgen will put up a dialog box where you can browse around the file system and find your private key file. Once you select the file, PuTTYgen will ask you for a passphrase (if necessary) and will then display the key details in the same way as if it had just generated the key. You can now copy the public key from the box at the top of the dialogue, or save a local copy of your public key, and then open it in a text editor.

Copy this public key, and continue following the GitHub instructions for [https://help.github.com/en/articles/adding-a-new-ssh-key-to-your-github-account adding an SSH key to your account].

===Fork the AtoM documentation project===

We're almost ready to start doing work! Now, to be able to make local changes and then submit them as a pull request, we first need to create a fork of the AtoM documentation repository in your GitHub account. In the next step, we'll modify the AtoM Vagrant box to track your version of the docs instead of the public one, so we can make changes and then submit them later. To create the fork:

'''1.''' If you're not already logged in, then log into GitHub

'''2.''' Navigate to the AtoM documentation GitHub repository: [https://github.com/artefactual/atom-docs https://github.com/artefactual/atom-docs]

'''3.''' At the top of the page, you should see a "Fork" button on the right side. Click it!

[[File:github-fork-button.png|center|300px|thumb|An image of the Fork button on a GitHub repository page]]

This will create a new copy of the atom-docs repository in your personal code repository. This will be indicated at the top of the page:

[[File:github-forked-repo.png|center|600px|thumb|An image of a forked version of the atom-docs repo as indicated in GitHub]]

===Change the AtoM vagrant box to track your new fork===

The last configuration step we need to take is to configure your global git identity in the Vagrant box, and set it up to track your fork, instead of the public atom-docs repository. First, start up Vagrant - remember to follow any instructions provided above to configure your SSH agent so it can forward your SSH key when needed!

Now we'll want to configure our git identity in the Vagrant box. You can set the username and email associated with your GitHub account using the following two commands (be sure to swap in your GitHub username and email in the placeholders!):

<pre>
git config --global user.name "your-username"
git config --global user.email your-email@example.com
</pre>

You can check that this was set correctly, along with other default settings, with the following command:

<pre>
git config --list
</pre>

There are other things you can configure if you want, such as your default terminal text editor and other preferences. For example, often the default text editor inside your command-line terminal is set to use vim, but the key combinations for getting out of vim can be very confusing, especially for non-technical users. Instead, we can use nano, which provides a list of navigation commands right at the bottom of the screen. If you want to set git to use nano as your default CLI text editor, use the following:

<pre>
git config --global core.editor nano
</pre>

For more information and other configuration options, see:

* [https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup]

Finally, let's set the remote origin to track your new fork. To do this, we will need to URL of your forked atom-docs repository - we'll add <code>.git</code> to the end of this in the command. The following example uses the URL for GitHub user <code>testy-mctest</code>'s fork - swap in yours:

<pre>
git remote set-url origin https://github.com/testy-mctest/atom-docs.git
git fetch
</pre>

We're ready to make changes!

===Add the files to your local text editor===

We're ready to start making changes! However, first we need to figure out how to get the AtoM documentation files from the Vagrant box into our local text editor! Because the files are inside the virtual machine, we will need to connect to them over your local network discovery settings. You may first need to make some changes on your computer to be able to find them! Some tips for major operating systems are included below.

'''Jump to:'''

* [[#Text editor config - Windows|Text editor config - Windows]]
* [[#Text editor config - Mac/Linux|Text editor config - Mac/Linux]]

====Text editor config - Windows====

'''1.''' Open the Control Panel, and navigate to: ''Control panel > Network and Internet > Network and Sharing Center''

'''2.''' Select Change advanced sharing settings from the left menu

[[File:window-network-config-1.png|center|600px|thumb|An image of the Network Sharing Center settings in Windows]]

'''3.''' Under the network discovery heading, choose "Turn on network discovery" in the settings, and then click the button to save your changes

[[File:window-network-config-2.png|center|600px|thumb|An image of the Network Sharing Center settings in Windows]]

'''4.''' Now we can try to find the Vagrant box on your local network. Open up an Explorer window, and click on the Network option in the left menu.

<admonition type="important">
The vagrant box must be booted up and running to be discoverable on your network. If you haven't already run "vagrant up" and followed the other usual steps to start your Vagrant session, you won't be able to find it on the network!

Note that even in the best circumstances, for whatever reason this doesn't always work immediately in Windows. You may need to refresh the search, try more than once, etc. You can also try entering the path directly into Explorer's file path:

<pre>
\\\VAGRANT\vagrant
</pre>

[[File:windows-vagrant.png|center|550px|thumb|An image a file explorer in Windows connecting to the AtoM docs in Vagrant]]

</admonition>

We strongly recommend that, once you manage to access this, you add it to your Explorer "Quick links" so you can easily find it later!

'''5.''' When your computer has successfully connected, you will see folders “atom” and “atom-docs”. Open your text editor and drag the "atom-docs" folder into the editor.

You're ready to start making changes now!

====Text editor config - Mac/Linux====

On your Mac, open Spotlight by clicking the magnifying glass icon in the top right corner of your desktop, or by choosing command-space bar, and type <code>cifs://10.10.10.10</code>.

<admonition type="important">
The vagrant box must be booted up and running to be discoverable on your network. If you haven't already run "vagrant up" and followed the other usual steps to start your Vagrant session, you won't be able to find it on the network!
</admonition>

[[File:mac-access-docs-locally.png|center|600px|thumb|An image of Spotlight on a Mac]]

Hit “enter” to connect. Choose “vagrant”. When asked for a username and password, type “vagrant” for both.

[[File:mac-connect.png|center|600px|thumb|Connect to your vagrant box]]

When your computer has successfully connected, you will see folders “atom” and “atom-docs”. Open your text editor (atom.io in this screenshot) and drag “atom-docs” into the editor.

[[File:mac-add-text-to-editor.png|center|600px|thumb|Add documents to your local text editor]]

You're ready to start making changes now!

===Make changes and commit them to your fork===

You should now have the entire AtoM documentation project file hierarchy represented in the navigation pane of your local text edit. You can now navigate to the .rst files you want to edit and make your changes.

<admonition type="important">
Before making any major changes, please review the following:

* [[Resources/Documentation/Contribution_guidelines|AtoM documentation contribution guidelines]]

You might also find the following resources helpful:

* [http://sphinx-doc.org/ Sphinx] documentation website
* [http://www.sphinx-doc.org/master/usage/restructuredtext/basics.html reStructured Text primer]
* [https://chris.beams.io/posts/git-commit/ How to write a commit message]
* [https://help.github.com/ GitHub Help pages]

'''If you are making major changes''' (e.g. significant rewrites, new content, etc), please file an issue in GitHub first, and reference the issue in your pull request name when you are ready to submit. For more information on filing issues, see:

* [[#File an issue in our documentation repository|File an issue in our documentation repository]]
</admonition>

When you have finished editing, save your work in your text editor. Return to the terminal screen and run <code>make clean html</code>. Sphinx maintains a copy of the local output in the <code>_build</code> directory - running the <code>make clean html</code> does two things at once - first, it will purge all older builds from your _build directory; second, it will then generate new HTML preview versions, which can be found in <code>_build/html</code>.

Review and resolve any errors or warnings output when you run the make task, and preview the local HTML build version in <code>_build/html</code>. Make any fixes as needed, and repeat this process as necessary until you are satisfied with the outcome, and there are no more errors or warnings when running the make command. Now we're ready to commit your changes to your copy of the AtoM docs repository!

These instructions assume some basic familiarity with git and workflow management in distributed version control systems. However, we'll include some reminders below:

'''Adding files to a commit:'''

* Use <code>git status -s</code> to see a list of all new and modified files in your local working directory
* You need to add files from your local working directory to the staging environment before you can make the commit.
* Use <code>git add -A</code> to add all the files in your working directory
* If you just want to make a selection (for example, if you fixed an unrelated typo along the way, and want to keep it as a separate commit), add each individually by providing the path, e.g. <code>git add user-manual/add-edit-content/archival-descriptions.rst</code>
* You can also add all the contents of a directory by just pointing to the parent directory. Unchanged files will be ignored. So for example, if you've added 3 images to the images directory in add-edit-content, you could add each individually, or just use: <code>git add user-manual/add-edit-content/images/</code>

'''Preparing and pushing commits:'''

* Try to follow best practices when preparing commit messages. See [https://chris.beams.io/posts/git-commit/ this blog post] from Chris Beams for a great summary
* If you are making major changes, remember to [[#File an issue in our documentation repository|file an issue in our documentation repository]] first, and reference the issue number in the commit subject - for example "Add permissive slug setting docs, fixes #82" (see the PR [https://github.com/artefactual/atom-docs/pull/91 here] and the related issue [https://github.com/artefactual/atom-docs/issues/82 here])
* Commits and pull requests should be atomic - that is, they should relate to only one specific thing at a time. If you are rewriting accession docs and find an unrelated typo in the physical storage documentation, keep that change in a separate commit - and a separate pull request
* Commit titles should be 50 characters or less, ideally! If you need a longer explanation, add a description as well
* You can add a commit title without a description by using <code>git commit -m "your message here"</code>. If you just enter "git commit", you will be taken to a separate edit screen where you can add both a title and a longer description
* When all the files in your local staging area have been committed, you can push them to your GitHub repository with <code>git push</code>

<admonition type="tip">
Did your push fail?

If so, it may be because of your GitHub account settings. Log into your GitHub account, and using the menu under your profile pic, choose Settings. On the settings page, select "Emails" from the menu on the left side and then scroll down the page:

[[File:github-email-settings.png|center|600px|thumb|An image of the email settings in GitHub]]

You may need to uncheck the box that says, "Block command line pushes that expose my email." GitHub will still hide your email on your profile page with this unchecked, but your email address is included as part of the commit history, when listing authors. Git will use the email address you configured when setting your Git identity in the steps above. Fortunately, if you don't want your primary email address included in commit messages, you have options, as GitHub can support multiple email addresses. For more information, see:

* [https://help.github.com/en/articles/about-commit-email-addresses GitHub: About commit email addresses]
* [https://help.github.com/en/articles/setting-your-commit-email-address-on-github GitHub: setting your commit email address on GitHub]
* [https://help.github.com/en/articles/setting-your-commit-email-address-in-git GitHub: setting your commit email address in git]

Don't forget to update your global git identity with the email you want to use as well! See the section [[#Change_the_AtoM_vagrant_box_to_track_your_new_fork|above]] for instructions.

Once you've updated your git and GitHub settings, you can try to run <code>git push</code> again.
</admonition>

Congrats! You're now ready to open a pull request against the public AtoM documentation!

===Keep your fork up to date===

If you've been working in your local version of the documentation for a while, it's possible that there are new changes in the public documentation repository that you don't yet have. Before we open a pull request, we should make sure that your local fork is up to date.

GitHub has a good summary here:

* [https://help.github.com/en/articles/configuring-a-remote-for-a-fork https://help.github.com/en/articles/configuring-a-remote-for-a-fork]

Essentially, we will add the public atom-docs repository as an "upstream" repository from your fork, so you can pull in the latest changes. To do so, enter:

<pre>
git remote add upstream https://github.com/artefactual/atom-docs.git
</pre>

You can verify that the new upstream repository has been added properly with:

<pre>
git remote -v
</pre>

Now let's update your fork from the upstream branch - i.e. the public atom-docs repo. See this GitHub guide for more information:

* https://help.github.com/en/articles/syncing-a-fork

An example: If you are working in the 2.6 documentation branch, you might do something like this:

<pre>
git checkout 2.6
git fetch upstream
git rebase upstream/2.6
</pre>

====Troubleshooting====

If you get an error when trying to rebase upstream, like this:

<pre>
git rebase upstream/2.6
Cannot rebase: You have unstaged changes.
Please commit or stash them.
</pre>

You can '''either''' commit your local changes, add a commit message, and push them:

<pre>
git commit -a
git rebase upstream/2.6
git push
</pre>

'''OR''' you can stash your local changes and then unstash them after rebasing:

<pre>
git stash
git rebase upstream/2.6
git stash pop
</pre>

<admonition type="tip">
For more on stashing with Git, see:

* [https://git-scm.com/book/en/v1/Git-Tools-Stashing https://git-scm.com/book/en/v1/Git-Tools-Stashing]
* [https://www.git-scm.com/docs/git-stash https://www.git-scm.com/docs/git-stash]
* [http://gitguys.com/topics/temporarily-stashing-your-work/ http://gitguys.com/topics/temporarily-stashing-your-work/]
</admonition>

'''OR''' you can throw them away

<admonition type="warning">
'''BE CAREFUL: THIS WILL DELETE ALL LOCAL CHANGES YOU HAVE MADE!'''
</admonition>

<pre>
git reset --hard
</pre>

If the files you have been altering have also been altered in the public repository while you've been working, then it's possible you will run into a conflict. Merge conflicts happen when you merge branches that have competing commits, and Git needs your help to decide which changes to incorporate in the final merge. Generally, you'll have to find the places in the files where the conflicts are listed, pick which version of the changes you want to keep, and delete any extraneous content that you don't want. Below are some resources to help get you started:

* [https://help.github.com/en/articles/about-merge-conflicts GitHub: About merge conflicts]
* [https://help.github.com/en/articles/resolving-a-merge-conflict-using-the-command-line GitHub: resolving a merge conflict using the command-line]
* [https://stackoverflow.com/questions/161813/how-to-resolve-merge-conflicts-in-git?answertab=votes#tab-top StackOverflow: suggestions on using git mergetool to resolve conflicts]
* [https://githowto.com/resolving_conflicts GitHowTo: Resolving conflicts]

===Open a pull request===

GitHub has a great guide here:

* [https://help.github.com/en/articles/creating-a-pull-request-from-a-fork https://help.github.com/en/articles/creating-a-pull-request-from-a-fork]

A few reminders:

* Make sure you are submitting your pull request against the correct branch of our docs! We version the AtoM documentation into separate branches for each major release (e.g. 2.3, 2.4, 2.5, etc)
* The [https://chris.beams.io/posts/git-commit/ Commit best practices] are also useful for preparing good Pull request summaries! Make sure we have a clear overview of what you've changed and why
* If you are making major changes, remember to [[#File an issue in our documentation repository|file an issue in our documentation repository]] first, and reference the issue number in the PR subject - for example "Add permissive slug setting docs, fixes #82" (see the PR [https://github.com/artefactual/atom-docs/pull/91 here] and the related issue [https://github.com/artefactual/atom-docs/issues/82 here])

Our team will be notified once you've submitted your pull request - we'll review the work, and if we have questions or feedback, we'll post comments directly on the pull request. Make sure GitHub account settings are configured to notify you of changes, so you can follow up!

===Add fixes and squash your commits===

Once you've submitted your pull request, the Artefactual team will review the changes. If there's a problem, we can send you a message via GitHub, or even [https://help.github.com/articles/using-pull-requests/#pull-request-discussion begin a discussion right on the code!] This way, if there's something we don't understand about the changes you've made, we can connect with you directly. This is very similar to the code review process we undertake on code submissions from developers - see our [[Development/Code review|Code review]] wiki page for more information.

You'll be able to see a summary of our changes and the status of the review on your pull request. We'll add comments if we have changes to request.

If you need to make changes, you can simply return to the files and edit them in place. Follow the same steps as above - when you push a new commit, GitHub should automatically include it as part of your pull request. You can also reply on the PR comments thread to ask for clarification or help, or to let us know that the requested changes have been implemented.

[[File:git-pull-respond.png|center|600px|frameless|An image of the comments thread as seen on a pull request in GitHub]]

====Squashing commits====

In some cases, we may request that you squash your commits when you update your PR, to keep the commit history clean and easy to understand.

<admonition type="tip">
'''What does squashing mean in git?'''

The term squashing refers to consolidating multiple commits into one single commit, for the purpose of simplifying the project history. When there are many small commits, including minor revisions to previous work, a lot of the commit history is only relevant for the developer who generated it, so it's considered best practice to simplify this before submitting your work to a shared repository. Git provides users with the ability to rewrite the history of a commit for cases such as this - so squashing in this context refers to moving the changes introduced in one commit into its parent, so that you end up with one commit out of two or more.

For more general information on this topic, see the following chapter in the Git Book:

* [https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History Git Tools: Rewriting History]
</admonition>

There are several ways that you can do this in git, but our preferred method is to use git's interactive rebase. To do so:

'''1.''' Run git rebase using interactive mode. The numeric value after our <code>HEAD</code> variable in the following command tells git how many commits we want to fetch. For example, if your pull request currently includes 4 commits (of which the first contains the body of your work, and the next three are minor corrections), then we can see all of these commits using <code>4</code> as the variable, like so:

<pre>
git rebase -i HEAD~4
</pre>

This should display something similar to the following output:

<pre>
pick d2c53e5 Update CSV import docs, fixes #50
pick efaf92d Fix a typo in CSV import rewrite
pick 5bc533c Add another section to the rewrite
pick 3d304f2 Another minor formatting fix

# Rebase d2c53e5...3d304f2 onto 609f966 (4 commands)
#
# Commands:
# p, pick = use commit
# r, reword = use commit, but edit the commit message
# e, edit = use commit, but stop for amending
# s, squash = use commit, but meld into previous commit
# f, fixup = like "squash", but discard this commit's log message
# x, exec = run command (the rest of the line) using shell
# d, drop = remove commit
</pre>

<admonition type="note">
Notice that there are 4 commits shown with the word <code>pick</code> next to them. If we ran the command using <code>HEAD~2</code>, this list would only include the 2 most recent commits. You can also show other unrelated commits (i.e. include more - <code>HEAD~8</code>) and simply leave them untouched in the following steps, if desired.
</admonition>

What we're seeing above is a list of the last 4 commits for the repository. Note that it's in reverse order - the bottom commit is the most recent one. Instead of merging four commits, three of which are minor fixes to the first commit, it would be tidier to have one commit that included all those fixes. To squash them together, you'll need to decide which changes are minor (or fixups) - in this case, the 3 last commits. Let's change them so they will be squashed.

'''2.''' using our command-line text editor, we now want to edit the word "pick" before the 3 corrections, and change them to "fixup" - once saved, this tells git that these commits should be squashed into the first commit (still marked as "pick" - i.e. use this one), and their commit message discarded in favor of the original message associated with the commit you are keeping.

<admonition type="tip">
When you were setting your global git identity, did you set your default preferred command-line text editor?

If not, odds are good that the default editor is vim - vim's commands can be pretty confusing if you are not used to them! Here are some tips:

* By default you are in "normal mode" - you can view, but not edit
* Press <code>i</code> to enter insert mode, so you can make edits
* Pressing <code>ESC</code> will return you to normal mode (not insert mode)
* When you've made edits and then have returned to normal mode, press <code>:wq</code> to save and exit (write and quit)
* You can quit ''without'' saving when in normal mode with <code>:q</code>
* If you are reordering commits, <code>dd</code> in insert mode will cut the current line and copy it to the clipboard, and <code>P</code> will paste the clipboard content before the current line

You can read more about vim here:

* [https://vim.fandom.com/wiki/Tutorial vim Tutorial]
* [https://vim.fandom.com/wiki/New_to_Vim New to vim]
* [https://vimhelp.org/vim_faq.txt.html vim FAQ]
</admonition>

Once you've made the necessary changes, save them and exit the editor:

* In vi or vim, use ESC to ensure you are in normal mode, then enter <code>:wq</code> to save and exit
* In nano, use <code>CTRL+o</code>, press enter, and then <code>CTRL+x</code>

'''3.''' Before we proceed, let's confirm we've done this correctly. Run the command: <code>git log -1</code> to show the latest commit - it shoudl be the main commit you want to keep, and not any of the smaller fixes we marked with fixup. It should look something like this:

<pre>
commit d2c53e548e339acdd5e1c3e2762347d1562b195f
Author: username <email@example.com>
Date: Wed Nov 14 15:54:08 2018 -0700

Update CSV import docs, fixes #50
</pre>

If it's not, you can run <code>git log</code> to see a full list of all commits, and figure out what you missed. Repeat the steps above as needed.

'''4.''' Once you've successfully squashed your commits, we'll force push the fixed-up commit:

<pre>
git push -f
</pre>

Success!

===Celebrate===

You did it! Thank you for contributing to the AtoM documentation!

Once we've accepted the pull request and merged it into our repository, you'll get a notification (you'll probably get an email too, unless you've changed your default GitHub account settings). You'll be able to see the status of any changes right on the pull request.

It's time to dance!

==Questions?==

If there's something that you're not clear about in these instructions, or you've run into an unexpected error, send us an email at [mailto:webmaster@artefactual.com webmaster@artefactual.com], or make a post in the AtoM [https://groups.google.com/forum/#!forum/ica-atom-users User Forum]!

<admonition type="seealso">
* [[Resources/Documentation/Contribution guidelines|Documentation contribution guidelines]]
* [[Resources/Documentation/About|About the AtoM documentation]]
* [[Development/Contribute code|Contribute code]]
* [[Resources/Translation|Contribute translations]]
* [[Resources/User forum|Using the AtoM User Forum]]
* [[Resources/Issue tracker|Using the AtoM Issue tracker]]
</admonition>

==Contribute documentation translations==

Want to help us translate these docs into your language? We rely on our amazing community volunteers to help us make AtoM a truly international application. Currently we are using [https://translations.artefactual.com/ Weblate] to help us manage our project translations.

<admonition type="warning">
This is still a work in progress! We hope to be able to add our documentation to Weblate in the future. In the meantime, we're always looking for help translating AtoM itself! See: [[Resources/Translation|Contribute translations]]
</admonition>

-----

* [[Resources/Documentation|Back to Documentation]]
* [[Resources|Back to Resources]]
* [[Main Page|AtoM wiki home]]

[[Category:Resources]]

User:Zerpal

2024-03-22T16:34:30Z

Dan: Creating user page for new user.

Docente , Universidad Central de Venezuela
Escuela Bibliotecología y Archivología
Cátedras: Archivos Históricos, Descripción documental y Teoría y práctica de las ciencias de la información.
Actualmente realizo mi trabajo de ascenso con el Software AtoM " una propuesta de descripción documental para el Archivo Histórico de esta universidad"

User:Adelaro

2024-03-22T16:34:20Z

Dan: Creating user page for new user.

Estudiante del curso de la UNED Digitalización del Patrimonio

User:Exponav

2024-03-22T16:31:05Z

Dan: Creating user page for new user.

Server's Atom Administrator. Archivo de la Fundación Exponav. Search support

User:Svarog

2024-03-22T16:30:50Z

Dan: Creating user page for new user.

Researcher of Serbian history of the Middle and Late Middle Ages

User:Arnaldoram

2024-03-22T16:30:33Z

Dan: Creating user page for new user.

Ingeniero de sistemas informáticos, nacido em la ciudad de Potosí Bolivia, encargado de sistemas del Archivo y Biblioteca Nacionales de Bolivia, además del área de digitalización.

Community/Community resources/Customization

2024-02-26T14:44:02Z

Dan: /* Instructions on swapping XSLT files */ Update instructions for PHP 7.4

{{#pagetitle:Customization}}
[[Main Page]] > [[Community]] > [[Community/Community resources]] > Community/Community resources/Customization

Here we will link some examples of AtoM customization by community members which can be achieved without developer support. Have a resource to add, or one that you know about which is publicly available? Please help us by [[Special:UserLogin|adding it!]]

<admonition type="seealso">
Looking for custom development, such as plugins, themes, and code patches? Check out our Community development page:
* [[Community/Community resources/Development|Community development]]
</admonition>

==Help pages==

Below are some examples of ways that AtoM administrators have tried to make their catalogues easier to use for their public users. Many of these examples use AtoM's existing static page and menu modules. Please feel free to add your own resources!

<admonition type="tip">
For details on creating new static pages see our [https://www.accesstomemory.org/en/docs/ documentation] for your current version; specifically see Manage Static Pages and Manage Menus.
</admonition>

===Beaton Institutite Project guides===

The [http://beatoninstitute.com/ Beaton Institute] at Cape Breton University has used a creative mix of static pages and subject terms to create beautiful user guides to their holdings. See some examples below:

* [http://beatoninstitute.com/projects Projects landing page]
* [http://beatoninstitute.com/ww1 Cape Breton during WWI]
* [http://beatoninstitute.com/newspapers Nova Scotia Historical Newspapers]
* [http://beatoninstitute.com/bns Black Nova Scotian Holdings]

===Mills Archive help pages===

The [http://catalogue.millsarchive.org/ Mills Archive] AtoM site includes a number of inter-linked static pages, created to help users understand how to use the catalogue. Here are some direct links to some examples:

* [http://catalogue.millsarchive.org/basic-search Basic search]
* [http://catalogue.millsarchive.org/advanced-search Advanced search]
* [http://catalogue.millsarchive.org/browse Browse]
* [http://catalogue.millsarchive.org/how_it_works How the catalogue works]

===City of Vancouver Archives search help===

The City of Vancouver Archives created an "About Searching" help page using the static page functionality in AtoM.

* [http://searcharchives.vancouver.ca/about CVA's About Searching page]

===Simon Fraser University user guides===

At Simon Fraser University, the SFU Archives and SFU Library's Special Collections and Rare Books share an AtoM instance, using AtoM's multi-institutional functionality. To assist their users, they have created an extremely detailed search guide, as well as a User's guide to finding aids, explaining (among other things), how hierarchical description is used in archives, how the reference codes are constructed, and more.

* [http://atom.archives.sfu.ca/index.php/search-tips SFU Search tips]
* [http://atom.archives.sfu.ca/index.php/users-guide-to-finding-aids SFU User's guide to finding aids]

===MemoryNS video tutorials===

[https://memoryns.ca/ MemoryNS], the Nova Scotian archival union catalogue maintained by the Council of Nova Scotia Archives ([http://www.councilofnsarchives.ca/ CNSA]), has created a number of video tutorials on searching, browsing, and much more, and included the playlist of videos in a static page in their AtoM instance. Check it out here:

* [https://memoryns.ca/tutorial-videos MemoryNS Tutorial videos]

===Borthwick Institute for Archives' FAQ and Glossary pages===

The [https://borthcat.york.ac.uk/ Borthwick Institute for Archives] at the [http://www.york.ac.uk/ University of York] has included two static pages to support their users - an FAQ, and a Glossary of archival terms used in the catalogue:

* [https://borthcat.york.ac.uk/index.php/glossary Glossary]
* [https://borthcat.york.ac.uk/index.php/about FAQ]

===Australia National University Archives' Help searching page===

With content describing over 20km of material (ca. 1800 collections, over 1200 creators), [http://archivescollection.anu.edu.au/ ANU] ensures that their users have a helpful resource nearby. This help page is maintained in HTML outside of AtoM, but is linked in the AtoM database via the Quick links menu, and mentioned on the home page

* [http://archives.anu.edu.au/collections/finding-aids/database ANU's Database help page]

==Institution pages==

Here are some examples of users who have taken advantage of the Archival institution theming options in AtoM and implemented them in creative ways!

===Guelph Public Library Archeion page===

Guelph Public Library Archives has done [http://www.archeion.ca/guelph-public-library-archives extensive customizations] to their Archeion (union database for the Archives Association of Ontario). For details on editing an institutional page see our [https://www.accesstomemory.org/en/docs/ documentation] for your current version, particularly Archival Institutions.

* [http://www.archeion.ca/guelph-public-library-archives Guelph Public Library Archives in Archeion]

==Stylesheets==

This section will include alternative XSLTs and other stylesheets that can be used in AtoM. As of the 2.2 release, an XSLT is used to transform archival description EAD XML into PDF or RTF finding aids, for example.

===French XSLTs for finding aid generation===

At this time, the labels used in the Finding aid XSLTs are hard-coded, meaning that they cannot easily be translated for use in other languages. However, several community users have translated the finding aid labels into French - various versions are included below, along with basic installation instructions.

====2.4 French XSLTs====

Les archives de la Ville de Montréal has created French versions of AtoM's XSLTs that are known to work with [[Releases/Release_announcements/Release_2.4|Release 2.4]]. If you would like your Finding aids to be generated with French labels instead of English ones, a developer can swap the following XSLTs in to replace the default ones included in AtoM.

* [https://storage.accesstomemory.org/tmp/french-xslts.tgz 2.4-french-xslts.tgz] (tarball, 3 files, 31.1 KB)

====2.6 French XSLTs====

Some stylistic changes were introduced to the finding aid layouts in [[Releases/Release_announcements/Release_2.6|Release 2.6]] - details can be found on Issue #[https://projects.artefactual.com/issues/10591#note-7 10591].

Community user Aude Alexandre updated the 2.4 version above with the changes introduced in Release 2.6 and has shared them with the community. If you would like to download this version of the French XSLTs, you can find them here:

* [http://storage.accesstomemory.org/xlsts/fr/atom-xlsts-fr-v262.zip 2.6-french-xslts.zip] (compressed ZIP, 2 files, 24KB)

====2.8 French XSLTs====

The finding aid templates were updated to use a local DTD in [[Releases/Release_announcements/Release_2.7|Release 2.7]]. Also, some of the common fields that were used in the multiple XSL files were moved to a single common file to avoid duplication. The French XSLTs from v2.6 were updated to reflect these changes, and the updated version can be found here:

* [http://storage.accesstomemory.org/xlsts/fr/atom-xlsts-fr-v280.zip 2.8.0-french-xslts.zip] (compressed ZIP, 4 files, 25.1KB)

====Instructions on swapping XSLT files====

* Download and then extract one of the tarball files linked above
* In your AtoM instance, navigate via the command-line to <code>lib/task/pdf/</code>
* Replace the existing files with those found in tarball
* Clear application cache, restart services (php-fpm, webserver, atom-worker) - the following examples assume you've installed using Nginx as your webserver:

'''If you are using Ubuntu 14.04 with PHP5.x:'''
<pre>
$ php symfony cc
$ sudo service nginx restart
$ sudo service php5-fpm restart
$ sudo restart atom-worker
</pre>

'''If you are using Ubuntu 16.04 with PHP7.0:'''
<pre>
$ php symfony cc
$ sudo systemctl restart nginx
$ sudo systemctl restart php7.0-fpm
$ sudo systemctl restart atom-worker
</pre>

'''If you are using Ubuntu 20.04 with PHP7.4:'''
<pre>
$ php symfony cc
$ sudo systemctl restart nginx
$ sudo systemctl restart php7.4-fpm
$ sudo systemctl restart atom-worker
</pre>

You may need to clear your web browser's cache to see the changes take effect as well.

You should now see French labels when you generate your next finding aid!

-----

* [[Community/Community_resources|Back to Community resources]]
* [[Community|Back to Community]]
* [[Main Page|AtoM wiki home]]

[[Category:Community]]

User:Pepe

2024-02-09T13:10:10Z

Dan: Creating user page for new user.

Archivero
"Hay que recuperar, mantener y transmitir la memoria histórica, porque se empieza por el olvido y se termina en la indiferencia.” José Saramago

User:Paolafilippi

2024-02-05T13:27:26Z

Dan: Creating user page for new user.

I am a firm believer in tha fact that, to remember is to not commit the same mistakes twice.

User:HannahMeir

2024-02-05T13:27:14Z

Dan: Creating user page for new user.

Archives and Records Management MA student at University of Liverpool

User:Laura.waters

2024-02-05T13:27:03Z

Dan: Creating user page for new user.

Laura Waters is the Freelance Collections Officer for the National Brewery Heritage Trust, based in Burton on Trent, United Kingdom.

User:Reedkayla

2024-01-24T16:50:14Z

Dan: Creating user page for new user.

Discovery, Systems, & Digital Strategy Librarian at Grinnell College, helps in managing library technology.

Resources/User forum/Tags

2024-01-19T16:31:05Z

Dan: Add new tag: linked-data

{{#pagetitle:User forum tags}}
[[Main Page]] > [[Resources]] > [[Resources/User forum]] > Tags

We have enabled topical tagging in the AtoM [https://groups.google.com/forum/#!forum/ica-atom-users user forum] to help with searching and browsing. If you wish, you can tag your post with keywords - the forum administrators may also add or remove tags later on as we see fit.

Instructions on searching and browsing forum posts with tags, as well as how to tag your own posts, are included below, along with a full list the the tags currently available for use in the forum.

<admonition type="seealso">
The AtoM User Forum is maintained via Google Groups - for more information, see the [https://support.google.com/groups#topic=9216 Groups Help] pages.
</admonition>

__TOC__

==Searching and browsing with tags==

'''Browsing by tag'''

If you want to browse all the tags currently in use in the forum, you will find a full list via the link in the right-hand top corner of the AtoM Forum home page:

[[File:forum-tag-link.png|center|700px|thumb| The AtoM User Forum home page with the tags link highlighted]]

Clicking on the link will take you to a page where you can see a list of all available tags. To filter all posts to a specific tag, you can either click on a tag from the list, or you can begin typing the tag into the input box above the list, and selecting the matching tag from the autocomplete results that appear.

[[File:forum-filter-tag.png|center|700px|thumb| The AtoM User Forum tags page]]

The AtoM user forum will reload, with your selected tag at the top of the page, and the results limited to those posts where the selected tag has been added.

[[File:forum-filtered.png|center|700px|thumb| The AtoM User Forum filtered using the import-export tag]]

<admonition type="seealso">
Google Groups Help article: [https://support.google.com/groups/answer/1311325?hl=en&ref_topic=2459442 View topics with a specific tag]
</admonition>

'''Searching by tag'''
You can also use the search box on the AtoM Forum page to use a tag as part of a more complex search. entering the tag you wish to search for, preceded by <code>tag:</code> will return results for posts with that tag. For example if you wanted to see all posts that had both the import-export and the ead tag, you could search: <code>tag:import-export tag:EAD</code>.

[[File:forum-search-tag.png|center|700px|thumb| Searching the AtoM User Forum for posts with the tag "elasticsearch"]]

<admonition type="seealso">
There are a lot of other useful search terms and operators you can use to improve your searching. For more information, see the following Groups help articles:

* [https://support.google.com/groups/answer/2467140?hl=en&ref_topic=2459443 Search for a group, topic, or post]
* [https://support.google.com/groups/answer/6141166?hl=en&ref_topic=2459443 Improve your searches with search terms and operators]
* [https://support.google.com/groups/answer/2371405?hl=en&ref_topic=2459443 List of available search terms]
</admonition>

==Adding a tag to your posts==

At this time, there's no way to add a tag from your email - so if you're subscribed to the User Forum and using it as a mailing list, you'll have to visit the Forum on the web ([https://groups.google.com/forum/#!forum/ica-atom-users here]) if you want to add tags to your posts.

From the web home, there are 2 ways you can add tags - either while creating a new post, or after you've posted, starting a thread.

To add tags as you are composing your post, click the "new topic" button from the Forum home page - you will see an area at the bottom of the compose page where you can add tags:

[[File:add-tag-new-post.png|center|700px|thumb| Adding a new tag while composing a post in the AtoM user forum]]

If you want to add tags to your post after you've already posted it (for example, if you start a topic via email, and then navigate to the Forum on the web), open the thread, and at the top of the thread, you should see a link that says "Add tags."

[[File:add-tag-old-post.png|center|700px|thumb| Adding a new tag to an existing Forum post]]

<admonition type="seealso">
You can also take a look at the related Groups Help page, [https://support.google.com/groups/answer/1047904?hl=en&ref_topic=2459442 Tag topics].
</admonition>

==Full tag list==

Below is a list of all the tags currently in use the AtoM User Forum:

* 500-error
* 504-timeout
* access-point
* accessibility
* accession
* analytics
* announcements
* ansible
* Apache
* API
* archival-description
* archival-institution
* archivematica
* AtoM3
* audit-log
* authority-record
* backups
* bug-report
* camps
* clipboard
* command-line
* community
* configuration
* CSV-export
* CSV-import
* DACS
* data-corruption
* Debian
* dependencies
* description-updates
* development
* digital-object
* DIP_upload
* docker
* documentation
* donor
* Dublin-Core
* EAC
* EAD
* elasticsearch
* FAQ
* finding-aid
* firewall
* formatting
* Foundation
* FreeBSD
* function
* governance
* hosting
* import-export
* installation
* inventory
* ISAAR-CPF
* ISAD-G
* ISDF
* ISDIAH
* job-scheduler
* languages
* LDAP
* linked-data
* linux
* logging
* mac-OS
* menus
* migration
* MODS
* monitoring
* multi-repository
* new-feature
* Nginx
* OAI-PMH
* off-topic
* Oracle
* PDF
* permissions
* PHP
* physical-storage
* plugins
* publication-status
* RAD
* regional-groups
* releases
* reports
* responsive-design
* rights
* scalability
* search-browse
* security
* SEO
* service-providers
* settings
* single-sign-on
* SKOS
* slugs
* SQL
* standards
* static-pages
* symfony
* system-requirements
* taxonomies
* themes
* training
* translations-i18n
* treeview
* upgrades
* usability
* user-stories
* users-groups
* vagrant
* visible-elements
* web-server
* Windows
* wish-list
* XML-export
* XML-import

-----

* [[Resources/User_forum|Back to User forum]]
* [[Resources|Back to Resources]]
* [[Main Page|AtoM wiki home]]

[[Category:Resources]]

User:Julice

2024-01-17T13:26:33Z

Dan: Creating user page for new user.

Juan Luis Cebrián Echarri (Madrid, 30 de octubre de 1944) es un periodista, escritor y empresario español. Fue director-fundador del diario El País, que dirigió desde 1976 hasta noviembre de 1988. Desde el 19 de diciembre de 1996 es académico de la Real Academia Española.1 En 2018 dejó la presidencia del Grupo Prisa en manos de Manuel Polanco. La presidencia de El País quedó en manos de Manuel Mirat y Cebrián fue nombrado presidente de honor. Cebrián ha sido considerado por diversos medios internacionales como uno de los diez españoles más influyentes en España y América Latina durante 43 años (desde 1976 a 2018). Es el único académico hispano miembro del Club Bilderberg y el único miembro de lengua española con funciones ejecutivas en el mismo.

User:GemmaBravo

2024-01-17T13:26:13Z

Dan: Creating user page for new user.

Estudiante Unleon que realiza prácticas para la asignatura de Tecnologías para la gestión
de unidades de información

User:Elisagiovannetti47

2024-01-17T13:26:01Z

Dan: Creating user page for new user.

I am an archivist specialising in the treatment and description of photographic heritage.

User:Shanshania

2024-01-17T13:25:48Z

Dan: Creating user page for new user.

I graduated with a Master degree in Library and Information Management and I'm now working in the archive sector.

User:Mmjimenez

2024-01-17T13:25:27Z

Dan: Creating user page for new user.

Me encuentras dedicada a la recuperación de la Memoria Colectiva de los Movimientos Sociales en La Digitalizadora de la Memoria Colectiva (http://archivo.ladigitalizadora.org/).

Organizando el Archivo Fotográfico de la Universidad de Málaga. El objetivo es la preservación de los originales fotográficos y la digitalización y difusión a través de Internet de los fondos fotográficos históricos.
https://archivo.fotografico.uma.es/historico/index.php/
https://archivo.fotografico.uma.es/vida-universitaria/index.php/

Como archivera vocacional dedicada a la fotografía, me encuentras en Photoespacio.com (https://www.photoespacio.com).

Releases/Release announcements/Release 2.8.0

2024-01-09T19:20:44Z

Dan: /* Bootstrap 5 */

{{#pagetitle:Release 2.8.0}}
[[Main Page]] > [[Releases]] > [[Releases/Release announcements]] > Release 2.8.0

'''Release date''': January 8, 2024

'''Download link''': [https://storage.accesstomemory.org/releases/atom-2.8.0.tar.gz atom-2.8.0.tar.gz]

'''Database schema version''': v193

'''Release 2.8''' is a major AtoM release, and includes important security updates for Content Security Policy, updates to the Bootstrap 5 Dominion theme, as well as bug fixes.

----

Visit the [https://www.accesstomemory.org/download/ Downloads] page to download the most recent release, and consult the 2.8 [https://www.accesstomemory.org/docs/2.8/admin-manual/installation/upgrading/ Upgrading] and [https://www.accesstomemory.org/en/docs/2.8/admin-manual/installation/ Installation] guides in our documentation for further information.

An overview of some of the major changes in the 2.8 release is included below.

__TOC__

-----

===Bootstrap 5===

Starting with this release the Bootstrap 5 theme (arDominionB5Plugin) is the default theme for new AtoM installations. Additionally, AtoM is deprecating Boostrap 2 themes starting this release since Bootstrap 2, which was used for the Dominion (arDominionPlugin) and the Archives Canada themes (arArchivesCanadaPlugin), is no longer officially supported.

'''Related documentation'''

* [https://www.accesstomemory.org/en/docs/2.8/admin-manual/customization/theming/#bs2-update Bootstrap 2 update - AtoM Documentation]

<admonition type="important">
'''Bootstrap 2 will be fully removed from the AtoM 2.9 release'''. If you have a custom theme plugin developed against an earlier release using Bootstrap 2, you will need to upgrade your theme plugin to extend from the new Bootstrap 5 templates instead BEFORE upgrading to 2.9, or else your custom theme will not work. Please follow the AtoM documentation link above, and review the official [https://getbootstrap.com/docs/5.2/getting-started/introduction/ Bootstrap 5 documentation] for guidance.
</admonition>

===Content Security Policy===

This release adds Content Security Policy headers to AtoM to further improve security for AtoM. Adding this significantly improved AtoM's performance in web security analysis tools such as Mozilla Observatory which now rate it as A+.

[[File:Mozilla-observatory-scan.png|700px]]

Please read the related documentation page for information on configuration or implementing CSP for your own custom theme.

'''Related documentation'''

* [https://www.accesstomemory.org/en/docs/2.8/admin-manual/security/csp-headers/ Content Security Policy - AtoM Documentation]

===General bug fixes and enhancements===

* [https://github.com/artefactual/atom/pull/1542 #1542] Added an authority record rename module
''Community code contributions from Matt Innes''
* [https://github.com/artefactual/atom/issues/1662 #1662] Fixed Dockerfile so that it no longer gives an error when it is trying to install a package from npm
''Community code contributions from Guilherme Arthur Geronimo''

* [https://github.com/artefactual/atom/issues/1684 #1684] Diacritics setting functionality
* [https://github.com/artefactual/atom/issues/1613 #1613] Added a tab for viewing failed jobs
* [https://github.com/artefactual/atom/issues/1632 #1632] Set arDominionB5Plugin to be the default theme for new installations in AtoM
* [https://github.com/artefactual/atom/issues/1642 #1642] Added a Bootstrap 2 deprecation notice in the web UI
* [https://github.com/artefactual/atom/issues/1628 #1628] Added REST API support for physical storage object creation
* [https://github.com/artefactual/atom/issues/1624 #1624] Added a new REST API endpoint that allows changing of an information object's publication status
* [https://projects.artefactual.com/issues/13650 #13650] Increased the PDF indexing limit to 16MB
* Amharic made available in [https://translations.artefactual.com/projects/atom/2-x/ Weblate] for translation
* [https://github.com/artefactual/atom/pull/1646 #1646] Add CSP headers to AtoM responses
* [https://github.com/artefactual/atom/pull/1693 #1693] Update CSP header default to 'report-only'
* [https://github.com/artefactual/atom/pull/1641 #1641] secure and samesite flags added to AtoM cookies
* [https://github.com/artefactual/atom/issues/1715 #1715] Fixed difficult to read job logs
* [https://github.com/artefactual/atom/issues/1713 #1713] Fixed typo in API key label when editing user.
* [https://github.com/artefactual/atom/issues/1710 #1710] Fixed archival institution page's upload limit form has a broken field on BS5 theme
* [https://github.com/artefactual/atom/issues/1703 #1703] Fixed invalid static pages being created with invalid slugs
* [https://github.com/artefactual/atom/issues/1701 #1701] Fixed clipboard send feature no longer sending the request data as a form submission
* [https://github.com/artefactual/atom/issues/1698 #1698] Fixed some BS5 theme typography issues and inconsistencies
* [https://github.com/artefactual/atom/issues/1696 #1696] Fixed autocomplete during SKOS import pointing to descriptions instead of taxonomies
* [https://github.com/artefactual/atom/issues/1678 #1678] Updated the CSRF attack message to be more informative
* [https://github.com/artefactual/atom/issues/1673 #1673] Added proper page titles for better accessibility (WCAG (2.4.2))
* [https://github.com/artefactual/atom/issues/1666 #1666] Added error handling for the rename-slug CLI tool
* [https://github.com/artefactual/atom/issues/1661 #1661] Fixed incomplete terms being saved in the taxonomy when adding access points
* [https://github.com/artefactual/atom/issues/1653 #1653] Fixed identifier counter not incrementing when used to modify existing descriptions
* [https://github.com/artefactual/atom/issues/1643 #1643] Fixed the broken media-type option on digital object deriv regeneration task
* [https://github.com/artefactual/atom/issues/1635 #1635] Fixed global search institutional delimiters and advanced search link
* [https://github.com/artefactual/atom/issues/1634 #1634] Removed the repeated re-index warnings on running the build-nested-set task
* [https://github.com/artefactual/atom/issues/1630 #1630] Fixed an ACL check in the REST API's digital object create endpoint that was malformed
* [https://github.com/artefactual/atom/issues/1611 #1611] Added a task description for the password reset task
* [https://github.com/artefactual/atom/issues/1606 #1606] Fixed G4 analytics not tracking pageviews from clicks in full-width treeview
* [https://github.com/artefactual/atom/issues/1605 #1605] Fixed escape special characters setting no longer working in 2.7.x
* [https://github.com/artefactual/atom/issues/1598 #1598] Reduced noise in search results that was there due to indexing inherited creators
* [https://github.com/artefactual/atom/pull/1704 #1704] Fixed multi-line i18n strings
* [https://projects.artefactual.com/issues/13657 #13657] Fixed update function for 'Language and script notes'.
* [https://github.com/artefactual/atom/issues/1688 #1688] Updated BS5 navbar-toggler-icon to Font Awesome icon
* [https://github.com/artefactual/atom/issues/1596 #1596] Fixed RAD template fields not appearing when switching languages

 

''Many thanks to Helder Gomes Silva who reported a security vulnerability for this release''

<admonition type="seealso">
You can read more about how to report a security vulnerability found in AtoM [https://github.com/artefactual/atom/blob/qa/2.x/SECURITY.md here]

If you're a developer interested in committing bug fixes and enhancements back to the public project, check out our guide on how to [[Development/Contribute_code|contribute code]]!
</admonition>

-----

'''Links'''

* AtoM 2.8 tarball direct download: [https://storage.accesstomemory.org/releases/atom-2.8.0.tar.gz atom-2.8.0.tar.gz]
* AtoM [https://www.accesstomemory.org/download/ Downloads] page
* 2.8 [https://www.accesstomemory.org/docs/2.8/admin-manual/installation/ubuntu/ installation] and [https://www.accesstomemory.org/docs/2.8/admin-manual/installation/upgrading/ upgrading] instructions

-----

* [[Releases/Release_announcements|Back to Release announcements]]
* [[Releases|Back to Releases]]
* [[Main Page|AtoM wiki Home]]

[[Category:Releases]]

Releases/Release announcements/Release 2.8.0

2024-01-09T19:20:19Z

Dan: Add warning about BS2 removal

{{#pagetitle:Release 2.8.0}}
[[Main Page]] > [[Releases]] > [[Releases/Release announcements]] > Release 2.8.0

'''Release date''': January 8, 2024

'''Download link''': [https://storage.accesstomemory.org/releases/atom-2.8.0.tar.gz atom-2.8.0.tar.gz]

'''Database schema version''': v193

'''Release 2.8''' is a major AtoM release, and includes important security updates for Content Security Policy, updates to the Bootstrap 5 Dominion theme, as well as bug fixes.

----

Visit the [https://www.accesstomemory.org/download/ Downloads] page to download the most recent release, and consult the 2.8 [https://www.accesstomemory.org/docs/2.8/admin-manual/installation/upgrading/ Upgrading] and [https://www.accesstomemory.org/en/docs/2.8/admin-manual/installation/ Installation] guides in our documentation for further information.

An overview of some of the major changes in the 2.8 release is included below.

__TOC__

-----

===Bootstrap 5===

Starting with this release the Bootstrap 5 theme (arDominionB5Plugin) is the default theme for new AtoM installations. Additionally, AtoM is deprecating Boostrap 2 themes starting this release since Bootstrap 2, which was used for the Dominion (arDominionPlugin) and the Archives Canada themes (arArchivesCanadaPlugin), is no longer officially supported.

'''Related documentation'''

* [https://www.accesstomemory.org/en/docs/2.8/admin-manual/customization/theming/#bs2-update Bootstrap 2 update - AtoM Documentation]

<admonition type="important">
Bootstrap 2 will be '''fully removed''' from the AtoM 2.9 release. If you have a custom theme plugin developed against an earlier release using Bootstrap 2, you will need to upgrade your theme plugin to extend from the new Bootstrap 5 templates instead BEFORE upgrading to 2.9, or else your custom theme will not work. Please follow the AtoM documentation link above, and review the official [https://getbootstrap.com/docs/5.2/getting-started/introduction/ Bootstrap 5 documentation] for guidance.
</admonition>

===Content Security Policy===

This release adds Content Security Policy headers to AtoM to further improve security for AtoM. Adding this significantly improved AtoM's performance in web security analysis tools such as Mozilla Observatory which now rate it as A+.

[[File:Mozilla-observatory-scan.png|700px]]

Please read the related documentation page for information on configuration or implementing CSP for your own custom theme.

'''Related documentation'''

* [https://www.accesstomemory.org/en/docs/2.8/admin-manual/security/csp-headers/ Content Security Policy - AtoM Documentation]

===General bug fixes and enhancements===

* [https://github.com/artefactual/atom/pull/1542 #1542] Added an authority record rename module
''Community code contributions from Matt Innes''
* [https://github.com/artefactual/atom/issues/1662 #1662] Fixed Dockerfile so that it no longer gives an error when it is trying to install a package from npm
''Community code contributions from Guilherme Arthur Geronimo''

* [https://github.com/artefactual/atom/issues/1684 #1684] Diacritics setting functionality
* [https://github.com/artefactual/atom/issues/1613 #1613] Added a tab for viewing failed jobs
* [https://github.com/artefactual/atom/issues/1632 #1632] Set arDominionB5Plugin to be the default theme for new installations in AtoM
* [https://github.com/artefactual/atom/issues/1642 #1642] Added a Bootstrap 2 deprecation notice in the web UI
* [https://github.com/artefactual/atom/issues/1628 #1628] Added REST API support for physical storage object creation
* [https://github.com/artefactual/atom/issues/1624 #1624] Added a new REST API endpoint that allows changing of an information object's publication status
* [https://projects.artefactual.com/issues/13650 #13650] Increased the PDF indexing limit to 16MB
* Amharic made available in [https://translations.artefactual.com/projects/atom/2-x/ Weblate] for translation
* [https://github.com/artefactual/atom/pull/1646 #1646] Add CSP headers to AtoM responses
* [https://github.com/artefactual/atom/pull/1693 #1693] Update CSP header default to 'report-only'
* [https://github.com/artefactual/atom/pull/1641 #1641] secure and samesite flags added to AtoM cookies
* [https://github.com/artefactual/atom/issues/1715 #1715] Fixed difficult to read job logs
* [https://github.com/artefactual/atom/issues/1713 #1713] Fixed typo in API key label when editing user.
* [https://github.com/artefactual/atom/issues/1710 #1710] Fixed archival institution page's upload limit form has a broken field on BS5 theme
* [https://github.com/artefactual/atom/issues/1703 #1703] Fixed invalid static pages being created with invalid slugs
* [https://github.com/artefactual/atom/issues/1701 #1701] Fixed clipboard send feature no longer sending the request data as a form submission
* [https://github.com/artefactual/atom/issues/1698 #1698] Fixed some BS5 theme typography issues and inconsistencies
* [https://github.com/artefactual/atom/issues/1696 #1696] Fixed autocomplete during SKOS import pointing to descriptions instead of taxonomies
* [https://github.com/artefactual/atom/issues/1678 #1678] Updated the CSRF attack message to be more informative
* [https://github.com/artefactual/atom/issues/1673 #1673] Added proper page titles for better accessibility (WCAG (2.4.2))
* [https://github.com/artefactual/atom/issues/1666 #1666] Added error handling for the rename-slug CLI tool
* [https://github.com/artefactual/atom/issues/1661 #1661] Fixed incomplete terms being saved in the taxonomy when adding access points
* [https://github.com/artefactual/atom/issues/1653 #1653] Fixed identifier counter not incrementing when used to modify existing descriptions
* [https://github.com/artefactual/atom/issues/1643 #1643] Fixed the broken media-type option on digital object deriv regeneration task
* [https://github.com/artefactual/atom/issues/1635 #1635] Fixed global search institutional delimiters and advanced search link
* [https://github.com/artefactual/atom/issues/1634 #1634] Removed the repeated re-index warnings on running the build-nested-set task
* [https://github.com/artefactual/atom/issues/1630 #1630] Fixed an ACL check in the REST API's digital object create endpoint that was malformed
* [https://github.com/artefactual/atom/issues/1611 #1611] Added a task description for the password reset task
* [https://github.com/artefactual/atom/issues/1606 #1606] Fixed G4 analytics not tracking pageviews from clicks in full-width treeview
* [https://github.com/artefactual/atom/issues/1605 #1605] Fixed escape special characters setting no longer working in 2.7.x
* [https://github.com/artefactual/atom/issues/1598 #1598] Reduced noise in search results that was there due to indexing inherited creators
* [https://github.com/artefactual/atom/pull/1704 #1704] Fixed multi-line i18n strings
* [https://projects.artefactual.com/issues/13657 #13657] Fixed update function for 'Language and script notes'.
* [https://github.com/artefactual/atom/issues/1688 #1688] Updated BS5 navbar-toggler-icon to Font Awesome icon
* [https://github.com/artefactual/atom/issues/1596 #1596] Fixed RAD template fields not appearing when switching languages

 

''Many thanks to Helder Gomes Silva who reported a security vulnerability for this release''

<admonition type="seealso">
You can read more about how to report a security vulnerability found in AtoM [https://github.com/artefactual/atom/blob/qa/2.x/SECURITY.md here]

If you're a developer interested in committing bug fixes and enhancements back to the public project, check out our guide on how to [[Development/Contribute_code|contribute code]]!
</admonition>

-----

'''Links'''

* AtoM 2.8 tarball direct download: [https://storage.accesstomemory.org/releases/atom-2.8.0.tar.gz atom-2.8.0.tar.gz]
* AtoM [https://www.accesstomemory.org/download/ Downloads] page
* 2.8 [https://www.accesstomemory.org/docs/2.8/admin-manual/installation/ubuntu/ installation] and [https://www.accesstomemory.org/docs/2.8/admin-manual/installation/upgrading/ upgrading] instructions

-----

* [[Releases/Release_announcements|Back to Release announcements]]
* [[Releases|Back to Releases]]
* [[Main Page|AtoM wiki Home]]

[[Category:Releases]]

Releases/Release announcements/Release 2.8.0

2024-01-09T19:11:10Z

Dan: Add page footer with links

{{#pagetitle:Release 2.8.0}}
[[Main Page]] > [[Releases]] > [[Releases/Release announcements]] > Release 2.8.0

'''Release date''': January 8, 2024

'''Download link''': [https://storage.accesstomemory.org/releases/atom-2.8.0.tar.gz atom-2.8.0.tar.gz]

'''Database schema version''': v193

'''Release 2.8''' is a major AtoM release, and includes important security updates for Content Security Policy, updates to the Bootstrap 5 Dominion theme, as well as bug fixes.

----

Visit the [https://www.accesstomemory.org/download/ Downloads] page to download the most recent release, and consult the 2.8 [https://www.accesstomemory.org/docs/2.8/admin-manual/installation/upgrading/ Upgrading] and [https://www.accesstomemory.org/en/docs/2.8/admin-manual/installation/ Installation] guides in our documentation for further information.

An overview of some of the major changes in the 2.8 release is included below.

__TOC__

-----

===Bootstrap 5===

Starting with this release the Bootstrap 5 theme (arDominionB5Plugin) is the default theme for new AtoM installations. Additionally, AtoM is deprecating Boostrap 2 themes starting this release since Bootstrap 2, which was used for the Dominion (arDominionPlugin) and the Archives Canada themes (arArchivesCanadaPlugin), is no longer officially supported.

'''Related documentation'''

* [https://www.accesstomemory.org/en/docs/2.8/admin-manual/customization/theming/#bs2-update Bootstrap 2 update - AtoM Documentation]

===Content Security Policy===

This release adds Content Security Policy headers to AtoM to further improve security for AtoM. Adding this significantly improved AtoM's performance in web security analysis tools such as Mozilla Observatory which now rate it as A+.

[[File:Mozilla-observatory-scan.png|700px]]

Please read the related documentation page for information on configuration or implementing CSP for your own custom theme.

'''Related documentation'''

* [https://www.accesstomemory.org/en/docs/2.8/admin-manual/security/csp-headers/ Content Security Policy - AtoM Documentation]

===General bug fixes and enhancements===

* [https://github.com/artefactual/atom/pull/1542 #1542] Added an authority record rename module
''Community code contributions from Matt Innes''
* [https://github.com/artefactual/atom/issues/1662 #1662] Fixed Dockerfile so that it no longer gives an error when it is trying to install a package from npm
''Community code contributions from Guilherme Arthur Geronimo''

* [https://github.com/artefactual/atom/issues/1684 #1684] Diacritics setting functionality
* [https://github.com/artefactual/atom/issues/1613 #1613] Added a tab for viewing failed jobs
* [https://github.com/artefactual/atom/issues/1632 #1632] Set arDominionB5Plugin to be the default theme for new installations in AtoM
* [https://github.com/artefactual/atom/issues/1642 #1642] Added a Bootstrap 2 deprecation notice in the web UI
* [https://github.com/artefactual/atom/issues/1628 #1628] Added REST API support for physical storage object creation
* [https://github.com/artefactual/atom/issues/1624 #1624] Added a new REST API endpoint that allows changing of an information object's publication status
* [https://projects.artefactual.com/issues/13650 #13650] Increased the PDF indexing limit to 16MB
* Amharic made available in [https://translations.artefactual.com/projects/atom/2-x/ Weblate] for translation
* [https://github.com/artefactual/atom/pull/1646 #1646] Add CSP headers to AtoM responses
* [https://github.com/artefactual/atom/pull/1693 #1693] Update CSP header default to 'report-only'
* [https://github.com/artefactual/atom/pull/1641 #1641] secure and samesite flags added to AtoM cookies
* [https://github.com/artefactual/atom/issues/1715 #1715] Fixed difficult to read job logs
* [https://github.com/artefactual/atom/issues/1713 #1713] Fixed typo in API key label when editing user.
* [https://github.com/artefactual/atom/issues/1710 #1710] Fixed archival institution page's upload limit form has a broken field on BS5 theme
* [https://github.com/artefactual/atom/issues/1703 #1703] Fixed invalid static pages being created with invalid slugs
* [https://github.com/artefactual/atom/issues/1701 #1701] Fixed clipboard send feature no longer sending the request data as a form submission
* [https://github.com/artefactual/atom/issues/1698 #1698] Fixed some BS5 theme typography issues and inconsistencies
* [https://github.com/artefactual/atom/issues/1696 #1696] Fixed autocomplete during SKOS import pointing to descriptions instead of taxonomies
* [https://github.com/artefactual/atom/issues/1678 #1678] Updated the CSRF attack message to be more informative
* [https://github.com/artefactual/atom/issues/1673 #1673] Added proper page titles for better accessibility (WCAG (2.4.2))
* [https://github.com/artefactual/atom/issues/1666 #1666] Added error handling for the rename-slug CLI tool
* [https://github.com/artefactual/atom/issues/1661 #1661] Fixed incomplete terms being saved in the taxonomy when adding access points
* [https://github.com/artefactual/atom/issues/1653 #1653] Fixed identifier counter not incrementing when used to modify existing descriptions
* [https://github.com/artefactual/atom/issues/1643 #1643] Fixed the broken media-type option on digital object deriv regeneration task
* [https://github.com/artefactual/atom/issues/1635 #1635] Fixed global search institutional delimiters and advanced search link
* [https://github.com/artefactual/atom/issues/1634 #1634] Removed the repeated re-index warnings on running the build-nested-set task
* [https://github.com/artefactual/atom/issues/1630 #1630] Fixed an ACL check in the REST API's digital object create endpoint that was malformed
* [https://github.com/artefactual/atom/issues/1611 #1611] Added a task description for the password reset task
* [https://github.com/artefactual/atom/issues/1606 #1606] Fixed G4 analytics not tracking pageviews from clicks in full-width treeview
* [https://github.com/artefactual/atom/issues/1605 #1605] Fixed escape special characters setting no longer working in 2.7.x
* [https://github.com/artefactual/atom/issues/1598 #1598] Reduced noise in search results that was there due to indexing inherited creators
* [https://github.com/artefactual/atom/pull/1704 #1704] Fixed multi-line i18n strings
* [https://projects.artefactual.com/issues/13657 #13657] Fixed update function for 'Language and script notes'.
* [https://github.com/artefactual/atom/issues/1688 #1688] Updated BS5 navbar-toggler-icon to Font Awesome icon
* [https://github.com/artefactual/atom/issues/1596 #1596] Fixed RAD template fields not appearing when switching languages

 

''Many thanks to Helder Gomes Silva who reported a security vulnerability for this release''

<admonition type="seealso">
You can read more about how to report a security vulnerability found in AtoM [https://github.com/artefactual/atom/blob/qa/2.x/SECURITY.md here]

If you're a developer interested in committing bug fixes and enhancements back to the public project, check out our guide on how to [[Development/Contribute_code|contribute code]]!
</admonition>

-----

'''Links'''

* AtoM 2.8 tarball direct download: [https://storage.accesstomemory.org/releases/atom-2.8.0.tar.gz atom-2.8.0.tar.gz]
* AtoM [https://www.accesstomemory.org/download/ Downloads] page
* 2.8 [https://www.accesstomemory.org/docs/2.8/admin-manual/installation/ubuntu/ installation] and [https://www.accesstomemory.org/docs/2.8/admin-manual/installation/upgrading/ upgrading] instructions

-----

* [[Releases/Release_announcements|Back to Release announcements]]
* [[Releases|Back to Releases]]
* [[Main Page|AtoM wiki Home]]

[[Category:Releases]]

Community/Groups

2024-01-08T19:02:32Z

Dan: Remove MidWest user group link, per this forum request: https://groups.google.com/g/ica-atom-users/c/ljPGK0kNkVg/m/zg5bZ517AwAJ

{{#pagetitle:Regional user groups}}
[[Main Page]] > [[Community]] > Community/Groups

This page holds information on local groups organized by AtoM users, including mandates, meeting times, resources, and more.

'''Current groups'''

* [[Community/Group/Australasia|Australiasia User group]]
* [[Community/Groups/Brazil|Brazil User group]]
* [[Community/Groups/Portugal|Portugal User group]]
* [[Community/Groups/SouthAfrica|South Africa User group]]
* [[Community/Groups/UK|UK User group]]
* [[Community/Groups/Sweden | Swedish User group]]
* [[Community/Groups/NA | Joint US Canada User group]]

<admonition type="tip">
Are you considering starting a User group in your region? Let us know about it! Feel free to leave a message in the AtoM [https://groups.google.com/forum/#!forum/ica-atom-users User forum]!
</admonition>

-----

* [[Community|Back to Community]]
* [[Main Page|AtoM wiki home]]

[[Category:Community]]

User:Homero

2024-01-03T13:04:20Z

Dan: Creating user page for new user.

actualmente me desempeño como administrador de redes y servidores.

User:Wcesnr

2024-01-03T13:03:56Z

Dan: Creating user page for new user.

I am a retired linux and database administrator. I recently helped an institution install linux, mysql and Atom ver 2.7. Although I installed atom I know very little about the software operation. I would like to learn more about the inner workings of AtoM.

User:Aminumerique

2024-01-03T13:03:47Z

Dan: Creating user page for new user.

Professional photographer from Montreal, Quebec. François was selected and invited 5 times at the "World Photographers focusing on Beijing". He work in Turkey for the project "Izmir, a legacy for tomorrow" organized by the Arkas Art Center and his photos were exposed at the Arkas Museum. He also participated at Izmir photo days. In 2014, he won first prize at the international photo contest « 2014 Chinese dream in the Eyes of Foreign Friends ».

His book "China: photographic narrative in the Middle Kingdom" is published with Les Editions Cayennes

His photos were published in National Geographic , Financial Times, Le Figaro, Courrier International, Jeune Afrique, etc. He is represented by the Hans Lucas Agency (AFP, REUTERS, etc) He likes to travel and always looking for new challenges. He now lives in Beijing. China.

User:KelliBee123

2024-01-03T13:03:22Z

Dan: Creating user page for new user.

Kelli Babcock is Digital Initiatives Librarian with the University of Toronto where she manages U of T's AtoM "Discover Archives" service (https://discoverarchives.library.utoronto.ca/). She is also involved with the Archives Association of Ontario and serves as Archeion Coordinator for the Ontario AtoM portal (https://www.archeion.ca/).

User:Rob Payne

2024-01-03T13:03:06Z

Dan: Creating user page for new user.

I am the Archivist at Jesus College, Cambridge. I use Atom to catalogue the College's Archives, Silver, Works of Art etc

User:DAYEONG

2023-12-05T13:14:11Z

Dan: Creating user page for new user.

I am a college student. My major is literature informatics.

User:Simphiwe Sithole

2023-12-05T13:13:59Z

Dan: Creating user page for new user.

I am a dedicated and detail-oriented Photo Archivist with a proven track record of preserving and organizing Audio- Visual history. Experienced at handling diverse photographic collections, employing cutting-edge archival techniques, and contributing to the enrichment of cultural heritage. Passionate about the significance of photographs as historical artifacts and committed to making visual narratives accessible to a broad audience.

User:MalenaRibes

2023-12-05T13:13:06Z

Dan: Creating user page for new user.

I am Malena, I am from València and I am studying a Cultural Heritage Master's Degree

User:Marygk

2023-12-05T13:08:03Z

Dan: Creating user page for new user.

Mary Grace Kosta has worked for many years as the Congregational Archivist for the Sisters of St. Joseph in Canada. In 2021, she was the recipient of the Archives Association of Ontario James J. Tallman award, and the Society of American Archivists Sister Claude Lane, O.P Memorial award. She is instrumental in the delivery of archives practicum and museum cataloguing programs for students at the University of Western Ontario. Presently, she is on the steering committee for the Society of American Archivists, Archivists of Religious Collections Section, the Joint US-Canada AtoM Users Group, and the NDSA Communications and Publications Working Group.