AtoM wiki - User contributions [en]

Releases/Release announcements

2020-06-04T16:06:03Z

Crogers: /* AtoM (2.x) releases */

{{#pagetitle: Release announcements }}

[[Main Page]] > [[Releases]] > Releases/Release announcements

Here are detailed lists of the new features, enhancements, and bug fixes in each ICA-AtoM and AtoM release.

<admonition type="tip">
Looking for information on upcoming releases? Check the [[Releases/Roadmap|Roadmap]] page!
</admonition>

== AtoM (2.x) releases ==

AtoM 2 releases are available on the AtoM website, at: https://www.accesstomemory.org/download/

* [[Releases/Release announcements/Release 2.5.4|Release 2.5.4]] (May 5, 2020)
* [[Releases/Release announcements/Release 2.5.3|Release 2.5.3]] (October 30, 2019)
* [[Releases/Release announcements/Release 2.5.2|Release 2.5.2]] (August 29, 2019)
* [[Releases/Release announcements/Release 2.5.1|Release 2.5.1]] (July 3, 2019)
* [[Releases/Release announcements/Release 2.5|Release 2.5]] (May 9, 2019)
* [[Releases/Release announcements/Release 2.4.1|Release 2.4.1]] (November 2, 2018)
* [[Releases/Release announcements/Release 2.4|Release 2.4]] (September 5, 2017)
* [[Releases/Release announcements/Release 2.3.1|Release 2.3.1]] (February 14th, 2017)
* [[Releases/Release announcements/Release 2.3|Release 2.3]] (July 19, 2016)
* [[Releases/Release announcements/Release 2.2.1|Release 2.2.1]] (February 10, 2016)
* [[Releases/Release announcements/Release 2.2|Release 2.2]] (July 10, 2015)
* [[Releases/Release announcements/Release 2.1.2|Release 2.1.2 translation pack]] (February 10, 2015 )
* [[Releases/Release announcements/Release 2.1.1|Release 2.1.1 security upgrade]] (January 28, 2015)
* [[Releases/Release announcements/Release 2.1|Release 2.1.0]] (September 22, 2014)
* [[Releases/Release announcements/Release 2.1.1|Release 2.0.2 security upgrade]] (January 28, 2015)
* [[Releases/Release announcements/Release 2.0.1|Release 2.0.1]] (December 16, 2013)
* [[Releases/Release announcements/Release 2.0.0|Release 2.0.0]] (October 7, 2013)

== ICA-AtoM (1.x) releases ==

For more information about ICA-AtoM, our earlier version of the AtoM software, please visit the ICA-AtoM wiki: https://www.ica-atom.org/doc/Main_Page

* [[Releases/Release announcements/Release 1.4|Release 1.4]] (unscheduled)
* [[Releases/Release announcements/Release 2.1.1|Release 1.3.2 security upgrade]] (January 28, 2015)
* [[Releases/Release announcements/Release 1.3.1|Release 1.3.1]] (May 7, 2013)
* [[Releases/Release announcements/Release 1.3|Release 1.3]] (August 27, 2012)
* [[Releases/Release announcements/Release 1.2.1|Release 1.2.1]] (June 28, 2012)
* [[Releases/Release announcements/Release 1.2|Release 1.2]] (November 29, 2011)
* [[Releases/Release announcements/Release 1.1|Release 1.1]] (November 22, 2010)
* [[Releases/Release announcements/Release 1.0.9-beta|Release 1.0.9-beta]] (May 17, 2010)
* [[Releases/Release announcements/Release 1.0.8-beta|Release 1.0.8-beta]] (November 2, 2009)
* [[Releases/Release announcements/Release 1.0.7-beta|Release 1.0.7-beta]] (June 1, 2009)
* [[Releases/Release announcements/Release 1.0.6-beta|Release 1.0.6-beta]] (April 27, 2009)
* [[Releases/Release announcements/Release 1.0.5-beta|Release 1.0.5-beta]] (March 11, 2009)
* [[Releases/Release announcements/Release 1.0.4-beta|Release 1.0.4-beta]] (November 17, 2008)
* [[Releases/Release announcements/Release 1.0.3-beta|Release 1.0.3-beta]] (October 9, 2008)
* [[Releases/Release announcements/Release 1.0.2-beta|Release 1.0.2-beta]] (August 8, 2008)
* [[Releases/Release announcements/Release 1.0.1-beta|Release 1.0.1-beta]] (July 22, 2008)
* [[Releases/Release announcements/Release 1.0-beta|Release 1.0-beta]] (July 1, 2008)

-----

* [[Releases|Back to Releases]]
* [[Main Page|AtoM wiki home]]

[[Category:Releases]]

Community/Groups/Sweden

2020-03-31T16:06:13Z

Crogers:

{{#pagetitle:AtoM Swedish Users group}}
[[Main Page]] > [[Community]] > [[Community/Groups]] > Community/Groups/Sweden

'''Background'''

The Archivematica and AtoM Swedish User Group started in 2018 to help local Archivematica and AtoM users Sweden and other Nordic countries share experiences.

'''Purpose of group'''

The user group forms a network for organizations using, or preparing to use, Archivematica and AtoM for digital preservation for internal use, or for providing public access to their information.

'''Who is it for?'''

The group is open to any organization or company in Sweden or the Nordics who are willing to share their experiences with these two products and their efforts and challenges for digital preservation.

'''Meetings'''

Twice a year, in spring and fall, one member organization hosts a meeting. Online meetings may be held, depending on member locations. Usually one or two presentations are given, followed by discussions around current topics, new features in latest releases, and proposals for new implementations or other work that may benefit the group or the community.

'''Web presence'''

The user group web site includes an online forum for questions.

* https://www.aoais.se/

'''Contact'''

Info, Swedish User group - [mailto:info@aoais.se info@aoais.se]

-----

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

[[Category:Community]]

Community/Groups/Sweden

2020-03-31T16:04:26Z

Crogers:

{{#pagetitle:AtoM Swedish Users group}}
[[Main Page]] > [[Community]] > [[Community/Groups]] > Community/Groups/Sweden

'''Background'''

The Archivematica and AtoM Swedish User Group started in 2018 to help local Archivematica and AtoM users Sweden and other Nordic countries share experiences.

'''Purpose of group'''

The user group forms a network for organizations using, or preparing to use, Archivematica and AtoM for digital preservation for internal use, or for providing public access to their information.

'''Who is it for?'''

The group is open to any organization or company in Sweden or the Nordics who are willing to share their experiences with these two products and their efforts and challenges for digital preservation.

'''Meetings'''

Twice a year, in spring and fall, one member organization hosts a meeting. Online meetings may be held, depending on member locations. Usually one or two presentations are given, followed by discussions around current topics, new features in latest releases, and proposals for new implementations or other work that may benefit the group or the community.

'''Web presence'''

The user group web site includes an online forum for questions.

* https://www.aoais.se/

'''Contact'''

[mailto:info@aoais.se info@aoais.se]

-----

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

[[Category:Community]]

Community/Groups/Sweden

2020-03-31T16:01:02Z

Crogers: Created page with "{{#pagetitle:AtoM Swedish Users group}} Main Page > Community > Community/Groups > Community/Groups/Sweden '''Background''' The Archivematica and AtoM Swedish..."

{{#pagetitle:AtoM Swedish Users group}}
[[Main Page]] > [[Community]] > [[Community/Groups]] > Community/Groups/Sweden

'''Background'''

The Archivematica and AtoM Swedish User Group started in 2018 to help local Archivematica and AtoM users Sweden and other Nordic countries share experiences.

'''Purpose of group'''

The user group forms a network for organizations using, or preparing to use, Archivematica and AtoM for digital preservation for internal use, or for providing public access to their information.

'''Who is it for?'''

The group is open to any organization or company in Sweden or the Nordics who are willing to share their experiences with these two products and their efforts and challenges for digital preservation.

'''Meetings'''

Twice a year, in spring and fall, one member organization hosts a meeting. Online meetings may be held, depending on member locations. Usually one or two presentations are given, followed by discussions around current topics, new features in latest releases, and proposals for new implementations or other work that may benefit the group or the community.

'''Web presence'''

The user group web site includes an online forum for questions.

* https://www.aoais.se/

'''Contact'''

[mailto: info@aoais.se]

-----

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

[[Category:Community]]

Community/Groups

2020-03-31T15:52:09Z

Crogers:

{{#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/Midwest|Midwest User group]]
* [[Community/Groups/Sweden | Swedish 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]]

Resources/Translation

2019-10-29T15:48:58Z

Crogers:

{{#pagetitle:Contribute translations}}
[[Main Page]] > [[Resources]] > Resources/Translation

Thank you for your interest in contributing user interface translations to the AtoM project! Your contributions help to further AtoM as a multilingual application
with a global reach.

In our continuing efforts to make the process of translating the AtoM interface more efficient, Artefactual Systems has moved from its previous translation
service, [https://www.transifex.com/ Transifex] to [https://www.weblate.org/ Weblate], an open source web-based translation management system supporting
continuous translation from multiple sources. More than one translator can contribute translated strings, making the process fast and easy, and
enabling Artefactual Systems to publish translations more often. Everything is web-based using Weblate, meaning you can access your translation work via any
web browser.

This page will introduce you to the AtoM Weblate translation project, so that you can log in and begin translating. If you have contributed through Transifex in the past, you will notice that the log in process with Weblate is slightly different, but contributing translations continues to be easy and flexible.

<admonition type="seealso">
* Interested in contributing to our project documentation? We have a separate page for that! See:[[Resources/Documentation/Contribute|Contribute documentation]]
* Looking to contribute code to AtoM? See: [[Development/Contribute code|Contribute code]]
* Check out our [https://www.accesstomemory.org/docs User Manual] for information on how to translate content or interface elements locally (in your installation only) - see the Multilingual section.
* Got questions, or find something that's not covered below that you think would be helpful? Let us know via the AtoM [https://groups.google.com/forum/#!forum/ica-atom-users User Forum], or send us an email at [mailto:translate@artefactual.com translate@artefactual.com].
</admonition>

__TOC__

==Browsing Artefactual translations==

'''The AtoM project in Weblate lives here:'''

* https://translations.artefactual.com/

[[File:weblate-first-view.png|frameless|500px|center|First view]]

You can browse the project as an anonymous user without logging in, view available languages, and see what has and hasn't been translated. Click on the <code>Browse</code> button or the <code>atom</code> link to begin. This will take you to the list of components within a given project. The project is
'''atom''' and the component(s) are the active versions of AtoM available for translation. For example purposes, this document shows two components for AtoM translations - '''2.4''' and '''2.5'''.

[[File:atom-components.png|frameless|500px|center|Components]]

While anyone can browse and view translations, only logged in users can contribute and save translations, and are credited for every translation made. To contribute translations, keep reading below!

==Log in to contribute to Artefactual translations==

'''1.''' You do not need to set up an account with Weblate to begin translating for AtoM. Artefactual has configured authentication through GitHub. Navigate to https://translations.artefactual.com/ and click '''Login''' at the top right. Use your GitHub account to log in. If you don't have a GitHub account, you can set one up [https://github.com/ here].

[[File:weblate-github.png|frameless|300px|center|GitHub auth]]

The first time you log in you will be asked to grant access to your GitHub account. Click
Authorize translations.artefactual.com by qubot
You will not see this screen on subsequent logins.

[[File:qubot-authorization.png|frameless|500px|center|Authorization]]

==Set your preferences==

'''2.''' When you log in you will see the Dashboard and menu options.

[[File:first-login.png|frameless|500px|center|Weblate dashboard]]

You can set your preferences by clicking on "Manage languages", "Manage watched projects", or "Settings" and selecting your preferences in the navigation tabs.
[[File:weblate-manage-settings.png|frameless|500px|center|Set your preferences]]

Each of these choices takes you to the settings screen. The three navigation tabs you will want to review before you start translating are '''Languages''', '''Subscriptions''', and '''Preferences'''.

'''3.''' From the '''Language''' navigation tab, choose the languages you wish to translate and those you may want to follow. Choose your primary languages from the '''Translated languages''' box. These are the languages you speak fluently and wish to translate. They will show up on your dashboard as "Watched languages" when you log in or navigate to the dashboard. If there are other languages you want to follow, choose those in the '''Secondary languages''' box. Strings that have been translated in these languages will appear on the translation page (see [[#Begin translating]]). When you have made your selections, click <code>Save</code>. You can change these settings at any time by returning to the Languages tab in settings.

[[File:weblate-language-tab.png|frameless|500px|center|Language tab]]

'''4.''' From the '''Subscription''' tab, you can choose translation project(s) you wish to follow and click <code>Save</code>. Currently Artefactual has only one translation project - '''atom'''. Even though there is currently only one project, choose it and click <code>Save</code> so that it will appear in your dashboard.

You can also specify '''notifications''' that you would like to receive. Notifications are selected from the '''Subscription''' tab below the Projects section. Translation notifications apply to your primary languages. This can be especially useful for users who are designated reviewers (see [[#Become a reviewer]]). When you are done, save your selections.

[[File:weblate-subscription-tab.png|frameless|500px|center|Subscription tab]]

These settings can be changed or updated at any time by returning to the Subscriptions tab in settings.

'''5.''' Once you have chosen languages and subscriptions (projects), these will appear on your dashboard, showing the status of translation for each of your chosen languages and projects. You will also see a '''Watched projects''' dropdown list on the main navigation bar at the top of the page; all Artefactual translation projects are available from the '''Projects''' dropdown list, and all available languages from the '''Languages''' dropdown list.

In the screenshot below, the user has selected three primary languages - these will always be shown on the dashboard for the available components of watched projects (subscriptions) when that user logs in.

[[File:weblate-dashboard2.png|frameless|500px|center|Projects dashboard]]

<admonition type="tip">
Don't see a language you would like to provide translations for? We have instructions on how you can request new languages in the section [[#Requesting new languages|below]]!
</admonition>

'''6.''' From the '''Preferences''' tab you can choose how you would like the translation screen to appear. '''Translation editor mode''' offers two choices - '''Full editor''' mode and '''Zen''' mode. These are described below in [[#Begin translating|Begin translating]]. You can also choose what information appears on your dashboard. When you are finished making your selections, click <code>Save</code>.

<admonition type="seealso">
Weblate has its own help documentation - here's a help page on getting started:

* [https://docs.weblate.org/en/latest/user/index.html Weblate Documentation]
</admonition>

===Requesting new languages===

'''7.''' Don't see a language you would like to provide translations for? If you would like to translate in a language that is not currently available in our Weblate project, you can request that it be added. To start a request, click on the project component in which you plan to add translations (currently 2.4 and 2.5). From the '''Tools''' menus select <code>Start new translation</code> or scroll to the bottom of the list of languages and click on <code>Start new translation</code> at the bottom of the page.

From the tools menu:

[[File:request-language-tools.png|frameless|400px|center|Request new language]]

From the bottom of the page:

[[File:request-language.png|frameless|400px|center|Request new language]]

Select the language(s) you would like added to the project and click '''Request new translation'''.

[[File:request-language2.png|frameless|500px|center|Request Acholi]]

If the languages listed still do not include one that you want to translate, click the link <code>Can't find your language in the list above?</code>. View a list of all languages supported in AtoM, with their corresponding language codes, here:

* [https://gist.github.com/sevein/d248525a66ef793c93d8 AtoM supported languages]

Complete the Weblate form with as much detail as possible using information from this list and click <code>Send</code>. Your request will be received by Artefactual.

[[File:request-language3.png|frameless|500px|center|Language contact]]

<admonition type="important"> Please review the options available in the list prior to requesting a new language! In many cases, we have had requests for different locales (for example, requesting "fr_FR" for France French, instead of working in the existing "fr" French project), but AtoM does not always support these very well. If at all possible, please work within the existing projects, or try to select the most generic option, without locale codes. We'll work with you if there are no other options, of course - but if you can avoid using a specific locale, it will make merging and maintaining your translations in AtoM much easier! </admonition>

==Begin translating==

'''8.''' From your dashboard you can navigate to the translation screen in two ways.

[[File:weblate-dashboard3.png|frameless|500px|center|Projects dashboard]]

Click on your choice of component and language in the '''Component''' column. This will take you to the '''Overview''' screen of the main translation page for that language. Here you will see links that can take you to the translation screen. Clicking on the <code>Translate</code> button will take you to the set of strings needing action. You can choose different filtered set by clicking any of the links under '''Strings to check'''.

[[File:weblate-translation-links.png|frameless|500px|center|Translating]]

The second way to reach the translation screen from your dashboard is to click on the <code>Translate</code> button to the right of the component/language you want to translate. This will take you directly to the translation screen and strings needing action. You can change the filter on strings for translation from the dropdown menu at the top left.

'''9.''' Once you have reached the translation screen you will see the first item needing translation. The default view is '''Full editor''' mode; the screen shows any watched (secondary) languages you have set, the source string to be translated, and a text field in which you can enter your translation. In this screenshot, there are no watched languages.

[[File:full-editor-mode.png|frameless|500px|center|Full editor]]

Many source strings include variables, e.g. %1%, or (%3% b). These should be included in the translated string in the appropriate position for the destination language, e.g. from the current example
%1%Download%2% (%3% b)
will be translated as
%1%Sækja%2% (%3% b)

When you have entered your translation, click <code>Save</code>. Your translation will be saved and checked by Weblate's quality checks. If there are any failing checks a message will appear. You can then edit your translation and resave, or leave the translation as is and move on to the next source string. You can skip any strings you do not want to translate.

<admonition type="note"> All translations are saved in Weblate regardless of failing checks. Weblate runs a wide range of quality checks on each translation, including syntax, length, consistency, duplication and more, taking into account special rules for different languages. See types of translation checks [https://docs.weblate.org/en/latest/user/checks.html#translation-checks here]. Any translation that has not been approved by a designated reviewer can be edited by any logged in user, including fixing failed checks or editing a saved translation. You can see the status of a translation by hovering over the '''State''' next to a translation on the translation screen. Translation states include <code>Message is approved</code> (green check mark, translation cannot be edited);
<code>Message is translated</code> (blue check mark, translation can be edited); <code>Message has failing checks</code> (brown exclamation mark, translation can be edited); and <code>Message not translated</code> (red x).

[[File:translation-states.png|frameless|300px|center|Translation states]]

</admonition>

'''10.''' For faster translation switch to '''Zen''' mode by clicking <code>Zen</code> at the top right of the screen. In Zen mode each item shows (1) the source string (location in the Artefactual database), (2) translations in any languages you are watching, (3) the term to be translated, and (4) the edit area for your translation.

[[File:edit-screen.png|frameless|500px|center|Adding Translations]]

You can switch from Zen mode back to Full Editor mode by clicking <code>Exit Zen</code>. .

In Zen mode your translation will be saved automatically, and checked, once you move your cursor out of the translation field.

[[File:weblate-translated-word.png|frameless|500px|center|Translated word]]

If your translation fails any checks, a red "x" will appear. Scrolling over the "x" will highlight the syntax error.

[[File:weblate-translation-fail.png|frameless|300px|center|Failed translation]]

You can work through the list of strings needing translation, choosing those you want to translate.

<admonition type="important"> When you are entering translations in '''Zen''' mode, your entries will be saved automatically. When you are in '''Full editor''' mode, however, you need to save the translation in the primary language. </admonition>

'''11.''' You can contribute translations in any language, even those you have not set as primary or secondary. Clicking on a project component will bring up a list of all languages in the project. Click <code>Translate</code> next to any language to go to the translation screen for that language. Click <code>Watched projects</code> from the main menu bar, select <code>atom</code>, and then select the component you want.

[[File:all-languages.png|frameless|500px|center|All languages]]

You can access a particular source string in any other language by starting from the translation screen of one of your primary languages. Exit '''Zen''' mode if necessary. From Full Editor mode you can then enter your translation in the primary language, and by scrolling down to <code>Other languages</code> enter or edit translations for that same string in as many languages as you like by clicking <code>Edit</code> to the right of the translation field for each language. If you do not want to edit the string that is offered, click on <code>Skip</code> in the main translation box. Move to the next string by clicking the counter at the top of the screen.

[[File:weblate-translate-many.png|frameless|500px|center|Translating in several languages]]

<admonition type="note"> Weblate supports keyboard shortcuts to make navigating through the site quicker and more efficient. You can see a complete list of shortcuts [https://docs.weblate.org/en/weblate-3.2.2/user/translating.html#keyboard-shortcuts here]. </admonition>

'''12.''' Your translations are all saved in our database. However, before they can be included into the public branch of AtoM they need to be approved by designated reviewers, and then pushed to AtoM by Artefactual administrators.

==Become a reviewer==

'''13.''' Before translations from Weblate are added to AtoM they must be approved by designated reviewers. Reviewers are community members who are willing the review and approve translations in languages in which they are proficient. Once a translation is approved it cannot be changed (except by an administrator). These approved and locked translations are then ready to be incorporated into the main AtoM site. This will be done periodically by Artefactual.

'''14.''' All logged-in users at https://translations.artefactual.com have translator privileges that allow them to enter translations and edit their own and others' translations prior to approval. Reviewers have the same privileges as translators, as well as privileges that allow them to approve (and therefore lock) translations. If you would like to be a reviewer, log into the [https://translations.artefactual.com translation project]. This will ensure that your email is registered with the site as a translator, and visible to the Artefactual administrators. Then send us an email at [mailto:translate@artefactual.com translate@artefactual.com] so that we can grant you reviewer privileges.

'''15.''' Once you have reviewer privileges you can search for strings to be approved in your primary language(s). Click on <code>Strings waiting for review</code> from the translation screen in your chosen language. In Full editor mode this link appears in the list of strings to check.

[[File:waiting-for-review-full.png|frameless|500px|center|Strings needing approval]]

If you have set Zen mode as your default view, you can select strings waiting for review from the drop down list at the top of the page.

[[File:waiting-for-review-zen.png|frameless|500px|center|Strings needing approval]]

For each string needing approval, you can click the radio button <code>Approved</code> to lock the translation for that string. Remember to click <code>Save</code> if you are using Full editor mode.

'''16.''' Several times through the year Artefactual developers will push approved strings into the main AtoM branch. Reviewers will receive an email several weeks before these events to request that they approve new translations in their designated languages.

==FAQs==

Below you'll find some responses to frequently asked questions about Weblate, and our move from Transifex. You can also explore the Weblate documentation - here are a few handy links:

* [https://docs.weblate.org/en/weblate-2.5/user/index.html Weblate: Translator's guide]
* [https://docs.weblate.org/en/latest/faq.html#usage Weblate: FAQ on usage]

<admonition type="tip">
Have a question you don't see addressed here? Let us know via the AtoM [https://groups.google.com/forum/#!forum/ica-atom-users User Forum], or send us an email at [mailto:translate@artefactual.com translate@artefactual.com].
</admonition>

===I just got comfortable using Transifex - Why are you moving from Transifex to Weblate?===

Artefactual was previously able to use Transifex because they offered free plans to open source projects. As of 2018, Transifex changed its policy to limit these free accounts to small projects with 10 collaborators or less - and because AtoM has a vibrant translation community with dozens of translators, we no longer qualify. A [https://www.transifex.com/pricing/ paid plan with Transifex] that could support as many collaborators as we need would cost at least $1,500 USD a month to maintain, which would represent a serious drain on the resources we have to maintain the project. Instead, we have chosen to move to an open source platform, Weblate, so we can host and manage the application ourselves.

===Why can I only log in through GitHub?===

Now that Artefactual is hosting and maintaining our translation infrastructure, we expect that many bots, web crawlers, and spam accounts would hit our user registration page, requiring significant time and energy to manage. GitHub is a long-established code repository platform that has existing filters and checks in place to reduce these kinds of spurious registration attempts, so we don't have to do it manually.

Artefactual already makes use of GitHub for AtoM's [https://github.com/artefactual/atom/ code repository] and [https://github.com/artefactual/atom-docs/ documentation], and going forward, the translation strings for each release will also be maintained in a separate [https://github.com/artefactual/atom-translations GitHub repository].

===There are two components in the Weblate AtoM project - which one should I use?===

Generally, Artefactual offers two kinds of releases: a major release (e.g. 2.3, 2.4, 2.5, etc) and sometimes, a minor release (e.g. 2.3.1, 2.4.1, etc). Major releases include new features and enhancements, while in most cases, minor releases will only include bug fixes. Both releases ''may'' include translation updates if they have been provided by our community. In Weblate, components will only have major numbers (e.g. 2.4, 2.5, 2.6, etc) and will be used to prepare any releases, major or minor, relating to the component number.

In most cases, there should only be one unlocked component in Weblate's AtoM project - if we've released 2.5 for example but expect to create a 2.5.1 release, we will likely not open a 2.6 component until 2.5.1 has been released, so that translators don't have add the same translations to both components. However, there may be rare cases where we have two components open and unlocked. This might occur if, for example, we've already added a 2.6 component, but then discover an issue in 2.5 big enough to warrant a 2.5.1 release, and want to allow our translator community an opportunity to supplement or update existing translations in that release as well.

In this rare case, it's up to you which component you choose to work in - but it should be informed by your goals, and a clear understanding of the consequences.

<admonition type="important">
If there are 2 open components in Weblate, then translations added to one component will '''not''' automatically be added to the other, even if it is for an earlier release. The only way to have your translations available in both components (and both releases) will be to manually add your translations to both components.
</admonition>

If there is a 2.5 and a 2.6 AtoM component in Weblate, then the 2.5 component will be used for a 2.5 minor release (i.e. 2.5.1, 2.5.2), and the 2.6 component will be used for the next major release (i.e. 2.6.0). In the case where there are 2 open components, those translation strings added in the earlier version will ''not'' be carried forward into the later component - but the later component ''will'' be used to create the next component in the future, meaning the strings will be carried forward into subsequent releases.

Because of this, we recommend only working in the earlier component if you want to fix poor translations or make other minor improvements in the next minor release so you can access them more quickly (since this will be the next public release), and you don't mind losing them in the next release or manually making the same changes in the later component. Otherwise, we recommend focusing on the latest component available - this ensures that your translations will be included in future releases as well.

===What's the difference between a reviewer and translator?===

Every person who logs into our AtoM translation project through GitHub will automatically be a translator. That means you can choose projects, and primary and secondary languages to watch, add translations in your chosen language(s) and any other languages you have knowledge of, and request that new languages that are currently unavailable in the project be added to it. When you add a translation, that string is automatically saved in the Weblate database and becomes visible to everyone. It can still be edited by you or by other translators. However, it will not be part of the next Artefactual commit until it has been approved. That is the role of a reviewer.

Reviewers have all the same privileges as translators, as well as the ability to approve translations. Once a reviewer has approved a translation it will no longer be editable, and it will be part of the next Artefactual commit.

===Why do I need a reviewer?===

Artefactual has chosen to use this model in order to maintain quality control on translations. If you would like to be a reviewer, please let us know by sending an email to [mailto:translate@artefactual.com translate@artefactual.com].

===What do I do if there are no reviewers on my language?===

We track who is a reviewer for any given language, and will contact translators directly if reviewers are needed for a language. If you find yourself completing translations with no reviewer for your chosen language(s), please feel free to contact us at [mailto:translate@artefactual.com translate@artefactual.com].

===Why can't i translate in a specific sublocale (like ES_es)?===

AtoM was built using the [https://symfony.com/legacy Symfony 1.x] PHP framework, and we borrow its internationalization (or i18n) functionality to implement AtoM's ability to translate content into multiple languages. However, as an older framework, Symfony's support for specific sublocales is limited. AtoM cannot at this time support a language that is not supported by the underlying Symfony i18n framework.

===Where can I find a list of supported languages for translation in AtoM?===

We have a list of all of AtoM's supported languages, and their 2-letter ISO 639-1 language codes, here:

* http://bit.ly/AtoM-langs

===How do I request a new language?===

First, please make sure that the language you would like to request is supported in AtoM - see this list:

* http://bit.ly/AtoM-langs

If it is supported, but you don't see it in Weblate, please see the [[#Requesting new languages|"Requesting new languages"]] section above. You can request a new language via Weblate - here's a quick summary of the steps outlined above:

* Navigate to the AtoM component in which you want to work
* Click the "Start new translation" button at the bottom of the page
* In the Language selection page that will appear, click the "Can't find your language in the list above?" hyperlink
* Weblate will open a Contact form - please fill out the details of your request. Artefactual will receive it and review the request. If you've requested a language that AtoM supports (full list available [http://bit.ly/AtoM-langs here]), we'll approve it!

See the documentation section [[Resources/Translation#Set_your_preferences|above]] for more details and screenshots.

Alternatively, feel free to email us at [mailto:translate@artefactual.com translate@artefactual.com] and we will be happy to add a new language for you!

----

'''Thank you''' for helping us translate AtoM - it is through your participation that we can make AtoM a truly international application!

Got questions, or find something that's not covered below that you think would be helpful? Let us know via the AtoM [https://groups.google.com/forum/#!forum/ica-atom-users User Forum], or send us an email at [mailto:translate@artefactual.com translate@artefactual.com].

-----

* [[Resources|Back to Resources]]
* [[Main_Page|AtoM wiki home]]

[[Category:Resources]]

Releases/Release announcements

2019-08-29T16:01:35Z

Crogers:

{{#pagetitle: Release announcements }}

[[Main Page]] > [[Releases]] > Releases/Release announcements

Here are detailed lists of the new features, enhancements, and bug fixes in each ICA-AtoM and AtoM release.

<admonition type="tip">
Looking for information on upcoming releases? Check the [[Releases/Roadmap|Roadmap]] page!
</admonition>

== AtoM (2.x) releases ==

AtoM 2 releases are available on the AtoM website, at: https://www.accesstomemory.org/download/

* [[Releases/Release announcements/Release 2.5.2|Release 2.5.2]] (August 29, 2019)
* [[Releases/Release announcements/Release 2.5.1|Release 2.5.1]] (July 3, 2019)
* [[Releases/Release announcements/Release 2.5|Release 2.5]] (May 9, 2019)
* [[Releases/Release announcements/Release 2.4.1|Release 2.4.1]] (November 2, 2018)
* [[Releases/Release announcements/Release 2.4|Release 2.4]] (September 5, 2017)
* [[Releases/Release announcements/Release 2.3.1|Release 2.3.1]] (February 14th, 2017)
* [[Releases/Release announcements/Release 2.3|Release 2.3]] (July 19, 2016)
* [[Releases/Release announcements/Release 2.2.1|Release 2.2.1]] (February 10, 2016)
* [[Releases/Release announcements/Release 2.2|Release 2.2]] (July 10, 2015)
* [[Releases/Release announcements/Release 2.1.2|Release 2.1.2 translation pack]] (February 10, 2015 )
* [[Releases/Release announcements/Release 2.1.1|Release 2.1.1 security upgrade]] (January 28, 2015)
* [[Releases/Release announcements/Release 2.1|Release 2.1.0]] (September 22, 2014)
* [[Releases/Release announcements/Release 2.1.1|Release 2.0.2 security upgrade]] (January 28, 2015)
* [[Releases/Release announcements/Release 2.0.1|Release 2.0.1]] (December 16, 2013)
* [[Releases/Release announcements/Release 2.0.0|Release 2.0.0]] (October 7, 2013)

== ICA-AtoM (1.x) releases ==

For more information about ICA-AtoM, our earlier version of the AtoM software, please visit the ICA-AtoM wiki: https://www.ica-atom.org/doc/Main_Page

* [[Releases/Release announcements/Release 1.4|Release 1.4]] (unscheduled)
* [[Releases/Release announcements/Release 2.1.1|Release 1.3.2 security upgrade]] (January 28, 2015)
* [[Releases/Release announcements/Release 1.3.1|Release 1.3.1]] (May 7, 2013)
* [[Releases/Release announcements/Release 1.3|Release 1.3]] (August 27, 2012)
* [[Releases/Release announcements/Release 1.2.1|Release 1.2.1]] (June 28, 2012)
* [[Releases/Release announcements/Release 1.2|Release 1.2]] (November 29, 2011)
* [[Releases/Release announcements/Release 1.1|Release 1.1]] (November 22, 2010)
* [[Releases/Release announcements/Release 1.0.9-beta|Release 1.0.9-beta]] (May 17, 2010)
* [[Releases/Release announcements/Release 1.0.8-beta|Release 1.0.8-beta]] (November 2, 2009)
* [[Releases/Release announcements/Release 1.0.7-beta|Release 1.0.7-beta]] (June 1, 2009)
* [[Releases/Release announcements/Release 1.0.6-beta|Release 1.0.6-beta]] (April 27, 2009)
* [[Releases/Release announcements/Release 1.0.5-beta|Release 1.0.5-beta]] (March 11, 2009)
* [[Releases/Release announcements/Release 1.0.4-beta|Release 1.0.4-beta]] (November 17, 2008)
* [[Releases/Release announcements/Release 1.0.3-beta|Release 1.0.3-beta]] (October 9, 2008)
* [[Releases/Release announcements/Release 1.0.2-beta|Release 1.0.2-beta]] (August 8, 2008)
* [[Releases/Release announcements/Release 1.0.1-beta|Release 1.0.1-beta]] (July 22, 2008)
* [[Releases/Release announcements/Release 1.0-beta|Release 1.0-beta]] (July 1, 2008)

-----

* [[Releases|Back to Releases]]
* [[Main Page|AtoM wiki home]]

[[Category:Releases]]

Releases/Release announcements/Release 2.5.2

2019-08-28T16:20:07Z

Crogers:

{{#pagetitle:Release 2.5.2}}
[[Main Page]] > [[Releases]] > [[Releases/Release announcements]] > Release 2.5.2

'''Release date''': August 28, 2019

'''Download link''': [http://storage.accesstomemory.org/releases/atom-2.5.2.tar.gz atom-2.5.2.tar.gz]

'''Release 2.5.2''' is a security patch release for AtoM 2.5. We've also closed a number of bug tickets in order to address issues that arose with the 2.5 release - you can view more details on each ticket in our issue tracker at the following links:

* [https://projects.artefactual.com/versions/129 Release 2.5.2 Roadmap / Overview]
* [http://bit.ly/2H76iKz 2.5.2 issues organized by category]

Visit the [https://www.accesstomemory.org/download/ Downloads] page to download the most recent release, and consult the 2.5 [https://www.accesstomemory.org/docs/2.5/admin-manual/installation/upgrading/ Upgrading] and [https://www.accesstomemory.org/docs/2.5/admin-manual/installation/linux/linux/ Installation] guides in our documentation for further information.

==Security patch==

A regression has been discovered in releases [[Releases/Release announcements/Release 2.5|2.5]] and [[Releases/Release announcements/Release 2.5.1|2.5.1]] that exposes AtoM users to a potential cross-site scripting ([https://en.wikipedia.org/wiki/Cross-site_scripting XSS]) vulnerability. This release includes patches that resolve the issue. '''We encourage all 2.5 users to upgrade as soon as possible'''.

The regression was introduced with the addition of full Markdown support (issue #12148) in the [[Releases/Release announcements/Release 2.5|2.5]] release. We have addressed the issue in this release with the following 2 commits, which a developer could potentially apply as a patch to an earlier 2.5.x release in lieu of upgrading:

* https://github.com/artefactual/atom/commit/c823af007ed28beeb406af8ba2cb788b107ddc9f
* https://github.com/artefactual/atom/commit/f55a9eeda2b587fb70217e8feb4a8f13c41542c1

For those who are concerned about this issue but unable to upgrade at this time, disabling Markdown via ''Admin > Settings > Markdown'' will also circumvent the issue until upgrading is possible.

==New Security Policy==

The security issue above was discovered thanks to hepful input from our AtoM community - thank you!

In order to provide consistent reporting and disclosure practices in the future, the AtoM project has developed a new Security Policy, which can be found in the AtoM code repository:

* [https://github.com/artefactual/atom/blob/HEAD/SECURITY.md View AtoM's new Security reporting and disclosure policy]

<admonition type="tip">
'''The short version of the policy:'''

* If you discover what you think is a security vulnerability in AtoM, please email us at [mailto:security@artefactual.com security@artefactual.com]
* Please ''do not'' post about the issue in our public forum or file a public issue in our GitHub repository - this may announce the vulnerability to malicious actors before we have had a chance to review the issue and prepare a fix
* We will disclose any security vulnerabilities after we have evaluated them and, if needed, prepared a patch to solve the issue. We will make this patch available for the development branch and the most recent stable release
* Depending on the severity of the issue we may also provide a patch for older stable releases
* The full policy can be reviewed [https://github.com/artefactual/atom/blob/HEAD/SECURITY.md here]
</admonition>

==Updated job scheduler configuration==

AtoM relies on a job scheduler called [http://gearman.org/ Gearman] in order to execute certain long-running tasks asynchronously to guarantee that web requests are handled promptly and work loads can be distributed across multiple machines. Examples include imports via the user interface, finding aid and report generation, rights inheritance, date calculation, [https://www.archivematica.org/ Archivematica] DIP uploads, and more. You can read more about the installation process in our documentation [https://www.accesstomemory.org/docs/latest/admin-manual/installation/asynchronous-jobs/ here].

As AtoM shifts to using the job scheduler in more areas of the application, we have seen an increase of posts in the user forum of users reporting 500 errors due to the atom-worker requiring a restart. After some research, user input via the forum, and internal testing, we have revised the config file for the atom-worker service in systemd (for Ubuntu 16.04 and 18.04 installations), which should resolve the majority of these issues, and prevent the atom-worker from dying as often as previously.

You can find the updated configuration block in our documentation here:

* https://www.accesstomemory.org/docs/2.5/admin-manual/installation/asynchronous-jobs/#systemd-ubuntu-16-04-18-04

As part of your upgrade, we recommend that you review the service configuration (located at <code>/usr/lib/systemd/system/atom-worker.service</code>) and update the atom-worker configuration as well!

==Bug fixes and minor enhancements==

<admonition type="tip">
Issue numbers associated with new features and bug fixes listed below refer to the AtoM project [https://projects.artefactual.com/projects/atom/issues issue tracker]. Artefactual uses the issue tracker to track bug reports, development tasks, feature requirements, quality assurance testing, and related development discussion. You can use the numbers to search for the related issue ticket in our Issue tracker - often the tickets will include more information on how the feature was implemented.
</admonition>

* #12782 - AtoM returns 200 HTTP status instead of 403 when bots and curl requests attempt to access restricted pages
* #12830 - Docker: qtSwordPluginWorker ability never gets added to the worker
* #13067 - Archivematica: DC metadata not imported into AtoM when DIP created from transfer in backlog
* #13068 - Archivematica: AtoM not creating information object for re-ingested AIPs with updated metadata
* #13070 - Copyright pop-up HTML content not rendering
* #13106 - Markdown not working on edit theme page of repository records
* #13108 - Job scheduler can't find worker after site title changes
* #13109 - AtoM worker service is unstable in systemd
* #13113 - User menu breaks when there are no login, logout, or myProfile menu options
* #13117 - Notify users of the need to restart the AtoM worker when the qtSwordPlugin is enabled/disabled via the user interface
* #13119 - Upgrade Docker image and Docker Compose env to work with latest dependencies
* #13124 - Full-width treeview paging button not shown for public users
* #13131 - description and actor browse pages broken when markdown is disabled and more than one filter applied
* #13137 - User interface layout broken by long site titles or large logos
* #13139 - Add a security reporting policy to the AtoM code repository
* #13143 - REST API returns 200 status in error responses
* #13144 - Creating a digital object without a path raises an error
* #13145 - Digital object metadata is not visible when Markdown is disabled

And more!

<admonition type="seealso">
For a full list of issues related to the 2.5.2 release, see the following links to our issue tracker:

* [https://projects.artefactual.com/versions/129 Release 2.5.2 Roadmap / Overview]
* [http://bit.ly/2H76iKz 2.5.2 issues organized by category]
</admonition>

-----

* [[Releases/Release_announcements|Back to Release announcements]]
* [[Releases|Back to Releases]]
* [[Main Page|AtoM wiki Home]]

[[Category:Releases]]

Releases/Release announcements/Release 2.5.1

2019-07-04T15:42:33Z

Crogers: Created page with "{{#pagetitle:Release 2.5.1}} Main Page > Releases > Releases/Release announcements > Release 2.5.1 '''Release date''': July 3, 2019 '''Download link''': [http://..."

{{#pagetitle:Release 2.5.1}}
[[Main Page]] > [[Releases]] > [[Releases/Release announcements]] > Release 2.5.1

'''Release date''': July 3, 2019

'''Download link''': [http://storage.accesstomemory.org/releases/atom-2.5.1.tar.gz atom-2.5.1.tar.gz]

'''Release 2.5.1''' is a bug fix release for AtoM 2.5. We've closed a number of bug tickets in order to address issues that arose with the 2.5 release - you can view more details on each ticket in our issue tracker at the following links:

* [https://projects.artefactual.com/versions/128 Release 2.5.1 Roadmap / Overview]

Visit the [https://www.accesstomemory.org/download/ Downloads] page to download the most recent release, and consult the 2.5 [https://www.accesstomemory.org/docs/2.5/admin-manual/installation/upgrading/ Upgrading] and [https://www.accesstomemory.org/docs/2.5/admin-manual/installation/linux/linux/ Installation] guides in our documentation for further information.

Releases/Release announcements

2019-07-04T15:39:03Z

Crogers:

{{#pagetitle: Release announcements }}

[[Main Page]] > [[Releases]] > Releases/Release announcements

Here are detailed lists of the new features, enhancements, and bug fixes in each ICA-AtoM and AtoM release.

<admonition type="tip">
Looking for information on upcoming releases? Check the [[Releases/Roadmap|Roadmap]] page!
</admonition>

== AtoM (2.x) releases ==

AtoM 2 releases are available on the AtoM website, at: https://www.accesstomemory.org/download/

* [[Releases/Release announcements/Release 2.5.1|Release 2.5.1]] (July 3, 2019)
* [[Releases/Release announcements/Release 2.5|Release 2.5]] (May 9, 2019)
* [[Releases/Release announcements/Release 2.4.1|Release 2.4.1]] (November 2, 2018)
* [[Releases/Release announcements/Release 2.4|Release 2.4]] (September 5, 2017)
* [[Releases/Release announcements/Release 2.3.1|Release 2.3.1]] (February 14th, 2017)
* [[Releases/Release announcements/Release 2.3|Release 2.3]] (July 19, 2016)
* [[Releases/Release announcements/Release 2.2.1|Release 2.2.1]] (February 10, 2016)
* [[Releases/Release announcements/Release 2.2|Release 2.2]] (July 10, 2015)
* [[Releases/Release announcements/Release 2.1.2|Release 2.1.2 translation pack]] (February 10, 2015 )
* [[Releases/Release announcements/Release 2.1.1|Release 2.1.1 security upgrade]] (January 28, 2015)
* [[Releases/Release announcements/Release 2.1|Release 2.1.0]] (September 22, 2014)
* [[Releases/Release announcements/Release 2.1.1|Release 2.0.2 security upgrade]] (January 28, 2015)
* [[Releases/Release announcements/Release 2.0.1|Release 2.0.1]] (December 16, 2013)
* [[Releases/Release announcements/Release 2.0.0|Release 2.0.0]] (October 7, 2013)

== ICA-AtoM (1.x) releases ==

For more information about ICA-AtoM, our earlier version of the AtoM software, please visit the ICA-AtoM wiki: https://www.ica-atom.org/doc/Main_Page

* [[Releases/Release announcements/Release 1.4|Release 1.4]] (unscheduled)
* [[Releases/Release announcements/Release 2.1.1|Release 1.3.2 security upgrade]] (January 28, 2015)
* [[Releases/Release announcements/Release 1.3.1|Release 1.3.1]] (May 7, 2013)
* [[Releases/Release announcements/Release 1.3|Release 1.3]] (August 27, 2012)
* [[Releases/Release announcements/Release 1.2.1|Release 1.2.1]] (June 28, 2012)
* [[Releases/Release announcements/Release 1.2|Release 1.2]] (November 29, 2011)
* [[Releases/Release announcements/Release 1.1|Release 1.1]] (November 22, 2010)
* [[Releases/Release announcements/Release 1.0.9-beta|Release 1.0.9-beta]] (May 17, 2010)
* [[Releases/Release announcements/Release 1.0.8-beta|Release 1.0.8-beta]] (November 2, 2009)
* [[Releases/Release announcements/Release 1.0.7-beta|Release 1.0.7-beta]] (June 1, 2009)
* [[Releases/Release announcements/Release 1.0.6-beta|Release 1.0.6-beta]] (April 27, 2009)
* [[Releases/Release announcements/Release 1.0.5-beta|Release 1.0.5-beta]] (March 11, 2009)
* [[Releases/Release announcements/Release 1.0.4-beta|Release 1.0.4-beta]] (November 17, 2008)
* [[Releases/Release announcements/Release 1.0.3-beta|Release 1.0.3-beta]] (October 9, 2008)
* [[Releases/Release announcements/Release 1.0.2-beta|Release 1.0.2-beta]] (August 8, 2008)
* [[Releases/Release announcements/Release 1.0.1-beta|Release 1.0.1-beta]] (July 22, 2008)
* [[Releases/Release announcements/Release 1.0-beta|Release 1.0-beta]] (July 1, 2008)

-----

* [[Releases|Back to Releases]]
* [[Main Page|AtoM wiki home]]

[[Category:Releases]]

Community/Camps/London2019

2019-06-18T16:43:53Z

Crogers:

{{#pagetitle:AtoM Camp London 2019}}
[[Main Page]] > [[Community]] > [[Community/Camps]] > London2019

We're excited to announce our fourth AtoM Camp, co-hosted by the [https://www.westminster.ac.uk/ University of Westminster] and Artefactual! Inspired by similar events like Hydra Camp, Islandora Camp and Fedora Camp, AtoM Camp is intended to provide a space for anyone interested in or currently using AtoM to come together, learn about the platform from other users, and share their experiences.

<admonition type="tip">
'''We're also hosting an Archivematica Camp in London!''' July 10-12, 2019, at the [http://www.lse.ac.uk/ London School of Economics]. For more details, see the Archivematica wiki:

* https://wiki.archivematica.org/Community/Camps/London2019

</admonition>

== Dates & Location ==
'''July 15th -17th, 2019''' - '''[https://www.westminster.ac.uk/business/facilities-and-services/venues-for-hire/conference-and-venues/cavendish Cavendish Campus]''' at the '''[https://www.westminster.ac.uk/ University of Westminster]'''

115 New Cavendish Street, London, United Kingdom, W1W 6UW

'''Rooms:''' C2.07, C2.06

Situated below the [https://en.wikipedia.org/wiki/BT_Tower BT Tower] is Cavendish Campus, a modern glass and steel building in New Cavendish Street (close to Warren Street, Great Portland Street or Goodge Street underground stations). Wander around the corner into [https://en.wikipedia.org/wiki/Fitzrovia Fitzrovia], a village-like district full of lively street cafes, and into the quiet garden square beyond.

[[Image:cavendish-campus.png|center|700px|link=https://goo.gl/maps/P4jmUpVgLqt ]]

[https://goo.gl/maps/P4jmUpVgLqt Click image for larger map]

===Accessibility===

The Cavendish Campus building is wheelchair accessible, with a ramp and automatic doors at the entrance. There are elevators inside for access to other floors.

A detailed accessibility profile for the building is available at: https://www.accessable.co.uk/venues/115-new-cavendish-street

* The nearest mainline station is Euston.
* There is a bus stop within 150m (164yds) of the venue.
* The nearest underground station is Great Portland Street.

===Getting to London===

'''By air'''

London has five major airports: London City, London Gatwick, London Heathrow, London Luton and London Stansted. There are several options for each airport for transport into London.
* London Heathrow, Gatwick and Stansted airports have dedicated express train services into central London.
* London Heathrow and City airports are directly connected to the Tube network.
* National Express, Easybus and Greenline coach transfers run 24 hours a day and start as low as £2 when booked in advance.
* Car hire is also available at every airport should you prefer to drive.

'''By train'''

Trains to London are often faster than driving or flying, and provide a greener form of transportation. London is the hub of the UK's rail network, with frequent services to all corners of the country from the city's centrally-located mainline railway stations. Rail services in the UK are run by a set of private train operating companies. Your point of departure will determine the best service to take and at what station your train will arrive in London.

If you're coming from Europe, the Eurostar train via the Channel Tunnel is also a great option. 'High Speed 1' delivers a faster, more reliable, less environmentally damaging alternative to flying from St Pancras station with connections that bring Eurostar services to travellers across the UK.

'''By car'''

London is easy to reach using the UK's motorway network – with the M1, M2, M3, M4, M11, M20, M23, M25 and M40 motorways in or near London – as well as a multitude of major A-roads. All of London's motorways intersect the M25 orbital motorway. Parking can prove difficult - National Car Parks (NCP) runs about 100 car parks in London. A [https://www.visitlondon.com/traveller-information/getting-around-london/congestion-charge Congestion Charge] applies to drivers of most vehicles in Central London between 7 am and 6 pm, Monday to Friday.

== '''Registration''' ==

Registration is now open!

This year, we are also running an Archivematica Camp in London the week before AtoM Camp (July 10-12), hosted by the London School of Economics. More details can be found on the [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica wiki]. If you register for both camps, we'll knock an additional £25 off the cost of each Camp, for a total savings of £50! We also have an early bird rate - registration will be £50 cheaper if you sign up before May 11, 2019!

* '''£375 Early bird (register before June 1, 2019) - extended!'''
* £350 Early bird with 2-Camp discount (must also register for [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica Camp London])
* £425 Regular registration (after June 1 - July 14, 2019)
* £400 Regular 2-Camp discount (must also register for [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica Camp London])

'''Register here''':

* '''https://atomcamp-london-2019.eventbrite.com'''

== Camp Counselors ==

At all of the camps that Artefactual hosts, we seek to provide attendees with counselors who have a wide range of experience with the software. Supplementing members of the Artefactual crew will be counselors who have extensive experience with AtoM as users and administrators.

'''Vicky Phillips'''

Vicky Phillips is Digital Standards Manager at the [https://www.library.wales/ National Library of Wales] in Aberystwyth. She helped with the [https://archives.library.wales/index.php/?sf_culture=en AtoM implementation project] in the Library back in 2015 and has overseen the upgrade to version 2.4 of AtoM in 2017. She is currently working with a programmer in NLW to embed the [https://universalviewer.io/ Universal Viewer] in AtoM so that visibility of their digitised material held in their digital repository is visible through AtoM.

'''Dan Gillean'''

Dan serves as AtoM Program Manager and provides quality assurance testing, requirements analysis, documentation, technical support and community dialogue for Artefactual’s AtoM and Archivematica projects. He completed his Dual MAS/MLIS degree at the University of British Columbia’s School of Library, Archival, and Information Studies ([https://slais.ubc.ca/ SLAIS]) in 2013. When he’s not trying to convince the archival profession to embrace linked open data, he can usually be found under a tree reading sci-fi, or in his bedroom twiddling knobs for his latest music project.

'''José Raddaoui'''

"Radda" has been part of Artefactual's team since 2012. He's a software developer working remotely from Seville (Spain) and he contributes in a wide variety of projects.

'''Corinne Rogers'''

Corinne joined Artefactual in 2018 as a Systems Archivist, and provides analysis, quality assurance testing, documentation, and training for AtoM. She's an adjunct professor at the University of British Columbia’s School of Library, Archival, and Information Studies where she teaches Digital Records Forensics, and before joining Artefactual was the Project Coordinator for [https://interparestrust.org InterPARES Trust]. At home she plays the harpsichord and trains her dog, Emma.

== Schedule ==

'''The schedule is a work in progress'''. Depending on the make-up of the campers, sessions might range from AtoM 101 for absolute beginners to command line tools to systems administration. We look forward to welcoming campers with a wide range of experience with AtoM!

<admonition type="tip">
If you'd like to get an idea of what to expect, why not take a look at the schedule from our previous Camps? Jump to:

* [[Community/Camps/SFU2017|SFU Vancouver Camp 2017]]
* [[Community/Camps/SJC2017|SJC Cambridge Camp 2017]]
* [[Community/Camps/UofT2018|UofT Toronto Camp 2018]]

</admonition>

'''**DRAFT SCHEDULE BELOW**'''

=== Day One - Monday, July 15th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room - C2.07'''
|'''Breakout room - C2.06'''
|-
|style="white-space: nowrap;" |8:45am - 9:15am
|colspan="2"|Arrival, sign-in, and setup!
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Introductions, code of conduct, agenda overview, etc.
|-
|style="white-space: nowrap;" |9:30am - 10:45am
|colspan="2"|'''AtoM 101 - Basic orientation and records creation'''
This session is intended to ensure that everyone is on the same page and has a basic understanding of AtoM. We'll talk briefly about the history of the project, look at basic search and browse, and cover how to create and link records.
|-
|style="white-space: nowrap;" |10:45am - 11:00am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:00am - 12:15pm
|'''Authority records and Archival institutions'''
Learn how to add complex relationships between authority records, how to link them to repositories, how to theme repository records, and more.
|'''Vagrant installation and configuration'''
Intended for developers and archivists comfortable with unix command-line basics, this session will focus on ensuring that everyone has a working AtoM instance on their local laptop, and how to create a reusable dataset for testing and development. Must arrive with some things already installed!
|-
|style="white-space: nowrap;" |12:15pm - 1:15pm
|colspan="2"|'''Lunch'''
|-
|style="white-space: nowrap;" |1:15pm - 2:15pm
|'''Searching in AtoM - advanced/expert searching'''
Going beyond search basics, this session will start with a review of the advanced search features, cover Boolean queries, and end with some neat tricks on how to search against AtoM's search index fields directly.
|'''Get to know AtoM's codebase'''
An introduction for developers and systems administrators covering symfony, developer resources, standard practices, and other information.
|-
|style="white-space: nowrap;"|2:15pm - 3:15pm
|'''Customizing AtoM through the web interface'''
This session will cover how to manage menus, static pages, labels, themes, and other front-end customizations - no coding required. Campers will again use their personal AtoM instances to get hands-on experience configuring their own sites.
|'''Basic Command-line tasks'''
This session will give everyone a grounding on using the command line for basic maintenance, user management, troubleshooting, and data import/export. Even if you don't use the command line firsthand, this session will be helpful for understanding the functionality provided by AtoM's CLI.
|-
|style="white-space: nowrap;" |3:15pm - 3:30pm
|colspan="2"|Break
|-
|style="white-space: nowrap;"|3:30pm - 4:30pm
|'''Managing access: permissions and rights'''
During this session, campers will focus on creating and managing users and groups, editing group permissions, and implementing PREMIS rights rules. We'll also talk about managing multi-tenanted AtoM instances.
|'''Production installation and upgrading'''
This session will cover recommended installation parameters, gotchas and tips for installing on other systems, using Ansible for deployment, managing upgrades, and multi-site management.
|-
|style="white-space: nowrap;" |4:30pm -4:45pm
|colspan="2"|Wrap up and discussion of tomorrow
|-
|style="white-space: nowrap;" |5:00pm - 5:45pm
|colspan="2"|'''Tours provided by the University of Wesminster!'''

Nice description here
|-
|style="white-space: nowrap;" |7:00pm
|colspan="2"|Evening social event: small sign-up group dinners
|}

=== Day Two - Tuesday, July 16th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room - C2.07'''
|'''Breakout room - C2.06'''
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Review and questions, morning announcements, overview of the day.
|-
|style="white-space: nowrap;" |9:30am - 10:15am
|colspan="2"|'''Implementation tours'''
A brief tour of how some institutions are using AtoM in production. Additionally, this session is a chance for users of all stripes to show off their current implementations! If you're interested in discussing how AtoM works (or might work) in your institution, come prepared with a 2-5 minute informal blurb to share, and a link if the site is public.
|-
|style="white-space: nowrap;" |10:15am - 11:00am
|'''Exports via the user interface'''
This session will cover how the Clipboard can be used to export descriptions, authority records, and repository records via the user interface. We'll also look at how logged in users can export search results in CSV format.
|'''Data backup and restoration'''
A quick introduction for developers and system administrators on what data to back up, how to do it, and how to load your data back into AtoM.
|-
|style="white-space: nowrap;" |11:00am - 11:15am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:15am - 12:30pm
|'''Imports via the user interface'''
This session will show campers how to prepare and import archival descriptions, authority records, taxonomies, and other data types using CSV templates. We will also look briefly at how imports can be used to update existing descriptions, and other import formats, such as SKOS and EAD XML.
|'''Imports and exports via the command-line'''
An overview of how to bulk import XML and CSV data from the command-line, including tips, tricks, and gotchas.
|-
|style="white-space: nowrap;" |12:30pm - 1:30pm
|colspan="2"|'''Lunch'''
|-
|style="white-space: nowrap;" |1:30pm - 2:45pm
|'''Accessions and Physical storage'''
An overview of the accessions module, and how to manage physical storage locations data and link them to archival descriptions.
|'''Custom theme plugin development'''
This session will incorporate an introduction to relevant theming files, registering a plugin, home page customizations, and also give devs a chance to create basic themes.
|-
|style="white-space: nowrap;" |2:45pm - 3:00pm
|colspan="2"|Break
|-
|style="white-space: nowrap;" |3:00pm - 4:00pm
|'''TBA'''
This is where content from our regional community counselor will be presented!
|'''Workflows with Archivematica'''
Campers interested in integrating their AtoM instance with Archivematica can learn about DIP upload, passing descriptive and rights metadata from Archivematica to AtoM, and future enhancements to Archivematica's AtoM integration.
|-
|style="white-space: nowrap;" |4:00pm -4:15pm
|colspan="2"|Wrap up and discussion of tomorrow
|-
|style="white-space: nowrap;" |6:00pm - 9:00pm
|colspan="2"|'''Evening social event''': Group dinner at [https://www.wahaca.co.uk/locations/charlotte-street-and-mezcaleria-bar/ Wahaca] hosted by Artefactual!

'''Address''': 19-23 Charlotte Street
|}

=== Day Three - Wednesday, July 17th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room - C2.07'''
|'''Breakout room - C2.06'''
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Review and questions, morning announcements, overview of the day.
|-
|style="white-space: nowrap;" |9:45am - 10:45am
|'''Things I wish I'd known...'''
A round-up of tips, tricks, and gotchas for those new to AtoM, with enough content to help out even regular AtoM users. Bring your own tips and cautionary tales to share!
|'''AtoM Feature development'''
Thinking of developing a new feature or customization for AtoM? This session will expand upon the code overview session and introduce best practices for developing features - and sharing them back with the community. A look at plugin registration, major modules, functions and classes, as well as how Artefactual performs code review and public code management, including things to consider when planning a development project and submitting code to the public AtoM branch.
|-
|style="white-space: nowrap;" |10:45am - 11:00am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:00am - 12:15pm
|'''Data migrations'''
Leaving a thorny topic for last, this session will be an overview of potential approaches to data migration. We'll go over known challenges, how to map to standards, data cleanup using OpenRefine, scripting transformations, and AtoM's import formats.
|'''Dev and sysadmin clinic (open space)'''
An informal opportunity for devs and sysadmins to discuss any issues, suggestions, ideas, or wild speculations with the experts.
|-
|style="white-space: nowrap;" |12:15pm - 1:15pm
|colspan="2"|'''Lunch'''
|-
|1:15pm - 2:45pm
|colspan="2"|'''Future of AtoM/project governance'''
This session will cover AtoM's history and current maintenance model, paired with a look at different maintenance and governance models used by other open source projects in the cultural heritage sector. We'll conclude by discussing where the AtoM project - and the AtoM community - is headed, and brainstorm ideas of what we'd like to see in a next-generation version of AtoM.
|-
|style="white-space: nowrap;" |2:45pm - 3:30pm
|colspan="2"|'''Open Discussion, Q&A, and AtoM 2.5 sneak peek'''
Last chance to ask us anything we haven't addressed during the Camp, or open a topic for discussion with your peers! We'll also take some time to show off some of the exciting new features that will be included in the upcoming 2.5 release.
|-
|style="white-space: nowrap;" |3:30pm - 3:45pm
|colspan="2"|'''Closing and goodbyes'''
|}

 

Is there something you think we're missing from the list? When you register, there will be a field to suggest any other topics you want us to cover. If there's a critical mass of people who want to discuss a particular topic, we'll cover it! During the camp, we'll also leave lots of space to adjust the schedule to give time to specific topics as they come up.

== Accommodation and Things to Do ==

'''Where to stay'''

If you are looking for accommodations near the camp that won't break the bank, try the [https://www.westminster.ac.uk/business-services/venues-and-accommodation/summer-accommodation/marylebone-hall Marylebone Residence]. For the Camp discounted rate, use the code "ARTF19".

The [https://www.yha.org.uk/hostel/yha-london-central YHA London Central Hostel] nearby offers private rooms at affordable rates, as does the [https://www.lsevacations.co.uk/Accommodation/Carr-Saunders/Carr-Saunders.aspx LSE Carr-Saunders Hall].

'''Things to do'''

There are a number of museums and galleries close to the Camp location, including UCL's [https://www.ucl.ac.uk/culture/grant-museum-zoology Grant Museum of Zoology], [https://www.ucl.ac.uk/culture/petrie-museum Petrie Museum of Egyptian Archaeology], and the [https://www.ucl.ac.uk/culture/ucl-art-museum UCL Art Museum]; [http://pollockstoys.com/ Pollock's Toy Museum]; the [https://www.cartoonmuseum.org/ Cartoon Museum]; the [https://www.woolffgallery.co.uk/ Woolff Gallery]; the [http://magdagallery.com/ Magda Danysz Gallery], and more. The beautifully restored [https://www.fitzroviachapel.org/ Fitzrovia Chapel] is also nearby for those who love architecture. For those who prefer street art, there is a Banksy stencil just under the BT Tower, at the corner of Clipstone and Cleveland Street. Just a couple blocks away you'll also find Fitzroy Square, a quaint little park overlooked by residences once occupied by George Bernard Shaw and Virginia Woolf. For more greenery, Regent's Park is about a 15-20 minute walk northwest from the Camp location.

The nearby [https://www.yelp.com/biz/the-fitzroy-tavern-london Fitzroy Tavern] was once a haunt of luminaries such as Jacob Epstein, Nina Hamnett, Dylan Thomas, Augustus John, and George Orwell. Meanwhile, [https://www.mr-foggs.com/house-of-botanicals/ Mr. Fogg's House of Botanicals] offers a botanical themed cocktail bar filled with flora and fauna inspired by the travels of Phileas Fogg in ''Around the World in 80 Days''. There are plenty of other bars, taverns, and clubs within easy walking distance. Charlotte street in particular is known for its cafes, restaurants, and bars. If you've got money to burn and nice clothes to wear, [https://www.bernerstavern.com/ Berners Tavern] is known for both its high-end cuisine and stunning decor.

Elsewhere in London there much to do and see - more than we can list here! But you'll find many handy guides and recommendations online for one of the most famous cities in the world.

==Code of Conduct==

The AtoM community is dedicated to providing a welcoming and positive experience for everyone, whether they are in a formal session or a social setting related to an AtoM event, or are taking part in activities online. AtoM community participants come from all over the world and bring with them a wide variety of professional, personal and social backgrounds; whatever these may be, we treat colleagues with dignity and respect. We are sensitive to the fact that the international nature of the AtoM community means that we span many different social norms around language and behaviour and we strive to conduct ourselves in ways that are unlikely to cause offense. In the event that someone’s conduct is causing offense or distress, the AtoM Camp has a detailed Anti-Harassment Policy, details below, which can be applied to address the problem.

The first step in dealing with any serious misconduct is to contact a member of the organizing group, or a counsellor at an AtoM Camp (please see counsellors, below). These people will be made known before and during any AtoM Camp event.

'''Anti-Harassment Policy'''

The AtoM community is dedicated to providing a harassment-free conference/camp experience for everyone. If you have been harassed, please consult this protocol for conflict resolution which makes clear how we can help.

The AtoM community has established the following policy to make it clear that we do not tolerate harassment in any form. Sexual or discriminatory language and imagery are not appropriate for any event venue, including talks, or any other communication channel used during the conference (such as social media).

Harassment includes:

* offensive verbal comments related to sex, gender, ethnicity, nationality, socioeconomic status, sexual orientation, disability, physical appearance, body size, age, race, religion;
* sexual or discriminatory images in public spaces;
* deliberate intimidation;
* stalking;
* harassing photography or recording;
* sustained disruption of talks or other events;
* inappropriate physical contact; and
* unwelcome sexual attention.

The lingua franca of AtoM Camp is English; however, English may not be the native language of AtoM Camp participants. Further, cultural norms around what may be considered obscene and offensive communication will vary among AtoM Camp attendees. Campers are asked to please be mindful of the international character of AtoM Camp, and to use respectful and clear language free of slang to facilitate communication.

Participants asked to stop any harassing behavior are expected to comply immediately.

If a participant engages in harassing behavior, event organizers and AtoM representatives (or their designees) may take any action they deem appropriate, including warning the offender, expulsion from the AtoM Camp, or contacting a higher authority such as a representative from the offender’s institution.

If a participant raises a concern relating to actions covered by this policy in good faith, there will be no retaliation for bringing forward their concern. Threatening or taking action against someone for invoking this policy or for participating in any related investigation will be considered a violation of this policy.

Participants are expected to follow the anti-harassment policy at all Camp-related venues, Camp-related social events, and online communication channels

We expect attendees and speakers past and present to be respectful to each other, and we will deal with any incidents that arise, including on social media.

We value your participation in the AtoM community and your support in keeping the AtoM community a safe, welcoming, and friendly space for fellow participants.

'''Acknowledgments'''

This policy is based on the [http://www.pasignyc.org/#code-of-conduct-section PASIG Code of Conduct], portions of which were modified from the [http://or2016.net/code-of-conduct/ Open Repositories’ code of conduct], which was itself modified from [https://www.seattleattic.com/codeofconduct Seattle Attic’s code of conduct] and the [http://adainitiative.org/what-we-do/events/ada-initiative-event-anti-harassment-policy/ Ada Initiative’s event harassment policy].

'''License'''

This document is licensed under [https://creativecommons.org/licenses/by-sa/3.0/ Creative Commons BY-SA].

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

[[Category:Community]]

Community/Camps/London2019

2019-05-17T18:25:53Z

Crogers: /* Registration */

{{#pagetitle:AtoM Camp London 2019}}
[[Main Page]] > [[Community]] > [[Community/Camps]] > London2019

We're excited to announce our fourth AtoM Camp, co-hosted by the [https://www.westminster.ac.uk/ University of Westminster] and Artefactual! Inspired by similar events like Hydra Camp, Islandora Camp and Fedora Camp, AtoM Camp is intended to provide a space for anyone interested in or currently using AtoM to come together, learn about the platform from other users, and share their experiences.

<admonition type="tip">
'''We're also hosting an Archivematica Camp in London!''' July 10-12, 2019, at the [http://www.lse.ac.uk/ London School of Economics]. For more details, see the Archivematica wiki:

* https://wiki.archivematica.org/Community/Camps/London2019

</admonition>

== Dates & Location ==
'''July 15th -17th, 2019''' - '''[https://www.westminster.ac.uk/business/facilities-and-services/venues-for-hire/conference-and-venues/cavendish Cavendish Campus]''' at the '''[https://www.westminster.ac.uk/ University of Westminster]'''

115 New Cavendish Street, London, United Kingdom, W1W 6UW

'''Rooms:''' [coming soon]

Situated below the [https://en.wikipedia.org/wiki/BT_Tower BT Tower] is Cavendish Campus, a modern glass and steel building in New Cavendish Street (close to Warren Street, Great Portland Street or Goodge Street underground stations). Wander around the corner into [https://en.wikipedia.org/wiki/Fitzrovia Fitzrovia], a village-like district full of lively street cafes, and into the quiet garden square beyond.

[[Image:cavendish-campus.png|center|700px|link=https://goo.gl/maps/P4jmUpVgLqt ]]

[https://goo.gl/maps/P4jmUpVgLqt Click image for larger map]

===Accessibility===

The Cavendish Campus building is wheelchair accessible, with a ramp and automatic doors at the entrance. There are elevators inside for access to other floors.

A detailed accessibility profile for the building is available at: https://www.accessable.co.uk/venues/115-new-cavendish-street

* The nearest mainline station is Euston.
* There is a bus stop within 150m (164yds) of the venue.
* The nearest underground station is Great Portland Street.

===Getting to London===

'''By air'''

London has five major airports: London City, London Gatwick, London Heathrow, London Luton and London Stansted. There are several options for each airport for transport into London.
* London Heathrow, Gatwick and Stansted airports have dedicated express train services into central London.
* London Heathrow and City airports are directly connected to the Tube network.
* National Express, Easybus and Greenline coach transfers run 24 hours a day and start as low as £2 when booked in advance.
* Car hire is also available at every airport should you prefer to drive.

'''By train'''

Trains to London are often faster than driving or flying, and provide a greener form of transportation. London is the hub of the UK's rail network, with frequent services to all corners of the country from the city's centrally-located mainline railway stations. Rail services in the UK are run by a set of private train operating companies. Your point of departure will determine the best service to take and at what station your train will arrive in London.

If you're coming from Europe, the Eurostar train via the Channel Tunnel is also a great option. 'High Speed 1' delivers a faster, more reliable, less environmentally damaging alternative to flying from St Pancras station with connections that bring Eurostar services to travellers across the UK.

'''By car'''

London is easy to reach using the UK's motorway network – with the M1, M2, M3, M4, M11, M20, M23, M25 and M40 motorways in or near London – as well as a multitude of major A-roads. All of London's motorways intersect the M25 orbital motorway. Parking can prove difficult - National Car Parks (NCP) runs about 100 car parks in London. A [https://www.visitlondon.com/traveller-information/getting-around-london/congestion-charge Congestion Charge] applies to drivers of most vehicles in Central London between 7 am and 6 pm, Monday to Friday.

== '''Registration''' ==

Registration is now open!

This year, we are also running an Archivematica Camp in London the week before AtoM Camp (July 10-12), hosted by the London School of Economics. More details can be found on the [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica wiki]. If you register for both camps, we'll knock an additional £25 off the cost of each Camp, for a total savings of £50! We also have an early bird rate - registration will be £50 cheaper if you sign up before May 11, 2019!

* '''£375 Early bird (register before June 1, 2019) - extended!'''
* £350 Early bird with 2-Camp discount (must also register for [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica Camp London])
* £425 Regular registration (after June 1 - July 14, 2019)
* £400 Regular 2-Camp discount (must also register for [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica Camp London])

'''Register here''':

* '''https://atomcamp-london-2019.eventbrite.com'''

== Camp Counselors ==

At all of the camps that Artefactual hosts, we seek to provide attendees with counselors who have a wide range of experience with the software. Supplementing members of the Artefactual crew will be counselors who have extensive experience with AtoM as users and administrators.

'''Vicky Phillips'''

Vicky Phillips is Digital Standards Manager at the [https://www.library.wales/ National Library of Wales] in Aberystwyth. She helped with the [https://archives.library.wales/index.php/?sf_culture=en AtoM implementation project] in the Library back in 2015 and has overseen the upgrade to version 2.4 of AtoM in 2017. She is currently working with a programmer in NLW to embed the [https://universalviewer.io/ Universal Viewer] in AtoM so that visibility of their digitised material held in their digital repository is visible through AtoM.

'''Dan Gillean'''

Dan serves as AtoM Program Manager and provides quality assurance testing, requirements analysis, documentation, technical support and community dialogue for Artefactual’s AtoM and Archivematica projects. He completed his Dual MAS/MLIS degree at the University of British Columbia’s School of Library, Archival, and Information Studies ([https://slais.ubc.ca/ SLAIS]) in 2013. When he’s not trying to convince the archival profession to embrace linked open data, he can usually be found under a tree reading sci-fi, or in his bedroom twiddling knobs for his latest music project.

'''Steve Breker'''

Steve joined the Artefactual team in 2016 as an AtoM programmer and is responsible for implementing a broad range of AtoM programming tasks and providing AtoM technical support. Steve can sometimes be seen lurking in the AtoM-users forum providing technical support.

'''Corinne Rogers'''

Corinne joined Artefactual in 2018 as a Systems Archivist, and provides analysis, quality assurance testing, documentation, and training for AtoM. She's an adjunct professor at the University of British Columbia’s School of Library, Archival, and Information Studies where she teaches Digital Records Forensics, and before joining Artefactual was the Project Coordinator for [https://interparestrust.org InterPARES Trust]. At home she plays the harpsichord and trains her dog, Emma.

== Schedule ==

'''The schedule is a work in progress'''. Depending on the make-up of the campers, sessions might range from AtoM 101 for absolute beginners to command line tools to systems administration. We look forward to welcoming campers with a wide range of experience with AtoM!

<admonition type="tip">
If you'd like to get an idea of what to expect, why not take a look at the schedule from our previous Camps? Jump to:

* [[Community/Camps/SFU2017|SFU Vancouver Camp 2017]]
* [[Community/Camps/SJC2017|SJC Cambridge Camp 2017]]
* [[Community/Camps/UofT2018|UofT Toronto Camp 2018]]

</admonition>

'''**DRAFT SCHEDULE BELOW**'''

=== Day One - Monday, July 15th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |8:45am - 9:15am
|colspan="2"|Arrival, sign-in, and setup!
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Introductions, code of conduct, agenda overview, etc.
|-
|style="white-space: nowrap;" |9:30am - 10:45am
|colspan="2"|'''AtoM 101 - Basic orientation and records creation'''
This session is intended to ensure that everyone is on the same page and has a basic understanding of AtoM. We'll talk briefly about the history of the project, look at basic search and browse, and cover how to create and link records.
|-
|style="white-space: nowrap;" |10:45am - 11:00am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:00am - 12:15pm
|'''Authority records and Archival institutions'''
Learn how to add complex relationships between authority records, how to link them to repositories, how to theme repository records, and more.
|'''Vagrant installation and configuration'''
Intended for developers and archivists comfortable with unix command-line basics, this session will focus on ensuring that everyone has a working AtoM instance on their local laptop, and how to create a reusable dataset for testing and development. Must arrive with some things already installed!
|-
|style="white-space: nowrap;" |12:15pm - 1:15pm
|colspan="2"|'''Lunch'''
|-
|style="white-space: nowrap;" |1:15pm - 2:15pm
|'''Searching in AtoM - advanced/expert searching'''
Going beyond search basics, this session will start with a review of the advanced search features, cover Boolean queries, and end with some neat tricks on how to search against AtoM's search index fields directly.
|'''Get to know AtoM's codebase'''
An introduction for developers and systems administrators covering symfony, developer resources, standard practices, and other information.
|-
|style="white-space: nowrap;"|2:15pm - 3:15pm
|'''Customizing AtoM through the web interface'''
This session will cover how to manage menus, static pages, labels, themes, and other front-end customizations - no coding required. Campers will again use their personal AtoM instances to get hands-on experience configuring their own sites.
|'''Basic Command-line tasks'''
This session will give everyone a grounding on using the command line for basic maintenance, user management, troubleshooting, and data import/export. Even if you don't use the command line firsthand, this session will be helpful for understanding the functionality provided by AtoM's CLI.
|-
|style="white-space: nowrap;" |3:15pm - 3:30pm
|colspan="2"|Break
|-
|style="white-space: nowrap;"|3:30pm - 4:30pm
|'''Managing access: permissions and rights'''
During this session, campers will focus on creating and managing users and groups, editing group permissions, and implementing PREMIS rights rules. We'll also talk about managing multi-tenanted AtoM instances.
|'''Production installation and upgrading'''
This session will cover recommended installation parameters, gotchas and tips for installing on other systems, using Ansible for deployment, managing upgrades, and multi-site management.
|-
|style="white-space: nowrap;" |4:30pm -4:45pm
|colspan="2"|Wrap up and discussion of tomorrow
|-
|style="white-space: nowrap;" |6:00pm
|colspan="2"|Evening social event: small sign-up group dinners
|}

=== Day Two - Tuesday, July 16th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Review and questions, morning announcements, overview of the day.
|-
|style="white-space: nowrap;" |9:30am - 10:15am
|colspan="2"|'''Implementation tours'''
A brief tour of how some institutions are using AtoM in production. Additionally, this session is a chance for users of all stripes to show off their current implementations! If you're interested in discussing how AtoM works (or might work) in your institution, come prepared with a 2-5 minute informal blurb to share, and a link if the site is public.
|-
|style="white-space: nowrap;" |10:15am - 11:00am
|'''Exports via the user interface'''
This session will cover how the Clipboard can be used to export descriptions, authority records, and repository records via the user interface. We'll also look at how logged in users can export search results in CSV format.
|'''Data backup and restoration'''
A quick introduction for developers and system administrators on what data to back up, how to do it, and how to load your data back into AtoM.
|-
|style="white-space: nowrap;" |11:00am - 11:15am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:15am - 12:30pm
|'''Imports via the user interface'''
This session will show campers how to prepare and import archival descriptions, authority records, taxonomies, and other data types using CSV templates. We will also look briefly at how imports can be used to update existing descriptions, and other import formats, such as SKOS and EAD XML.
|'''Imports and exports via the command-line'''
An overview of how to bulk import XML and CSV data from the command-line, including tips, tricks, and gotchas.
|-
|style="white-space: nowrap;" |12:30pm - 1:30pm
|colspan="2"|'''Lunch'''
|-
|style="white-space: nowrap;" |1:30pm - 2:45pm
|'''Accessions and Physical storage'''
An overview of the accessions module, and how to manage physical storage locations data and link them to archival descriptions.
|'''Custom theme plugin development'''
This session will incorporate an introduction to relevant theming files, registering a plugin, home page customizations, and also give devs a chance to create basic themes.
|-
|style="white-space: nowrap;" |2:45pm - 3:00pm
|colspan="2"|Break
|-
|style="white-space: nowrap;" |3:00pm - 4:00pm
|'''TBA'''
This is where content from our regional community counselor will be presented!
|'''Workflows with Archivematica'''
Campers interested in integrating their AtoM instance with Archivematica can learn about DIP upload, passing descriptive and rights metadata from Archivematica to AtoM, and future enhancements to Archivematica's AtoM integration.
|-
|style="white-space: nowrap;" |4:00pm -4:15pm
|colspan="2"|Wrap up and discussion of tomorrow
|-
|style="white-space: nowrap;" |6:00pm - 11:00pm
|colspan="2"|'''Evening social event''': Group dinner at [https://www.wahaca.co.uk/locations/charlotte-street-and-mezcaleria-bar/ Wahaca] hosted by Artefactual!

'''Address''': 19-23 Charlotte Street
|}

=== Day Three - Wednesday, July 17th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Review and questions, morning announcements, overview of the day.
|-
|style="white-space: nowrap;" |9:45am - 10:45am
|'''Things I wish I'd known...'''
A round-up of tips, tricks, and gotchas for those new to AtoM, with enough content to help out even regular AtoM users. Bring your own tips and cautionary tales to share!
|'''AtoM Feature development'''
Thinking of developing a new feature or customization for AtoM? This session will expand upon the code overview session and introduce best practices for developing features - and sharing them back with the community. A look at plugin registration, major modules, functions and classes, as well as how Artefactual performs code review and public code management, including things to consider when planning a development project and submitting code to the public AtoM branch.
|-
|style="white-space: nowrap;" |10:45am - 11:00am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:00am - 12:15pm
|'''Data migrations'''
Leaving a thorny topic for last, this session will be an overview of potential approaches to data migration. We'll go over known challenges, how to map to standards, data cleanup using OpenRefine, scripting transformations, and AtoM's import formats.
|'''Dev and sysadmin clinic (open space)'''
An informal opportunity for devs and sysadmins to discuss any issues, suggestions, ideas, or wild speculations with the experts.
|-
|style="white-space: nowrap;" |12:15pm - 1:15pm
|colspan="2"|'''Lunch'''
|-
|1:15pm - 2:45pm
|colspan="2"|'''Future of AtoM/project governance'''
This session will cover AtoM's history and current maintenance model, paired with a look at different maintenance and governance models used by other open source projects in the cultural heritage sector. We'll conclude by discussing where the AtoM project - and the AtoM community - is headed, and brainstorm ideas of what we'd like to see in a next-generation version of AtoM.
|-
|style="white-space: nowrap;" |2:45pm - 3:30pm
|colspan="2"|'''Open Discussion, Q&A, and AtoM 2.5 sneak peek'''
Last chance to ask us anything we haven't addressed during the Camp, or open a topic for discussion with your peers! We'll also take some time to show off some of the exciting new features that will be included in the upcoming 2.5 release.
|-
|style="white-space: nowrap;" |3:30pm - 3:45pm
|colspan="2"|'''Closing and goodbyes'''
|}

 

Is there something you think we're missing from the list? When you register, there will be a field to suggest any other topics you want us to cover. If there's a critical mass of people who want to discuss a particular topic, we'll cover it! During the camp, we'll also leave lots of space to adjust the schedule to give time to specific topics as they come up.

== Accommodation and Things to Do ==

'''Where to stay'''

If you are looking for accommodations near the camp that won't break the bank, try the [https://www.westminster.ac.uk/business-services/venues-and-accommodation/summer-accommodation/marylebone-hall Marylebone Residence]. For the Camp discounted rate, use the code "ARTF19".

'''Things to do'''

Coming soon!

==Code of Conduct==

The AtoM community is dedicated to providing a welcoming and positive experience for everyone, whether they are in a formal session or a social setting related to an AtoM event, or are taking part in activities online. AtoM community participants come from all over the world and bring with them a wide variety of professional, personal and social backgrounds; whatever these may be, we treat colleagues with dignity and respect. We are sensitive to the fact that the international nature of the AtoM community means that we span many different social norms around language and behaviour and we strive to conduct ourselves in ways that are unlikely to cause offense. In the event that someone’s conduct is causing offense or distress, the AtoM Camp has a detailed Anti-Harassment Policy, details below, which can be applied to address the problem.

The first step in dealing with any serious misconduct is to contact a member of the organizing group, or a counsellor at an AtoM Camp (please see counsellors, below). These people will be made known before and during any AtoM Camp event.

'''Anti-Harassment Policy'''

The AtoM community is dedicated to providing a harassment-free conference/camp experience for everyone. If you have been harassed, please consult this protocol for conflict resolution which makes clear how we can help.

The AtoM community has established the following policy to make it clear that we do not tolerate harassment in any form. Sexual or discriminatory language and imagery are not appropriate for any event venue, including talks, or any other communication channel used during the conference (such as social media).

Harassment includes:

* offensive verbal comments related to sex, gender, ethnicity, nationality, socioeconomic status, sexual orientation, disability, physical appearance, body size, age, race, religion;
* sexual or discriminatory images in public spaces;
* deliberate intimidation;
* stalking;
* harassing photography or recording;
* sustained disruption of talks or other events;
* inappropriate physical contact; and
* unwelcome sexual attention.

The lingua franca of AtoM Camp is English; however, English may not be the native language of AtoM Camp participants. Further, cultural norms around what may be considered obscene and offensive communication will vary among AtoM Camp attendees. Campers are asked to please be mindful of the international character of AtoM Camp, and to use respectful and clear language free of slang to facilitate communication.

Participants asked to stop any harassing behavior are expected to comply immediately.

If a participant engages in harassing behavior, event organizers and AtoM representatives (or their designees) may take any action they deem appropriate, including warning the offender, expulsion from the AtoM Camp, or contacting a higher authority such as a representative from the offender’s institution.

If a participant raises a concern relating to actions covered by this policy in good faith, there will be no retaliation for bringing forward their concern. Threatening or taking action against someone for invoking this policy or for participating in any related investigation will be considered a violation of this policy.

Participants are expected to follow the anti-harassment policy at all Camp-related venues, Camp-related social events, and online communication channels

We expect attendees and speakers past and present to be respectful to each other, and we will deal with any incidents that arise, including on social media.

We value your participation in the AtoM community and your support in keeping the AtoM community a safe, welcoming, and friendly space for fellow participants.

'''Acknowledgments'''

This policy is based on the [http://www.pasignyc.org/#code-of-conduct-section PASIG Code of Conduct], portions of which were modified from the [http://or2016.net/code-of-conduct/ Open Repositories’ code of conduct], which was itself modified from [https://www.seattleattic.com/codeofconduct Seattle Attic’s code of conduct] and the [http://adainitiative.org/what-we-do/events/ada-initiative-event-anti-harassment-policy/ Ada Initiative’s event harassment policy].

'''License'''

This document is licensed under [https://creativecommons.org/licenses/by-sa/3.0/ Creative Commons BY-SA].

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

[[Category:Community]]

Community/Camps/London2019

2019-05-17T18:25:10Z

Crogers: /* Registration */

{{#pagetitle:AtoM Camp London 2019}}
[[Main Page]] > [[Community]] > [[Community/Camps]] > London2019

We're excited to announce our fourth AtoM Camp, co-hosted by the [https://www.westminster.ac.uk/ University of Westminster] and Artefactual! Inspired by similar events like Hydra Camp, Islandora Camp and Fedora Camp, AtoM Camp is intended to provide a space for anyone interested in or currently using AtoM to come together, learn about the platform from other users, and share their experiences.

<admonition type="tip">
'''We're also hosting an Archivematica Camp in London!''' July 10-12, 2019, at the [http://www.lse.ac.uk/ London School of Economics]. For more details, see the Archivematica wiki:

* https://wiki.archivematica.org/Community/Camps/London2019

</admonition>

== Dates & Location ==
'''July 15th -17th, 2019''' - '''[https://www.westminster.ac.uk/business/facilities-and-services/venues-for-hire/conference-and-venues/cavendish Cavendish Campus]''' at the '''[https://www.westminster.ac.uk/ University of Westminster]'''

115 New Cavendish Street, London, United Kingdom, W1W 6UW

'''Rooms:''' [coming soon]

Situated below the [https://en.wikipedia.org/wiki/BT_Tower BT Tower] is Cavendish Campus, a modern glass and steel building in New Cavendish Street (close to Warren Street, Great Portland Street or Goodge Street underground stations). Wander around the corner into [https://en.wikipedia.org/wiki/Fitzrovia Fitzrovia], a village-like district full of lively street cafes, and into the quiet garden square beyond.

[[Image:cavendish-campus.png|center|700px|link=https://goo.gl/maps/P4jmUpVgLqt ]]

[https://goo.gl/maps/P4jmUpVgLqt Click image for larger map]

===Accessibility===

The Cavendish Campus building is wheelchair accessible, with a ramp and automatic doors at the entrance. There are elevators inside for access to other floors.

A detailed accessibility profile for the building is available at: https://www.accessable.co.uk/venues/115-new-cavendish-street

* The nearest mainline station is Euston.
* There is a bus stop within 150m (164yds) of the venue.
* The nearest underground station is Great Portland Street.

===Getting to London===

'''By air'''

London has five major airports: London City, London Gatwick, London Heathrow, London Luton and London Stansted. There are several options for each airport for transport into London.
* London Heathrow, Gatwick and Stansted airports have dedicated express train services into central London.
* London Heathrow and City airports are directly connected to the Tube network.
* National Express, Easybus and Greenline coach transfers run 24 hours a day and start as low as £2 when booked in advance.
* Car hire is also available at every airport should you prefer to drive.

'''By train'''

Trains to London are often faster than driving or flying, and provide a greener form of transportation. London is the hub of the UK's rail network, with frequent services to all corners of the country from the city's centrally-located mainline railway stations. Rail services in the UK are run by a set of private train operating companies. Your point of departure will determine the best service to take and at what station your train will arrive in London.

If you're coming from Europe, the Eurostar train via the Channel Tunnel is also a great option. 'High Speed 1' delivers a faster, more reliable, less environmentally damaging alternative to flying from St Pancras station with connections that bring Eurostar services to travellers across the UK.

'''By car'''

London is easy to reach using the UK's motorway network – with the M1, M2, M3, M4, M11, M20, M23, M25 and M40 motorways in or near London – as well as a multitude of major A-roads. All of London's motorways intersect the M25 orbital motorway. Parking can prove difficult - National Car Parks (NCP) runs about 100 car parks in London. A [https://www.visitlondon.com/traveller-information/getting-around-london/congestion-charge Congestion Charge] applies to drivers of most vehicles in Central London between 7 am and 6 pm, Monday to Friday.

== '''Registration''' ==

Registration is now open!

This year, we are also running an Archivematica Camp in London the week before AtoM Camp (July 10-12), hosted by the London School of Economics. More details can be found on the [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica wiki]. If you register for both camps, we'll knock an additional £25 off the cost of each Camp, for a total savings of £50! We also have an early bird rate - registration will be £50 cheaper if you sign up before May 11, 2019!

'''* £375 Early bird (register before June 1, 2019) - extended!'''
* £350 Early bird with 2-Camp discount (must also register for [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica Camp London])
* £425 Regular registration (after June 1 - July 14, 2019)
* £400 Regular 2-Camp discount (must also register for [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica Camp London])

'''Register here''':

* '''https://atomcamp-london-2019.eventbrite.com'''

== Camp Counselors ==

At all of the camps that Artefactual hosts, we seek to provide attendees with counselors who have a wide range of experience with the software. Supplementing members of the Artefactual crew will be counselors who have extensive experience with AtoM as users and administrators.

'''Vicky Phillips'''

Vicky Phillips is Digital Standards Manager at the [https://www.library.wales/ National Library of Wales] in Aberystwyth. She helped with the [https://archives.library.wales/index.php/?sf_culture=en AtoM implementation project] in the Library back in 2015 and has overseen the upgrade to version 2.4 of AtoM in 2017. She is currently working with a programmer in NLW to embed the [https://universalviewer.io/ Universal Viewer] in AtoM so that visibility of their digitised material held in their digital repository is visible through AtoM.

'''Dan Gillean'''

Dan serves as AtoM Program Manager and provides quality assurance testing, requirements analysis, documentation, technical support and community dialogue for Artefactual’s AtoM and Archivematica projects. He completed his Dual MAS/MLIS degree at the University of British Columbia’s School of Library, Archival, and Information Studies ([https://slais.ubc.ca/ SLAIS]) in 2013. When he’s not trying to convince the archival profession to embrace linked open data, he can usually be found under a tree reading sci-fi, or in his bedroom twiddling knobs for his latest music project.

'''Steve Breker'''

Steve joined the Artefactual team in 2016 as an AtoM programmer and is responsible for implementing a broad range of AtoM programming tasks and providing AtoM technical support. Steve can sometimes be seen lurking in the AtoM-users forum providing technical support.

'''Corinne Rogers'''

Corinne joined Artefactual in 2018 as a Systems Archivist, and provides analysis, quality assurance testing, documentation, and training for AtoM. She's an adjunct professor at the University of British Columbia’s School of Library, Archival, and Information Studies where she teaches Digital Records Forensics, and before joining Artefactual was the Project Coordinator for [https://interparestrust.org InterPARES Trust]. At home she plays the harpsichord and trains her dog, Emma.

== Schedule ==

'''The schedule is a work in progress'''. Depending on the make-up of the campers, sessions might range from AtoM 101 for absolute beginners to command line tools to systems administration. We look forward to welcoming campers with a wide range of experience with AtoM!

<admonition type="tip">
If you'd like to get an idea of what to expect, why not take a look at the schedule from our previous Camps? Jump to:

* [[Community/Camps/SFU2017|SFU Vancouver Camp 2017]]
* [[Community/Camps/SJC2017|SJC Cambridge Camp 2017]]
* [[Community/Camps/UofT2018|UofT Toronto Camp 2018]]

</admonition>

'''**DRAFT SCHEDULE BELOW**'''

=== Day One - Monday, July 15th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |8:45am - 9:15am
|colspan="2"|Arrival, sign-in, and setup!
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Introductions, code of conduct, agenda overview, etc.
|-
|style="white-space: nowrap;" |9:30am - 10:45am
|colspan="2"|'''AtoM 101 - Basic orientation and records creation'''
This session is intended to ensure that everyone is on the same page and has a basic understanding of AtoM. We'll talk briefly about the history of the project, look at basic search and browse, and cover how to create and link records.
|-
|style="white-space: nowrap;" |10:45am - 11:00am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:00am - 12:15pm
|'''Authority records and Archival institutions'''
Learn how to add complex relationships between authority records, how to link them to repositories, how to theme repository records, and more.
|'''Vagrant installation and configuration'''
Intended for developers and archivists comfortable with unix command-line basics, this session will focus on ensuring that everyone has a working AtoM instance on their local laptop, and how to create a reusable dataset for testing and development. Must arrive with some things already installed!
|-
|style="white-space: nowrap;" |12:15pm - 1:15pm
|colspan="2"|'''Lunch'''
|-
|style="white-space: nowrap;" |1:15pm - 2:15pm
|'''Searching in AtoM - advanced/expert searching'''
Going beyond search basics, this session will start with a review of the advanced search features, cover Boolean queries, and end with some neat tricks on how to search against AtoM's search index fields directly.
|'''Get to know AtoM's codebase'''
An introduction for developers and systems administrators covering symfony, developer resources, standard practices, and other information.
|-
|style="white-space: nowrap;"|2:15pm - 3:15pm
|'''Customizing AtoM through the web interface'''
This session will cover how to manage menus, static pages, labels, themes, and other front-end customizations - no coding required. Campers will again use their personal AtoM instances to get hands-on experience configuring their own sites.
|'''Basic Command-line tasks'''
This session will give everyone a grounding on using the command line for basic maintenance, user management, troubleshooting, and data import/export. Even if you don't use the command line firsthand, this session will be helpful for understanding the functionality provided by AtoM's CLI.
|-
|style="white-space: nowrap;" |3:15pm - 3:30pm
|colspan="2"|Break
|-
|style="white-space: nowrap;"|3:30pm - 4:30pm
|'''Managing access: permissions and rights'''
During this session, campers will focus on creating and managing users and groups, editing group permissions, and implementing PREMIS rights rules. We'll also talk about managing multi-tenanted AtoM instances.
|'''Production installation and upgrading'''
This session will cover recommended installation parameters, gotchas and tips for installing on other systems, using Ansible for deployment, managing upgrades, and multi-site management.
|-
|style="white-space: nowrap;" |4:30pm -4:45pm
|colspan="2"|Wrap up and discussion of tomorrow
|-
|style="white-space: nowrap;" |6:00pm
|colspan="2"|Evening social event: small sign-up group dinners
|}

=== Day Two - Tuesday, July 16th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Review and questions, morning announcements, overview of the day.
|-
|style="white-space: nowrap;" |9:30am - 10:15am
|colspan="2"|'''Implementation tours'''
A brief tour of how some institutions are using AtoM in production. Additionally, this session is a chance for users of all stripes to show off their current implementations! If you're interested in discussing how AtoM works (or might work) in your institution, come prepared with a 2-5 minute informal blurb to share, and a link if the site is public.
|-
|style="white-space: nowrap;" |10:15am - 11:00am
|'''Exports via the user interface'''
This session will cover how the Clipboard can be used to export descriptions, authority records, and repository records via the user interface. We'll also look at how logged in users can export search results in CSV format.
|'''Data backup and restoration'''
A quick introduction for developers and system administrators on what data to back up, how to do it, and how to load your data back into AtoM.
|-
|style="white-space: nowrap;" |11:00am - 11:15am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:15am - 12:30pm
|'''Imports via the user interface'''
This session will show campers how to prepare and import archival descriptions, authority records, taxonomies, and other data types using CSV templates. We will also look briefly at how imports can be used to update existing descriptions, and other import formats, such as SKOS and EAD XML.
|'''Imports and exports via the command-line'''
An overview of how to bulk import XML and CSV data from the command-line, including tips, tricks, and gotchas.
|-
|style="white-space: nowrap;" |12:30pm - 1:30pm
|colspan="2"|'''Lunch'''
|-
|style="white-space: nowrap;" |1:30pm - 2:45pm
|'''Accessions and Physical storage'''
An overview of the accessions module, and how to manage physical storage locations data and link them to archival descriptions.
|'''Custom theme plugin development'''
This session will incorporate an introduction to relevant theming files, registering a plugin, home page customizations, and also give devs a chance to create basic themes.
|-
|style="white-space: nowrap;" |2:45pm - 3:00pm
|colspan="2"|Break
|-
|style="white-space: nowrap;" |3:00pm - 4:00pm
|'''TBA'''
This is where content from our regional community counselor will be presented!
|'''Workflows with Archivematica'''
Campers interested in integrating their AtoM instance with Archivematica can learn about DIP upload, passing descriptive and rights metadata from Archivematica to AtoM, and future enhancements to Archivematica's AtoM integration.
|-
|style="white-space: nowrap;" |4:00pm -4:15pm
|colspan="2"|Wrap up and discussion of tomorrow
|-
|style="white-space: nowrap;" |6:00pm - 11:00pm
|colspan="2"|'''Evening social event''': Group dinner at [https://www.wahaca.co.uk/locations/charlotte-street-and-mezcaleria-bar/ Wahaca] hosted by Artefactual!

'''Address''': 19-23 Charlotte Street
|}

=== Day Three - Wednesday, July 17th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Review and questions, morning announcements, overview of the day.
|-
|style="white-space: nowrap;" |9:45am - 10:45am
|'''Things I wish I'd known...'''
A round-up of tips, tricks, and gotchas for those new to AtoM, with enough content to help out even regular AtoM users. Bring your own tips and cautionary tales to share!
|'''AtoM Feature development'''
Thinking of developing a new feature or customization for AtoM? This session will expand upon the code overview session and introduce best practices for developing features - and sharing them back with the community. A look at plugin registration, major modules, functions and classes, as well as how Artefactual performs code review and public code management, including things to consider when planning a development project and submitting code to the public AtoM branch.
|-
|style="white-space: nowrap;" |10:45am - 11:00am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:00am - 12:15pm
|'''Data migrations'''
Leaving a thorny topic for last, this session will be an overview of potential approaches to data migration. We'll go over known challenges, how to map to standards, data cleanup using OpenRefine, scripting transformations, and AtoM's import formats.
|'''Dev and sysadmin clinic (open space)'''
An informal opportunity for devs and sysadmins to discuss any issues, suggestions, ideas, or wild speculations with the experts.
|-
|style="white-space: nowrap;" |12:15pm - 1:15pm
|colspan="2"|'''Lunch'''
|-
|1:15pm - 2:45pm
|colspan="2"|'''Future of AtoM/project governance'''
This session will cover AtoM's history and current maintenance model, paired with a look at different maintenance and governance models used by other open source projects in the cultural heritage sector. We'll conclude by discussing where the AtoM project - and the AtoM community - is headed, and brainstorm ideas of what we'd like to see in a next-generation version of AtoM.
|-
|style="white-space: nowrap;" |2:45pm - 3:30pm
|colspan="2"|'''Open Discussion, Q&A, and AtoM 2.5 sneak peek'''
Last chance to ask us anything we haven't addressed during the Camp, or open a topic for discussion with your peers! We'll also take some time to show off some of the exciting new features that will be included in the upcoming 2.5 release.
|-
|style="white-space: nowrap;" |3:30pm - 3:45pm
|colspan="2"|'''Closing and goodbyes'''
|}

 

Is there something you think we're missing from the list? When you register, there will be a field to suggest any other topics you want us to cover. If there's a critical mass of people who want to discuss a particular topic, we'll cover it! During the camp, we'll also leave lots of space to adjust the schedule to give time to specific topics as they come up.

== Accommodation and Things to Do ==

'''Where to stay'''

If you are looking for accommodations near the camp that won't break the bank, try the [https://www.westminster.ac.uk/business-services/venues-and-accommodation/summer-accommodation/marylebone-hall Marylebone Residence]. For the Camp discounted rate, use the code "ARTF19".

'''Things to do'''

Coming soon!

==Code of Conduct==

The AtoM community is dedicated to providing a welcoming and positive experience for everyone, whether they are in a formal session or a social setting related to an AtoM event, or are taking part in activities online. AtoM community participants come from all over the world and bring with them a wide variety of professional, personal and social backgrounds; whatever these may be, we treat colleagues with dignity and respect. We are sensitive to the fact that the international nature of the AtoM community means that we span many different social norms around language and behaviour and we strive to conduct ourselves in ways that are unlikely to cause offense. In the event that someone’s conduct is causing offense or distress, the AtoM Camp has a detailed Anti-Harassment Policy, details below, which can be applied to address the problem.

The first step in dealing with any serious misconduct is to contact a member of the organizing group, or a counsellor at an AtoM Camp (please see counsellors, below). These people will be made known before and during any AtoM Camp event.

'''Anti-Harassment Policy'''

The AtoM community is dedicated to providing a harassment-free conference/camp experience for everyone. If you have been harassed, please consult this protocol for conflict resolution which makes clear how we can help.

The AtoM community has established the following policy to make it clear that we do not tolerate harassment in any form. Sexual or discriminatory language and imagery are not appropriate for any event venue, including talks, or any other communication channel used during the conference (such as social media).

Harassment includes:

* offensive verbal comments related to sex, gender, ethnicity, nationality, socioeconomic status, sexual orientation, disability, physical appearance, body size, age, race, religion;
* sexual or discriminatory images in public spaces;
* deliberate intimidation;
* stalking;
* harassing photography or recording;
* sustained disruption of talks or other events;
* inappropriate physical contact; and
* unwelcome sexual attention.

The lingua franca of AtoM Camp is English; however, English may not be the native language of AtoM Camp participants. Further, cultural norms around what may be considered obscene and offensive communication will vary among AtoM Camp attendees. Campers are asked to please be mindful of the international character of AtoM Camp, and to use respectful and clear language free of slang to facilitate communication.

Participants asked to stop any harassing behavior are expected to comply immediately.

If a participant engages in harassing behavior, event organizers and AtoM representatives (or their designees) may take any action they deem appropriate, including warning the offender, expulsion from the AtoM Camp, or contacting a higher authority such as a representative from the offender’s institution.

If a participant raises a concern relating to actions covered by this policy in good faith, there will be no retaliation for bringing forward their concern. Threatening or taking action against someone for invoking this policy or for participating in any related investigation will be considered a violation of this policy.

Participants are expected to follow the anti-harassment policy at all Camp-related venues, Camp-related social events, and online communication channels

We expect attendees and speakers past and present to be respectful to each other, and we will deal with any incidents that arise, including on social media.

We value your participation in the AtoM community and your support in keeping the AtoM community a safe, welcoming, and friendly space for fellow participants.

'''Acknowledgments'''

This policy is based on the [http://www.pasignyc.org/#code-of-conduct-section PASIG Code of Conduct], portions of which were modified from the [http://or2016.net/code-of-conduct/ Open Repositories’ code of conduct], which was itself modified from [https://www.seattleattic.com/codeofconduct Seattle Attic’s code of conduct] and the [http://adainitiative.org/what-we-do/events/ada-initiative-event-anti-harassment-policy/ Ada Initiative’s event harassment policy].

'''License'''

This document is licensed under [https://creativecommons.org/licenses/by-sa/3.0/ Creative Commons BY-SA].

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

[[Category:Community]]

Resources/Documentation/Contribute

2019-05-16T15:48:01Z

Crogers: /* SSH keys - Mac and Linux users */

{{#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/en/docs/2.5/dev-manual/env/vagrant/#install-vagrant-and-virtualbox 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://www.transifex.com/projects/p/atom/ Transifex] 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 Transifex 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]]

Resources/Documentation/Contribute

2019-05-16T15:46:35Z

Crogers:

{{#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/en/docs/2.5/dev-manual/env/vagrant/#install-vagrant-and-virtualbox 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 <cade>vagrant uop</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://www.transifex.com/projects/p/atom/ Transifex] 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 Transifex 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]]

Community/Camps/London2019

2019-05-16T15:37:11Z

Crogers:

{{#pagetitle:AtoM Camp London 2019}}
[[Main Page]] > [[Community]] > [[Community/Camps]] > London2019

We're excited to announce our fourth AtoM Camp, co-hosted by the [https://www.westminster.ac.uk/ University of Westminster] and Artefactual! Inspired by similar events like Hydra Camp, Islandora Camp and Fedora Camp, AtoM Camp is intended to provide a space for anyone interested in or currently using AtoM to come together, learn about the platform from other users, and share their experiences.

<admonition type="tip">
'''We're also hosting an Archivematica Camp in London!''' July 10-12, 2019, at the [http://www.lse.ac.uk/ London School of Economics]. For more details, see the Archivematica wiki:

* https://wiki.archivematica.org/Community/Camps/London2019

</admonition>

== Dates & Location ==
'''July 15th -17th, 2019''' - '''[https://www.westminster.ac.uk/business/facilities-and-services/venues-for-hire/conference-and-venues/cavendish Cavendish Campus]''' at the '''[https://www.westminster.ac.uk/ University of Westminster]'''

115 New Cavendish Street, London, United Kingdom, W1W 6UW

'''Rooms:''' [coming soon]

Situated below the [https://en.wikipedia.org/wiki/BT_Tower BT Tower] is Cavendish Campus, a modern glass and steel building in New Cavendish Street (close to Warren Street, Great Portland Street or Goodge Street underground stations). Wander around the corner into [https://en.wikipedia.org/wiki/Fitzrovia Fitzrovia], a village-like district full of lively street cafes, and into the quiet garden square beyond.

[[Image:cavendish-campus.png|center|700px|link=https://goo.gl/maps/P4jmUpVgLqt ]]

[https://goo.gl/maps/P4jmUpVgLqt Click image for larger map]

===Accessibility===

The Cavendish Campus building is wheelchair accessible, with a ramp and automatic doors at the entrance. There are elevators inside for access to other floors.

A detailed accessibility profile for the building is available at: https://www.accessable.co.uk/venues/115-new-cavendish-street

* The nearest mainline station is Euston.
* There is a bus stop within 150m (164yds) of the venue.
* The nearest underground station is Great Portland Street.

===Getting to London===

'''By air'''

London has five major airports: London City, London Gatwick, London Heathrow, London Luton and London Stansted. There are several options for each airport for transport into London.
* London Heathrow, Gatwick and Stansted airports have dedicated express train services into central London.
* London Heathrow and City airports are directly connected to the Tube network.
* National Express, Easybus and Greenline coach transfers run 24 hours a day and start as low as £2 when booked in advance.
* Car hire is also available at every airport should you prefer to drive.

'''By train'''

Trains to London are often faster than driving or flying, and provide a greener form of transportation. London is the hub of the UK's rail network, with frequent services to all corners of the country from the city's centrally-located mainline railway stations. Rail services in the UK are run by a set of private train operating companies. Your point of departure will determine the best service to take and at what station your train will arrive in London.

If you're coming from Europe, the Eurostar train via the Channel Tunnel is also a great option. 'High Speed 1' delivers a faster, more reliable, less environmentally damaging alternative to flying from St Pancras station with connections that bring Eurostar services to travellers across the UK.

'''By car'''

London is easy to reach using the UK's motorway network – with the M1, M2, M3, M4, M11, M20, M23, M25 and M40 motorways in or near London – as well as a multitude of major A-roads. All of London's motorways intersect the M25 orbital motorway. Parking can prove difficult - National Car Parks (NCP) runs about 100 car parks in London. A [https://www.visitlondon.com/traveller-information/getting-around-london/congestion-charge Congestion Charge] applies to drivers of most vehicles in Central London between 7 am and 6 pm, Monday to Friday.

== '''Registration''' ==

Registration is now open!

This year, we are also running an Archivematica Camp in London the week before AtoM Camp (July 10-12), hosted by the London School of Economics. More details can be found on the [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica wiki]. If you register for both camps, we'll knock an additional £25 off the cost of each Camp, for a total savings of £50! We also have an early bird rate - registration will be £50 cheaper if you sign up before May 11, 2019!

* £375 Early bird (register before May 11th, 2019)
* £350 Early bird with 2-Camp discount (must also register for [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica Camp London])
* £425 Regular registration (after May 11 - July 14, 2019)
* £400 Regular 2-Camp discount (must also register for [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica Camp London])

'''Register here''':

* '''https://atomcamp-london-2019.eventbrite.com'''

== Camp Counselors ==

At all of the camps that Artefactual hosts, we seek to provide attendees with counselors who have a wide range of experience with the software. Supplementing members of the Artefactual crew will be counselors who have extensive experience with AtoM as users and administrators.

'''Vicky Phillips'''

Vicky Phillips is Digital Standards Manager at the [https://www.library.wales/ National Library of Wales] in Aberystwyth. She helped with the [https://archives.library.wales/index.php/?sf_culture=en AtoM implementation project] in the Library back in 2015 and has overseen the upgrade to version 2.4 of AtoM in 2017. She is currently working with a programmer in NLW to embed the [https://universalviewer.io/ Universal Viewer] in AtoM so that visibility of their digitised material held in their digital repository is visible through AtoM.

'''Dan Gillean'''

Dan serves as AtoM Program Manager and provides quality assurance testing, requirements analysis, documentation, technical support and community dialogue for Artefactual’s AtoM and Archivematica projects. He completed his Dual MAS/MLIS degree at the University of British Columbia’s School of Library, Archival, and Information Studies ([https://slais.ubc.ca/ SLAIS]) in 2013. When he’s not trying to convince the archival profession to embrace linked open data, he can usually be found under a tree reading sci-fi, or in his bedroom twiddling knobs for his latest music project.

'''Steve Breker'''

Steve joined the Artefactual team in 2016 as an AtoM programmer and is responsible for implementing a broad range of AtoM programming tasks and providing AtoM technical support. Steve can sometimes be seen lurking in the AtoM-users forum providing technical support.

'''Corinne Rogers'''

Corinne joined Artefactual in 2018 as a Systems Archivist, and provides analysis, quality assurance testing, documentation, and training for AtoM. She's an adjunct professor at the University of British Columbia’s School of Library, Archival, and Information Studies where she teaches Digital Records Forensics, and before joining Artefactual was the Project Coordinator for [https://interparestrust.org InterPARES Trust]. At home she plays the harpsichord and trains her dog, Emma.

== Schedule ==

'''The schedule is a work in progress'''. Depending on the make-up of the campers, sessions might range from AtoM 101 for absolute beginners to command line tools to systems administration. We look forward to welcoming campers with a wide range of experience with AtoM!

<admonition type="tip">
If you'd like to get an idea of what to expect, why not take a look at the schedule from our previous Camps? Jump to:

* [[Community/Camps/SFU2017|SFU Vancouver Camp 2017]]
* [[Community/Camps/SJC2017|SJC Cambridge Camp 2017]]
* [[Community/Camps/UofT2018|UofT Toronto Camp 2018]]

</admonition>

'''**DRAFT SCHEDULE BELOW**'''

=== Day One - Monday, July 15th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |8:45am - 9:15am
|colspan="2"|Arrival, sign-in, and setup!
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Introductions, code of conduct, agenda overview, etc.
|-
|style="white-space: nowrap;" |9:30am - 10:45am
|colspan="2"|'''AtoM 101 - Basic orientation and records creation'''
This session is intended to ensure that everyone is on the same page and has a basic understanding of AtoM. We'll talk briefly about the history of the project, look at basic search and browse, and cover how to create and link records.
|-
|style="white-space: nowrap;" |10:45am - 11:00am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:00am - 12:15pm
|'''Authority records and Archival institutions'''
Learn how to add complex relationships between authority records, how to link them to repositories, how to theme repository records, and more.
|'''Vagrant installation and configuration'''
Intended for developers and archivists comfortable with unix command-line basics, this session will focus on ensuring that everyone has a working AtoM instance on their local laptop, and how to create a reusable dataset for testing and development. Must arrive with some things already installed!
|-
|style="white-space: nowrap;" |12:15pm - 1:15pm
|colspan="2"|'''Lunch'''
|-
|style="white-space: nowrap;" |1:15pm - 2:15pm
|'''Searching in AtoM - advanced/expert searching'''
Going beyond search basics, this session will start with a review of the advanced search features, cover Boolean queries, and end with some neat tricks on how to search against AtoM's search index fields directly.
|'''Get to know AtoM's codebase'''
An introduction for developers and systems administrators covering symfony, developer resources, standard practices, and other information.
|-
|style="white-space: nowrap;"|2:15pm - 3:15pm
|'''Customizing AtoM through the web interface'''
This session will cover how to manage menus, static pages, labels, themes, and other front-end customizations - no coding required. Campers will again use their personal AtoM instances to get hands-on experience configuring their own sites.
|'''Basic Command-line tasks'''
This session will give everyone a grounding on using the command line for basic maintenance, user management, troubleshooting, and data import/export. Even if you don't use the command line firsthand, this session will be helpful for understanding the functionality provided by AtoM's CLI.
|-
|style="white-space: nowrap;" |3:15pm - 3:30pm
|colspan="2"|Break
|-
|style="white-space: nowrap;"|3:30pm - 4:30pm
|'''Managing access: permissions and rights'''
During this session, campers will focus on creating and managing users and groups, editing group permissions, and implementing PREMIS rights rules. We'll also talk about managing multi-tenanted AtoM instances.
|'''Production installation and upgrading'''
This session will cover recommended installation parameters, gotchas and tips for installing on other systems, using Ansible for deployment, managing upgrades, and multi-site management.
|-
|style="white-space: nowrap;" |4:30pm -4:45pm
|colspan="2"|Wrap up and discussion of tomorrow
|-
|style="white-space: nowrap;" |6:00pm
|colspan="2"|Evening social event: small sign-up group dinners
|}

=== Day Two - Tuesday, July 16th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Review and questions, morning announcements, overview of the day.
|-
|style="white-space: nowrap;" |9:30am - 10:15am
|colspan="2"|'''Implementation tours'''
A brief tour of how some institutions are using AtoM in production. Additionally, this session is a chance for users of all stripes to show off their current implementations! If you're interested in discussing how AtoM works (or might work) in your institution, come prepared with a 2-5 minute informal blurb to share, and a link if the site is public.
|-
|style="white-space: nowrap;" |10:15am - 11:00am
|'''Exports via the user interface'''
This session will cover how the Clipboard can be used to export descriptions, authority records, and repository records via the user interface. We'll also look at how logged in users can export search results in CSV format.
|'''Data backup and restoration'''
A quick introduction for developers and system administrators on what data to back up, how to do it, and how to load your data back into AtoM.
|-
|style="white-space: nowrap;" |11:00am - 11:15am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:15am - 12:30pm
|'''Imports via the user interface'''
This session will show campers how to prepare and import archival descriptions, authority records, taxonomies, and other data types using CSV templates. We will also look briefly at how imports can be used to update existing descriptions, and other import formats, such as SKOS and EAD XML.
|'''Imports and exports via the command-line'''
An overview of how to bulk import XML and CSV data from the command-line, including tips, tricks, and gotchas.
|-
|style="white-space: nowrap;" |12:30pm - 1:30pm
|colspan="2"|'''Lunch'''
|-
|style="white-space: nowrap;" |1:30pm - 2:45pm
|'''Accessions and Physical storage'''
An overview of the accessions module, and how to manage physical storage locations data and link them to archival descriptions.
|'''Custom theme plugin development'''
This session will incorporate an introduction to relevant theming files, registering a plugin, home page customizations, and also give devs a chance to create basic themes.
|-
|style="white-space: nowrap;" |2:45pm - 3:00pm
|colspan="2"|Break
|-
|style="white-space: nowrap;" |3:00pm - 4:00pm
|'''TBA'''
This is where content from our regional community counselor will be presented!
|'''Workflows with Archivematica'''
Campers interested in integrating their AtoM instance with Archivematica can learn about DIP upload, passing descriptive and rights metadata from Archivematica to AtoM, and future enhancements to Archivematica's AtoM integration.
|-
|style="white-space: nowrap;" |4:00pm -4:15pm
|colspan="2"|Wrap up and discussion of tomorrow
|-
|style="white-space: nowrap;" |6:00pm - 11:00pm
|colspan="2"|'''Evening social event''': Group dinner at [https://www.wahaca.co.uk/locations/charlotte-street-and-mezcaleria-bar/ Wahaca] hosted by Artefactual!

'''Address''': 19-23 Charlotte Street
|}

=== Day Three - Wednesday, July 17th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Review and questions, morning announcements, overview of the day.
|-
|style="white-space: nowrap;" |9:45am - 10:45am
|'''Things I wish I'd known...'''
A round-up of tips, tricks, and gotchas for those new to AtoM, with enough content to help out even regular AtoM users. Bring your own tips and cautionary tales to share!
|'''AtoM Feature development'''
Thinking of developing a new feature or customization for AtoM? This session will expand upon the code overview session and introduce best practices for developing features - and sharing them back with the community. A look at plugin registration, major modules, functions and classes, as well as how Artefactual performs code review and public code management, including things to consider when planning a development project and submitting code to the public AtoM branch.
|-
|style="white-space: nowrap;" |10:45am - 11:00am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:00am - 12:15pm
|'''Data migrations'''
Leaving a thorny topic for last, this session will be an overview of potential approaches to data migration. We'll go over known challenges, how to map to standards, data cleanup using OpenRefine, scripting transformations, and AtoM's import formats.
|'''Dev and sysadmin clinic (open space)'''
An informal opportunity for devs and sysadmins to discuss any issues, suggestions, ideas, or wild speculations with the experts.
|-
|style="white-space: nowrap;" |12:15pm - 1:15pm
|colspan="2"|'''Lunch'''
|-
|1:15pm - 2:45pm
|colspan="2"|'''Future of AtoM/project governance'''
This session will cover AtoM's history and current maintenance model, paired with a look at different maintenance and governance models used by other open source projects in the cultural heritage sector. We'll conclude by discussing where the AtoM project - and the AtoM community - is headed, and brainstorm ideas of what we'd like to see in a next-generation version of AtoM.
|-
|style="white-space: nowrap;" |2:45pm - 3:30pm
|colspan="2"|'''Open Discussion, Q&A, and AtoM 2.5 sneak peek'''
Last chance to ask us anything we haven't addressed during the Camp, or open a topic for discussion with your peers! We'll also take some time to show off some of the exciting new features that will be included in the upcoming 2.5 release.
|-
|style="white-space: nowrap;" |3:30pm - 3:45pm
|colspan="2"|'''Closing and goodbyes'''
|}

 

Is there something you think we're missing from the list? When you register, there will be a field to suggest any other topics you want us to cover. If there's a critical mass of people who want to discuss a particular topic, we'll cover it! During the camp, we'll also leave lots of space to adjust the schedule to give time to specific topics as they come up.

== Accommodation and Things to Do ==

'''Where to stay'''

If you are looking for accommodations near the camp that won't break the bank, try the [https://www.westminster.ac.uk/business-services/venues-and-accommodation/summer-accommodation/marylebone-hall Marylebone Residence]. For the Camp discounted rate, use the code "ARTF19".

'''Things to do'''

Coming soon!

==Code of Conduct==

The AtoM community is dedicated to providing a welcoming and positive experience for everyone, whether they are in a formal session or a social setting related to an AtoM event, or are taking part in activities online. AtoM community participants come from all over the world and bring with them a wide variety of professional, personal and social backgrounds; whatever these may be, we treat colleagues with dignity and respect. We are sensitive to the fact that the international nature of the AtoM community means that we span many different social norms around language and behaviour and we strive to conduct ourselves in ways that are unlikely to cause offense. In the event that someone’s conduct is causing offense or distress, the AtoM Camp has a detailed Anti-Harassment Policy, details below, which can be applied to address the problem.

The first step in dealing with any serious misconduct is to contact a member of the organizing group, or a counsellor at an AtoM Camp (please see counsellors, below). These people will be made known before and during any AtoM Camp event.

'''Anti-Harassment Policy'''

The AtoM community is dedicated to providing a harassment-free conference/camp experience for everyone. If you have been harassed, please consult this protocol for conflict resolution which makes clear how we can help.

The AtoM community has established the following policy to make it clear that we do not tolerate harassment in any form. Sexual or discriminatory language and imagery are not appropriate for any event venue, including talks, or any other communication channel used during the conference (such as social media).

Harassment includes:

* offensive verbal comments related to sex, gender, ethnicity, nationality, socioeconomic status, sexual orientation, disability, physical appearance, body size, age, race, religion;
* sexual or discriminatory images in public spaces;
* deliberate intimidation;
* stalking;
* harassing photography or recording;
* sustained disruption of talks or other events;
* inappropriate physical contact; and
* unwelcome sexual attention.

The lingua franca of AtoM Camp is English; however, English may not be the native language of AtoM Camp participants. Further, cultural norms around what may be considered obscene and offensive communication will vary among AtoM Camp attendees. Campers are asked to please be mindful of the international character of AtoM Camp, and to use respectful and clear language free of slang to facilitate communication.

Participants asked to stop any harassing behavior are expected to comply immediately.

If a participant engages in harassing behavior, event organizers and AtoM representatives (or their designees) may take any action they deem appropriate, including warning the offender, expulsion from the AtoM Camp, or contacting a higher authority such as a representative from the offender’s institution.

If a participant raises a concern relating to actions covered by this policy in good faith, there will be no retaliation for bringing forward their concern. Threatening or taking action against someone for invoking this policy or for participating in any related investigation will be considered a violation of this policy.

Participants are expected to follow the anti-harassment policy at all Camp-related venues, Camp-related social events, and online communication channels

We expect attendees and speakers past and present to be respectful to each other, and we will deal with any incidents that arise, including on social media.

We value your participation in the AtoM community and your support in keeping the AtoM community a safe, welcoming, and friendly space for fellow participants.

'''Acknowledgments'''

This policy is based on the [http://www.pasignyc.org/#code-of-conduct-section PASIG Code of Conduct], portions of which were modified from the [http://or2016.net/code-of-conduct/ Open Repositories’ code of conduct], which was itself modified from [https://www.seattleattic.com/codeofconduct Seattle Attic’s code of conduct] and the [http://adainitiative.org/what-we-do/events/ada-initiative-event-anti-harassment-policy/ Ada Initiative’s event harassment policy].

'''License'''

This document is licensed under [https://creativecommons.org/licenses/by-sa/3.0/ Creative Commons BY-SA].

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

[[Category:Community]]

Workspace

2019-05-15T22:03:05Z

Crogers:

<admonition type="warning">
'''Oops, you found us!'''

This is an internal workspace for Artefactual staff who are drafting new wiki content or major revisions to existing pages to test out their edits. Contents here are considered draft, unstable, and temporary.
</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:

* [[#Suggest minor fixes to Artefactual|Suggest minor fixes to Artefactual]]
* [[#File an issue in our documentation repository|File an issue in our documentation repository]]
* [[#Contribute documentation yourself via GitHub|Contribute documentation yourself via GitHub]]
* [[#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/ 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==

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!

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.

'''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>

'''Jump to:'''

* [[#Contributing_documentation_via_GitHub|Contributing documentation via GitHub]]
* [[#Contributing_documentation_using_Vagrant|Contributing documentation using Vagrant]]

===Contributing documentation 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 [[#Contributing_documentation_using_Vagrant|our instructions below]] for guidance.

'''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!

==Contributing 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!]]

===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.

====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'''

Using your command line interface, navigate to the folder where you have initialized your 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, you can run <code>vagrant ssh -- -A</code> to SSH into the Vagrant environment with your own key. 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 [https://wiki.accesstomemory.org/Workspace#Fork_the_AtoM_documentation_project Fork the AtoM project].

====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

====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.

====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!

====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: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: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: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://www.transifex.com/projects/p/atom/ Transifex] 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 Transifex in the future. In the meantime, we're always looking for help translating AtoM itself! See: [[Resources/Translation|Contribute translations]]
</admonition>

[[#Resources/Documentation/Contribute|Back to top]]

-----

* [[Main_Page|AtoM wiki home]]

Workspace

2019-05-14T01:57:17Z

Crogers:

Workspace

2019-05-13T20:06:33Z

Crogers: /* Add your public key to GitHub */

Workspace

2019-05-13T20:02:12Z

Crogers: /* Contributing documentation using Vagrant */

Workspace

2019-05-13T19:58:27Z

Crogers:

Workspace

2019-05-13T19:51:03Z

Crogers:

Community/Camps/London2019

2019-05-08T17:25:24Z

Crogers:

{{#pagetitle:AtoM Camp London 2019}}
[[Main Page]] > [[Community]] > [[Community/Camps]] > London2019

We're excited to announce our fourth AtoM Camp, co-hosted by the [https://www.westminster.ac.uk/ University of Westminster] and Artefactual! Inspired by similar events like Hydra Camp, Islandora Camp and Fedora Camp, AtoM Camp is intended to provide a space for anyone interested in or currently using AtoM to come together, learn about the platform from other users, and share their experiences.

<admonition type="tip">
'''We're also hosting an Archivematica Camp in London!''' July 10-12, 2019, at the [http://www.lse.ac.uk/ London School of Economics]. For more details, see the Archivematica wiki:

* https://wiki.archivematica.org/Community/Camps/London2019

</admonition>

== Dates & Location ==
'''July 15th -17th, 2019''' - '''[https://www.westminster.ac.uk/business/facilities-and-services/venues-for-hire/conference-and-venues/cavendish Cavendish Campus]''' at the '''[https://www.westminster.ac.uk/ University of Westminster]'''

115 New Cavendish Street, London, United Kingdom, W1W 6UW

'''Rooms:''' [coming soon]

Situated below the [https://en.wikipedia.org/wiki/BT_Tower BT Tower] is Cavendish Campus, a modern glass and steel building in New Cavendish Street (close to Warren Street, Great Portland Street or Goodge Street underground stations). Wander around the corner into [https://en.wikipedia.org/wiki/Fitzrovia Fitzrovia], a village-like district full of lively street cafes, and into the quiet garden square beyond.

[[Image:cavendish-campus.png|center|700px|link=https://goo.gl/maps/P4jmUpVgLqt ]]

[https://goo.gl/maps/P4jmUpVgLqt Click image for larger map]

===Accessibility===

The Cavendish Campus building is wheelchair accessible, with a ramp and automatic doors at the entrance. There are elevators inside for access to other floors.

A detailed accessibility profile for the building is available at: https://www.accessable.co.uk/venues/115-new-cavendish-street

* The nearest mainline station is Euston.
* There is a bus stop within 150m (164yds) of the venue.
* The nearest underground station is Great Portland Street.

===Getting to London===

'''By air'''

London has five major airports: London City, London Gatwick, London Heathrow, London Luton and London Stansted. There are several options for each airport for transport into London.
* London Heathrow, Gatwick and Stansted airports have dedicated express train services into central London.
* London Heathrow and City airports are directly connected to the Tube network.
* National Express, Easybus and Greenline coach transfers run 24 hours a day and start as low as £2 when booked in advance.
* Car hire is also available at every airport should you prefer to drive.

'''By train'''

Trains to London are often faster than driving or flying, and provide a greener form of transportation. London is the hub of the UK's rail network, with frequent services to all corners of the country from the city's centrally-located mainline railway stations. Rail services in the UK are run by a set of private train operating companies. Your point of departure will determine the best service to take and at what station your train will arrive in London.

If you're coming from Europe, the Eurostar train via the Channel Tunnel is also a great option. 'High Speed 1' delivers a faster, more reliable, less environmentally damaging alternative to flying from St Pancras station with connections that bring Eurostar services to travellers across the UK.

'''By car'''

London is easy to reach using the UK's motorway network – with the M1, M2, M3, M4, M11, M20, M23, M25 and M40 motorways in or near London – as well as a multitude of major A-roads. All of London's motorways intersect the M25 orbital motorway. Parking can prove difficult - National Car Parks (NCP) runs about 100 car parks in London. A [https://www.visitlondon.com/traveller-information/getting-around-london/congestion-charge Congestion Charge] applies to drivers of most vehicles in Central London between 7 am and 6 pm, Monday to Friday.

== '''Registration''' ==

Registration is now open!

This year, we are also running an Archivematica Camp in London the week before AtoM Camp (July 10-12), hosted by the London School of Economics. More details can be found on the [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica wiki]. If you register for both camps, we'll knock an additional £25 off the cost of each Camp, for a total savings of £50! We also have an early bird rate - registration will be £50 cheaper if you sign up before May 11, 2019!

* £375 Early bird (register before May 11th, 2019)
* £350 Early bird with 2-Camp discount (must also register for [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica Camp London])
* £425 Regular registration (after May 11 - July 14, 2019)
* £400 Regular 2-Camp discount (must also register for [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica Camp London])

'''Register here''':

* '''https://atomcamp-london-2019.eventbrite.com'''

== Camp Counselors ==

At all of the camps that Artefactual hosts, we seek to provide attendees with counselors who have a wide range of experience with the software. Supplementing members of the Artefactual crew will be counselors who have extensive experience with AtoM as users and administrators.

Details coming soon!

== Schedule ==

'''The schedule is a work in progress'''. Depending on the make-up of the campers, sessions might range from AtoM 101 for absolute beginners to command line tools to systems administration. We look forward to welcoming campers with a wide range of experience with AtoM!

<admonition type="tip">
If you'd like to get an idea of what to expect, why not take a look at the schedule from our previous Camps? Jump to:

* [[Community/Camps/SFU2017|SFU Vancouver Camp 2017]]
* [[Community/Camps/SJC2017|SJC Cambridge Camp 2017]]
* [[Community/Camps/UofT2018|UofT Toronto Camp 2018]]

</admonition>

'''**DRAFT SCHEDULE BELOW**'''

=== Day One - Monday, July 15th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |8:45am - 9:15am
|colspan="2"|Arrival, sign-in, and setup!
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Introductions, code of conduct, agenda overview, etc.
|-
|style="white-space: nowrap;" |9:30am - 10:45am
|colspan="2"|'''AtoM 101 - Basic orientation and records creation'''
This session is intended to ensure that everyone is on the same page and has a basic understanding of AtoM. We'll talk briefly about the history of the project, look at basic search and browse, and cover how to create and link records.
|-
|style="white-space: nowrap;" |10:45am - 11:00am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:00am - 12:15pm
|'''Authority records and Archival institutions'''
Learn how to add complex relationships between authority records, how to link them to repositories, how to theme repository records, and more.
|'''Vagrant installation and configuration'''
Intended for developers and archivists comfortable with unix command-line basics, this session will focus on ensuring that everyone has a working AtoM instance on their local laptop, and how to create a reusable dataset for testing and development. Must arrive with some things already installed!
|-
|style="white-space: nowrap;" |12:15pm - 1:15pm
|colspan="2"|'''Lunch'''
|-
|style="white-space: nowrap;" |1:15pm - 2:15pm
|'''Searching in AtoM - advanced/expert searching'''
Going beyond search basics, this session will start with a review of the advanced search features, cover Boolean queries, and end with some neat tricks on how to search against AtoM's search index fields directly.
|'''Get to know AtoM's codebase'''
An introduction for developers and systems administrators covering symfony, developer resources, standard practices, and other information.
|-
|style="white-space: nowrap;"|2:15pm - 3:15pm
|'''Customizing AtoM through the web interface'''
This session will cover how to manage menus, static pages, labels, themes, and other front-end customizations - no coding required. Campers will again use their personal AtoM instances to get hands-on experience configuring their own sites.
|'''Basic Command-line tasks'''
This session will give everyone a grounding on using the command line for basic maintenance, user management, troubleshooting, and data import/export. Even if you don't use the command line firsthand, this session will be helpful for understanding the functionality provided by AtoM's CLI.
|-
|style="white-space: nowrap;" |3:15pm - 3:30pm
|colspan="2"|Break
|-
|style="white-space: nowrap;"|3:30pm - 4:30pm
|'''Managing access: permissions and rights'''
During this session, campers will focus on creating and managing users and groups, editing group permissions, and implementing PREMIS rights rules. We'll also talk about managing multi-tenanted AtoM instances.
|'''Production installation and upgrading'''
This session will cover recommended installation parameters, gotchas and tips for installing on other systems, using Ansible for deployment, managing upgrades, and multi-site management.
|-
|style="white-space: nowrap;" |4:30pm -4:45pm
|colspan="2"|Wrap up and discussion of tomorrow
|-
|style="white-space: nowrap;" |6:00pm
|colspan="2"|Evening social event: small sign-up group dinners
|}

=== Day Two - Tuesday, July 16th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Review and questions, morning announcements, overview of the day.
|-
|style="white-space: nowrap;" |9:30am - 10:15am
|colspan="2"|'''Implementation tours'''
A brief tour of how some institutions are using AtoM in production. Additionally, this session is a chance for users of all stripes to show off their current implementations! If you're interested in discussing how AtoM works (or might work) in your institution, come prepared with a 2-5 minute informal blurb to share, and a link if the site is public.
|-
|style="white-space: nowrap;" |10:15am - 11:00am
|'''Exports via the user interface'''
This session will cover how the Clipboard can be used to export descriptions, authority records, and repository records via the user interface. We'll also look at how logged in users can export search results in CSV format.
|'''Data backup and restoration'''
A quick introduction for developers and system administrators on what data to back up, how to do it, and how to load your data back into AtoM.
|-
|style="white-space: nowrap;" |11:00am - 11:15am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:15am - 12:30pm
|'''Imports via the user interface'''
This session will show campers how to prepare and import archival descriptions, authority records, taxonomies, and other data types using CSV templates. We will also look briefly at how imports can be used to update existing descriptions, and other import formats, such as SKOS and EAD XML.
|'''Imports and exports via the command-line'''
An overview of how to bulk import XML and CSV data from the command-line, including tips, tricks, and gotchas.
|-
|style="white-space: nowrap;" |12:30pm - 1:30pm
|colspan="2"|'''Lunch'''
|-
|style="white-space: nowrap;" |1:30pm - 2:45pm
|'''Accessions and Physical storage'''
An overview of the accessions module, and how to manage physical storage locations data and link them to archival descriptions.
|'''Custom theme plugin development'''
This session will incorporate an introduction to relevant theming files, registering a plugin, home page customizations, and also give devs a chance to create basic themes.
|-
|style="white-space: nowrap;" |2:45pm - 3:00pm
|colspan="2"|Break
|-
|style="white-space: nowrap;" |3:00pm - 4:00pm
|'''TBA'''
This is where content from our regional community counselor will be presented!
|'''Workflows with Archivematica'''
Campers interested in integrating their AtoM instance with Archivematica can learn about DIP upload, passing descriptive and rights metadata from Archivematica to AtoM, and future enhancements to Archivematica's AtoM integration.
|-
|style="white-space: nowrap;" |4:00pm -4:15pm
|colspan="2"|Wrap up and discussion of tomorrow
|-
|style="white-space: nowrap;" |6:00pm - 11:00pm
|colspan="2"|'''Evening social event''': Group dinner at [https://www.wahaca.co.uk/locations/charlotte-street-and-mezcaleria-bar/ Wahaca] hosted by Artefactual!

'''Address''': 19-23 Charlotte Street
|}

=== Day Three - Wednesday, July 17th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Review and questions, morning announcements, overview of the day.
|-
|style="white-space: nowrap;" |9:45am - 10:45am
|'''Things I wish I'd known...'''
A round-up of tips, tricks, and gotchas for those new to AtoM, with enough content to help out even regular AtoM users. Bring your own tips and cautionary tales to share!
|'''AtoM Feature development'''
Thinking of developing a new feature or customization for AtoM? This session will expand upon the code overview session and introduce best practices for developing features - and sharing them back with the community. A look at plugin registration, major modules, functions and classes, as well as how Artefactual performs code review and public code management, including things to consider when planning a development project and submitting code to the public AtoM branch.
|-
|style="white-space: nowrap;" |10:45am - 11:00am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:00am - 12:15pm
|'''Data migrations'''
Leaving a thorny topic for last, this session will be an overview of potential approaches to data migration. We'll go over known challenges, how to map to standards, data cleanup using OpenRefine, scripting transformations, and AtoM's import formats.
|'''Dev and sysadmin clinic (open space)'''
An informal opportunity for devs and sysadmins to discuss any issues, suggestions, ideas, or wild speculations with the experts.
|-
|style="white-space: nowrap;" |12:15pm - 1:15pm
|colspan="2"|'''Lunch'''
|-
|1:15pm - 2:45pm
|colspan="2"|'''Future of AtoM/project governance'''
This session will cover AtoM's history and current maintenance model, paired with a look at different maintenance and governance models used by other open source projects in the cultural heritage sector. We'll conclude by discussing where the AtoM project - and the AtoM community - is headed, and brainstorm ideas of what we'd like to see in a next-generation version of AtoM.
|-
|style="white-space: nowrap;" |2:45pm - 3:30pm
|colspan="2"|'''Open Discussion, Q&A, and AtoM 2.5 sneak peek'''
Last chance to ask us anything we haven't addressed during the Camp, or open a topic for discussion with your peers! We'll also take some time to show off some of the exciting new features that will be included in the upcoming 2.5 release.
|-
|style="white-space: nowrap;" |3:30pm - 3:45pm
|colspan="2"|'''Closing and goodbyes'''
|}

 

Is there something you think we're missing from the list? When you register, there will be a field to suggest any other topics you want us to cover. If there's a critical mass of people who want to discuss a particular topic, we'll cover it! During the camp, we'll also leave lots of space to adjust the schedule to give time to specific topics as they come up.

== Accommodation and Things to Do ==

'''Where to stay'''

If you are looking for accommodations near the camp that won't break the bank, try the [https://www.westminster.ac.uk/business-services/venues-and-accommodation/summer-accommodation/marylebone-hall Marylebone Residence]. For the Camp discounted rate, use the code "ARTF19".

'''Things to do'''

Coming soon!

==Code of Conduct==

The AtoM community is dedicated to providing a welcoming and positive experience for everyone, whether they are in a formal session or a social setting related to an AtoM event, or are taking part in activities online. AtoM community participants come from all over the world and bring with them a wide variety of professional, personal and social backgrounds; whatever these may be, we treat colleagues with dignity and respect. We are sensitive to the fact that the international nature of the AtoM community means that we span many different social norms around language and behaviour and we strive to conduct ourselves in ways that are unlikely to cause offense. In the event that someone’s conduct is causing offense or distress, the AtoM Camp has a detailed Anti-Harassment Policy, details below, which can be applied to address the problem.

The first step in dealing with any serious misconduct is to contact a member of the organizing group, or a counsellor at an AtoM Camp (please see counsellors, below). These people will be made known before and during any AtoM Camp event.

'''Anti-Harassment Policy'''

The AtoM community is dedicated to providing a harassment-free conference/camp experience for everyone. If you have been harassed, please consult this protocol for conflict resolution which makes clear how we can help.

The AtoM community has established the following policy to make it clear that we do not tolerate harassment in any form. Sexual or discriminatory language and imagery are not appropriate for any event venue, including talks, or any other communication channel used during the conference (such as social media).

Harassment includes:

* offensive verbal comments related to sex, gender, ethnicity, nationality, socioeconomic status, sexual orientation, disability, physical appearance, body size, age, race, religion;
* sexual or discriminatory images in public spaces;
* deliberate intimidation;
* stalking;
* harassing photography or recording;
* sustained disruption of talks or other events;
* inappropriate physical contact; and
* unwelcome sexual attention.

The lingua franca of AtoM Camp is English; however, English may not be the native language of AtoM Camp participants. Further, cultural norms around what may be considered obscene and offensive communication will vary among AtoM Camp attendees. Campers are asked to please be mindful of the international character of AtoM Camp, and to use respectful and clear language free of slang to facilitate communication.

Participants asked to stop any harassing behavior are expected to comply immediately.

If a participant engages in harassing behavior, event organizers and AtoM representatives (or their designees) may take any action they deem appropriate, including warning the offender, expulsion from the AtoM Camp, or contacting a higher authority such as a representative from the offender’s institution.

If a participant raises a concern relating to actions covered by this policy in good faith, there will be no retaliation for bringing forward their concern. Threatening or taking action against someone for invoking this policy or for participating in any related investigation will be considered a violation of this policy.

Participants are expected to follow the anti-harassment policy at all Camp-related venues, Camp-related social events, and online communication channels

We expect attendees and speakers past and present to be respectful to each other, and we will deal with any incidents that arise, including on social media.

We value your participation in the AtoM community and your support in keeping the AtoM community a safe, welcoming, and friendly space for fellow participants.

'''Acknowledgments'''

This policy is based on the [http://www.pasignyc.org/#code-of-conduct-section PASIG Code of Conduct], portions of which were modified from the [http://or2016.net/code-of-conduct/ Open Repositories’ code of conduct], which was itself modified from [https://www.seattleattic.com/codeofconduct Seattle Attic’s code of conduct] and the [http://adainitiative.org/what-we-do/events/ada-initiative-event-anti-harassment-policy/ Ada Initiative’s event harassment policy].

'''License'''

This document is licensed under [https://creativecommons.org/licenses/by-sa/3.0/ Creative Commons BY-SA].

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

[[Category:Community]]

Community/Camps/London2019

2019-05-08T16:08:01Z

Crogers:

{{#pagetitle:AtoM Camp London 2019}}
[[Main Page]] > [[Community]] > [[Community/Camps]] > London2019

We're excited to announce our fourth AtoM Camp, co-hosted by the [https://www.westminster.ac.uk/ University of Westminster] and Artefactual! Inspired by similar events like Hydra Camp, Islandora Camp and Fedora Camp, AtoM Camp is intended to provide a space for anyone interested in or currently using AtoM to come together, learn about the platform from other users, and share their experiences.

<admonition type="tip">
'''We're also hosting an Archivematica Camp in London!''' July 10-12, 2019, at the [http://www.lse.ac.uk/ London School of Economics]. For more details, see the Archivematica wiki:

* https://wiki.archivematica.org/Community/Camps/London2019

</admonition>

== Dates & Location ==
'''July 15th -17th, 2019''' - '''[https://www.westminster.ac.uk/business/facilities-and-services/venues-for-hire/conference-and-venues/cavendish Cavendish Campus]''' at the '''[https://www.westminster.ac.uk/ University of Westminster]'''

115 New Cavendish Street, London, United Kingdom, W1W 6UW

'''Rooms:''' [coming soon]

Situated below the [https://en.wikipedia.org/wiki/BT_Tower BT Tower] is Cavendish Campus, a modern glass and steel building in New Cavendish Street (close to Warren Street, Great Portland Street or Goodge Street underground stations). Wander around the corner into [https://en.wikipedia.org/wiki/Fitzrovia Fitzrovia], a village-like district full of lively street cafes, and into the quiet garden square beyond.

[[Image:cavendish-campus.png|center|700px|link=https://goo.gl/maps/P4jmUpVgLqt ]]

[https://goo.gl/maps/P4jmUpVgLqt Click image for larger map]

===Accessibility===

The Cavendish Campus building is wheelchair accessible, with a ramp and automatic doors at the entrance. There are elevators inside for access to other floors.

A detailed accessibility profile for the building is available at: https://www.accessable.co.uk/venues/115-new-cavendish-street

* The nearest mainline station is Euston.
* There is a bus stop within 150m (164yds) of the venue.
* The nearest underground station is Great Portland Street.

===Getting to London===

'''By air'''

London has five major airports: London City, London Gatwick, London Heathrow, London Luton and London Stansted. There are several options for each airport for transport into London.
* London Heathrow, Gatwick and Stansted airports have dedicated express train services into central London.
* London Heathrow and City airports are directly connected to the Tube network.
* National Express, Easybus and Greenline coach transfers run 24 hours a day and start as low as £2 when booked in advance.
* Car hire is also available at every airport should you prefer to drive.

'''By train'''

Trains to London are often faster than driving or flying, and provide a greener form of transportation. London is the hub of the UK's rail network, with frequent services to all corners of the country from the city's centrally-located mainline railway stations. Rail services in the UK are run by a set of private train operating companies. Your point of departure will determine the best service to take and at what station your train will arrive in London.

If you're coming from Europe, the Eurostar train via the Channel Tunnel is also a great option. 'High Speed 1' delivers a faster, more reliable, less environmentally damaging alternative to flying from St Pancras station with connections that bring Eurostar services to travellers across the UK.

'''By car'''

London is easy to reach using the UK's motorway network – with the M1, M2, M3, M4, M11, M20, M23, M25 and M40 motorways in or near London – as well as a multitude of major A-roads. All of London's motorways intersect the M25 orbital motorway. Parking can prove difficult - National Car Parks (NCP) runs about 100 car parks in London. A [https://www.visitlondon.com/traveller-information/getting-around-london/congestion-charge Congestion Charge] applies to drivers of most vehicles in Central London between 7 am and 6 pm, Monday to Friday.

== '''Registration''' ==

Registration is now open!

This year, we are also running an Archivematica Camp in London the week before AtoM Camp (July 10-12), hosted by the London School of Economics. More details can be found on the [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica wiki]. If you register for both camps, we'll knock an additional £25 off the cost of each Camp, for a total savings of £50! We also have an early bird rate - registration will be £50 cheaper if you sign up before May 11, 2019!

* £375 Early bird (register before May 11th, 2019)
* £350 Early bird with 2-Camp discount (must also register for [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica Camp London])
* £425 Regular registration (after May 11 - July 14, 2019)
* £400 Regular 2-Camp discount (must also register for [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica Camp London])

'''Register here''':

* '''https://atomcamp-london-2019.eventbrite.com'''

== Camp Counselors ==

At all of the camps that Artefactual hosts, we seek to provide attendees with counselors who have a wide range of experience with the software. Supplementing members of the Artefactual crew will be counselors who have extensive experience with AtoM as users and administrators.

Details coming soon!

== Schedule ==

'''The schedule is a work in progress'''. Depending on the make-up of the campers, sessions might range from AtoM 101 for absolute beginners to command line tools to systems administration. We look forward to welcoming campers with a wide range of experience with AtoM!

<admonition type="tip">
If you'd like to get an idea of what to expect, why not take a look at the schedule from our previous Camps? Jump to:

* [[Community/Camps/SFU2017|SFU Vancouver Camp 2017]]
* [[Community/Camps/SJC2017|SJC Cambridge Camp 2017]]
* [[Community/Camps/UofT2018|UofT Toronto Camp 2018]]

</admonition>

'''**DRAFT SCHEDULE BELOW**'''

=== Day One - Monday, July 15th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |8:45am - 9:15am
|colspan="2"|Arrival, sign-in, and setup!
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Introductions, code of conduct, agenda overview, etc.
|-
|style="white-space: nowrap;" |9:30am - 10:45am
|colspan="2"|'''AtoM 101 - Basic orientation and records creation'''
This session is intended to ensure that everyone is on the same page and has a basic understanding of AtoM. We'll talk briefly about the history of the project, look at basic search and browse, and cover how to create and link records.
|-
|style="white-space: nowrap;" |10:45am - 11:00am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:00am - 12:15pm
|'''Authority records and Archival institutions'''
Learn how to add complex relationships between authority records, how to link them to repositories, how to theme repository records, and more.
|'''Vagrant installation and configuration'''
Intended for developers and archivists comfortable with unix command-line basics, this session will focus on ensuring that everyone has a working AtoM instance on their local laptop, and how to create a reusable dataset for testing and development. Must arrive with some things already installed!
|-
|style="white-space: nowrap;" |12:15pm - 1:15pm
|colspan="2"|'''Lunch'''
|-
|style="white-space: nowrap;" |1:15pm - 2:15pm
|'''Searching in AtoM - advanced/expert searching'''
Going beyond search basics, this session will start with a review of the advanced search features, cover Boolean queries, and end with some neat tricks on how to search against AtoM's search index fields directly.
|'''Get to know AtoM's codebase'''
An introduction for developers and systems administrators covering symfony, developer resources, standard practices, and other information.
|-
|style="white-space: nowrap;"|2:15pm - 3:15pm
|'''Customizing AtoM through the web interface'''
This session will cover how to manage menus, static pages, labels, themes, and other front-end customizations - no coding required. Campers will again use their personal AtoM instances to get hands-on experience configuring their own sites.
|'''Basic Command-line tasks'''
This session will give everyone a grounding on using the command line for basic maintenance, user management, troubleshooting, and data import/export. Even if you don't use the command line firsthand, this session will be helpful for understanding the functionality provided by AtoM's CLI.
|-
|style="white-space: nowrap;" |3:15pm - 3:30pm
|colspan="2"|Break
|-
|style="white-space: nowrap;"|3:30pm - 4:30pm
|'''Managing access: permissions and rights'''
During this session, campers will focus on creating and managing users and groups, editing group permissions, and implementing PREMIS rights rules. We'll also talk about managing multi-tenanted AtoM instances.
|'''Production installation and upgrading'''
This session will cover recommended installation parameters, gotchas and tips for installing on other systems, using Ansible for deployment, managing upgrades, and multi-site management.
|-
|style="white-space: nowrap;" |4:30pm -4:45pm
|colspan="2"|Wrap up and discussion of tomorrow
|-
|style="white-space: nowrap;" |6:00pm
|colspan="2"|Evening social event: small sign-up group dinners
|}

=== Day Two - Tuesday, July 16th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Review and questions, morning announcements, overview of the day.
|-
|style="white-space: nowrap;" |9:30am - 10:15am
|colspan="2"|'''Implementation tours'''
A brief tour of how some institutions are using AtoM in production. Additionally, this session is a chance for users of all stripes to show off their current implementations! If you're interested in discussing how AtoM works (or might work) in your institution, come prepared with a 2-5 minute informal blurb to share, and a link if the site is public.
|-
|style="white-space: nowrap;" |10:15am - 11:00am
|'''Exports via the user interface'''
This session will cover how the Clipboard can be used to export descriptions, authority records, and repository records via the user interface. We'll also look at how logged in users can export search results in CSV format.
|'''Data backup and restoration'''
A quick introduction for developers and system administrators on what data to back up, how to do it, and how to load your data back into AtoM.
|-
|style="white-space: nowrap;" |11:00am - 11:15am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:15am - 12:30pm
|'''Imports via the user interface'''
This session will show campers how to prepare and import archival descriptions, authority records, taxonomies, and other data types using CSV templates. We will also look briefly at how imports can be used to update existing descriptions, and other import formats, such as SKOS and EAD XML.
|'''Imports and exports via the command-line'''
An overview of how to bulk import XML and CSV data from the command-line, including tips, tricks, and gotchas.
|-
|style="white-space: nowrap;" |12:30pm - 1:30pm
|colspan="2"|'''Lunch'''
|-
|style="white-space: nowrap;" |1:30pm - 2:45pm
|'''Accessions and Physical storage'''
An overview of the accessions module, and how to manage physical storage locations data and link them to archival descriptions.
|'''Custom theme plugin development'''
This session will incorporate an introduction to relevant theming files, registering a plugin, home page customizations, and also give devs a chance to create basic themes.
|-
|style="white-space: nowrap;" |2:45pm - 3:00pm
|colspan="2"|Break
|-
|style="white-space: nowrap;" |3:00pm - 4:00pm
|'''TBA'''
This is where content from our regional community counselor will be presented!
|'''Workflows with Archivematica'''
Campers interested in integrating their AtoM instance with Archivematica can learn about DIP upload, passing descriptive and rights metadata from Archivematica to AtoM, and future enhancements to Archivematica's AtoM integration.
|-
|style="white-space: nowrap;" |4:00pm -4:15pm
|colspan="2"|Wrap up and discussion of tomorrow
|-
|style="white-space: nowrap;" |6:00pm - 11:00pm
|colspan="2"|'''Evening social event''': Details TBA!
|}

=== Day Three - Wednesday, July 17th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Review and questions, morning announcements, overview of the day.
|-
|style="white-space: nowrap;" |9:45am - 10:45am
|'''Things I wish I'd known...'''
A round-up of tips, tricks, and gotchas for those new to AtoM, with enough content to help out even regular AtoM users. Bring your own tips and cautionary tales to share!
|'''AtoM Feature development'''
Thinking of developing a new feature or customization for AtoM? This session will expand upon the code overview session and introduce best practices for developing features - and sharing them back with the community. A look at plugin registration, major modules, functions and classes, as well as how Artefactual performs code review and public code management, including things to consider when planning a development project and submitting code to the public AtoM branch.
|-
|style="white-space: nowrap;" |10:45am - 11:00am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:00am - 12:15pm
|'''Data migrations'''
Leaving a thorny topic for last, this session will be an overview of potential approaches to data migration. We'll go over known challenges, how to map to standards, data cleanup using OpenRefine, scripting transformations, and AtoM's import formats.
|'''Dev and sysadmin clinic (open space)'''
An informal opportunity for devs and sysadmins to discuss any issues, suggestions, ideas, or wild speculations with the experts.
|-
|style="white-space: nowrap;" |12:15pm - 1:15pm
|colspan="2"|'''Lunch'''
|-
|1:15pm - 2:45pm
|colspan="2"|'''Future of AtoM/project governance'''
This session will cover AtoM's history and current maintenance model, paired with a look at different maintenance and governance models used by other open source projects in the cultural heritage sector. We'll conclude by discussing where the AtoM project - and the AtoM community - is headed, and brainstorm ideas of what we'd like to see in a next-generation version of AtoM.
|-
|style="white-space: nowrap;" |2:45pm - 3:30pm
|colspan="2"|'''Open Discussion, Q&A, and AtoM 2.5 sneak peek'''
Last chance to ask us anything we haven't addressed during the Camp, or open a topic for discussion with your peers! We'll also take some time to show off some of the exciting new features that will be included in the upcoming 2.5 release.
|-
|style="white-space: nowrap;" |3:30pm - 3:45pm
|colspan="2"|'''Closing and goodbyes'''
|}

 

Is there something you think we're missing from the list? When you register, there will be a field to suggest any other topics you want us to cover. If there's a critical mass of people who want to discuss a particular topic, we'll cover it! During the camp, we'll also leave lots of space to adjust the schedule to give time to specific topics as they come up.

== Accommodation and Things to Do ==

'''Where to stay'''

If you are looking for accommodations near the camp that won't break the bank, try the [https://www.westminster.ac.uk/business-services/venues-and-accommodation/summer-accommodation/marylebone-hall Marylebone Residence]. For the Camp discounted rate, use the code "ARTF19".

'''Things to do'''

Coming soon!

==Code of Conduct==

The AtoM community is dedicated to providing a welcoming and positive experience for everyone, whether they are in a formal session or a social setting related to an AtoM event, or are taking part in activities online. AtoM community participants come from all over the world and bring with them a wide variety of professional, personal and social backgrounds; whatever these may be, we treat colleagues with dignity and respect. We are sensitive to the fact that the international nature of the AtoM community means that we span many different social norms around language and behaviour and we strive to conduct ourselves in ways that are unlikely to cause offense. In the event that someone’s conduct is causing offense or distress, the AtoM Camp has a detailed Anti-Harassment Policy, details below, which can be applied to address the problem.

The first step in dealing with any serious misconduct is to contact a member of the organizing group, or a counsellor at an AtoM Camp (please see counsellors, below). These people will be made known before and during any AtoM Camp event.

'''Anti-Harassment Policy'''

The AtoM community is dedicated to providing a harassment-free conference/camp experience for everyone. If you have been harassed, please consult this protocol for conflict resolution which makes clear how we can help.

The AtoM community has established the following policy to make it clear that we do not tolerate harassment in any form. Sexual or discriminatory language and imagery are not appropriate for any event venue, including talks, or any other communication channel used during the conference (such as social media).

Harassment includes:

* offensive verbal comments related to sex, gender, ethnicity, nationality, socioeconomic status, sexual orientation, disability, physical appearance, body size, age, race, religion;
* sexual or discriminatory images in public spaces;
* deliberate intimidation;
* stalking;
* harassing photography or recording;
* sustained disruption of talks or other events;
* inappropriate physical contact; and
* unwelcome sexual attention.

The lingua franca of AtoM Camp is English; however, English may not be the native language of AtoM Camp participants. Further, cultural norms around what may be considered obscene and offensive communication will vary among AtoM Camp attendees. Campers are asked to please be mindful of the international character of AtoM Camp, and to use respectful and clear language free of slang to facilitate communication.

Participants asked to stop any harassing behavior are expected to comply immediately.

If a participant engages in harassing behavior, event organizers and AtoM representatives (or their designees) may take any action they deem appropriate, including warning the offender, expulsion from the AtoM Camp, or contacting a higher authority such as a representative from the offender’s institution.

If a participant raises a concern relating to actions covered by this policy in good faith, there will be no retaliation for bringing forward their concern. Threatening or taking action against someone for invoking this policy or for participating in any related investigation will be considered a violation of this policy.

Participants are expected to follow the anti-harassment policy at all Camp-related venues, Camp-related social events, and online communication channels

We expect attendees and speakers past and present to be respectful to each other, and we will deal with any incidents that arise, including on social media.

We value your participation in the AtoM community and your support in keeping the AtoM community a safe, welcoming, and friendly space for fellow participants.

'''Acknowledgments'''

This policy is based on the [http://www.pasignyc.org/#code-of-conduct-section PASIG Code of Conduct], portions of which were modified from the [http://or2016.net/code-of-conduct/ Open Repositories’ code of conduct], which was itself modified from [https://www.seattleattic.com/codeofconduct Seattle Attic’s code of conduct] and the [http://adainitiative.org/what-we-do/events/ada-initiative-event-anti-harassment-policy/ Ada Initiative’s event harassment policy].

'''License'''

This document is licensed under [https://creativecommons.org/licenses/by-sa/3.0/ Creative Commons BY-SA].

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

[[Category:Community]]

Community/Camps/London2019

2019-04-29T16:16:14Z

Crogers:

{{#pagetitle:AtoM Camp London 2019}}
[[Main Page]] > [[Community]] > [[Community/Camps]] > London2019

We're excited to announce our fourth AtoM Camp, co-hosted by the [https://www.westminster.ac.uk/ University of Westminster] and Artefactual! Inspired by similar events like Hydra Camp, Islandora Camp and Fedora Camp, AtoM Camp is intended to provide a space for anyone interested in or currently using AtoM to come together, learn about the platform from other users, and share their experiences.

<admonition type="tip">
'''We're also hosting an Archivematica Camp in London!''' July 10-12, 2019, at the [http://www.lse.ac.uk/ London School of Economics]. For more details, see the Archivematica wiki:

* https://wiki.archivematica.org/Community/Camps/London2019

</admonition>

== Dates & Location ==
'''July 15th -17th, 2019''' - '''[https://www.westminster.ac.uk/business/facilities-and-services/venues-for-hire/conference-and-venues/cavendish Cavendish Campus]''' at the '''[https://www.westminster.ac.uk/ University of Westminster]'''

115 New Cavendish Street, London, United Kingdom, W1W 6UW

'''Rooms:''' [coming soon]

Situated below the [https://en.wikipedia.org/wiki/BT_Tower BT Tower] is Cavendish Campus, a modern glass and steel building in New Cavendish Street (close to Warren Street, Great Portland Street or Goodge Street underground stations). Wander around the corner into [https://en.wikipedia.org/wiki/Fitzrovia Fitzrovia], a village-like district full of lively street cafes, and into the quiet garden square beyond.

[[Image:cavendish-campus.png|center|700px|link=https://goo.gl/maps/P4jmUpVgLqt ]]

[https://goo.gl/maps/P4jmUpVgLqt Click image for larger map]

===Accessibility===

The Cavendish Campus building is wheelchair accessible, with a ramp and automatic doors at the entrance. There are elevators inside for access to other floors.

A detailed accessibility profile for the building is available at: https://www.accessable.co.uk/venues/115-new-cavendish-street

* The nearest mainline station is Euston.
* There is a bus stop within 150m (164yds) of the venue.
* The nearest underground station is Great Portland Street.

===Getting to London===

Coming soon!

== '''Registration''' ==

Registration is now open!

This year, we are also running an Archivematica Camp in London the week before AtoM Camp (July 10-12), hosted by the London School of Economics. More details can be found on the [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica wiki]. If you register for both camps, we'll knock an additional £25 off the cost of each Camp, for a total savings of £50! We also have an early bird rate - registration will be £50 cheaper if you sign up before May 11, 2019!

* £375 Early bird (register before May 11th, 2019)
* £350 Early bird with 2-Camp discount (must also register for [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica Camp London])
* £425 Regular registration (after May 11 - July 14, 2019)
* £400 Regular 2-Camp discount (must also register for [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica Camp London])

'''Register here''':

* '''https://atomcamp-london-2019.eventbrite.com'''

== Camp Counselors ==

At all of the camps that Artefactual hosts, we seek to provide attendees with counselors who have a wide range of experience with the software. Supplementing members of the Artefactual crew will be counselors who have extensive experience with AtoM as users and administrators.

Details coming soon!

== Schedule ==

'''The schedule is a work in progress'''. Depending on the make-up of the campers, sessions might range from AtoM 101 for absolute beginners to command line tools to systems administration. We look forward to welcoming campers with a wide range of experience with AtoM!

<admonition type="tip">
If you'd like to get an idea of what to expect, why not take a look at the schedule from our previous Camps? Jump to:

* [[Community/Camps/SFU2017|SFU Vancouver Camp 2017]]
* [[Community/Camps/SJC2017|SJC Cambridge Camp 2017]]
* [[Community/Camps/UofT2018|UofT Toronto Camp 2018]]

</admonition>

'''**DRAFT SCHEDULE BELOW**'''

=== Day One - Monday, July 15th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |8:45am - 9:15am
|colspan="2"|Arrival, sign-in, and setup!
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Introductions, code of conduct, agenda overview, etc.
|-
|style="white-space: nowrap;" |9:30am - 10:45am
|colspan="2"|'''AtoM 101 - Basic orientation and records creation'''
This session is intended to ensure that everyone is on the same page and has a basic understanding of AtoM. We'll talk briefly about the history of the project, look at basic search and browse, and cover how to create and link records.
|-
|style="white-space: nowrap;" |10:45am - 11:00am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:00am - 12:15pm
|'''Authority records and Archival institutions'''
Learn how to add complex relationships between authority records, how to link them to repositories, how to theme repository records, and more.
|'''Vagrant installation and configuration'''
Intended for developers and archivists comfortable with unix command-line basics, this session will focus on ensuring that everyone has a working AtoM instance on their local laptop, and how to create a reusable dataset for testing and development. Must arrive with some things already installed!
|-
|style="white-space: nowrap;" |12:15pm - 1:15pm
|colspan="2"|'''Lunch'''
|-
|style="white-space: nowrap;" |1:15pm - 2:15pm
|'''Searching in AtoM - advanced/expert searching'''
Going beyond search basics, this session will start with a review of the advanced search features, cover Boolean queries, and end with some neat tricks on how to search against AtoM's search index fields directly.
|'''Get to know AtoM's codebase'''
An introduction for developers and systems administrators covering symfony, developer resources, standard practices, and other information.
|-
|style="white-space: nowrap;"|2:15pm - 3:15pm
|'''Customizing AtoM through the web interface'''
This session will cover how to manage menus, static pages, labels, themes, and other front-end customizations - no coding required. Campers will again use their personal AtoM instances to get hands-on experience configuring their own sites.
|'''Basic Command-line tasks'''
This session will give everyone a grounding on using the command line for basic maintenance, user management, troubleshooting, and data import/export. Even if you don't use the command line firsthand, this session will be helpful for understanding the functionality provided by AtoM's CLI.
|-
|style="white-space: nowrap;" |3:15pm - 3:30pm
|colspan="2"|Break
|-
|style="white-space: nowrap;"|3:30pm - 4:30pm
|'''Managing access: permissions and rights'''
During this session, campers will focus on creating and managing users and groups, editing group permissions, and implementing PREMIS rights rules. We'll also talk about managing multi-tenanted AtoM instances.
|'''Production installation and upgrading'''
This session will cover recommended installation parameters, gotchas and tips for installing on other systems, using Ansible for deployment, managing upgrades, and multi-site management.
|-
|style="white-space: nowrap;" |4:30pm -4:45pm
|colspan="2"|Wrap up and discussion of tomorrow
|-
|style="white-space: nowrap;" |6:00pm
|colspan="2"|Evening social event: small sign-up group dinners
|}

=== Day Two - Tuesday, July 16th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Review and questions, morning announcements, overview of the day.
|-
|style="white-space: nowrap;" |9:30am - 10:15am
|colspan="2"|'''Implementation tours'''
A brief tour of how some institutions are using AtoM in production. Additionally, this session is a chance for users of all stripes to show off their current implementations! If you're interested in discussing how AtoM works (or might work) in your institution, come prepared with a 2-5 minute informal blurb to share, and a link if the site is public.
|-
|style="white-space: nowrap;" |10:15am - 11:00am
|'''Exports via the user interface'''
This session will cover how the Clipboard can be used to export descriptions, authority records, and repository records via the user interface. We'll also look at how logged in users can export search results in CSV format.
|'''Data backup and restoration'''
A quick introduction for developers and system administrators on what data to back up, how to do it, and how to load your data back into AtoM.
|-
|style="white-space: nowrap;" |11:00am - 11:15am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:15am - 12:30pm
|'''Imports via the user interface'''
This session will show campers how to prepare and import archival descriptions, authority records, taxonomies, and other data types using CSV templates. We will also look briefly at how imports can be used to update existing descriptions, and other import formats, such as SKOS and EAD XML.
|'''Imports and exports via the command-line'''
An overview of how to bulk import XML and CSV data from the command-line, including tips, tricks, and gotchas.
|-
|style="white-space: nowrap;" |12:30pm - 1:30pm
|colspan="2"|'''Lunch'''
|-
|style="white-space: nowrap;" |1:30pm - 2:45pm
|'''Accessions and Physical storage'''
An overview of the accessions module, and how to manage physical storage locations data and link them to archival descriptions.
|'''Custom theme plugin development'''
This session will incorporate an introduction to relevant theming files, registering a plugin, home page customizations, and also give devs a chance to create basic themes.
|-
|style="white-space: nowrap;" |2:45pm - 3:00pm
|colspan="2"|Break
|-
|style="white-space: nowrap;" |3:00pm - 4:00pm
|'''TBA'''
This is where content from our regional community counselor will be presented!
|'''Workflows with Archivematica'''
Campers interested in integrating their AtoM instance with Archivematica can learn about DIP upload, passing descriptive and rights metadata from Archivematica to AtoM, and future enhancements to Archivematica's AtoM integration.
|-
|style="white-space: nowrap;" |4:00pm -4:15pm
|colspan="2"|Wrap up and discussion of tomorrow
|-
|style="white-space: nowrap;" |6:00pm - 11:00pm
|colspan="2"|'''Evening social event''': Details TBA!
|}

=== Day Three - Wednesday, July 17th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Review and questions, morning announcements, overview of the day.
|-
|style="white-space: nowrap;" |9:45am - 10:45am
|'''Things I wish I'd known...'''
A round-up of tips, tricks, and gotchas for those new to AtoM, with enough content to help out even regular AtoM users. Bring your own tips and cautionary tales to share!
|'''AtoM Feature development'''
Thinking of developing a new feature or customization for AtoM? This session will expand upon the code overview session and introduce best practices for developing features - and sharing them back with the community. A look at plugin registration, major modules, functions and classes, as well as how Artefactual performs code review and public code management, including things to consider when planning a development project and submitting code to the public AtoM branch.
|-
|style="white-space: nowrap;" |10:45am - 11:00am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:00am - 12:15pm
|'''Data migrations'''
Leaving a thorny topic for last, this session will be an overview of potential approaches to data migration. We'll go over known challenges, how to map to standards, data cleanup using OpenRefine, scripting transformations, and AtoM's import formats.
|'''Dev and sysadmin clinic (open space)'''
An informal opportunity for devs and sysadmins to discuss any issues, suggestions, ideas, or wild speculations with the experts.
|-
|style="white-space: nowrap;" |12:15pm - 1:15pm
|colspan="2"|'''Lunch'''
|-
|1:15pm - 2:45pm
|colspan="2"|'''Future of AtoM/project governance'''
This session will cover AtoM's history and current maintenance model, paired with a look at different maintenance and governance models used by other open source projects in the cultural heritage sector. We'll conclude by discussing where the AtoM project - and the AtoM community - is headed, and brainstorm ideas of what we'd like to see in a next-generation version of AtoM.
|-
|style="white-space: nowrap;" |2:45pm - 3:30pm
|colspan="2"|'''Open Discussion, Q&A, and AtoM 2.5 sneak peek'''
Last chance to ask us anything we haven't addressed during the Camp, or open a topic for discussion with your peers! We'll also take some time to show off some of the exciting new features that will be included in the upcoming 2.5 release.
|-
|style="white-space: nowrap;" |3:30pm - 3:45pm
|colspan="2"|'''Closing and goodbyes'''
|}

 

Is there something you think we're missing from the list? When you register, there will be a field to suggest any other topics you want us to cover. If there's a critical mass of people who want to discuss a particular topic, we'll cover it! During the camp, we'll also leave lots of space to adjust the schedule to give time to specific topics as they come up.

== Accommodation and Things to Do ==

'''Where to stay'''

If you are looking for accommodations near the camp that won't break the bank, try the [https://www.westminster.ac.uk/business-services/venues-and-accommodation/summer-accommodation/marylebone-hall Marylebone Residence]. For the Camp discounted rate, use the code "ARTF19".

'''Things to do'''

Coming soon!

==Code of Conduct==

The AtoM community is dedicated to providing a welcoming and positive experience for everyone, whether they are in a formal session or a social setting related to an AtoM event, or are taking part in activities online. AtoM community participants come from all over the world and bring with them a wide variety of professional, personal and social backgrounds; whatever these may be, we treat colleagues with dignity and respect. We are sensitive to the fact that the international nature of the AtoM community means that we span many different social norms around language and behaviour and we strive to conduct ourselves in ways that are unlikely to cause offense. In the event that someone’s conduct is causing offense or distress, the AtoM Camp has a detailed Anti-Harassment Policy, details below, which can be applied to address the problem.

The first step in dealing with any serious misconduct is to contact a member of the organizing group, or a counsellor at an AtoM Camp (please see counsellors, below). These people will be made known before and during any AtoM Camp event.

'''Anti-Harassment Policy'''

The AtoM community is dedicated to providing a harassment-free conference/camp experience for everyone. If you have been harassed, please consult this protocol for conflict resolution which makes clear how we can help.

The AtoM community has established the following policy to make it clear that we do not tolerate harassment in any form. Sexual or discriminatory language and imagery are not appropriate for any event venue, including talks, or any other communication channel used during the conference (such as social media).

Harassment includes:

* offensive verbal comments related to sex, gender, ethnicity, nationality, socioeconomic status, sexual orientation, disability, physical appearance, body size, age, race, religion;
* sexual or discriminatory images in public spaces;
* deliberate intimidation;
* stalking;
* harassing photography or recording;
* sustained disruption of talks or other events;
* inappropriate physical contact; and
* unwelcome sexual attention.

The lingua franca of AtoM Camp is English; however, English may not be the native language of AtoM Camp participants. Further, cultural norms around what may be considered obscene and offensive communication will vary among AtoM Camp attendees. Campers are asked to please be mindful of the international character of AtoM Camp, and to use respectful and clear language free of slang to facilitate communication.

Participants asked to stop any harassing behavior are expected to comply immediately.

If a participant engages in harassing behavior, event organizers and AtoM representatives (or their designees) may take any action they deem appropriate, including warning the offender, expulsion from the AtoM Camp, or contacting a higher authority such as a representative from the offender’s institution.

If a participant raises a concern relating to actions covered by this policy in good faith, there will be no retaliation for bringing forward their concern. Threatening or taking action against someone for invoking this policy or for participating in any related investigation will be considered a violation of this policy.

Participants are expected to follow the anti-harassment policy at all Camp-related venues, Camp-related social events, and online communication channels

We expect attendees and speakers past and present to be respectful to each other, and we will deal with any incidents that arise, including on social media.

We value your participation in the AtoM community and your support in keeping the AtoM community a safe, welcoming, and friendly space for fellow participants.

'''Acknowledgments'''

This policy is based on the [http://www.pasignyc.org/#code-of-conduct-section PASIG Code of Conduct], portions of which were modified from the [http://or2016.net/code-of-conduct/ Open Repositories’ code of conduct], which was itself modified from [https://www.seattleattic.com/codeofconduct Seattle Attic’s code of conduct] and the [http://adainitiative.org/what-we-do/events/ada-initiative-event-anti-harassment-policy/ Ada Initiative’s event harassment policy].

'''License'''

This document is licensed under [https://creativecommons.org/licenses/by-sa/3.0/ Creative Commons BY-SA].

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

[[Category:Community]]

Community/Camps/London2019

2019-04-23T17:19:06Z

Crogers:

{{#pagetitle:AtoM Camp London 2019}}
[[Main Page]] > [[Community]] > [[Community/Camps]] > London2019

We're excited to announce our fourth AtoM Camp, co-hosted by the [https://www.westminster.ac.uk/ University of Westminster] and Artefactual! Inspired by similar events like Hydra Camp, Islandora Camp and Fedora Camp, AtoM Camp is intended to provide a space for anyone interested in or currently using AtoM to come together, learn about the platform from other users, and share their experiences.

<admonition type="tip">
'''We're also hosting an Archivematica Camp in London!''' July 10-12, 2019, at the [http://www.lse.ac.uk/ London School of Economics]. For more details, see the Archivematica wiki:

* https://wiki.archivematica.org/Community/Camps/London2019

</admonition>

== Dates & Location ==
'''July 15th -17th, 2019''' - '''[https://www.westminster.ac.uk/business/facilities-and-services/venues-for-hire/conference-and-venues/cavendish Cavendish Campus]''' at the '''[https://www.westminster.ac.uk/ University of Westminster]'''

115 New Cavendish Street, London, United Kingdom, W1W 6UW

'''Rooms:''' [coming soon]

Situated below the [https://en.wikipedia.org/wiki/BT_Tower BT Tower] is Cavendish Campus, a modern glass and steel building in New Cavendish Street (close to Warren Street, Great Portland Street or Goodge Street underground stations). Wander around the corner into [https://en.wikipedia.org/wiki/Fitzrovia Fitzrovia], a village-like district full of lively street cafes, and into the quiet garden square beyond.

[[Image:cavendish-campus.png|center|700px|link=https://goo.gl/maps/P4jmUpVgLqt ]]

[https://goo.gl/maps/P4jmUpVgLqt Click image for larger map]

===Accessibility===

The Cavendish Campus building is wheelchair accessible, with a ramp and automatic doors at the entrance. There are elevators inside for access to other floors.

A detailed accessibility profile for the building is available at: https://www.accessable.co.uk/venues/115-new-cavendish-street

* The nearest mainline station is Euston.
* There is a bus stop within 150m (164yds) of the venue.
* The nearest underground station is Great Portland Street.

===Getting to London===

Coming soon!

== '''Registration''' ==

Registration is now open!

This year, we are also running an Archivematica Camp in London the week before AtoM Camp (July 10-12), hosted by the London School of Economics. More details can be found on the [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica wiki]. If you register for both camps, we'll knock an additional £25 off the cost of each Camp, for a total savings of £50! We also have an early bird rate - registration will be £50 cheaper if you sign up before May 11, 2019!

* £375 Early bird (register before May 11th, 2019)
* £350 Early bird with 2-Camp discount (must also register for [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica Camp London])
* £425 Regular registration (after May 11 - July 14, 2019)
* £400 Regular 2-Camp discount (must also register for [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica Camp London])

'''Register here''':

* '''https://atomcamp-london-2019.eventbrite.com'''

== Camp Counselors ==

At all of the camps that Artefactual hosts, we seek to provide attendees with counselors who have a wide range of experience with the software. Supplementing members of the Artefactual crew will be counselors who have extensive experience with AtoM as users and administrators.

Details coming soon!

== Schedule ==

'''The schedule is a work in progress'''. Depending on the make-up of the campers, sessions might range from AtoM 101 for absolute beginners to command line tools to systems administration. We look forward to welcoming campers with a wide range of experience with AtoM!

<admonition type="tip">
If you'd like to get an idea of what to expect, why not take a look at the schedule from our previous Camps? Jump to:

* [[Community/Camps/SFU2017|SFU Vancouver Camp 2017]]
* [[Community/Camps/SJC2017|SJC Cambridge Camp 2017]]
* [[Community/Camps/UofT2018|UofT Toronto Camp 2018]]

</admonition>

'''**DRAFT SCHEDULE BELOW**'''

=== Day One - Monday, July 15th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |8:45am - 9:15am
|colspan="2"|Arrival, sign-in, and setup!
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Introductions, code of conduct, agenda overview, etc.
|-
|style="white-space: nowrap;" |9:30am - 10:45am
|colspan="2"|'''AtoM 101 - Basic orientation and records creation'''
This session is intended to ensure that everyone is on the same page and has a basic understanding of AtoM. We'll talk briefly about the history of the project, look at basic search and browse, and cover how to create and link records.
|-
|style="white-space: nowrap;" |10:45am - 11:00am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:00am - 12:15pm
|'''Authority records and Archival institutions'''
Learn how to add complex relationships between authority records, how to link them to repositories, how to theme repository records, and more.
|'''Vagrant installation and configuration'''
Intended for developers and archivists comfortable with unix command-line basics, this session will focus on ensuring that everyone has a working AtoM instance on their local laptop, and how to create a reusable dataset for testing and development. Must arrive with some things already installed!
|-
|style="white-space: nowrap;" |12:15pm - 1:15pm
|colspan="2"|'''Lunch'''
|-
|style="white-space: nowrap;" |1:15pm - 2:15pm
|'''Searching in AtoM - advanced/expert searching'''
Going beyond search basics, this session will start with a review of the advanced search features, cover Boolean queries, and end with some neat tricks on how to search against AtoM's search index fields directly.
|'''Get to know AtoM's codebase'''
An introduction for developers and systems administrators covering symfony, developer resources, standard practices, and other information.
|-
|style="white-space: nowrap;"|2:15pm - 3:15pm
|'''Customizing AtoM through the web interface'''
This session will cover how to manage menus, static pages, labels, themes, and other front-end customizations - no coding required. Campers will again use their personal AtoM instances to get hands-on experience configuring their own sites.
|'''Basic Command-line tasks'''
This session will give everyone a grounding on using the command line for basic maintenance, user management, troubleshooting, and data import/export. Even if you don't use the command line firsthand, this session will be helpful for understanding the functionality provided by AtoM's CLI.
|-
|style="white-space: nowrap;" |3:15pm - 3:30pm
|colspan="2"|Break
|-
|style="white-space: nowrap;"|3:30pm - 4:30pm
|'''Managing access: permissions and rights'''
During this session, campers will focus on creating and managing users and groups, editing group permissions, and implementing PREMIS rights rules. We'll also talk about managing multi-tenanted AtoM instances.
|'''Production installation and upgrading'''
This session will cover recommended installation parameters, gotchas and tips for installing on other systems, using Ansible for deployment, managing upgrades, and multi-site management.
|-
|style="white-space: nowrap;" |4:30pm -4:45pm
|colspan="2"|Wrap up and discussion of tomorrow
|-
|style="white-space: nowrap;" |6:00pm
|colspan="2"|Evening social event: small sign-up group dinners
|}

=== Day Two - Tuesday, July 16th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Review and questions, morning announcements, overview of the day.
|-
|style="white-space: nowrap;" |9:30am - 10:15am
|colspan="2"|'''Implementation tours'''
A brief tour of how some institutions are using AtoM in production. Additionally, this session is a chance for users of all stripes to show off their current implementations! If you're interested in discussing how AtoM works (or might work) in your institution, come prepared with a 2-5 minute informal blurb to share, and a link if the site is public.
|-
|style="white-space: nowrap;" |10:15am - 11:00am
|'''Exports via the user interface'''
This session will cover how the Clipboard can be used to export descriptions, authority records, and repository records via the user interface. We'll also look at how logged in users can export search results in CSV format.
|'''Data backup and restoration'''
A quick introduction for developers and system administrators on what data to back up, how to do it, and how to load your data back into AtoM.
|-
|style="white-space: nowrap;" |11:00am - 11:15am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:15am - 12:30pm
|'''Imports via the user interface'''
This session will show campers how to prepare and import archival descriptions, authority records, taxonomies, and other data types using CSV templates. We will also look briefly at how imports can be used to update existing descriptions, and other import formats, such as SKOS and EAD XML.
|'''Imports and exports via the command-line'''
An overview of how to bulk import XML and CSV data from the command-line, including tips, tricks, and gotchas.
|-
|style="white-space: nowrap;" |12:30pm - 1:30pm
|colspan="2"|'''Lunch'''
|-
|style="white-space: nowrap;" |1:30pm - 2:45pm
|'''Accessions and Physical storage'''
An overview of the accessions module, and how to manage physical storage locations data and link them to archival descriptions.
|'''Custom theme plugin development'''
This session will incorporate an introduction to relevant theming files, registering a plugin, home page customizations, and also give devs a chance to create basic themes.
|-
|style="white-space: nowrap;" |2:45pm - 3:00pm
|colspan="2"|Break
|-
|style="white-space: nowrap;" |3:00pm - 4:00pm
|'''TBA'''
This is where content from our regional community counselor will be presented!
|'''Workflows with Archivematica'''
Campers interested in integrating their AtoM instance with Archivematica can learn about DIP upload, passing descriptive and rights metadata from Archivematica to AtoM, and future enhancements to Archivematica's AtoM integration.
|-
|style="white-space: nowrap;" |4:00pm -4:15pm
|colspan="2"|Wrap up and discussion of tomorrow
|-
|style="white-space: nowrap;" |6:00pm - 11:00pm
|colspan="2"|'''Evening social event''': Details TBA!
|}

=== Day Three - Wednesday, July 17th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Review and questions, morning announcements, overview of the day.
|-
|style="white-space: nowrap;" |9:45am - 10:45am
|'''Things I wish I'd known...'''
A round-up of tips, tricks, and gotchas for those new to AtoM, with enough content to help out even regular AtoM users. Bring your own tips and cautionary tales to share!
|'''AtoM Feature development'''
Thinking of developing a new feature or customization for AtoM? This session will expand upon the code overview session and introduce best practices for developing features - and sharing them back with the community. A look at plugin registration, major modules, functions and classes, as well as how Artefactual performs code review and public code management, including things to consider when planning a development project and submitting code to the public AtoM branch.
|-
|style="white-space: nowrap;" |10:45am - 11:00am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:00am - 12:15pm
|'''Data migrations'''
Leaving a thorny topic for last, this session will be an overview of potential approaches to data migration. We'll go over known challenges, how to map to standards, data cleanup using OpenRefine, scripting transformations, and AtoM's import formats.
|'''Dev and sysadmin clinic (open space)'''
An informal opportunity for devs and sysadmins to discuss any issues, suggestions, ideas, or wild speculations with the experts.
|-
|style="white-space: nowrap;" |12:15pm - 1:15pm
|colspan="2"|'''Lunch'''
|-
|1:15pm - 2:45pm
|colspan="2"|'''Future of AtoM/project governance'''
This session will cover AtoM's history and current maintenance model, paired with a look at different maintenance and governance models used by other open source projects in the cultural heritage sector. We'll conclude by discussing where the AtoM project - and the AtoM community - is headed, and brainstorm ideas of what we'd like to see in a next-generation version of AtoM.
|-
|style="white-space: nowrap;" |2:45pm - 3:30pm
|colspan="2"|'''Open Discussion, Q&A, and AtoM 2.5 sneak peek'''
Last chance to ask us anything we haven't addressed during the Camp, or open a topic for discussion with your peers! We'll also take some time to show off some of the exciting new features that will be included in the upcoming 2.5 release.
|-
|style="white-space: nowrap;" |3:30pm - 3:45pm
|colspan="2"|'''Closing and goodbyes'''
|}

 

Is there something you think we're missing from the list? When you register, there will be a field to suggest any other topics you want us to cover. If there's a critical mass of people who want to discuss a particular topic, we'll cover it! During the camp, we'll also leave lots of space to adjust the schedule to give time to specific topics as they come up.

== Accommodation and Things to Do ==

'''Where to stay'''

If you are looking for accommodations near the camp that won't break the bank, try the [https://www.westminster.ac.uk/business-services/venues-and-accommodation/summer-accommodation/marylebone-hall Marylebone Residence].

'''Things to do'''

Coming soon!

==Code of Conduct==

The AtoM community is dedicated to providing a welcoming and positive experience for everyone, whether they are in a formal session or a social setting related to an AtoM event, or are taking part in activities online. AtoM community participants come from all over the world and bring with them a wide variety of professional, personal and social backgrounds; whatever these may be, we treat colleagues with dignity and respect. We are sensitive to the fact that the international nature of the AtoM community means that we span many different social norms around language and behaviour and we strive to conduct ourselves in ways that are unlikely to cause offense. In the event that someone’s conduct is causing offense or distress, the AtoM Camp has a detailed Anti-Harassment Policy, details below, which can be applied to address the problem.

The first step in dealing with any serious misconduct is to contact a member of the organizing group, or a counsellor at an AtoM Camp (please see counsellors, below). These people will be made known before and during any AtoM Camp event.

'''Anti-Harassment Policy'''

The AtoM community is dedicated to providing a harassment-free conference/camp experience for everyone. If you have been harassed, please consult this protocol for conflict resolution which makes clear how we can help.

The AtoM community has established the following policy to make it clear that we do not tolerate harassment in any form. Sexual or discriminatory language and imagery are not appropriate for any event venue, including talks, or any other communication channel used during the conference (such as social media).

Harassment includes:

* offensive verbal comments related to sex, gender, ethnicity, nationality, socioeconomic status, sexual orientation, disability, physical appearance, body size, age, race, religion;
* sexual or discriminatory images in public spaces;
* deliberate intimidation;
* stalking;
* harassing photography or recording;
* sustained disruption of talks or other events;
* inappropriate physical contact; and
* unwelcome sexual attention.

The lingua franca of AtoM Camp is English; however, English may not be the native language of AtoM Camp participants. Further, cultural norms around what may be considered obscene and offensive communication will vary among AtoM Camp attendees. Campers are asked to please be mindful of the international character of AtoM Camp, and to use respectful and clear language free of slang to facilitate communication.

Participants asked to stop any harassing behavior are expected to comply immediately.

If a participant engages in harassing behavior, event organizers and AtoM representatives (or their designees) may take any action they deem appropriate, including warning the offender, expulsion from the AtoM Camp, or contacting a higher authority such as a representative from the offender’s institution.

If a participant raises a concern relating to actions covered by this policy in good faith, there will be no retaliation for bringing forward their concern. Threatening or taking action against someone for invoking this policy or for participating in any related investigation will be considered a violation of this policy.

Participants are expected to follow the anti-harassment policy at all Camp-related venues, Camp-related social events, and online communication channels

We expect attendees and speakers past and present to be respectful to each other, and we will deal with any incidents that arise, including on social media.

We value your participation in the AtoM community and your support in keeping the AtoM community a safe, welcoming, and friendly space for fellow participants.

'''Acknowledgments'''

This policy is based on the [http://www.pasignyc.org/#code-of-conduct-section PASIG Code of Conduct], portions of which were modified from the [http://or2016.net/code-of-conduct/ Open Repositories’ code of conduct], which was itself modified from [https://www.seattleattic.com/codeofconduct Seattle Attic’s code of conduct] and the [http://adainitiative.org/what-we-do/events/ada-initiative-event-anti-harassment-policy/ Ada Initiative’s event harassment policy].

'''License'''

This document is licensed under [https://creativecommons.org/licenses/by-sa/3.0/ Creative Commons BY-SA].

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

[[Category:Community]]

Community/Camps/London2019

2019-04-23T16:50:35Z

Crogers:

{{#pagetitle:AtoM Camp London 2019}}
[[Main Page]] > [[Community]] > [[Community/Camps]] > London2019

We're excited to announce our fourth AtoM Camp, co-hosted by the [https://www.westminster.ac.uk/ University of Westminster] and Artefactual! Inspired by similar events like Hydra Camp, Islandora Camp and Fedora Camp, AtoM Camp is intended to provide a space for anyone interested in or currently using AtoM to come together, learn about the platform from other users, and share their experiences.

<admonition type="tip">
'''We're also hosting an Archivematica Camp in London!''' July 10-12, 2019, at the [http://www.lse.ac.uk/ London School of Economics]. For more details, see the Archivematica wiki:

* https://wiki.archivematica.org/Community/Camps/London2019

</admonition>

== Dates & Location ==
'''July 15th -17th, 2019''' - '''[https://www.westminster.ac.uk/business/facilities-and-services/venues-for-hire/conference-and-venues/cavendish Cavendish Campus]''' at the '''[https://www.westminster.ac.uk/ University of Westminster]'''

115 New Cavendish Street, London, United Kingdom, W1W 6UW

'''Rooms:''' [coming soon]

Situated below the [https://en.wikipedia.org/wiki/BT_Tower BT Tower] is Cavendish Campus, a modern glass and steel building in New Cavendish Street (close to Warren Street, Great Portland Street or Goodge Street underground stations). Wander around the corner into [https://en.wikipedia.org/wiki/Fitzrovia Fitzrovia], a village-like district full of lively street cafes, and into the quiet garden square beyond.

[[Image:cavendish-campus.png|center|700px|link=https://goo.gl/maps/P4jmUpVgLqt ]]

[https://goo.gl/maps/P4jmUpVgLqt Click image for larger map]

===Accessibility===

The Cavendish Campus building is wheelchair accessible, with a ramp and automatic doors at the entrance. There are elevators inside for access to other floors.

A detailed accessibility profile for the building is available at: https://www.accessable.co.uk/venues/115-new-cavendish-street

* The nearest mainline station is Euston.
* There is a bus stop within 150m (164yds) of the venue.
* The nearest underground station is Great Portland Street.

===Getting to London===

Coming soon!

'''Where to stay'''

If you are looking for accommodations near the camp that won't break the bank, try the [https://www.westminster.ac.uk/business-services/venues-and-accommodation/summer-accommodation/marylebone-hall Marylebone Residence].

== '''Registration''' ==

Registration is now open!

This year, we are also running an Archivematica Camp in London the week before AtoM Camp (July 10-12), hosted by the London School of Economics. More details can be found on the [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica wiki]. If you register for both camps, we'll knock an additional £25 off the cost of each Camp, for a total savings of £50! We also have an early bird rate - registration will be £50 cheaper if you sign up before May 11, 2019!

* £375 Early bird (register before May 11th, 2019)
* £350 Early bird with 2-Camp discount (must also register for [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica Camp London])
* £425 Regular registration (after May 11 - July 14, 2019)
* £400 Regular 2-Camp discount (must also register for [https://wiki.archivematica.org/Community/Camps/London2019 Archivematica Camp London])

'''Register here''':

* '''https://atomcamp-london-2019.eventbrite.com'''

== Camp Counselors ==

At all of the camps that Artefactual hosts, we seek to provide attendees with counselors who have a wide range of experience with the software. Supplementing members of the Artefactual crew will be counselors who have extensive experience with AtoM as users and administrators.

Details coming soon!

== Schedule ==

'''The schedule is a work in progress'''. Depending on the make-up of the campers, sessions might range from AtoM 101 for absolute beginners to command line tools to systems administration. We look forward to welcoming campers with a wide range of experience with AtoM!

<admonition type="tip">
If you'd like to get an idea of what to expect, why not take a look at the schedule from our previous Camps? Jump to:

* [[Community/Camps/SFU2017|SFU Vancouver Camp 2017]]
* [[Community/Camps/SJC2017|SJC Cambridge Camp 2017]]
* [[Community/Camps/UofT2018|UofT Toronto Camp 2018]]

</admonition>

'''**DRAFT SCHEDULE BELOW**'''

=== Day One - Monday, July 15th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |8:45am - 9:15am
|colspan="2"|Arrival, sign-in, and setup!
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Introductions, code of conduct, agenda overview, etc.
|-
|style="white-space: nowrap;" |9:30am - 10:45am
|colspan="2"|'''AtoM 101 - Basic orientation and records creation'''
This session is intended to ensure that everyone is on the same page and has a basic understanding of AtoM. We'll talk briefly about the history of the project, look at basic search and browse, and cover how to create and link records.
|-
|style="white-space: nowrap;" |10:45am - 11:00am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:00am - 12:15pm
|'''Authority records and Archival institutions'''
Learn how to add complex relationships between authority records, how to link them to repositories, how to theme repository records, and more.
|'''Vagrant installation and configuration'''
Intended for developers and archivists comfortable with unix command-line basics, this session will focus on ensuring that everyone has a working AtoM instance on their local laptop, and how to create a reusable dataset for testing and development. Must arrive with some things already installed!
|-
|style="white-space: nowrap;" |12:15pm - 1:15pm
|colspan="2"|'''Lunch'''
|-
|style="white-space: nowrap;" |1:15pm - 2:15pm
|'''Searching in AtoM - advanced/expert searching'''
Going beyond search basics, this session will start with a review of the advanced search features, cover Boolean queries, and end with some neat tricks on how to search against AtoM's search index fields directly.
|'''Get to know AtoM's codebase'''
An introduction for developers and systems administrators covering symfony, developer resources, standard practices, and other information.
|-
|style="white-space: nowrap;"|2:15pm - 3:15pm
|'''Customizing AtoM through the web interface'''
This session will cover how to manage menus, static pages, labels, themes, and other front-end customizations - no coding required. Campers will again use their personal AtoM instances to get hands-on experience configuring their own sites.
|'''Basic Command-line tasks'''
This session will give everyone a grounding on using the command line for basic maintenance, user management, troubleshooting, and data import/export. Even if you don't use the command line firsthand, this session will be helpful for understanding the functionality provided by AtoM's CLI.
|-
|style="white-space: nowrap;" |3:15pm - 3:30pm
|colspan="2"|Break
|-
|style="white-space: nowrap;"|3:30pm - 4:30pm
|'''Managing access: permissions and rights'''
During this session, campers will focus on creating and managing users and groups, editing group permissions, and implementing PREMIS rights rules. We'll also talk about managing multi-tenanted AtoM instances.
|'''Production installation and upgrading'''
This session will cover recommended installation parameters, gotchas and tips for installing on other systems, using Ansible for deployment, managing upgrades, and multi-site management.
|-
|style="white-space: nowrap;" |4:30pm -4:45pm
|colspan="2"|Wrap up and discussion of tomorrow
|-
|style="white-space: nowrap;" |6:00pm
|colspan="2"|Evening social event: small sign-up group dinners
|}

=== Day Two - Tuesday, July 16th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Review and questions, morning announcements, overview of the day.
|-
|style="white-space: nowrap;" |9:30am - 10:15am
|colspan="2"|'''Implementation tours'''
A brief tour of how some institutions are using AtoM in production. Additionally, this session is a chance for users of all stripes to show off their current implementations! If you're interested in discussing how AtoM works (or might work) in your institution, come prepared with a 2-5 minute informal blurb to share, and a link if the site is public.
|-
|style="white-space: nowrap;" |10:15am - 11:00am
|'''Exports via the user interface'''
This session will cover how the Clipboard can be used to export descriptions, authority records, and repository records via the user interface. We'll also look at how logged in users can export search results in CSV format.
|'''Data backup and restoration'''
A quick introduction for developers and system administrators on what data to back up, how to do it, and how to load your data back into AtoM.
|-
|style="white-space: nowrap;" |11:00am - 11:15am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:15am - 12:30pm
|'''Imports via the user interface'''
This session will show campers how to prepare and import archival descriptions, authority records, taxonomies, and other data types using CSV templates. We will also look briefly at how imports can be used to update existing descriptions, and other import formats, such as SKOS and EAD XML.
|'''Imports and exports via the command-line'''
An overview of how to bulk import XML and CSV data from the command-line, including tips, tricks, and gotchas.
|-
|style="white-space: nowrap;" |12:30pm - 1:30pm
|colspan="2"|'''Lunch'''
|-
|style="white-space: nowrap;" |1:30pm - 2:45pm
|'''Accessions and Physical storage'''
An overview of the accessions module, and how to manage physical storage locations data and link them to archival descriptions.
|'''Custom theme plugin development'''
This session will incorporate an introduction to relevant theming files, registering a plugin, home page customizations, and also give devs a chance to create basic themes.
|-
|style="white-space: nowrap;" |2:45pm - 3:00pm
|colspan="2"|Break
|-
|style="white-space: nowrap;" |3:00pm - 4:00pm
|'''TBA'''
This is where content from our regional community counselor will be presented!
|'''Workflows with Archivematica'''
Campers interested in integrating their AtoM instance with Archivematica can learn about DIP upload, passing descriptive and rights metadata from Archivematica to AtoM, and future enhancements to Archivematica's AtoM integration.
|-
|style="white-space: nowrap;" |4:00pm -4:15pm
|colspan="2"|Wrap up and discussion of tomorrow
|-
|style="white-space: nowrap;" |6:00pm - 11:00pm
|colspan="2"|'''Evening social event''': Details TBA!
|}

=== Day Three - Wednesday, July 17th, 2019 ===

{| border="1" style="border-collapse:collapse;"
|'''Time'''
|'''Main room'''
|'''Breakout room'''
|-
|style="white-space: nowrap;" |9:15am - 9:30am
|colspan="2"|'''Welcome'''
Review and questions, morning announcements, overview of the day.
|-
|style="white-space: nowrap;" |9:45am - 10:45am
|'''Things I wish I'd known...'''
A round-up of tips, tricks, and gotchas for those new to AtoM, with enough content to help out even regular AtoM users. Bring your own tips and cautionary tales to share!
|'''AtoM Feature development'''
Thinking of developing a new feature or customization for AtoM? This session will expand upon the code overview session and introduce best practices for developing features - and sharing them back with the community. A look at plugin registration, major modules, functions and classes, as well as how Artefactual performs code review and public code management, including things to consider when planning a development project and submitting code to the public AtoM branch.
|-
|style="white-space: nowrap;" |10:45am - 11:00am
|colspan="2"|Break
|-
|style="white-space: nowrap;" |11:00am - 12:15pm
|'''Data migrations'''
Leaving a thorny topic for last, this session will be an overview of potential approaches to data migration. We'll go over known challenges, how to map to standards, data cleanup using OpenRefine, scripting transformations, and AtoM's import formats.
|'''Dev and sysadmin clinic (open space)'''
An informal opportunity for devs and sysadmins to discuss any issues, suggestions, ideas, or wild speculations with the experts.
|-
|style="white-space: nowrap;" |12:15pm - 1:15pm
|colspan="2"|'''Lunch'''
|-
|1:15pm - 2:45pm
|colspan="2"|'''Future of AtoM/project governance'''
This session will cover AtoM's history and current maintenance model, paired with a look at different maintenance and governance models used by other open source projects in the cultural heritage sector. We'll conclude by discussing where the AtoM project - and the AtoM community - is headed, and brainstorm ideas of what we'd like to see in a next-generation version of AtoM.
|-
|style="white-space: nowrap;" |2:45pm - 3:30pm
|colspan="2"|'''Open Discussion, Q&A, and AtoM 2.5 sneak peek'''
Last chance to ask us anything we haven't addressed during the Camp, or open a topic for discussion with your peers! We'll also take some time to show off some of the exciting new features that will be included in the upcoming 2.5 release.
|-
|style="white-space: nowrap;" |3:30pm - 3:45pm
|colspan="2"|'''Closing and goodbyes'''
|}

 

Is there something you think we're missing from the list? When you register, there will be a field to suggest any other topics you want us to cover. If there's a critical mass of people who want to discuss a particular topic, we'll cover it! During the camp, we'll also leave lots of space to adjust the schedule to give time to specific topics as they come up.

== Accommodation and Things to Do ==

Coming soon!

==Code of Conduct==

The AtoM community is dedicated to providing a welcoming and positive experience for everyone, whether they are in a formal session or a social setting related to an AtoM event, or are taking part in activities online. AtoM community participants come from all over the world and bring with them a wide variety of professional, personal and social backgrounds; whatever these may be, we treat colleagues with dignity and respect. We are sensitive to the fact that the international nature of the AtoM community means that we span many different social norms around language and behaviour and we strive to conduct ourselves in ways that are unlikely to cause offense. In the event that someone’s conduct is causing offense or distress, the AtoM Camp has a detailed Anti-Harassment Policy, details below, which can be applied to address the problem.

The first step in dealing with any serious misconduct is to contact a member of the organizing group, or a counsellor at an AtoM Camp (please see counsellors, below). These people will be made known before and during any AtoM Camp event.

'''Anti-Harassment Policy'''

The AtoM community is dedicated to providing a harassment-free conference/camp experience for everyone. If you have been harassed, please consult this protocol for conflict resolution which makes clear how we can help.

The AtoM community has established the following policy to make it clear that we do not tolerate harassment in any form. Sexual or discriminatory language and imagery are not appropriate for any event venue, including talks, or any other communication channel used during the conference (such as social media).

Harassment includes:

* offensive verbal comments related to sex, gender, ethnicity, nationality, socioeconomic status, sexual orientation, disability, physical appearance, body size, age, race, religion;
* sexual or discriminatory images in public spaces;
* deliberate intimidation;
* stalking;
* harassing photography or recording;
* sustained disruption of talks or other events;
* inappropriate physical contact; and
* unwelcome sexual attention.

The lingua franca of AtoM Camp is English; however, English may not be the native language of AtoM Camp participants. Further, cultural norms around what may be considered obscene and offensive communication will vary among AtoM Camp attendees. Campers are asked to please be mindful of the international character of AtoM Camp, and to use respectful and clear language free of slang to facilitate communication.

Participants asked to stop any harassing behavior are expected to comply immediately.

If a participant engages in harassing behavior, event organizers and AtoM representatives (or their designees) may take any action they deem appropriate, including warning the offender, expulsion from the AtoM Camp, or contacting a higher authority such as a representative from the offender’s institution.

If a participant raises a concern relating to actions covered by this policy in good faith, there will be no retaliation for bringing forward their concern. Threatening or taking action against someone for invoking this policy or for participating in any related investigation will be considered a violation of this policy.

Participants are expected to follow the anti-harassment policy at all Camp-related venues, Camp-related social events, and online communication channels

We expect attendees and speakers past and present to be respectful to each other, and we will deal with any incidents that arise, including on social media.

We value your participation in the AtoM community and your support in keeping the AtoM community a safe, welcoming, and friendly space for fellow participants.

'''Acknowledgments'''

This policy is based on the [http://www.pasignyc.org/#code-of-conduct-section PASIG Code of Conduct], portions of which were modified from the [http://or2016.net/code-of-conduct/ Open Repositories’ code of conduct], which was itself modified from [https://www.seattleattic.com/codeofconduct Seattle Attic’s code of conduct] and the [http://adainitiative.org/what-we-do/events/ada-initiative-event-anti-harassment-policy/ Ada Initiative’s event harassment policy].

'''License'''

This document is licensed under [https://creativecommons.org/licenses/by-sa/3.0/ Creative Commons BY-SA].

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

[[Category:Community]]

Community/Users

2019-04-03T20:08:57Z

Crogers:

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

On this page you'll find some examples of institutions and organizations using AtoM and/or ICA-AtoM. Don't see your institution on this list? Please feel free to [[Special:UserLogin|add a link]] to your AtoM installation!

==AtoM (2.x) sites==

'''English'''
* [https://archives.rcaf.museum/ Air Force Museum of Alberta Archives]
* [http://www.albertaonrecord.ca/ Alberta on Record: Archives Society of Alberta Portal]
* [https://archives.ambrose.edu/ Ambrose Archives]
* [http://archeion.ca Archeion: Ontario's Archival Information Network]
* [https://archie.library.carleton.ca/ Archives & Research Collections, Carleton University Library]
* [http://anglicanarchives.ica-atom.org/ Archives of the Anglican Diocese of New Westminster and Provincial Synod of BC and Yukon]
* [http://arc.anla.nf.ca/ ARC: the Archival Resource Catalogue of the Association of Newfoundland and Labrador Archives]
* [https://archivescanada.accesstomemory.ca/ ArchivesCanada - the Canadian Archival Information Network Portal]
* [http://archives.canbarchives.ca/ ArchivesCANB: the Council of Archives New Brunswick's archival database]
* [http://www.archives.pe.ca/atom/index.php/ Archives PEI, the Archives Council of Prince Edward Island's description database]
* [http://archives.artcenter.edu/ ArtCenter Archives and the Hoffmitz Milken Center for Typography Archives]
* [http://archivescollection.anu.edu.au/ Australian National University Archives]
* [http://beatoninstitute.com/ The Beaton Institute (Cape Breton University)]
* [https://hbbarchive.ca/ Bishop's University - History beyond Borders project]
* [https://borthcat.york.ac.uk/ Borthwick Institute for Archives - University of York]
* [http://atom.lib.bcit.ca/ British Columbia Institute of Technology Archives & Special Collections]
* [https://archives.cendari.dariah.eu/ CENDARI Archives Directory]
* [https://ccap.uvic.ca Chinese Canadian Artifacts Project]
* [http://searcharchives.coquitlam.ca/ City of Coquitlam Archives]
* [http://searcharchives.vancouver.ca/ City of Vancouver Archives]
* [https://archives.victoria.ca/ City of Victoria Archives]
* [http://winnipeginfocus.winnipeg.ca/ City of Winnipeg Archives]
* [http://claretiansusa.org Claretain Missionaries USA-Canada Province] (archives site not public)
* [https://archives.cliftonbridge.org.uk/ Clifton Suspension Bridge Archives]
* [https://discover.cabhc.ca/ Community Archives of Belleville and Hastings County]
* [http://concordia.accesstomemory.org/ Concordia University]
* [https://onlinecollections.cumberlandmuseum.ca/ Cumberland Museum and Archives]
* [http://helates.cut.ac.cy/ Cyprus University of Technology Library Archives] (Greek)
* [https://findingaids.library.dal.ca/ Dalhousie University Libraries]
* [https://saanich.accesstomemory.org/ District of Saanich Archives]
* [http://atom.doaks.org/atom/ Dumbarton Oaks Research Library and Collection]
* [https://atom-sparc.fitnyc.edu/ Fashion Institute of Technology - Gladys Marcus Library's Special Collections and College Archives]
* [https://fhya.org/ Five Hundred Year Archive (FHYA)]
* [https://archives.franciscanfriars.ca/ Franciscans of Canada Archives West]
* [http://archives.gcu.ac.uk/ Glasgow Caledonian University Archives]
* [http://archive.griffith.ox.ac.uk Griffith Institute Archive]
* [http://archives.hpl.ca/ Hamilton Public Library Local History & Archives Department]
* [https://archives.highgatecemetery.org/ Highgate Cemetary Archives]
* [http://www.highlandparkhistory.org/ Highland Park Historical Society]
* [http://historicalpapers-atom.wits.ac.za/historical-papers-research-archive-library-university-of-witwatersrand Historical Papers Research Archive, Wits University]
* [http://ica.institutomarcelodeda.com.br/ Instituto Marcelo Déda]
* [http://jikn.sikn.go.id/ Jaringan Informasi Kearsipan Nasional] (Indonesian)
* [http://archives.jewishmuseum.ca/ The Jewish Museum & Archives of BC]
* [https://archives.kpu.ca/ Kwantlen Polytechnic University Archives]
* [http://archives.lakeheadu.ca/ Lakehead University Archives]
* [https://libarchives.wlu.ca/ Laurier Archives]
* [http://www.ltiarchives.ca Leeds and the Thousand Islands Archives]
* [http://www.legatum.ufba.br/atom/ Legatum - Sonus et Imago Repository] (multilingual)
* [http://lslirc-tarrarchives.accesstomemory.org/ Lesser Slave Lake IRC Treaty Aboriginal Rights Research Archives]
* [https://archives.mhsc.ca/ MAID: The Mennonite Archival Image Database]
* [http://nanna.lib.umanitoba.ca/ MAIN: Manitoba Archival Information Network]
* [http://archives.mcmaster.ca/ McMaster University Library Archives and Research Collections]
* [http://www.memorybc.ca/ MemoryBC - British Columbia's Archival Information Network]
* [https://memoryns.ca/ MemoryNS, the Council of Nova Scotia Archives' archival database]
* [http://www.gov.pe.ca/paroatom/ Memory PEI - Public Archives and Records Office of Prince Edward Island]
* [http://catalogue.millsarchive.org/ Mills Archive]
* [http://history.missionarchives.com/ Mission Community Archives]
* [https://archives.mtroyal.ca/ Mount Royal University Archives and Special Collections]
* [http://archives.museeheritage.ca Musée Héritage Museum Archives]
* [http://atom.moa.ubc.ca/ Museum of Anthropology, Audrey and Harry Hawthorn Library and Archives, University of British Columbia]
* [http://museumofcroydoncollections.com/catalogues/ Museum of Croydon]
* [https://archives.library.wales/ National Library of Wales - Archives and Manuscripts]
* [https://archives.nyrr.org/ New York Road Runners Archives]
* [http://archives.eclibrary.ca/ Nipissing University and Canadore College Archives and Special Collections]
* [http://archives.nato.int/ North Atlantic Treaty Organization (NATO) Archives]
* [https://atomic.library.tmc.edu/ Nuclear Memories Archive] (Texas Medical Center Library)
* [http://offalyhistoryarchives.com/ Offaly History Archives]
* [https://digitalcollections.ohs.org/ Oregon Historical Society Digital Collections]
* [http://asiapacific.anu.edu.au/pambu/catalogue/ Pacific Manuscripts Bureau]
* [http://atom.prattsils.org/ Pratt School of Information On-site Archives and Special Collections]
* [http://archives.ppcli.com/ Princess Patricia’s Canadian Light Infantry Museum & Archives]
* [http://atom.skagafjordur.is/index.php/ Regional Archives of Skagafj ordur] (English, Icelandic)
*[https://archives.renison.ca/ Renison University College, Florence Li Tim-Oi Memorial Archives]
* [https://rcdcarchives.ica-atom.org/ Roman Catholic Diocese of Calgary Archives]
* [http://search-bcarchives.royalbcmuseum.bc.ca/ Royal British Columbia Museum - BC Archives]
* [http://archives.rncm.ac.uk/ Royal Northern College of Music]
* [https://royalroads.accesstomemory.org/ Royal Roads University]
* [https://www.sjcarchives.org.uk/institutional/ Saint John's College Archives]
* [http://atom.library.moore.edu.au/ The Samuel Marsden Archives, Moore College Library]
* [http://sain.scaa.sk.ca/collections/ Saskatchewan Archival Information Network Collections Database]
* [http://sain.scaa.sk.ca/items/ Saskatchewan Archival Information Network Photographs Database]
* [https://senecacollege.accesstomemory.org/ Seneca College Archives and Special Collections]
* [http://atom.archives.sfu.ca/ SFU AtoM - Simon Fraser University]
* [https://atom.schalifax.ca/ The Sisters of Charity - Halifax Archives]
* [http://squamishlibrary.digitalcollections.ca/ Squamish Public Library - Digital Collections]
* [https://archive.sro.wa.gov.au/ State Records Office of Western Australia]
* [https://archives.sgul.ac.uk/ St George's Archives & Special Collections, University of London]
* [https://stirlingcouncil.ica-atom.org/ Stirling Council Archives]
* [https://archives.trinity.edu/ Trinity University Coates Library Special Collections and Archives]
* [http://archivessearch.twu.ca/ Trinity Western University Archives and Special Collections]
* [http://search.nbca.unbc.ca/index.php/ UNBC Northern BC Archives]
* [http://atom.archives.unesco.org/ UNESCO Archives]
* [http://search.archives.un.org/ United Nations Archives and Records Management Section]
* [http://rbscarchives.library.ubc.ca/ University of British Columbia Rare Books and Special Collections]
* [https://searcharchives.ucalgary.ca/ University of Calgary Archives and Special Collections]
* [http://www.atom.lib.uct.ac.za/ University of Capetown Libraries: Special Collections]
* [http://sca.glos.ac.uk/index.php/ University of Gloucestershire Special Collections and Archives]
* [https://atom.library.miami.edu/ University of Miami Archival Collections]
* [http://archives.unam.edu.na/ University of Namibia Archives]
* [http://search.nbca.unbc.ca/ University of Northern British Columbia Archives]
* [https://biblio.uottawa.ca/atom/index.php/ University of Ottawa - Archives and Special Collections]
* [http://strathclyde.ica-atom.org/ University of Strathclyde Archives]
* [https://sparc.utas.edu.au/ University of Tasmania - Special & Rare Collections online]
* [https://discoverarchives.library.utoronto.ca/ University of Toronto - Discover Archives]
* [http://whistler.ica-atom.org/ Whistler Museum and Archives]
* [https://archivesholdings.worldbank.org/ World Bank Group Archives Holdings]
* [http://atom.library.yorku.ca Clara Thomas Archives and Special Collections, York University Libraries]

'''French'''
* [https://inventaires.archivescommunales-vd.ch/ Archives comunales du canton de Vaud] (Swiss)
* [http://archivesdemontreal.ica-atom.org/ Archives de Montréal]
* [https://archives.uclouvain.be/atom/index.php/ Archives de l'Université catholique de Louvain] (Belgium)
* [http://ratp.histolab.fr/index.php/?sf_culture=fr Archives Groupe RATP ] (French)
* [https://archiveshistoriques.ville.levis.qc.ca/ Archives privées de la Ville de Lévis]
* [http://http://claretains.ca/ Missionaires Clarétains] (archives site not public)
* [https://caspar.cinematheque.ch CASPAR - Cinémathèque Suisse Papier Archives] (French)
* [http://archives.graduateinstitute.ch/ The Graduate Institute IHEID, Geneva] (French)
* [https://legis.cdij.bj/ LEGIS : Base de données des textes de loi en République du Bénin] (French)

'''Brazillian Portuguese'''
* [http://fonte.ufsm.br/ Acervo Arquivístico da Universidade Federal de Santa Maria]
* [http://acervo.cidarq.ufg.br/index.php/iuryy;isad Acervos Arquivísticos]
* [http://icaatom.almg.gov.br/ Acervo Arquivístico da Assembleia Legislativa do Estado de Minas Gerais]
* [http://www.acervomemorial.al.rs.gov.br/index.php/?sf_culture=pt Acervo do Memorial do Legislativo]
* [http://arquivodigital.furg.br/ Arquivo digital da Universidade Federal do Rio Grande]
* [https://atom.tjpe.jus.br/ Arquivo Histórico do Memorial da Justiça]
* [http://arquivomunicipal.caxias.rs.gov.br/ Arquivo Histórico Municipal João Spadari Adami - Caxias do Sul]
*[https://www.acervo.arquivopublico.pe.gov.br/index.php/arquivo-publico-estadual-jordao-emerenciano Arquivo Público Estadual Jordão Emerenciano]
* [http://www.cle.unicamp.br/atom-2.2.1/index.php/ Arquivos Históricos do Centro de Lógica, Epistemologia e História da Ciência]
* [http://200.222.27.136/ Arquivo Público do Estado do Rio de Janeiro]
* [http://www.icaatom.apeb.fpc.ba.gov.br/index.php/?sf_culture=pt/ Bahia. Arquivo Público do Estado da Bahia (Apeb)]
* [http://www.basearch.coc.fiocruz.br/ Base Arch - Fundação Oswaldo Cruz]
* [http://dibrarq.arquivonacional.gov.br/index.php/ Brasil. Arquivo Nacional. Diretório Brasil de Arquivos (Dibrarq)]
* [http://linux.an.gov.br/icaatom/index.php/ Brasil. Arquivo Nacional. Guia de fontes para a história da Holanda e holandeses no Brasil]
* [https://arquivohistorico.camara.leg.br/index.php/ Brasil. Câmara dos Deputados]
* [http://www.arquivodamarinha.dphdm.mar.mil.br/index.php/ Brasil. Marinha do Brasil. Diretoria do Patrimônio Histórico e Documentação (DPHDM)]
* [http://arquivohistorico.inep.gov.br/ Brasil. Ministério da Educação. Instituto Nacional de Estudos e Pesquisas Educacionais 'Anísio Teixeira' (Inep)]
* [http://arch.coc.fiocruz.br/ Brasil. Ministério da Saúde. Fundação Oswaldo Cruz (Fiocruz)]
* [http://bibjuventude.ibict.br/jspui/bitstream/192/232/1/OLIVEIRA_implementacaoatomsnj_2017.pdf Brasil. Secretaria Nacional da Juventude (SNJ)]
* [http://arquivocidadao.stj.jus.br/index.php/ Brasil. Superior Tribunal de Justiça (STJ)]
* [http://arquivomunicipal.caxias.rs.gov.br/index.php/ Caxias do Sul-RS. Arquivo Histórico Municipal 'João Spadari Adami']
* [http://dibrarq.arquivonacional.gov.br/ DIBRARQ - Diretório Brasil de Arquivos]
* [http://www.atom.arquivopublico.df.gov.br/ Distrito Federal. Arquivo Público do Distrito Federal (APDF)]
* [http://201.62.44.38/index.php/?sf_culture=pt_BR Espírito Santo. Arquivo Público do Estado do Espírito Santo (Apees)]
* [https://acervo.fpabramo.org.br/ Fundação Perseu Abramo. Centro sérgio Buarque de Holanda (CSBH/FPA)]
* [http://www.legatum.ufba.br/atom/index.php/?sf_culture=pt Iniciativa Legatum]
* [http://atom.poa.ifrs.edu.br/index.php/ Instituto Federal do Rio Grande do Sul. Campus Porto Alegre]
* [http://atom.poa.ifrs.edu.br/ Instituto Federal Rio Grande do Sul - Campus Porto Alegre]
* [http://ica.institutomarcelodeda.com.br/index.php/ Instituto Marcelo Deda (IMD)]
* [http://atom.ippdh.mercosur.int/index.php/ Mercosul. Instituto de Políticas Públicas em Direitos Humanos. Guia de Arquivos e Fundos Documentais]
* [https://atom.almg.gov.br/index.php/ Minas Gerais. Assembleia Legislativa (ALMG)]
* [http://www.lampeh.ufv.br/breve/atom/index.php/?sf_culture=p Minas Gerais. Tribunal de Justiça de Minas Gerais (TJMG)]
* [https://www.acervo.pe.gov.br/ Pernambuco. Arquivo Público Estadual Jordão Emerenciano]
* [https://atom.tjpe.jus.br/index.php/ Pernambuco. Tribunal de Justiça de Pernambuco (TJPE)]
* [https://www.acervo.pe.gov.br Portal Estadual do Patrimônio Documental de Pernambuco]
* [http://200.222.27.136/index.php/ Rio de Janeiro (estado). Arquivo Público do Estado do Rio de Janeiro (Aperj)]
* [http://www.acervomemorial.al.rs.gov.br/index.php/?sf_culture=pt Rio Grande do Sul. Assembleia Legislativa (ALRS)]
* [https://atom.jfrs.jus.br/atom/index.php/ Rio Grande do Sul. Justiça Federal do Rio Grande do Sul (JFRS)]
* [http://atom.unijui.edu.br/index.php/?sf_culture=pt_BR Rio Grande do Sul. Museu Antropológico 'Diretor Pestana' (MADP)]
* [http://web2.santamaria.rs.gov.br/arquivohistorico/sistema_descricao_documental/ Santa Maria-RS. Arquivo Histórico Municipal]
* [http://icaatom.arquivoestado.sp.gov.br/ica-atom/destaques.php São Paulo (estado). Arquivo Público do Estado de São Paulo (Apesp)]
* [http://icaatom.arquivoestado.sp.gov.br/ica-atom/destaques.php São Paulo (estado). Arquivo Público do Estado de São Paulo (Apesp)]
* [https://atom.unb.br/ Universidade de Brasília]
* [http://ar[qhist.cle.unicamp.br/index.php/?sf_culture=pt_BR Universidade de Campinas (Unicamp). Centro de Lógica, Epistemologia e História da Ciência]
* [http://atom.ufcspa.edu.br/ Universidade Federal de Ciências da Saúde de Porto Alegre]
* [http://atom.ufv.br/ Universidade Federal de Viçosa]
* [http://goo.gl/UPvjqa Universidade de São Paulo (USP). Museu Histórico 'Carlos da Silva Lacaz']
* [http://www.arquivohistorico.poli.usp.br/ Universidade de São Paulo (USP). Escola Politécnica. Arquivo Histórico]
* [http://acervo.cidarq.ufg.br/index.php/ Universidade Federal de Goiás (UFG)]
* [http://fonte.ufsm.br/ Universidade Federal de Santa Maria (UFSM)]
* [https://arquivodigital.furg.br/?sf_culture=pt_BR Universidade Federal do Rio Grande (Furg)]
* [http://www.ufrgs.br/arquivo-artes/icaatom/web/index.php/?sf_culture=pt Universidade Federal do Rio Grande do Sul (UFRGS). Instituto de Artes]

'''Portuguese'''
* [http://arquivoatom.up.pt/index.php/fundacao-instituto-arquitecto-jose-marques-da-silva Arquivo da Fundação Instituto Marques da Silva] (Portuguese)
* [http://fotos.psd.pt/atom/index.php/ Arquivo da Social-Democracia] (Portuguese)
* [http://arquivo.igreja-lusitana.org/ Arquivo Histórico da Igreja Lusitana] (Portuguese)
* [https://arquivo.cdi-maceiraliz.pt/ Arquivo Histórico Fábrica Maceira-Liz] (Portuguese)
* [http://www.ahsocial.ics.ulisboa.pt/atom/ Arquivo de História Social do Instituto de Ciências Sociais da Universidade de Lisboa] (Portuguese)
* [http://arquivo.cm-albergaria.pt/ Arquivo Municipal de Albergaria-a-Velha] (Portuguese)
* [http://arquivodigital.cm-oaz.pt/ Arquivo Municipal de Oliveira de Azeméis] (Portuguese)
* [http://45.33.69.154/index.php/?sf_culture=pt Arquivo Municipal de Sines] (Portuguese)
* [http://arquivo.cm-valedecambra.pt/ Arquivo Municipal de Vale de Cambra] (Portuguese)
* [https://arquivo.cm-viladobispo.pt/ Arquivo Municipal de Vila do Bispo] (Portuguese)
* [http://portal.cehr.ft.lisboa.ucp.pt/arquivos/ PAPIR - Plataforma de Arquivos Pessoais e de Instituições Religiosas] (Portuguese)
* [http://arquivoatom.up.pt/ Universidade do Porto] (Portuguese)

'''Spanish'''
* [http://132.248.192.4:8081 Archivo Histórico de la UNAM] (Spanish)
* [http://www.madrid.org/archivos_atom/ Archivos de la Comunidad de Madrid] (Spanish)
* [http://archivospublicos.cl/ Archivos Históricos de la Universidad Alberto Hurtado] (Spanish)
* [http://archivo.mariategui.org/ Archivo José Carlos Mariátegui] (Perú - Spanish)
* [http://amp.ing.puc.cl/ Archivo de Música Popular Chilena] (Spanish)
* [http://archivospresidenciales.archivonacional.cl/ Archivo Michelle Bachelet Jeria (President of Chile)] (Spanish)
* [http://archivo.plasencia.es/ Archivo Municipal de Plasencia (Extremadura)] (Spanish)
* [http://archivos.cedinci.org/ CeDInCI - Centro de Documentación e Investigación de la Cultura de Izquierdas en Argentina] (Spanish)
* [http://fondomigueldelibes.fundacionmigueldelibes.es/index.php Fondo Documental Miguel Delibes] (Spanish)
* [http://archivosescolares.ing.puc.cl/ Programa de Archivos Escolares] (Spanish)

'''Dutch'''
* [https://archief.onroerenderfgoed.be/ Archief van het Vlaams Instituut voor het Onroerend Erfgoed] (Dutch)

'''Italian'''
* [http://atom.unito.it/ Historical Archives of the University of Torino] (Italian)

'''Swedish'''
* [https://arken.kb.se/ National Library of Sweden - Arken Directory] (Swedish)

'''Greek'''
* [http://nspantelakis.gr/family-archives/ Nikolaos S. Pantelakis Family archives] (Greek)

==ICA-AtoM (1.x) sites==

'''English'''
* [http://www.dart.ipsr.mahidol.ac.th/index.php/n56S2;isad Digital Archive of Research on Thailand]
* [http://archive.womenslibrary.org.uk/index.php/ Glasgow Women's Library Archive Catalogue]
* [http://www.migan.org MIGAN - the directory of Caribbean archival institutions] (English/French)
* [http://ica-atom.tasglann.org.uk/ Tasglann nan Eilean Siar (Hebridean Archives)]

'''Brazilian Portuguese'''
* [http://web2.santamaria.rs.gov.br/arquivohistorico/sistema_descricao_documental/index.php/ Acervo digital do Arquivo Histórico Municipal de Santa Maria] (Brazilian Portuguese)
* [http://icaatom.arquivoestado.sp.gov.br Arquivo Público do Estado de São Paulo] (Brazilian Portuguese)

'''Portuguese'''
* [http://cad.cgtp.pt/ica/ Centro de Arquivo e Documentação CGTP-IN] (Portuguese)

'''Spanish'''
* [http://archivo.ateneodemadrid.es Archivo del Ateneo de Madrid] (Spanish)
* [http://www.madrid.org/icaatom_pub/index.php/ Archivos de la Comunidad de Madrid] (Spanish)
* [http://archivo.plasencia.es/ Archivo Municipal de Plasencia] (Spanish)
* [http://archivocti.uma.es/icaatom/ Base de datos fotográfica del Centro de Tecnología de la Imagen de la Universidad de Málaga] (Spanish)

Please feel free to [[Special:UserLogin|add a link]] to your AtoM installation.

[[Category:Community]]

Community/Users

2019-04-03T20:04:00Z

Crogers: /* AtoM (2.x) sites */

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

On this page you'll find some examples of institutions and organizations using AtoM and/or ICA-AtoM. Don't see your institution on this list? Please feel free to [[Special:UserLogin|add a link]] to your AtoM installation!

==AtoM (2.x) sites==

'''English'''
* [https://archives.rcaf.museum/ Air Force Museum of Alberta Archives]
* [http://www.albertaonrecord.ca/ Alberta on Record: Archives Society of Alberta Portal]
* [https://archives.ambrose.edu/ Ambrose Archives]
* [http://archeion.ca Archeion: Ontario's Archival Information Network]
* [https://archie.library.carleton.ca/ Archives & Research Collections, Carleton University Library]
* [http://anglicanarchives.ica-atom.org/ Archives of the Anglican Diocese of New Westminster and Provincial Synod of BC and Yukon]
* [http://arc.anla.nf.ca/ ARC: the Archival Resource Catalogue of the Association of Newfoundland and Labrador Archives]
* [https://archivescanada.accesstomemory.ca/ ArchivesCanada - the Canadian Archival Information Network Portal]
* [http://archives.canbarchives.ca/ ArchivesCANB: the Council of Archives New Brunswick's archival database]
* [http://www.archives.pe.ca/atom/index.php/ Archives PEI, the Archives Council of Prince Edward Island's description database]
* [http://archives.artcenter.edu/ ArtCenter Archives and the Hoffmitz Milken Center for Typography Archives]
* [http://archivescollection.anu.edu.au/ Australian National University Archives]
* [http://beatoninstitute.com/ The Beaton Institute (Cape Breton University)]
* [https://hbbarchive.ca/ Bishop's University - History beyond Borders project]
* [https://borthcat.york.ac.uk/ Borthwick Institute for Archives - University of York]
* [http://atom.lib.bcit.ca/ British Columbia Institute of Technology Archives & Special Collections]
* [https://archives.cendari.dariah.eu/ CENDARI Archives Directory]
* [https://ccap.uvic.ca Chinese Canadian Artifacts Project]
* [http://searcharchives.coquitlam.ca/ City of Coquitlam Archives]
* [http://searcharchives.vancouver.ca/ City of Vancouver Archives]
* [https://archives.victoria.ca/ City of Victoria Archives]
* [http://winnipeginfocus.winnipeg.ca/ City of Winnipeg Archives]
* [http://claretiansusa.org Claretain Missionaries USA-Canada Province] (archives site not public)
* [https://archives.cliftonbridge.org.uk/ Clifton Suspension Bridge Archives]
* [https://discover.cabhc.ca/ Community Archives of Belleville and Hastings County]
* [http://concordia.accesstomemory.org/ Concordia University]
* [https://onlinecollections.cumberlandmuseum.ca/ Cumberland Museum and Archives]
* [http://helates.cut.ac.cy/ Cyprus University of Technology Library Archives] (Greek)
* [https://findingaids.library.dal.ca/ Dalhousie University Libraries]
* [https://saanich.accesstomemory.org/ District of Saanich Archives]
* [http://atom.doaks.org/atom/ Dumbarton Oaks Research Library and Collection]
* [https://atom-sparc.fitnyc.edu/ Fashion Institute of Technology - Gladys Marcus Library's Special Collections and College Archives]
* [https://fhya.org/ Five Hundred Year Archive (FHYA)]
* [https://archives.franciscanfriars.ca/ Franciscans of Canada Archives West]
* [http://archives.gcu.ac.uk/ Glasgow Caledonian University Archives]
* [http://archive.griffith.ox.ac.uk Griffith Institute Archive]
* [http://archives.hpl.ca/ Hamilton Public Library Local History & Archives Department]
* [https://archives.highgatecemetery.org/ Highgate Cemetary Archives]
* [http://www.highlandparkhistory.org/ Highland Park Historical Society]
* [http://historicalpapers-atom.wits.ac.za/historical-papers-research-archive-library-university-of-witwatersrand Historical Papers Research Archive, Wits University]
* [http://ica.institutomarcelodeda.com.br/ Instituto Marcelo Déda]
* [http://jikn.sikn.go.id/ Jaringan Informasi Kearsipan Nasional] (Indonesian)
* [http://archives.jewishmuseum.ca/ The Jewish Museum & Archives of BC]
* [https://archives.kpu.ca/ Kwantlen Polytechnic University Archives]
* [http://archives.lakeheadu.ca/ Lakehead University Archives]
* [https://libarchives.wlu.ca/ Laurier Archives]
* [http://www.ltiarchives.ca Leeds and the Thousand Islands Archives]
* [http://www.legatum.ufba.br/atom/ Legatum - Sonus et Imago Repository] (multilingual)
* [http://lslirc-tarrarchives.accesstomemory.org/ Lesser Slave Lake IRC Treaty Aboriginal Rights Research Archives]
* [https://archives.mhsc.ca/ MAID: The Mennonite Archival Image Database]
* [http://nanna.lib.umanitoba.ca/ MAIN: Manitoba Archival Information Network]
* [http://archives.mcmaster.ca/ McMaster University Library Archives and Research Collections]
* [http://www.memorybc.ca/ MemoryBC - British Columbia's Archival Information Network]
* [https://memoryns.ca/ MemoryNS, the Council of Nova Scotia Archives' archival database]
* [http://www.gov.pe.ca/paroatom/ Memory PEI - Public Archives and Records Office of Prince Edward Island]
* [http://catalogue.millsarchive.org/ Mills Archive]
* [http://history.missionarchives.com/ Mission Community Archives]
* [https://archives.mtroyal.ca/ Mount Royal University Archives and Special Collections]
* [http://archives.museeheritage.ca Musée Héritage Museum Archives]
* [http://atom.moa.ubc.ca/ Museum of Anthropology, Audrey and Harry Hawthorn Library and Archives, University of British Columbia]
* [http://museumofcroydoncollections.com/catalogues/ Museum of Croydon]
* [https://archives.library.wales/ National Library of Wales - Archives and Manuscripts]
* [https://archives.nyrr.org/ New York Road Runners Archives]
* [http://archives.eclibrary.ca/ Nipissing University and Canadore College Archives and Special Collections]
* [http://archives.nato.int/ North Atlantic Treaty Organization (NATO) Archives]
* [https://atomic.library.tmc.edu/ Nuclear Memories Archive] (Texas Medical Center Library)
* [http://offalyhistoryarchives.com/ Offaly History Archives]
* [https://digitalcollections.ohs.org/ Oregon Historical Society Digital Collections]
* [http://asiapacific.anu.edu.au/pambu/catalogue/ Pacific Manuscripts Bureau]
* [http://atom.prattsils.org/ Pratt School of Information On-site Archives and Special Collections]
* [http://archives.ppcli.com/ Princess Patricia’s Canadian Light Infantry Museum & Archives]
* [http://atom.skagafjordur.is/index.php/ Regional Archives of Skagafj ordur] (English, Icelandic)
*[https://archives.renison.ca/ Renison University College, Florence Li Tim-Oi Memorial Archives]
* [https://rcdcarchives.ica-atom.org/ Roman Catholic Diocese of Calgary Archives]
* [http://search-bcarchives.royalbcmuseum.bc.ca/ Royal British Columbia Museum - BC Archives]
* [http://archives.rncm.ac.uk/ Royal Northern College of Music]
* [https://royalroads.accesstomemory.org/ Royal Roads University]
* [https://www.sjcarchives.org.uk/institutional/ Saint John's College Archives]
* [http://atom.library.moore.edu.au/ The Samuel Marsden Archives, Moore College Library]
* [http://sain.scaa.sk.ca/collections/ Saskatchewan Archival Information Network Collections Database]
* [http://sain.scaa.sk.ca/items/ Saskatchewan Archival Information Network Photographs Database]
* [https://senecacollege.accesstomemory.org/ Seneca College Archives and Special Collections]
* [http://atom.archives.sfu.ca/ SFU AtoM - Simon Fraser University]
* [https://atom.schalifax.ca/ The Sisters of Charity - Halifax Archives]
* [http://squamishlibrary.digitalcollections.ca/ Squamish Public Library - Digital Collections]
* [https://archive.sro.wa.gov.au/ State Records Office of Western Australia]
* [https://archives.sgul.ac.uk/ St George's Archives & Special Collections, University of London]
* [https://stirlingcouncil.ica-atom.org/ Stirling Council Archives]
* [https://archives.trinity.edu/ Trinity University Coates Library Special Collections and Archives]
* [http://archivessearch.twu.ca/ Trinity Western University Archives and Special Collections]
* [http://search.nbca.unbc.ca/index.php/ UNBC Northern BC Archives]
* [http://atom.archives.unesco.org/ UNESCO Archives]
* [http://search.archives.un.org/ United Nations Archives and Records Management Section]
* [http://rbscarchives.library.ubc.ca/ University of British Columbia Rare Books and Special Collections]
* [https://searcharchives.ucalgary.ca/ University of Calgary Archives and Special Collections]
* [http://www.atom.lib.uct.ac.za/ University of Capetown Libraries: Special Collections]
* [http://sca.glos.ac.uk/index.php/ University of Gloucestershire Special Collections and Archives]
* [https://atom.library.miami.edu/ University of Miami Archival Collections]
* [http://archives.unam.edu.na/ University of Namibia Archives]
* [http://search.nbca.unbc.ca/ University of Northern British Columbia Archives]
* [https://biblio.uottawa.ca/atom/index.php/ University of Ottawa - Archives and Special Collections]
* [http://strathclyde.ica-atom.org/ University of Strathclyde Archives]
* [https://sparc.utas.edu.au/ University of Tasmania - Special & Rare Collections online]
* [https://discoverarchives.library.utoronto.ca/ University of Toronto - Discover Archives]
* [http://whistler.ica-atom.org/ Whistler Museum and Archives]
* [https://archivesholdings.worldbank.org/ World Bank Group Archives Holdings]
* [http://atom.library.yorku.ca Clara Thomas Archives and Special Collections, York University Libraries]

'''French'''
* [https://inventaires.archivescommunales-vd.ch/ Archives comunales du canton de Vaud] (Swiss)
* [http://archivesdemontreal.ica-atom.org/ Archives de Montréal]
* [https://archives.uclouvain.be/atom/index.php/ Archives de l'Université catholique de Louvain] (Belgium)
* [http://ratp.histolab.fr/index.php/?sf_culture=fr Archives Groupe RATP ] (French)
* [https://archiveshistoriques.ville.levis.qc.ca/ Archives privées de la Ville de Lévis]
* [http://http://claretains.ca/ Missionaires Clarétains] (archives site not public)
* [https://caspar.cinematheque.ch CASPAR - Cinémathèque Suisse Papier Archives] (French)
* [http://archives.graduateinstitute.ch/ The Graduate Institute IHEID, Geneva] (French)
* [https://legis.cdij.bj/ LEGIS : Base de données des textes de loi en République du Bénin] (French)

'''Brazillian Portuguese'''
* [http://fonte.ufsm.br/ Acervo Arquivístico da Universidade Federal de Santa Maria]
* [http://acervo.cidarq.ufg.br/index.php/iuryy;isad Acervos Arquivísticos]
* [http://icaatom.almg.gov.br/ Acervo Arquivístico da Assembleia Legislativa do Estado de Minas Gerais]
* [http://www.acervomemorial.al.rs.gov.br/index.php/?sf_culture=pt Acervo do Memorial do Legislativo]
* [http://arquivodigital.furg.br/ Arquivo digital da Universidade Federal do Rio Grande]
* [https://atom.tjpe.jus.br/ Arquivo Histórico do Memorial da Justiça]
* [http://arquivomunicipal.caxias.rs.gov.br/ Arquivo Histórico Municipal João Spadari Adami - Caxias do Sul]
*[https://www.acervo.arquivopublico.pe.gov.br/index.php/arquivo-publico-estadual-jordao-emerenciano Arquivo Público Estadual Jordão Emerenciano]
* [http://www.cle.unicamp.br/atom-2.2.1/index.php/ Arquivos Históricos do Centro de Lógica, Epistemologia e História da Ciência]
* [http://200.222.27.136/ Arquivo Público do Estado do Rio de Janeiro]
* [http://www.icaatom.apeb.fpc.ba.gov.br/index.php/?sf_culture=pt/ Bahia. Arquivo Público do Estado da Bahia (Apeb)]
* [http://www.basearch.coc.fiocruz.br/ Base Arch - Fundação Oswaldo Cruz]
* [http://dibrarq.arquivonacional.gov.br/index.php/ Brasil. Arquivo Nacional. Diretório Brasil de Arquivos (Dibrarq)]
* [http://linux.an.gov.br/icaatom/index.php/ Brasil. Arquivo Nacional. Guia de fontes para a história da Holanda e holandeses no Brasil]
* [https://arquivohistorico.camara.leg.br/index.php/ Brasil. Câmara dos Deputados]
* [http://www.arquivodamarinha.dphdm.mar.mil.br/index.php/ Brasil. Marinha do Brasil. Diretoria do Patrimônio Histórico e Documentação (DPHDM)]
* [http://arquivohistorico.inep.gov.br/ Brasil. Ministério da Educação. Instituto Nacional de Estudos e Pesquisas Educacionais 'Anísio Teixeira' (Inep)]
* [http://arch.coc.fiocruz.br/ Brasil. Ministério da Saúde. Fundação Oswaldo Cruz (Fiocruz)]
* [http://bibjuventude.ibict.br/jspui/bitstream/192/232/1/OLIVEIRA_implementacaoatomsnj_2017.pdf Brasil. Secretaria Nacional da Juventude (SNJ)]
* [http://arquivocidadao.stj.jus.br/index.php/ Brasil. Superior Tribunal de Justiça (STJ)]
* [http://arquivomunicipal.caxias.rs.gov.br/index.php/ Caxias do Sul-RS. Arquivo Histórico Municipal 'João Spadari Adami']
* [http://dibrarq.arquivonacional.gov.br/ DIBRARQ - Diretório Brasil de Arquivos]
* [http://www.atom.arquivopublico.df.gov.br/ Distrito Federal. Arquivo Público do Distrito Federal (APDF)]
* [http://201.62.44.38/index.php/?sf_culture=pt_BR Espírito Santo. Arquivo Público do Estado do Espírito Santo (Apees)]
* [https://acervo.fpabramo.org.br/ Fundação Perseu Abramo. Centro sérgio Buarque de Holanda (CSBH/FPA)]
* [http://www.legatum.ufba.br/atom/index.php/?sf_culture=pt Iniciativa Legatum]
* [http://atom.poa.ifrs.edu.br/index.php/ Instituto Federal do Rio Grande do Sul. Campus Porto Alegre]
* [http://atom.poa.ifrs.edu.br/ Instituto Federal Rio Grande do Sul - Campus Porto Alegre]
* [http://ica.institutomarcelodeda.com.br/index.php/ Instituto Marcelo Deda (IMD)]
*[http://atom.ippdh.mercosur.int/index.php/ Mercosul. Instituto de Políticas Públicas em Direitos Humanos. Guia de Arquivos e Fundos Documentais]
* [https://atom.almg.gov.br/index.php/ Minas Gerais. Assembleia Legislativa (ALMG)]
* [http://www.lampeh.ufv.br/breve/atom/index.php/?sf_culture=p Minas Gerais. Tribunal de Justiça de Minas Gerais (TJMG)]
* [https://www.acervo.pe.gov.br/ Pernambuco. Arquivo Público Estadual Jordão Emerenciano]
* [https://atom.tjpe.jus.br/index.php/ Pernambuco. Tribunal de Justiça de Pernambuco (TJPE)]
* [https://www.acervo.pe.gov.br Portal Estadual do Patrimônio Documental de Pernambuco]
* [http://200.222.27.136/index.php/ Rio de Janeiro (estado). Arquivo Público do Estado do Rio de Janeiro (Aperj)]
* [http://www.acervomemorial.al.rs.gov.br/index.php/?sf_culture=pt Rio Grande do Sul. Assembleia Legislativa (ALRS)]
* [https://atom.jfrs.jus.br/atom/index.php/ Rio Grande do Sul. Justiça Federal do Rio Grande do Sul (JFRS)]
* [http://atom.unijui.edu.br/index.php/?sf_culture=pt_BR Rio Grande do Sul. Museu Antropológico 'Diretor Pestana' (MADP)]
* [http://web2.santamaria.rs.gov.br/arquivohistorico/sistema_descricao_documental/ Santa Maria-RS. Arquivo Histórico Municipal]
* [http://icaatom.arquivoestado.sp.gov.br/ica-atom/destaques.php São Paulo (estado). Arquivo Público do Estado de São Paulo (Apesp)]
* São Paulo (estado). Arquivo Público do Estado de São Paulo (Apesp)

* [https://atom.unb.br/ Universidade de Brasília]
* http://ar[qhist.cle.unicamp.br/index.php/?sf_culture=pt_BR Universidade de Campinas (Unicamp). Centro de Lógica, Epistemologia e História da Ciência]
* [http://atom.ufcspa.edu.br/ Universidade Federal de Ciências da Saúde de Porto Alegre]
* [http://atom.ufv.br/ Universidade Federal de Viçosa]
* [http://goo.gl/UPvjqa Universidade de São Paulo (USP). Museu Histórico 'Carlos da Silva Lacaz']
* [http://www.arquivohistorico.poli.usp.br/ Universidade de São Paulo (USP). Escola Politécnica. Arquivo Histórico]
* [http://acervo.cidarq.ufg.br/index.php/ Universidade Federal de Goiás (UFG)]
* [http://fonte.ufsm.br/ Universidade Federal de Santa Maria (UFSM)]
* [https://arquivodigital.furg.br/?sf_culture=pt_BR Universidade Federal do Rio Grande (Furg)]
* [http://www.ufrgs.br/arquivo-artes/icaatom/web/index.php/?sf_culture=pt Universidade Federal do Rio Grande do Sul (UFRGS). Instituto de Artes]

'''Portuguese'''
* [http://arquivoatom.up.pt/index.php/fundacao-instituto-arquitecto-jose-marques-da-silva Arquivo da Fundação Instituto Marques da Silva] (Portuguese)
* [http://fotos.psd.pt/atom/index.php/ Arquivo da Social-Democracia] (Portuguese)
* [http://arquivo.igreja-lusitana.org/ Arquivo Histórico da Igreja Lusitana] (Portuguese)
* [https://arquivo.cdi-maceiraliz.pt/ Arquivo Histórico Fábrica Maceira-Liz] (Portuguese)
* [http://www.ahsocial.ics.ulisboa.pt/atom/ Arquivo de História Social do Instituto de Ciências Sociais da Universidade de Lisboa] (Portuguese)
* [http://arquivo.cm-albergaria.pt/ Arquivo Municipal de Albergaria-a-Velha] (Portuguese)
* [http://arquivodigital.cm-oaz.pt/ Arquivo Municipal de Oliveira de Azeméis] (Portuguese)
* [http://45.33.69.154/index.php/?sf_culture=pt Arquivo Municipal de Sines] (Portuguese)
* [http://arquivo.cm-valedecambra.pt/ Arquivo Municipal de Vale de Cambra] (Portuguese)
* [https://arquivo.cm-viladobispo.pt/ Arquivo Municipal de Vila do Bispo] (Portuguese)
* [http://portal.cehr.ft.lisboa.ucp.pt/arquivos/ PAPIR - Plataforma de Arquivos Pessoais e de Instituições Religiosas] (Portuguese)
* [http://arquivoatom.up.pt/ Universidade do Porto] (Portuguese)

'''Spanish'''
* [http://132.248.192.4:8081 Archivo Histórico de la UNAM] (Spanish)
* [http://www.madrid.org/archivos_atom/ Archivos de la Comunidad de Madrid] (Spanish)
* [http://archivospublicos.cl/ Archivos Históricos de la Universidad Alberto Hurtado] (Spanish)
* [http://archivo.mariategui.org/ Archivo José Carlos Mariátegui] (Perú - Spanish)
* [http://amp.ing.puc.cl/ Archivo de Música Popular Chilena] (Spanish)
* [http://archivospresidenciales.archivonacional.cl/ Archivo Michelle Bachelet Jeria (President of Chile)] (Spanish)
* [http://archivo.plasencia.es/ Archivo Municipal de Plasencia (Extremadura)] (Spanish)
* [http://archivos.cedinci.org/ CeDInCI - Centro de Documentación e Investigación de la Cultura de Izquierdas en Argentina] (Spanish)
* [http://fondomigueldelibes.fundacionmigueldelibes.es/index.php Fondo Documental Miguel Delibes] (Spanish)
* [http://archivosescolares.ing.puc.cl/ Programa de Archivos Escolares] (Spanish)

'''Dutch'''
* [https://archief.onroerenderfgoed.be/ Archief van het Vlaams Instituut voor het Onroerend Erfgoed] (Dutch)

'''Italian'''
* [http://atom.unito.it/ Historical Archives of the University of Torino] (Italian)

'''Swedish'''
* [https://arken.kb.se/ National Library of Sweden - Arken Directory] (Swedish)

'''Greek'''
* [http://nspantelakis.gr/family-archives/ Nikolaos S. Pantelakis Family archives] (Greek)

==ICA-AtoM (1.x) sites==

'''English'''
* [http://www.dart.ipsr.mahidol.ac.th/index.php/n56S2;isad Digital Archive of Research on Thailand]
* [http://archive.womenslibrary.org.uk/index.php/ Glasgow Women's Library Archive Catalogue]
* [http://www.migan.org MIGAN - the directory of Caribbean archival institutions] (English/French)
* [http://ica-atom.tasglann.org.uk/ Tasglann nan Eilean Siar (Hebridean Archives)]

'''Brazilian Portuguese'''
* [http://web2.santamaria.rs.gov.br/arquivohistorico/sistema_descricao_documental/index.php/ Acervo digital do Arquivo Histórico Municipal de Santa Maria] (Brazilian Portuguese)
* [http://icaatom.arquivoestado.sp.gov.br Arquivo Público do Estado de São Paulo] (Brazilian Portuguese)

'''Portuguese'''
* [http://cad.cgtp.pt/ica/ Centro de Arquivo e Documentação CGTP-IN] (Portuguese)

'''Spanish'''
* [http://archivo.ateneodemadrid.es Archivo del Ateneo de Madrid] (Spanish)
* [http://www.madrid.org/icaatom_pub/index.php/ Archivos de la Comunidad de Madrid] (Spanish)
* [http://archivo.plasencia.es/ Archivo Municipal de Plasencia] (Spanish)
* [http://archivocti.uma.es/icaatom/ Base de datos fotográfica del Centro de Tecnología de la Imagen de la Universidad de Málaga] (Spanish)

Please feel free to [[Special:UserLogin|add a link]] to your AtoM installation.

[[Category:Community]]

Development/MediaPlayers

2019-03-25T20:57:41Z

Crogers: /* Current status */

{{#pagetitle:Media players}}
[[Development]] > MediaPlayers

This page will provide an overview of the digital object media player(s) supported in AtoM, which are used to allow users to play access derivative copies of streaming media such as video and audio files in the browser. It was first created on 2018-11-23, and is current as of the AtoM 2.4 and 2.5 releases.

__TOC__

==Early implementation==

The current media library, [https://flowplayer.com/ Flowplayer], was implemented in the [[Releases/Release_announcements/Release_1.0.8-beta|1.0.8-beta release]]. At the time, Flowplayer was a flash-based video player (version 3.1 of Flowplayer was released in [https://sourceforge.net/p/flowplayer/news/2009/04/flowplayer-31-is-out-now/ April 2009]), and version 3.1.5 was added to AtoM in August of 2009, and included in the 1.0.8 release. See development ticket [https://projects.artefactual.com/issues/2187 #2187] in the AtoM issues list for further details.

==Current status==

Since the initial implementation of Flowplayer in AtoM, no major upgrades or changes have been made to AtoM's time-based media playback functionality. Meanwhile, increasing discoveries of security vulnerabilities and zero-day exploits in Flash have led an increasing number of browsers and platforms to disavow Flash support, starting as early as 2010, when Steve Jobs stated that Apple would not allow Flash on the iPhone, iPod touch and iPad – citing abysmal security as one reason ([https://www.apple.com/hotnews/thoughts-on-flash/ source]). Since then, with increasing security problems being discovered in Flash and the arrival of HTML5 (which supports native video playback), most major browsers have chosen to disable Flash by default.

Flowplayer itself has redesigned its media player and while they do still maintain a [http://flash.flowplayer.org/ Flash implementation], future development efforts have been focused on an HTML5 version of the player. Support for version 3.1.5, which AtoM still uses, has been discontinued for some time. The Flowplayer Flash version has not been actively developed [https://github.com/flowplayer/flash since 2014], and the last major release was [https://github.com/flowplayer/flash/releases version 3.2.18]. At this point, it is likely that support for Flash will be fully discontinued by 2020.

AtoM is in need of an updated open source media player.

==Replacement requirements==

Any new video player replacement for AtoM should:

* Be open source
* Be HTML5-based
* Be able to play audio as well
* Ideally, include a Flash fallback for legacy browser users
* Support a broad range of playback formats
* Be under active development
* Include basic responsive support for different devices and screen sizes
* Support accessibility, including:
** ARIA support for screenreaders
** Keyboard control support
** Subtitle support

==Evaluating options==

In August of 2018, Artefactual explored the current open source HTML5 video player landscape in search of a replacement candidate that met our requirements. We found the following page extremely useful in evaluating the best contenders:

* http://videosws.praegnanz.de/

After exploring the options listed in the site above, as well as any other popular options that met our criteria we could find, we found the following 3 players to be the closest match to our requirements:

'''Able Player'''

* [https://github.com/paypal/accessible-html5-video-player Webpage]
* [https://github.com/ableplayer/ableplayer GitHub code repository]
* [https://ableplayer.github.io/ableplayer/demos/index.html Examples]

'''MediaElement.js'''

* [https://www.mediaelementjs.com/ Webpage]
* [https://github.com/mediaelement/mediaelement/ GitHub code repository] (examples included on homepage)

'''Accessible HTML5 Video Player'''

* [http://paypal.github.io/accessible-html5-video-player/ Webpage] (basically just a big example video player)
* [https://github.com/paypal/accessible-html5-video-player GitHub code repository]

==Final recommendation==

Of the above options, the Artefactual team felt that [https://www.mediaelementjs.com/ MediaElement.js] would be the best fit as a replacement video player for AtoM.

First developed by John Dyer at the Dallas Theological Seminary and released under MIT license, MediaElement.js is a widely-used project under active development, built responsively with a unified API that can fall back gracefully to Flash, which includes ARIA screen-reader support, subtitles, chapters and playlists, keyboard control, and more. The look and feel is skinnable, it requires no additional Javascript library support, and can also support playback of videos hosted on YouTube, Vimeo, and DailyMotion. It also has a [https://github.com/mediaelement/mediaelement-plugins plugin] ecosystem that can further extend functionality, such as adding basic Google Analytics support, preview on hover, and extended playback controls.

Artefactual has prepared initial development estimates for our community based on implementing MediaElement as the replacement for the current Flowplayer.

We selected the H.264/MPEG-4 video format for in-browser video playback due to it's broad support across desktop and mobile browsers and operating systems (e.g. Windows, Mac OSX, iOS, Android). AtoM currently uses the MP3 audio format for in-browser audio playback, which will remain unchanged.

==Development tasks and estimates==

Below you will find a summary of development task and associated cost estimates, prepared by the [http://artefactual.com/ Artefactual] developers based on the decision to use MediaElement as the replacement library.

'''Current as of: 2018-11-23'''

{| border="1" style="border-collapse:collapse;" align="center"
|colspan="3" style="background-color:#BDF3FB;" align="center"|'''Integrate MediaElement Player in AtoM'''
|- style="background-color:#cccccc;"
|'''Subtask'''
|'''Notes'''
|'''Estimate'''
|- style="background-color:#ffffff;"
|Remove Flowplayer
|Work required to extract the current library
|$300
|-
|Add MediaElement player files to AtoM
|Install player to vendor folder and update Copyright file; general configuration
|$300
|-
|Incorporate MediaElement player into AtoM pages for viewing
|Modify the digital object module's showAudio and showVideo components; create the JS file to load the player; CSS changes; testing
|$3,600
|-
|Remove Flashplayer check from AtoM
|Remove current code that checks the user's browser to see if Flash is present
|$300
|-
|colspan="3" style="background-color:#FEC355;" align="center"|'''Generate mp4 reference derivatives instead of flash video (flv) files'''
|- style="background-color:#cccccc;" align="center"
|'''Subtask'''
|'''Notes'''
|'''Estimate'''
|- style="background-color:#ffffff;"
|Update digital object code to create MPEG4 / H.264 reference derivatives instead of Flash video derivs
|Determine default bitrate, size, etc for new derivatives; review and update all affected areas (including regen-derivatives CLI task, digital object code to support CSV imports via web interface and command-line, etc).
|$2,700
|-
|colspan="3" style="background-color:#AEFEE5;" align="center"|'''Develop task to replace existing Flash video derivatives with mp4 files'''
|- style="background-color:#cccccc;" align="center"
|'''Subtask'''
|'''Notes'''
|'''Estimate'''
|- style="background-color:#ffffff;"
|Add new option to the regen-derivatives command-line task to allow regenerating only video file derivatives to mp4 files
|Ensure users have an easy way to update existing derivatives without having to regenerate all derivatives, which could lose custom user derivative uploads
|$1,200
|-
|colspan="3" style="background-color:#F8FAC7;" align="center"|'''TOTAL DEVELOPMENT FEES: $8,400'''
|}

 

===Costs not included in this table===

There are a few administrative costs not included in the table above, which Artefactual would include in any formal quote prepared based on the estimates above. These include:

{| border="1" style="border-collapse:collapse;" align="center"
|colspan="3" style="background-color:#BDF3FB;" align="center"|'''Additional deployment, testing, and administrative costs'''
|- style="background-color:#cccccc;"
|'''Subtask'''
|'''Notes'''
|'''Estimate'''
|- style="background-color:#ffffff;"
|Community support fee
|A 10% fee we add to development projects that are included in public releases, to help offset the costs of Artefactual maintaining the feature through subsequent releases, writing documentation, managing bug fixes, and offering basic community support via the AtoM [https://groups.google.com/forum/#!forum/ica-atom-users user forum].
|$840
|-
|Test site deployment
|Deployment of an instance of AtoM populated with test data, to be used throughout the development project for previewing the feature, and managing testing and feedback
|$600
|-
|Q/A Testing
|Quality assurance testing and analysis throughout the project to ensure the feature meets the deliverable requirements, identify and resolve any bugs, offer implementation improvement recommendations within the project scope, etc.
|$900
|-
|Backporting, deployment, and maintenance
|Backport the new functionality to a stable branch and either deploy it or make the code available to sponsor for local installation, and assist in running the derivatives regeneration task for current flash-based video derivatives
|$1200
|-
|colspan="3" style="background-color:#F8FAC7;" align="center"|'''Total additional administrative project costs: $3,540 '''
|-
|colspan="3" style="background-color:#AEFEE5;" align="center"|'''TOTAL ALL COSTS: $11,940'''
|}

==Collaborative sponsorship opportunities==

Given that the costs of sponsoring this development may be out of reach for some institutions who nevertheless would really like to see this updated functionality added to AtoM, we would like to encourage our community of users to consider ways in which the feature might be sponsored collaboratively.

Coordinating with many institutions with different schedules and availability, as well differing perspectives and feedback, can potentially add complications to a development project. In light of this, for Artefactual to be able to work effectively with multiple dispersed sponsors, we have outlined our requirements for managing such a project below.

===Artefactual requirements for collaborative development===

'''1) Single point of contact''': We require one institution who is willing to act as the project lead, and the main point of contact throughout the project. This simplifies the communication between our team and the sponsors - the project lead institution would act as the go-between with other sponsoring institutions to coordinate scheduling, testing, and administrative communication throughout the project.

'''2) Single point of feedback''': Working with multiple institutions on a collaboratively funded feature can be challenging if we are receiving contradictory input during the testing and feedback phase of the project. Instead, we would ask that the project lead manage internal discussions among the sponsors during the testing phase, and again act as the single point of contact for feedback, so that any contradictions around design, ideal behavior, and change requests can be resolved prior to communicating with our development team.

'''3) Ideally, a single point of payment administration''': Preferably, the project lead can process contributions from any other participating sponsors, so that Artefactual can supply and process a single invoice at the close of the project. We understand that this may not be possible for all institutions, and can explore alternatives with participating institutions if needed.

===Additional deployment costs for co-sponsors===

As with any major feature development carried out by Artefactual, the work will be included in the next major public release for the entire AtoM community to use, and will be immediately available in the 2.5 development branch in our public GiHub [https://github.com/artefactual/atom/ code repository]. However, if the feature were sponsored collaboratively and all participating institutions wanted access to the enhancement prior to the next public release, there may be additional deployment costs for the participating co-sponsors, so Artefactual can assist in making the work available in a stable branch and deploying it for immediate use.

The prices included in the section above entitled "[[Development/MediaPlayers#Costs_not_included_in_this_table|Costs not included in this table]]" assume deployment of the completed feature to a single institution. If co-sponsors wanted to access the feature prior to the next major public release and would like Artefactual's assistance in doing so, there will be additional costs, which we would handle on a time and materials basis for each institution. For institutions hosted by Artefactual, it would be possible to use support tickets to cover deployment costs.

Please feel free to [mailto:info@artefactual.com contact us] if you have any questions.

-----

* [[Development|Back to Development]]
* [[Main Page|AtoM wiki home]]

[[Category:Development documentation]]

Community/Translators

2019-03-05T17:10:01Z

Crogers: /* AtoM translators */

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

On this page we'll try to gather up all the information we can about anyone who has contributed user interface translations to the AtoM project. If you've volunteered your time to help make AtoM a truly international application, 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 code contributors on this page: [[Community/Contributors|Code contributors]]

Interested in contributing translations to the public AtoM project? You'll find information to help you get started here:
* [[Resources/Translation]]
</admonition>

===ICA-AtoM translators===

ICA-AtoM was the original name of the AtoM application during its early (1.x) development. With the release of version [[Releases/Release announcements/Release 2.0.0|2.0.0]], the application was rebranded as AtoM. You can still see the original ICA-AtoM website here: https://www.ica-atom.org

During ICA-AtoM's development, translation had to be done by manually sending out copies of the translation [https://en.wikipedia.org/wiki/XLIFF XLIFF] files, which made them difficult to manage, work with, and review. This process almost made group translation work challenging, and nearly impossible for geographically dispersed teams. Nevertheless, we had a brave cadre of volunteers who assisted us time and time again! Here are some of them:

{| class="wikitable" style="background-color:#ffffff;"
|+ style="caption-side:top; color:#e76700;"|''ICA-AtoM volunteer translators''
! Name || Language
|-
| test || test
|-
|}

===AtoM translators===

After the release of version [[Releases/Release announcements/Release 2.0.0|2.0.0]] the application was rebranded as AtoM, and we began using [https://www.transifex.com/ Transifex] to manage our translations. In early 2019 we moved from Transifex to [https://www.weblate.org/ Weblate], an open source web-based translation management system supporting continuous translation from multiple sources. The web-based Translation Editor gives users a graphical way of managing the translation files, and allows for team collaboration, work in multiple languages at once, discussion and collaboration tools on a per-string basis, and more.

<admonition type="seealso">
Get started using Weblate to translate AtoM with this handy guide:
* [[Resources/Translation]]
</admonition>

-----

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

[[Category:Community]]

Community/Translators

2019-03-05T17:09:27Z

Crogers: /* AtoM translators */

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

On this page we'll try to gather up all the information we can about anyone who has contributed user interface translations to the AtoM project. If you've volunteered your time to help make AtoM a truly international application, 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 code contributors on this page: [[Community/Contributors|Code contributors]]

Interested in contributing translations to the public AtoM project? You'll find information to help you get started here:
* [[Resources/Translation]]
</admonition>

===ICA-AtoM translators===

ICA-AtoM was the original name of the AtoM application during its early (1.x) development. With the release of version [[Releases/Release announcements/Release 2.0.0|2.0.0]], the application was rebranded as AtoM. You can still see the original ICA-AtoM website here: https://www.ica-atom.org

During ICA-AtoM's development, translation had to be done by manually sending out copies of the translation [https://en.wikipedia.org/wiki/XLIFF XLIFF] files, which made them difficult to manage, work with, and review. This process almost made group translation work challenging, and nearly impossible for geographically dispersed teams. Nevertheless, we had a brave cadre of volunteers who assisted us time and time again! Here are some of them:

{| class="wikitable" style="background-color:#ffffff;"
|+ style="caption-side:top; color:#e76700;"|''ICA-AtoM volunteer translators''
! Name || Language
|-
| test || test
|-
|}

===AtoM translators===

After the release of version [[Releases/Release announcements/Release 2.0.0|2.0.0]] the application was rebranded as AtoM, and we began using [https://www.transifex.com/ Transifex] to manage our translations. In early 2019 we moved from Transifex to [https://www.weblate.org/ Weblate], an open source web-based translation management system supporting continuous translation from multiple sources. The web-based Translation Editor gives users a graphical way of managing the translation files, and allows for team collaboration, work in multiple languages at once, discussion and collaboration tools on a per-string basis, and more.

<admonition type="seealso">
Get started using Weblate to translate AtoM with this handy guide:
* [[Resources/Translation]]
</admonition>

{| class="wikitable" style="background-color:#ffffff;"
|+ style="caption-side:top; color:#e76700;"|''AtoM volunteer translators''
! Transifex Username || Name (if known) || Language(s)
|-
| test || test || test
|-
|}

-----

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

[[Category:Community]]

Community/Users

2019-02-12T18:34:32Z

Crogers: /* AtoM (2.x) sites */

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

On this page you'll find some examples of institutions and organizations using AtoM and/or ICA-AtoM. Don't see your institution on this list? Please feel free to [[Special:UserLogin|add a link]] to your AtoM installation!

==AtoM (2.x) sites==

'''English'''
* [https://archives.rcaf.museum/ Air Force Museum of Alberta Archives]
* [http://www.albertaonrecord.ca/ Alberta on Record: Archives Society of Alberta Portal]
* [https://archives.ambrose.edu/ Ambrose Archives]
* [http://archeion.ca Archeion: Ontario's Archival Information Network]
* [https://archie.library.carleton.ca/ Archives & Research Collections, Carleton University Library]
* [http://anglicanarchives.ica-atom.org/ Archives of the Anglican Diocese of New Westminster and Provincial Synod of BC and Yukon]
* [http://arc.anla.nf.ca/ ARC: the Archival Resource Catalogue of the Association of Newfoundland and Labrador Archives]
* [https://archivescanada.accesstomemory.ca/ ArchivesCanada - the Canadian Archival Information Network Portal]
* [http://archives.canbarchives.ca/ ArchivesCANB: the Council of Archives New Brunswick's archival database]
* [http://www.archives.pe.ca/atom/index.php/ Archives PEI, the Archives Council of Prince Edward Island's description database]
* [http://archives.artcenter.edu/ ArtCenter Archives and the Hoffmitz Milken Center for Typography Archives]
* [http://archivescollection.anu.edu.au/ Australian National University Archives]
* [http://beatoninstitute.com/ The Beaton Institute (Cape Breton University)]
* [https://hbbarchive.ca/ Bishop's University - History beyond Borders project]
* [https://borthcat.york.ac.uk/ Borthwick Institute for Archives - University of York]
* [http://collections.westbeyondthewest.ca British Columbia Digitization Coalition's West Beyond the West Portal]
* [http://atom.lib.bcit.ca/ British Columbia Institute of Technology Archives & Special Collections]
* [https://archives.cendari.dariah.eu/ CENDARI Archives Directory]
* [https://ccap.uvic.ca Chinese Canadian Artifacts Project]
* [http://searcharchives.coquitlam.ca/ City of Coquitlam Archives]
* [http://searcharchives.vancouver.ca/ City of Vancouver Archives]
* [https://archives.victoria.ca/ City of Victoria Archives]
* [http://winnipeginfocus.winnipeg.ca/ City of Winnipeg Archives]
* [http://claretiansusa.org Claretain Missionaries USA-Canada Province] (archives site not public)
* [https://archives.cliftonbridge.org.uk/ Clifton Suspension Bridge Archives]
* [https://discover.cabhc.ca/ Community Archives of Belleville and Hastings County]
* [http://concordia.accesstomemory.org/ Concordia University]
* [https://onlinecollections.cumberlandmuseum.ca/ Cumberland Museum and Archives]
* [http://helates.cut.ac.cy/ Cyprus University of Technology Library Archives] (Greek)
* [https://findingaids.library.dal.ca/ Dalhousie University Libraries]
* [https://saanich.accesstomemory.org/ District of Saanich Archives]
* [http://atom.doaks.org/atom/ Dumbarton Oaks Research Library and Collection]
* [https://atom-sparc.fitnyc.edu/ Fashion Institute of Technology - Gladys Marcus Library's Special Collections and College Archives]
* [https://fhya.org/ Five Hundred Year Archive (FHYA)]
* [https://archives.franciscanfriars.ca/ Franciscans of Canada Archives West]
* [http://archives.gcu.ac.uk/ Glasgow Caledonian University Archives]
* [http://archive.griffith.ox.ac.uk Griffith Institute Archive]
* [http://archives.hpl.ca/ Hamilton Public Library Local History & Archives Department]
* [https://archives.highgatecemetery.org/ Highgate Cemetary Archives]
* [http://www.highlandparkhistory.org/ Highland Park Historical Society]
* [http://historicalpapers-atom.wits.ac.za/historical-papers-research-archive-library-university-of-witwatersrand Historical Papers Research Archive, Wits University]
* [http://ica.institutomarcelodeda.com.br/ Instituto Marcelo Déda]
* [http://jikn.sikn.go.id/ Jaringan Informasi Kearsipan Nasional] (Indonesian)
* [http://archives.jewishmuseum.ca/ The Jewish Museum & Archives of BC]
* [https://archives.kpu.ca/ Kwantlen Polytechnic University Archives]
* [http://archives.lakeheadu.ca/ Lakehead University Archives]
* [https://libarchives.wlu.ca/ Laurier Archives]
* [http://www.ltiarchives.ca Leeds and the Thousand Islands Archives]
* [http://www.legatum.ufba.br/atom/ Legatum - Sonus et Imago Repository] (multilingual)
* [http://lslirc-tarrarchives.accesstomemory.org/ Lesser Slave Lake IRC Treaty Aboriginal Rights Research Archives]
* [https://archives.mhsc.ca/ MAID: The Mennonite Archival Image Database]
* [http://nanna.lib.umanitoba.ca/ MAIN: Manitoba Archival Information Network]
* [http://archives.mcmaster.ca/ McMaster University Library Archives and Research Collections]
* [http://www.memorybc.ca/ MemoryBC - British Columbia's Archival Information Network]
* [https://memoryns.ca/ MemoryNS, the Council of Nova Scotia Archives' archival database]
* [http://www.gov.pe.ca/paroatom/ Memory PEI - Public Archives and Records Office of Prince Edward Island]
* [http://catalogue.millsarchive.org/ Mills Archive]
* [http://history.missionarchives.com/ Mission Community Archives]
* [https://archives.mtroyal.ca/ Mount Royal University Archives and Special Collections]
* [http://archives.museeheritage.ca Musée Héritage Museum Archives]
* [http://atom.moa.ubc.ca/ Museum of Anthropology, Audrey and Harry Hawthorn Library and Archives, University of British Columbia]
* [http://museumofcroydoncollections.com/catalogues/ Museum of Croydon]
* [https://archives.library.wales/ National Library of Wales - Archives and Manuscripts]
* [https://archives.nyrr.org/ New York Road Runners Archives]
* [http://archives.eclibrary.ca/ Nipissing University and Canadore College Archives and Special Collections]
* [http://archives.nato.int/ North Atlantic Treaty Organization (NATO) Archives]
* [https://atomic.library.tmc.edu/ Nuclear Memories Archive] (Texas Medical Center Library)
* [http://offalyhistoryarchives.com/ Offaly History Archives]
* [https://digitalcollections.ohs.org/ Oregon Historical Society Digital Collections]
* [http://asiapacific.anu.edu.au/pambu/catalogue/ Pacific Manuscripts Bureau]
* [http://atom.prattsils.org/ Pratt School of Information On-site Archives and Special Collections]
* [http://archives.ppcli.com/ Princess Patricia’s Canadian Light Infantry Museum & Archives]
* [http://atom.skagafjordur.is/index.php/ Regional Archives of Skagafj ordur] (English, Icelandic)
*[https://archives.renison.ca/ Renison University College, Florence Li Tim-Oi Memorial Archives]
* [https://rcdcarchives.ica-atom.org/ Roman Catholic Diocese of Calgary Archives]
* [http://search-bcarchives.royalbcmuseum.bc.ca/ Royal British Columbia Museum - BC Archives]
* [http://archives.rncm.ac.uk/ Royal Northern College of Music]
* [https://royalroads.accesstomemory.org/ Royal Roads University]
* [https://www.sjcarchives.org.uk/institutional/ Saint John's College Archives]
* [http://atom.library.moore.edu.au/ The Samuel Marsden Archives, Moore College Library]
* [http://sain.scaa.sk.ca/collections/ Saskatchewan Archival Information Network Collections Database]
* [http://sain.scaa.sk.ca/items/ Saskatchewan Archival Information Network Photographs Database]
* [https://senecacollege.accesstomemory.org/ Seneca College Archives and Special Collections]
* [http://atom.archives.sfu.ca/ SFU AtoM - Simon Fraser University]
* [https://atom.schalifax.ca/ The Sisters of Charity - Halifax Archives]
* [http://squamishlibrary.digitalcollections.ca/ Squamish Public Library - Digital Collections]
* [https://archive.sro.wa.gov.au/ State Records Office of Western Australia]
* [https://archives.sgul.ac.uk/ St George's Archives & Special Collections, University of London]
* [https://stirlingcouncil.ica-atom.org/ Stirling Council Archives]
* [https://archives.trinity.edu/ Trinity University Coates Library Special Collections and Archives]
* [http://archivessearch.twu.ca/ Trinity Western University Archives and Special Collections]
* [http://search.nbca.unbc.ca/index.php/ UNBC Northern BC Archives]
* [http://atom.archives.unesco.org/ UNESCO Archives]
* [http://search.archives.un.org/ United Nations Archives and Records Management Section]
* [http://rbscarchives.library.ubc.ca/ University of British Columbia Rare Books and Special Collections]
* [https://searcharchives.ucalgary.ca/ University of Calgary Archives and Special Collections]
* [http://www.atom.lib.uct.ac.za/ University of Capetown Libraries: Special Collections]
* [http://sca.glos.ac.uk/index.php/ University of Gloucestershire Special Collections and Archives]
* [https://atom.library.miami.edu/ University of Miami Archival Collections]
* [http://archives.unam.edu.na/ University of Namibia Archives]
* [http://search.nbca.unbc.ca/ University of Northern British Columbia Archives]
* [https://biblio.uottawa.ca/atom/index.php/ University of Ottawa - Archives and Special Collections]
* [http://strathclyde.ica-atom.org/ University of Strathclyde Archives]
* [https://sparc.utas.edu.au/ University of Tasmania - Special & Rare Collections online]
* [https://discoverarchives.library.utoronto.ca/ University of Toronto - Discover Archives]
* [http://whistler.ica-atom.org/ Whistler Museum and Archives]
* [https://archivesholdings.worldbank.org/ World Bank Group Archives Holdings]
* [http://atom.library.yorku.ca Clara Thomas Archives and Special Collections, York University Libraries]

'''French'''
* [https://inventaires.archivescommunales-vd.ch/ Archives comunales du canton de Vaud] (Swiss)
* [http://archivesdemontreal.ica-atom.org/ Archives de Montréal]
* [https://archives.uclouvain.be/atom/index.php/ Archives de l'Université catholique de Louvain] (Belgium)
* [http://ratp.histolab.fr/index.php/?sf_culture=fr Archives Groupe RATP ] (French)
* [https://archiveshistoriques.ville.levis.qc.ca/ Archives privées de la Ville de Lévis]
* [http://http://claretains.ca/ Missionaires Clarétains] (archives site not public)
* [https://caspar.cinematheque.ch CASPAR - Cinémathèque Suisse Papier Archives] (French)
* [http://archives.graduateinstitute.ch/ The Graduate Institute IHEID, Geneva] (French)
* [https://legis.cdij.bj/ LEGIS : Base de données des textes de loi en République du Bénin] (French)

'''Brazillian Portuguese'''
* [http://fonte.ufsm.br/ Acervo Arquivístico da Universidade Federal de Santa Maria] (Brazilian Portuguese)
* [http://acervo.cidarq.ufg.br/index.php/iuryy;isad Acervos Arquivísticos] (Brazilian Portuguese)
* [http://icaatom.almg.gov.br/ Acervo Arquivístico da Assembleia Legislativa do Estado de Minas Gerais] (Brazilian Portuguese)
* [http://arquivodigital.furg.br/ Arquivo digital da Universidade Federal do Rio Grande] (Brazilian Portuguese)
* [https://atom.tjpe.jus.br/ Arquivo Histórico do Memorial da Justiça] (Brazilian Portuguese)
* [http://arquivomunicipal.caxias.rs.gov.br/ Arquivo Histórico Municipal João Spadari Adami - Caxias do Sul] (Brazilian Portuguese)
* [http://www.cle.unicamp.br/atom-2.2.1/index.php/ Arquivos Históricos do Centro de Lógica, Epistemologia e História da Ciência] (Brazilian Portuguese)
* [http://200.222.27.136/ Arquivo Público do Estado do Rio de Janeiro] (Brazilian Portuguese)
* [http://www.basearch.coc.fiocruz.br/ Base Arch - Fundação Oswaldo Cruz] (Brazilian Portuguese)
* [http://dibrarq.arquivonacional.gov.br/ DIBRARQ - Diretório Brasil de Arquivos] (Brazilian Portuguese)
* [http://atom.poa.ifrs.edu.br/ Instituto Federal Rio Grande do Sul - Campus Porto Alegre] (Brazilian Portuguese)
* [https://www.acervo.pe.gov.br Portal Estadual do Patrimônio Documental de Pernambuco] (Brazilian Portuguese)
** [https://www.acervo.arquivopublico.pe.gov.br/index.php/arquivo-publico-estadual-jordao-emerenciano Arquivo Público Estadual Jordão Emerenciano]
* [https://atom.unb.br/ Universidade de Brasília] (Brazilian Portuguese)
* [http://atom.ufcspa.edu.br/ Universidade Federal de Ciências da Saúde de Porto Alegre] (Brazilian Portuguese)
* [http://atom.ufv.br/ Universidade Federal de Viçosa] (Brazilian Portuguese)

'''Portuguese'''
* [http://fotos.psd.pt/atom/index.php/ Arquivo da Social-Democracia] (Portuguese)
* [http://arquivo.cm-albufeira.pt/ Arquivo Municipal Albufeira] (Portuguese)
* [http://arquivo.cm-albergaria.pt/ Arquivo Municipal de Albergaria-a-Velha] (Portuguese)
* [http://arquivodigital.cm-oaz.pt/ Arquivo Municipal de Oliveira de Azeméis] (Portuguese)
* [http://45.33.69.154/index.php/?sf_culture=pt Arquivo Municipal de Sines] (Portuguese)
* [http://arquivo.cm-valedecambra.pt/ Arquivo Municipal de Vale de Cambra] (Portuguese)
* [https://arquivo.cm-viladobispo.pt/ Arquivo Municipal de Vila do Bispo] (Portuguese)
* [http://arquivoatom.up.pt/index.php/fundacao-instituto-arquitecto-jose-marques-da-silva Arquivo da Fundação Instituto Marques da Silva] (Portuguese)
* [http://www.ahsocial.ics.ulisboa.pt/atom/ Arquivo de História Social do Instituto de Ciências Sociais da Universidade de Lisboa] (Portuguese)
* [http://arquivo.igreja-lusitana.org/ Arquivo Histórico da Igreja Lusitana] (Portuguese)
* [http://portal.cehr.ft.lisboa.ucp.pt/arquivos/ PAPIR - Plataforma de Arquivos Pessoais e de Instituições Religiosas] (Portuguese)
* [http://arquivoatom.up.pt/ Universidade do Porto] (Portuguese)

'''Spanish'''
* [http://132.248.192.4:8081 Archivo Histórico de la UNAM] (Spanish)
* [http://www.madrid.org/archivos_atom/ Archivos de la Comunidad de Madrid] (Spanish)
* [http://archivospublicos.cl/ Archivos Históricos de la Universidad Alberto Hurtado] (Spanish)
* [http://archivo.mariategui.org/ Archivo José Carlos Mariátegui] (Perú - Spanish)
* [http://amp.ing.puc.cl/ Archivo de Música Popular Chilena] (Spanish)
* [http://archivospresidenciales.archivonacional.cl/ Archivo Michelle Bachelet Jeria (President of Chile)] (Spanish)
* [http://archivo.plasencia.es/ Archivo Municipal de Plasencia (Extremadura)] (Spanish)
* [http://archivos.cedinci.org/ CeDInCI - Centro de Documentación e Investigación de la Cultura de Izquierdas en Argentina] (Spanish)
* [http://fondomigueldelibes.fundacionmigueldelibes.es/index.php Fondo Documental Miguel Delibes] (Spanish)
* [http://archivosescolares.ing.puc.cl/ Programa de Archivos Escolares] (Spanish)

'''Dutch'''
* [https://archief.onroerenderfgoed.be/ Archief van het Vlaams Instituut voor het Onroerend Erfgoed] (Dutch)

'''Italian'''
* [http://atom.unito.it/ Historical Archives of the University of Torino] (Italian)

'''Swedish'''
* [https://arken.kb.se/ National Library of Sweden - Arken Directory] (Swedish)

'''Greek'''
* [http://nspantelakis.gr/family-archives/ Nikolaos S. Pantelakis Family archives] (Greek)

==ICA-AtoM (1.x) sites==

'''English'''
* [http://www.dart.ipsr.mahidol.ac.th/index.php/n56S2;isad Digital Archive of Research on Thailand]
* [http://archive.womenslibrary.org.uk/index.php/ Glasgow Women's Library Archive Catalogue]
* [http://www.migan.org MIGAN - the directory of Caribbean archival institutions] (English/French)
* [http://ica-atom.tasglann.org.uk/ Tasglann nan Eilean Siar (Hebridean Archives)]

'''Brazilian Portuguese'''
* [http://web2.santamaria.rs.gov.br/arquivohistorico/sistema_descricao_documental/index.php/ Acervo digital do Arquivo Histórico Municipal de Santa Maria] (Brazilian Portuguese)
* [http://icaatom.arquivoestado.sp.gov.br Arquivo Público do Estado de São Paulo] (Brazilian Portuguese)

'''Portuguese'''
* [http://cad.cgtp.pt/ica/ Centro de Arquivo e Documentação CGTP-IN] (Portuguese)

'''Spanish'''
* [http://archivo.ateneodemadrid.es Archivo del Ateneo de Madrid] (Spanish)
* [http://www.madrid.org/icaatom_pub/index.php/ Archivos de la Comunidad de Madrid] (Spanish)
* [http://archivo.plasencia.es/ Archivo Municipal de Plasencia] (Spanish)
* [http://archivocti.uma.es/icaatom/ Base de datos fotográfica del Centro de Tecnología de la Imagen de la Universidad de Málaga] (Spanish)

Please feel free to [[Special:UserLogin|add a link]] to your AtoM installation.

[[Category:Community]]

Community/Users

2019-02-12T18:32:15Z

Crogers: /* AtoM (2.x) sites */

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

On this page you'll find some examples of institutions and organizations using AtoM and/or ICA-AtoM. Don't see your institution on this list? Please feel free to [[Special:UserLogin|add a link]] to your AtoM installation!

==AtoM (2.x) sites==

'''English'''
* [https://archives.rcaf.museum/ Air Force Museum of Alberta Archives]
* [http://www.albertaonrecord.ca/ Alberta on Record: Archives Society of Alberta Portal]
* [https://archives.ambrose.edu/ Ambrose Archives]
* [http://archeion.ca Archeion: Ontario's Archival Information Network]
* [https://archie.library.carleton.ca/ Archives & Research Collections, Carleton University Library]
* [http://anglicanarchives.ica-atom.org/ Archives of the Anglican Diocese of New Westminster and Provincial Synod of BC and Yukon]
* [http://arc.anla.nf.ca/ ARC: the Archival Resource Catalogue of the Association of Newfoundland and Labrador Archives]
* [https://archivescanada.accesstomemory.ca/ ArchivesCanada - the Canadian Archival Information Network Portal]
* [http://archives.canbarchives.ca/ ArchivesCANB: the Council of Archives New Brunswick's archival database]
* [http://www.archives.pe.ca/atom/index.php/ Archives PEI, the Archives Council of Prince Edward Island's description database]
* [http://archives.artcenter.edu/ ArtCenter Archives and the Hoffmitz Milken Center for Typography Archives]
* [http://archivescollection.anu.edu.au/ Australian National University Archives]
* [http://beatoninstitute.com/ The Beaton Institute (Cape Breton University)]
* [https://hbbarchive.ca/ Bishop's University - History beyond Borders project]
* [https://borthcat.york.ac.uk/ Borthwick Institute for Archives - University of York]
* [http://collections.westbeyondthewest.ca British Columbia Digitization Coalition's West Beyond the West Portal]
* [http://atom.lib.bcit.ca/ British Columbia Institute of Technology Archives & Special Collections]
* [https://archives.cendari.dariah.eu/ CENDARI Archives Directory]
* [https://ccap.uvic.ca Chinese Canadian Artifacts Project]
* [http://searcharchives.coquitlam.ca/ City of Coquitlam Archives]
* [http://searcharchives.vancouver.ca/ City of Vancouver Archives]
* [https://archives.victoria.ca/ City of Victoria Archives]
* [http://winnipeginfocus.winnipeg.ca/ City of Winnipeg Archives]
* [http://claretiansusa.org Claretain Missionaries USA-Canada Province] (archives site not public)
* [https://archives.cliftonbridge.org.uk/ Clifton Suspension Bridge Archives]
* [https://discover.cabhc.ca/ Community Archives of Belleville and Hastings County]
* [http://concordia.accesstomemory.org/ Concordia University]
* [https://onlinecollections.cumberlandmuseum.ca/ Cumberland Museum and Archives]
* [http://helates.cut.ac.cy/ Cyprus University of Technology Library Archives] (Greek)
* [https://findingaids.library.dal.ca/ Dalhousie University Libraries]
* [https://saanich.accesstomemory.org/ District of Saanich Archives]
* [http://atom.doaks.org/atom/ Dumbarton Oaks Research Library and Collection]
* [https://atom-sparc.fitnyc.edu/ Fashion Institute of Technology - Gladys Marcus Library's Special Collections and College Archives]
* [https://fhya.org/ Five Hundred Year Archive (FHYA)]
* [https://archives.franciscanfriars.ca/ Franciscans of Canada Archives West]
* [http://archives.gcu.ac.uk/ Glasgow Caledonian University Archives]
* [http://archive.griffith.ox.ac.uk Griffith Institute Archive]
* [http://archives.hpl.ca/ Hamilton Public Library Local History & Archives Department]
* [https://archives.highgatecemetery.org/ Highgate Cemetary Archives]
* [http://www.highlandparkhistory.org/ Highland Park Historical Society]
* [http://historicalpapers-atom.wits.ac.za/historical-papers-research-archive-library-university-of-witwatersrand Historical Papers Research Archive, Wits University]
* [http://ica.institutomarcelodeda.com.br/ Instituto Marcelo Déda]
* [http://jikn.sikn.go.id/ Jaringan Informasi Kearsipan Nasional] (Indonesian)
* [http://archives.jewishmuseum.ca/ The Jewish Museum & Archives of BC]
* [https://archives.kpu.ca/ Kwantlen Polytechnic University Archives]
* [http://archives.lakeheadu.ca/ Lakehead University Archives]
* [https://libarchives.wlu.ca/ Laurier Archives]
* [http://www.ltiarchives.ca Leeds and the Thousand Islands Archives]
* [http://www.legatum.ufba.br/atom/ Legatum - Sonus et Imago Repository] (multilingual)
* [http://lslirc-tarrarchives.accesstomemory.org/ Lesser Slave Lake IRC Treaty Aboriginal Rights Research Archives]
* [https://archives.mhsc.ca/ MAID: The Mennonite Archival Image Database]
* [http://nanna.lib.umanitoba.ca/ MAIN: Manitoba Archival Information Network]
* [http://archives.mcmaster.ca/ McMaster University Library Archives and Research Collections]
* [http://www.memorybc.ca/ MemoryBC - British Columbia's Archival Information Network]
* [https://memoryns.ca/ MemoryNS, the Council of Nova Scotia Archives' archival database]
* [http://www.gov.pe.ca/paroatom/ Memory PEI - Public Archives and Records Office of Prince Edward Island]
* [http://catalogue.millsarchive.org/ Mills Archive]
* [http://history.missionarchives.com/ Mission Community Archives]
* [https://archives.mtroyal.ca/ Mount Royal University Archives and Special Collections]
* [http://archives.museeheritage.ca Musée Héritage Museum Archives]
* [http://atom.moa.ubc.ca/ Museum of Anthropology, Audrey and Harry Hawthorn Library and Archives, University of British Columbia]
* [http://museumofcroydoncollections.com/catalogues/ Museum of Croydon]
* [https://archives.library.wales/ National Library of Wales - Archives and Manuscripts]
* [https://archives.nyrr.org/ New York Road Runners Archives]
* [http://archives.eclibrary.ca/ Nipissing University and Canadore College Archives and Special Collections]
* [http://archives.nato.int/ North Atlantic Treaty Organization (NATO) Archives]
* [https://atomic.library.tmc.edu/ Nuclear Memories Archive] (Texas Medical Center Library)
* [http://offalyhistoryarchives.com/ Offaly History Archives]
* [https://digitalcollections.ohs.org/ Oregon Historical Society Digital Collections]
* [http://asiapacific.anu.edu.au/pambu/catalogue/ Pacific Manuscripts Bureau]
* [http://atom.prattsils.org/ Pratt School of Information On-site Archives and Special Collections]
* [http://archives.ppcli.com/ Princess Patricia’s Canadian Light Infantry Museum & Archives]
* [http://atom.skagafjordur.is/index.php/ Regional Archives of Skagafj ordur] (English, Icelandic)
*[https://archives.renison.ca/ Renison University College, Florence Li Tim-Oi Memorial Archives]
* [https://rcdcarchives.ica-atom.org/ Roman Catholic Diocese of Calgary Archives]
* [http://search-bcarchives.royalbcmuseum.bc.ca/ Royal British Columbia Museum - BC Archives]
* [http://archives.rncm.ac.uk/ Royal Northern College of Music]
* [https://royalroads.accesstomemory.org/ Royal Roads University]
* [https://www.sjcarchives.org.uk/institutional/ Saint John's College Archives]
* [http://atom.library.moore.edu.au/ The Samuel Marsden Archives, Moore College Library]
* [http://sain.scaa.sk.ca/collections/ Saskatchewan Archival Information Network Collections Database]
* [http://sain.scaa.sk.ca/items/ Saskatchewan Archival Information Network Photographs Database]
* [https://senecacollege.accesstomemory.org/ Seneca College Archives and Special Collections]
* [http://atom.archives.sfu.ca/ SFU AtoM - Simon Fraser University]
* [https://atom.schalifax.ca/ The Sisters of Charity - Halifax Archives]
* [http://squamishlibrary.digitalcollections.ca/ Squamish Public Library - Digital Collections]
* [https://archive.sro.wa.gov.au/ State Records Office of Western Australia]
* [https://archives.sgul.ac.uk/ St George's Archives & Special Collections, University of London]
* [https://stirlingcouncil.ica-atom.org/ Stirling Council Archives]
* [https://archives.trinity.edu/ Trinity University Coates Library Special Collections and Archives]
* [http://archivessearch.twu.ca/ Trinity Western University Archives and Special Collections]
* [http://search.nbca.unbc.ca/index.php/ UNBC Northern BC Archives]
* [http://atom.archives.unesco.org/ UNESCO Archives]
* [http://search.archives.un.org/ United Nations Archives and Records Management Section]
* [http://rbscarchives.library.ubc.ca/ University of British Columbia Rare Books and Special Collections]
* [https://searcharchives.ucalgary.ca/ University of Calgary Archives and Special Collections]
* [http://www.atom.lib.uct.ac.za/ University of Capetown Libraries: Special Collections]
* [http://sca.glos.ac.uk/index.php/ University of Gloucestershire Special Collections and Archives]
* [https://atom.library.miami.edu/ University of Miami Archival Collections]
* [http://archives.unam.edu.na/ University of Namibia Archives]
* [http://search.nbca.unbc.ca/ University of Northern British Columbia Archives]
* [https://biblio.uottawa.ca/atom/index.php/ University of Ottawa - Archives and Special Collections]
* [http://strathclyde.ica-atom.org/ University of Strathclyde Archives]
* [https://sparc.utas.edu.au/ University of Tasmania - Special & Rare Collections online]
* [https://discoverarchives.library.utoronto.ca/ University of Toronto - Discover Archives]
* [http://whistler.ica-atom.org/ Whistler Museum and Archives]
* [https://archivesholdings.worldbank.org/ World Bank Group Archives Holdings]
* [http://atom.library.yorku.ca Clara Thomas Archives and Special Collections, York University Libraries]

'''French'''
* [https://inventaires.archivescommunales-vd.ch/ Archives comunales du canton de Vaud] (Swiss)
* [http://archivesdemontreal.ica-atom.org/ Archives de Montréal]
* [https://archives.uclouvain.be/atom/index.php/ Archives de l'Université catholique de Louvain] (Belgium)
* [http://ratp.histolab.fr/index.php/?sf_culture=fr Archives Groupe RATP ] (French)
* [https://archiveshistoriques.ville.levis.qc.ca/ Archives privées de la Ville de Lévis]
* [https://legis.cdij.bj/ LEGIS : Base de données des textes de loi en République du Bénin]
* [http://http://claretains.ca/ Missionaires Clarétains] (archives site not public)
* [https://caspar.cinematheque.ch CASPAR - Cinémathèque Suisse Papier Archives] (French)
* [http://archives.graduateinstitute.ch/ The Graduate Institute IHEID, Geneva] (French)
* [https://legis.cdij.bj/ LEGIS : Base de données des textes de loi en République du Bénin] (French)

'''Brazillian Portuguese'''
* [http://fonte.ufsm.br/ Acervo Arquivístico da Universidade Federal de Santa Maria] (Brazilian Portuguese)
* [http://acervo.cidarq.ufg.br/index.php/iuryy;isad Acervos Arquivísticos] (Brazilian Portuguese)
* [http://icaatom.almg.gov.br/ Acervo Arquivístico da Assembleia Legislativa do Estado de Minas Gerais] (Brazilian Portuguese)
* [http://arquivodigital.furg.br/ Arquivo digital da Universidade Federal do Rio Grande] (Brazilian Portuguese)
* [http://arquivomunicipal.caxias.rs.gov.br/ Arquivo Histórico Municipal João Spadari Adami - Caxias do Sul] (Brazilian Portuguese)
* [http://www.cle.unicamp.br/atom-2.2.1/index.php/ Arquivos Históricos do Centro de Lógica, Epistemologia e História da Ciência] (Brazilian Portuguese)
* [http://200.222.27.136/ Arquivo Público do Estado do Rio de Janeiro] (Brazilian Portuguese)
* [http://www.basearch.coc.fiocruz.br/ Base Arch - Fundação Oswaldo Cruz] (Brazilian Portuguese)
* [http://dibrarq.arquivonacional.gov.br/ DIBRARQ - Diretório Brasil de Arquivos] (Brazilian Portuguese)
* [http://atom.poa.ifrs.edu.br/ Instituto Federal Rio Grande do Sul - Campus Porto Alegre] (Brazilian Portuguese)
* [https://www.acervo.pe.gov.br Portal Estadual do Patrimônio Documental de Pernambuco] (Brazilian Portuguese)
* [https://atom.unb.br/ Universidade de Brasília] (Brazilian Portuguese)
* [http://atom.ufcspa.edu.br/ Universidade Federal de Ciências da Saúde de Porto Alegre] (Brazilian Portuguese)
* [http://atom.ufv.br/ Universidade Federal de Viçosa] (Brazilian Portuguese)

'''Portuguese'''
* [http://fotos.psd.pt/atom/index.php/ Arquivo da Social-Democracia] (Portuguese)
* [http://arquivo.cm-albufeira.pt/ Arquivo Municipal Albufeira] (Portuguese)
* [http://arquivo.cm-albergaria.pt/ Arquivo Municipal de Albergaria-a-Velha] (Portuguese)
* [http://arquivodigital.cm-oaz.pt/ Arquivo Municipal de Oliveira de Azeméis] (Portuguese)
* [http://45.33.69.154/index.php/?sf_culture=pt Arquivo Municipal de Sines] (Portuguese)
* [http://arquivo.cm-valedecambra.pt/ Arquivo Municipal de Vale de Cambra] (Portuguese)
* [https://arquivo.cm-viladobispo.pt/ Arquivo Municipal de Vila do Bispo] (Portuguese)
* [http://arquivoatom.up.pt/index.php/fundacao-instituto-arquitecto-jose-marques-da-silva Arquivo da Fundação Instituto Marques da Silva] (Portuguese)
* [http://www.ahsocial.ics.ulisboa.pt/atom/ Arquivo de História Social do Instituto de Ciências Sociais da Universidade de Lisboa] (Portuguese)
* [http://arquivo.igreja-lusitana.org/ Arquivo Histórico da Igreja Lusitana] (Portuguese)
* [http://portal.cehr.ft.lisboa.ucp.pt/arquivos/ PAPIR - Plataforma de Arquivos Pessoais e de Instituições Religiosas] (Portuguese)
* [http://arquivoatom.up.pt/ Universidade do Porto] (Portuguese)

'''Spanish'''
* [http://132.248.192.4:8081 Archivo Histórico de la UNAM] (Spanish)
* [http://www.madrid.org/archivos_atom/ Archivos de la Comunidad de Madrid] (Spanish)
* [http://archivospublicos.cl/ Archivos Históricos de la Universidad Alberto Hurtado] (Spanish)
* [http://archivo.mariategui.org/ Archivo José Carlos Mariátegui] (Perú - Spanish)
* [http://amp.ing.puc.cl/ Archivo de Música Popular Chilena] (Spanish)
* [http://archivospresidenciales.archivonacional.cl/ Archivo Michelle Bachelet Jeria (President of Chile)] (Spanish)
* [http://archivo.plasencia.es/ Archivo Municipal de Plasencia (Extremadura)] (Spanish)
* [http://archivos.cedinci.org/ CeDInCI - Centro de Documentación e Investigación de la Cultura de Izquierdas en Argentina] (Spanish)
* [http://fondomigueldelibes.fundacionmigueldelibes.es/index.php Fondo Documental Miguel Delibes] (Spanish)
* [http://archivosescolares.ing.puc.cl/ Programa de Archivos Escolares] (Spanish)

'''Dutch'''
* [https://archief.onroerenderfgoed.be/ Archief van het Vlaams Instituut voor het Onroerend Erfgoed] (Dutch)

'''Italian'''
* [http://atom.unito.it/ Historical Archives of the University of Torino] (Italian)

'''Swedish'''
* [https://arken.kb.se/ National Library of Sweden - Arken Directory] (Swedish)

'''Greek'''
* [http://nspantelakis.gr/family-archives/ Nikolaos S. Pantelakis Family archives] (Greek)

==ICA-AtoM (1.x) sites==

'''English'''
* [http://www.dart.ipsr.mahidol.ac.th/index.php/n56S2;isad Digital Archive of Research on Thailand]
* [http://archive.womenslibrary.org.uk/index.php/ Glasgow Women's Library Archive Catalogue]
* [http://www.migan.org MIGAN - the directory of Caribbean archival institutions] (English/French)
* [http://ica-atom.tasglann.org.uk/ Tasglann nan Eilean Siar (Hebridean Archives)]

'''Brazilian Portuguese'''
* [http://web2.santamaria.rs.gov.br/arquivohistorico/sistema_descricao_documental/index.php/ Acervo digital do Arquivo Histórico Municipal de Santa Maria] (Brazilian Portuguese)
* [http://icaatom.arquivoestado.sp.gov.br Arquivo Público do Estado de São Paulo] (Brazilian Portuguese)

'''Portuguese'''
* [http://cad.cgtp.pt/ica/ Centro de Arquivo e Documentação CGTP-IN] (Portuguese)

'''Spanish'''
* [http://archivo.ateneodemadrid.es Archivo del Ateneo de Madrid] (Spanish)
* [http://www.madrid.org/icaatom_pub/index.php/ Archivos de la Comunidad de Madrid] (Spanish)
* [http://archivo.plasencia.es/ Archivo Municipal de Plasencia] (Spanish)
* [http://archivocti.uma.es/icaatom/ Base de datos fotográfica del Centro de Tecnología de la Imagen de la Universidad de Málaga] (Spanish)

Please feel free to [[Special:UserLogin|add a link]] to your AtoM installation.

[[Category:Community]]

Community/Users

2019-02-12T18:31:20Z

Crogers: /* AtoM (2.x) sites */

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

On this page you'll find some examples of institutions and organizations using AtoM and/or ICA-AtoM. Don't see your institution on this list? Please feel free to [[Special:UserLogin|add a link]] to your AtoM installation!

==AtoM (2.x) sites==

'''English'''
* [https://archives.rcaf.museum/ Air Force Museum of Alberta Archives]
* [http://www.albertaonrecord.ca/ Alberta on Record: Archives Society of Alberta Portal]
* [https://archives.ambrose.edu/ Ambrose Archives]
* [http://archeion.ca Archeion: Ontario's Archival Information Network]
* [https://archie.library.carleton.ca/ Archives & Research Collections, Carleton University Library]
* [http://anglicanarchives.ica-atom.org/ Archives of the Anglican Diocese of New Westminster and Provincial Synod of BC and Yukon]
* [http://arc.anla.nf.ca/ ARC: the Archival Resource Catalogue of the Association of Newfoundland and Labrador Archives]
* [https://archivescanada.accesstomemory.ca/ ArchivesCanada - the Canadian Archival Information Network Portal]
* [http://archives.canbarchives.ca/ ArchivesCANB: the Council of Archives New Brunswick's archival database]
* [http://www.archives.pe.ca/atom/index.php/ Archives PEI, the Archives Council of Prince Edward Island's description database]
* [http://archives.artcenter.edu/ ArtCenter Archives and the Hoffmitz Milken Center for Typography Archives]
* [http://archivescollection.anu.edu.au/ Australian National University Archives]
* [http://beatoninstitute.com/ The Beaton Institute (Cape Breton University)]
* [https://hbbarchive.ca/ Bishop's University - History beyond Borders project]
* [https://borthcat.york.ac.uk/ Borthwick Institute for Archives - University of York]
* [http://collections.westbeyondthewest.ca British Columbia Digitization Coalition's West Beyond the West Portal]
* [http://atom.lib.bcit.ca/ British Columbia Institute of Technology Archives & Special Collections]
* [https://archives.cendari.dariah.eu/ CENDARI Archives Directory]
* [https://ccap.uvic.ca Chinese Canadian Artifacts Project]
* [http://searcharchives.coquitlam.ca/ City of Coquitlam Archives]
* [http://searcharchives.vancouver.ca/ City of Vancouver Archives]
* [https://archives.victoria.ca/ City of Victoria Archives]
* [http://winnipeginfocus.winnipeg.ca/ City of Winnipeg Archives]
* [http://claretiansusa.org Claretain Missionaries USA-Canada Province] (archives site not public)
* [https://archives.cliftonbridge.org.uk/ Clifton Suspension Bridge Archives]
* [https://discover.cabhc.ca/ Community Archives of Belleville and Hastings County]
* [http://concordia.accesstomemory.org/ Concordia University]
* [https://onlinecollections.cumberlandmuseum.ca/ Cumberland Museum and Archives]
* [http://helates.cut.ac.cy/ Cyprus University of Technology Library Archives] (Greek)
* [https://findingaids.library.dal.ca/ Dalhousie University Libraries]
* [https://saanich.accesstomemory.org/ District of Saanich Archives]
* [http://atom.doaks.org/atom/ Dumbarton Oaks Research Library and Collection]
* [https://atom-sparc.fitnyc.edu/ Fashion Institute of Technology - Gladys Marcus Library's Special Collections and College Archives]
* [https://fhya.org/ Five Hundred Year Archive (FHYA)]
* [https://archives.franciscanfriars.ca/ Franciscans of Canada Archives West]
* [http://archives.gcu.ac.uk/ Glasgow Caledonian University Archives]
* [http://archive.griffith.ox.ac.uk Griffith Institute Archive]
* [http://archives.hpl.ca/ Hamilton Public Library Local History & Archives Department]
* [https://archives.highgatecemetery.org/ Highgate Cemetary Archives]
* [http://www.highlandparkhistory.org/ Highland Park Historical Society]
* [http://historicalpapers-atom.wits.ac.za/historical-papers-research-archive-library-university-of-witwatersrand Historical Papers Research Archive, Wits University]
* [http://ica.institutomarcelodeda.com.br/ Instituto Marcelo Déda]
* [http://jikn.sikn.go.id/ Jaringan Informasi Kearsipan Nasional] (Indonesian)
* [http://archives.jewishmuseum.ca/ The Jewish Museum & Archives of BC]
* [https://archives.kpu.ca/ Kwantlen Polytechnic University Archives]
* [http://archives.lakeheadu.ca/ Lakehead University Archives]
* [https://libarchives.wlu.ca/ Laurier Archives]
* [http://www.ltiarchives.ca Leeds and the Thousand Islands Archives]
* [http://www.legatum.ufba.br/atom/ Legatum - Sonus et Imago Repository] (multilingual)
* [http://lslirc-tarrarchives.accesstomemory.org/ Lesser Slave Lake IRC Treaty Aboriginal Rights Research Archives]
* [https://archives.mhsc.ca/ MAID: The Mennonite Archival Image Database]
* [http://nanna.lib.umanitoba.ca/ MAIN: Manitoba Archival Information Network]
* [http://archives.mcmaster.ca/ McMaster University Library Archives and Research Collections]
* [http://www.memorybc.ca/ MemoryBC - British Columbia's Archival Information Network]
* [https://memoryns.ca/ MemoryNS, the Council of Nova Scotia Archives' archival database]
* [http://www.gov.pe.ca/paroatom/ Memory PEI - Public Archives and Records Office of Prince Edward Island]
* [http://catalogue.millsarchive.org/ Mills Archive]
* [http://history.missionarchives.com/ Mission Community Archives]
* [https://archives.mtroyal.ca/ Mount Royal University Archives and Special Collections]
* [http://archives.museeheritage.ca Musée Héritage Museum Archives]
* [http://atom.moa.ubc.ca/ Museum of Anthropology, Audrey and Harry Hawthorn Library and Archives, University of British Columbia]
* [http://museumofcroydoncollections.com/catalogues/ Museum of Croydon]
* [https://archives.library.wales/ National Library of Wales - Archives and Manuscripts]
* [https://archives.nyrr.org/ New York Road Runners Archives]
* [http://archives.eclibrary.ca/ Nipissing University and Canadore College Archives and Special Collections]
* [http://archives.nato.int/ North Atlantic Treaty Organization (NATO) Archives]
* [https://atomic.library.tmc.edu/ Nuclear Memories Archive] (Texas Medical Center Library)
* [http://offalyhistoryarchives.com/ Offaly History Archives]
* [https://digitalcollections.ohs.org/ Oregon Historical Society Digital Collections]
* [http://asiapacific.anu.edu.au/pambu/catalogue/ Pacific Manuscripts Bureau]
* [http://atom.prattsils.org/ Pratt School of Information On-site Archives and Special Collections]
* [http://archives.ppcli.com/ Princess Patricia’s Canadian Light Infantry Museum & Archives]
* [http://atom.skagafjordur.is/index.php/ Regional Archives of Skagafj ordur] (English, Icelandic)
*[https://archives.renison.ca/ Renison University College, Florence Li Tim-Oi Memorial Archives]
* [https://rcdcarchives.ica-atom.org/ Roman Catholic Diocese of Calgary Archives]
* [http://search-bcarchives.royalbcmuseum.bc.ca/ Royal British Columbia Museum - BC Archives]
* [http://archives.rncm.ac.uk/ Royal Northern College of Music]
* [https://royalroads.accesstomemory.org/ Royal Roads University]
* [https://www.sjcarchives.org.uk/institutional/ Saint John's College Archives]
* [http://atom.library.moore.edu.au/ The Samuel Marsden Archives, Moore College Library]
* [http://sain.scaa.sk.ca/collections/ Saskatchewan Archival Information Network Collections Database]
* [http://sain.scaa.sk.ca/items/ Saskatchewan Archival Information Network Photographs Database]
* [https://senecacollege.accesstomemory.org/ Seneca College Archives and Special Collections]
* [http://atom.archives.sfu.ca/ SFU AtoM - Simon Fraser University]
* [https://atom.schalifax.ca/ The Sisters of Charity - Halifax Archives]
* [http://squamishlibrary.digitalcollections.ca/ Squamish Public Library - Digital Collections]
* [https://archive.sro.wa.gov.au/ State Records Office of Western Australia]
* [https://archives.sgul.ac.uk/ St George's Archives & Special Collections, University of London]
* [https://stirlingcouncil.ica-atom.org/ Stirling Council Archives]
* [https://archives.trinity.edu/ Trinity University Coates Library Special Collections and Archives]
* [http://archivessearch.twu.ca/ Trinity Western University Archives and Special Collections]
* [http://search.nbca.unbc.ca/index.php/ UNBC Northern BC Archives]
* [http://atom.archives.unesco.org/ UNESCO Archives]
* [http://search.archives.un.org/ United Nations Archives and Records Management Section]
* [http://rbscarchives.library.ubc.ca/ University of British Columbia Rare Books and Special Collections]
* [https://searcharchives.ucalgary.ca/ University of Calgary Archives and Special Collections]
* [http://www.atom.lib.uct.ac.za/ University of Capetown Libraries: Special Collections]
* [http://sca.glos.ac.uk/index.php/ University of Gloucestershire Special Collections and Archives]
* [https://atom.library.miami.edu/ University of Miami Archival Collections]
* [http://archives.unam.edu.na/ University of Namibia Archives]
* [http://search.nbca.unbc.ca/ University of Northern British Columbia Archives]
* [https://biblio.uottawa.ca/atom/index.php/ University of Ottawa - Archives and Special Collections]
* [http://strathclyde.ica-atom.org/ University of Strathclyde Archives]
* [https://sparc.utas.edu.au/ University of Tasmania - Special & Rare Collections online]
* [https://discoverarchives.library.utoronto.ca/ University of Toronto - Discover Archives]
* [http://whistler.ica-atom.org/ Whistler Museum and Archives]
* [https://archivesholdings.worldbank.org/ World Bank Group Archives Holdings]
* [http://atom.library.yorku.ca Clara Thomas Archives and Special Collections, York University Libraries]

'''French'''
* [https://inventaires.archivescommunales-vd.ch/ Archives comunales du canton de Vaud] (Swiss)
* [http://archivesdemontreal.ica-atom.org/ Archives de Montréal]
* [https://archives.uclouvain.be/atom/index.php/ Archives de l'Université catholique de Louvain] (Belgium)
* [http://ratp.histolab.fr/index.php/?sf_culture=fr Archives Groupe RATP ] (French)
* [https://archiveshistoriques.ville.levis.qc.ca/ Archives privées de la Ville de Lévis]
* [https://legis.cdij.bj/ Benin Online Laws]
* [http://http://claretains.ca/ Missionaires Clarétains] (archives site not public)
* [https://caspar.cinematheque.ch CASPAR - Cinémathèque Suisse Papier Archives] (French)
* [http://archives.graduateinstitute.ch/ The Graduate Institute IHEID, Geneva] (French)
* [https://legis.cdij.bj/ LEGIS : Base de données des textes de loi en République du Bénin] (French)

'''Brazillian Portuguese'''
* [http://fonte.ufsm.br/ Acervo Arquivístico da Universidade Federal de Santa Maria] (Brazilian Portuguese)
* [http://acervo.cidarq.ufg.br/index.php/iuryy;isad Acervos Arquivísticos] (Brazilian Portuguese)
* [http://icaatom.almg.gov.br/ Acervo Arquivístico da Assembleia Legislativa do Estado de Minas Gerais] (Brazilian Portuguese)
* [http://arquivodigital.furg.br/ Arquivo digital da Universidade Federal do Rio Grande] (Brazilian Portuguese)
* [http://arquivomunicipal.caxias.rs.gov.br/ Arquivo Histórico Municipal João Spadari Adami - Caxias do Sul] (Brazilian Portuguese)
* [http://www.cle.unicamp.br/atom-2.2.1/index.php/ Arquivos Históricos do Centro de Lógica, Epistemologia e História da Ciência] (Brazilian Portuguese)
* [http://200.222.27.136/ Arquivo Público do Estado do Rio de Janeiro] (Brazilian Portuguese)
* [http://www.basearch.coc.fiocruz.br/ Base Arch - Fundação Oswaldo Cruz] (Brazilian Portuguese)
* [http://dibrarq.arquivonacional.gov.br/ DIBRARQ - Diretório Brasil de Arquivos] (Brazilian Portuguese)
* [http://atom.poa.ifrs.edu.br/ Instituto Federal Rio Grande do Sul - Campus Porto Alegre] (Brazilian Portuguese)
* [https://www.acervo.pe.gov.br Portal Estadual do Patrimônio Documental de Pernambuco] (Brazilian Portuguese)
* [https://atom.unb.br/ Universidade de Brasília] (Brazilian Portuguese)
* [http://atom.ufcspa.edu.br/ Universidade Federal de Ciências da Saúde de Porto Alegre] (Brazilian Portuguese)
* [http://atom.ufv.br/ Universidade Federal de Viçosa] (Brazilian Portuguese)

'''Portuguese'''
* [http://fotos.psd.pt/atom/index.php/ Arquivo da Social-Democracia] (Portuguese)
* [http://arquivo.cm-albufeira.pt/ Arquivo Municipal Albufeira] (Portuguese)
* [http://arquivo.cm-albergaria.pt/ Arquivo Municipal de Albergaria-a-Velha] (Portuguese)
* [http://arquivodigital.cm-oaz.pt/ Arquivo Municipal de Oliveira de Azeméis] (Portuguese)
* [http://45.33.69.154/index.php/?sf_culture=pt Arquivo Municipal de Sines] (Portuguese)
* [http://arquivo.cm-valedecambra.pt/ Arquivo Municipal de Vale de Cambra] (Portuguese)
* [https://arquivo.cm-viladobispo.pt/ Arquivo Municipal de Vila do Bispo] (Portuguese)
* [http://arquivoatom.up.pt/index.php/fundacao-instituto-arquitecto-jose-marques-da-silva Arquivo da Fundação Instituto Marques da Silva] (Portuguese)
* [http://www.ahsocial.ics.ulisboa.pt/atom/ Arquivo de História Social do Instituto de Ciências Sociais da Universidade de Lisboa] (Portuguese)
* [http://arquivo.igreja-lusitana.org/ Arquivo Histórico da Igreja Lusitana] (Portuguese)
* [http://portal.cehr.ft.lisboa.ucp.pt/arquivos/ PAPIR - Plataforma de Arquivos Pessoais e de Instituições Religiosas] (Portuguese)
* [http://arquivoatom.up.pt/ Universidade do Porto] (Portuguese)

'''Spanish'''
* [http://132.248.192.4:8081 Archivo Histórico de la UNAM] (Spanish)
* [http://www.madrid.org/archivos_atom/ Archivos de la Comunidad de Madrid] (Spanish)
* [http://archivospublicos.cl/ Archivos Históricos de la Universidad Alberto Hurtado] (Spanish)
* [http://archivo.mariategui.org/ Archivo José Carlos Mariátegui] (Perú - Spanish)
* [http://amp.ing.puc.cl/ Archivo de Música Popular Chilena] (Spanish)
* [http://archivospresidenciales.archivonacional.cl/ Archivo Michelle Bachelet Jeria (President of Chile)] (Spanish)
* [http://archivo.plasencia.es/ Archivo Municipal de Plasencia (Extremadura)] (Spanish)
* [http://archivos.cedinci.org/ CeDInCI - Centro de Documentación e Investigación de la Cultura de Izquierdas en Argentina] (Spanish)
* [http://fondomigueldelibes.fundacionmigueldelibes.es/index.php Fondo Documental Miguel Delibes] (Spanish)
* [http://archivosescolares.ing.puc.cl/ Programa de Archivos Escolares] (Spanish)

'''Dutch'''
* [https://archief.onroerenderfgoed.be/ Archief van het Vlaams Instituut voor het Onroerend Erfgoed] (Dutch)

'''Italian'''
* [http://atom.unito.it/ Historical Archives of the University of Torino] (Italian)

'''Swedish'''
* [https://arken.kb.se/ National Library of Sweden - Arken Directory] (Swedish)

'''Greek'''
* [http://nspantelakis.gr/family-archives/ Nikolaos S. Pantelakis Family archives] (Greek)

==ICA-AtoM (1.x) sites==

'''English'''
* [http://www.dart.ipsr.mahidol.ac.th/index.php/n56S2;isad Digital Archive of Research on Thailand]
* [http://archive.womenslibrary.org.uk/index.php/ Glasgow Women's Library Archive Catalogue]
* [http://www.migan.org MIGAN - the directory of Caribbean archival institutions] (English/French)
* [http://ica-atom.tasglann.org.uk/ Tasglann nan Eilean Siar (Hebridean Archives)]

'''Brazilian Portuguese'''
* [http://web2.santamaria.rs.gov.br/arquivohistorico/sistema_descricao_documental/index.php/ Acervo digital do Arquivo Histórico Municipal de Santa Maria] (Brazilian Portuguese)
* [http://icaatom.arquivoestado.sp.gov.br Arquivo Público do Estado de São Paulo] (Brazilian Portuguese)

'''Portuguese'''
* [http://cad.cgtp.pt/ica/ Centro de Arquivo e Documentação CGTP-IN] (Portuguese)

'''Spanish'''
* [http://archivo.ateneodemadrid.es Archivo del Ateneo de Madrid] (Spanish)
* [http://www.madrid.org/icaatom_pub/index.php/ Archivos de la Comunidad de Madrid] (Spanish)
* [http://archivo.plasencia.es/ Archivo Municipal de Plasencia] (Spanish)
* [http://archivocti.uma.es/icaatom/ Base de datos fotográfica del Centro de Tecnología de la Imagen de la Universidad de Málaga] (Spanish)

Please feel free to [[Special:UserLogin|add a link]] to your AtoM installation.

[[Category:Community]]

Resources/Translation

2019-02-04T18:11:30Z

Crogers:

{{#pagetitle:Contribute translations}}
[[Main Page]] > [[Resources]] > Resources/Translation

Thank you for your interest in contributing user interface translations to the AtoM project! Your contributions help to further AtoM as a multilingual application
with a global reach.

In our continuing efforts to make the process of translating the AtoM interface more efficient, Artefactual Systems has moved from its previous translation
service, [https://www.transifex.com/ Transifex] to [https://www.weblate.org/ Weblate], an open source web-based translation management system supporting
continuous translation from multiple sources. More than one translator can contribute translated strings, making the process fast and easy, and
enabling Artefactual Systems to publish translations more often. Everything is web-based using Weblate, meaning you can access your translation work via any
web browser.

This page will introduce you to the AtoM Weblate translation project, so that you can log in and begin translating. If you have contributed through Transifex in the past, you will notice that the log in process with Weblate is slightly different, but contributing translations continues to be easy and flexible.

<admonition type="seealso">
* Interested in contributing to our project documentation? We have a separate page for that! See:[[Resources/Documentation/Contribute|Contribute documentation]]
* Looking to contribute code to AtoM? See: [[Development/Contribute code|Contribute code]]
* Check out our [https://www.accesstomemory.org/docs User Manual] for information on how to translate content or interface elements locally (in your installation only) - see the Multilingual section.
* Got questions, or find something that's not covered below that you think would be helpful? Let us know via the AtoM [https://groups.google.com/forum/#!forum/ica-atom-users User Forum], or send us an email at [mailto:translate@artefactual.com translate@artefactual.com].
</admonition>

__TOC__

==Browsing Artefactual translations==

'''The AtoM project in Weblate lives here:'''

* https://translations.artefactual.com/

[[File:weblate-first-view.png|frameless|500px|center|First view]]

You can browse the project as an anonymous user without logging in, view available languages, and see what has and hasn't been translated. Click on the <code>Browse</code> button or the <code>atom</code> link to begin. This will take you to the list of components within a given project. The project is
'''atom''' and the component(s) are the active versions of AtoM available for translation. For example purposes, this document shows two components for AtoM translations - '''2.4''' and '''2.5'''.

[[File:atom-components.png|frameless|500px|center|Components]]

While anyone can browse and view translations, only logged in users can contribute and save translations, and are credited for every translation made. To contribute translations, keep reading below!

==Log in to contribute to Artefactual translations==

'''1.''' You do not need to set up an account with Weblate to begin translating for AtoM. Artefactual has configured authentication through GitHub. Navigate to https://translations.artefactual.com/ and click '''Login''' at the top right. Use your GitHub account to log in. If you don't have a GitHub account, you can set one up [https://github.com/ here].

[[File:weblate-github.png|frameless|300px|center|GitHub auth]]

The first time you log in you will be asked to grant access to your GitHub account. Click
Authorize translations.artefactual.com by qubot
You will not see this screen on subsequent logins.

[[File:qubot-authorization.png|frameless|500px|center|Authorization]]

==Set your preferences==

'''2.''' When you log in you will see the Dashboard and menu options.

[[File:first-login.png|frameless|500px|center|Weblate dashboard]]

You can set your preferences by clicking on "Manage languages", "Manage watched projects", or "Settings" and selecting your preferences in the navigation tabs.
[[File:weblate-manage-settings.png|frameless|500px|center|Set your preferences]]

Each of these choices takes you to the settings screen. The three navigation tabs you will want to review before you start translating are '''Languages''', '''Subscriptions''', and '''Preferences'''.

'''3.''' From the '''Language''' navigation tab, choose the languages you wish to translate and those you may want to follow. Choose your primary languages from the '''Translated languages''' box. These are the languages you speak fluently and wish to translate. They will show up on your dashboard as "Watched languages" when you log in or navigate to the dashboard. If there are other languages you want to follow, choose those in the '''Secondary languages''' box. Strings that have been translated in these languages will appear on the translation page (see [[#Begin translating]]). When you have made your selections, click <code>Save</code>. You can change these settings at any time by returning to the Languages tab in settings.

[[File:weblate-language-tab.png|frameless|500px|center|Language tab]]

'''4.''' From the '''Subscription''' tab, you can choose translation project(s) you wish to follow and click <code>Save</code>. Currently Artefactual has only one translation project - '''atom'''. Even though there is currently only one project, choose it and click <code>Save</code> so that it will appear in your dashboard.

You can also specify '''notifications''' that you would like to receive. Notifications are selected from the '''Subscription''' tab below the Projects section. Translation notifications apply to your primary languages. This can be especially useful for users who are designated reviewers (see [[#Become a reviewer]]). When you are done, save your selections.

[[File:weblate-subscription-tab.png|frameless|500px|center|Subscription tab]]

These settings can be changed or updated at any time by returning to the Subscriptions tab in settings.

'''5.''' Once you have chosen languages and subscriptions (projects), these will appear on your dashboard, showing the status of translation for each of your chosen languages and projects. You will also see a '''Watched projects''' dropdown list on the main navigation bar at the top of the page; all Artefactual translation projects are available from the '''Projects''' dropdown list, and all available languages from the '''Languages''' dropdown list.

In the screenshot below, the user has selected three primary languages - these will always be shown on the dashboard for the available components of watched projects (subscriptions) when that user logs in.

[[File:weblate-dashboard2.png|frameless|500px|center|Projects dashboard]]

<admonition type="tip">
Don't see a language you would like to provide translations for? We have instructions on how you can request new languages in the section [[#Requesting new languages|below]]!
</admonition>

'''6.''' From the '''Preferences''' tab you can choose how you would like the translation screen to appear. '''Translation editor mode''' offers two choices - '''Full editor''' mode and '''Zen''' mode. These are described below in [[#Begin translating|Begin translating]]. You can also choose what information appears on your dashboard. When you are finished making your selections, click <code>Save</code>.

<admonition type="seealso">
Weblate has its own help documentation - here's a help page on getting started:

* [https://docs.weblate.org/en/latest/user/index.html Weblate Documentation]
</admonition>

===Requesting new languages===

'''7.''' Don't see a language you would like to provide translations for? If you would like to translate in a language that is not currently available in our Weblate project, you can request that it be added. To start a request, click on the project component in which you plan to add translations (currently 2.4 and 2.5). From the '''Tools''' menus select <code>Start new translation</code> or scroll to the bottom of the list of languages and click on <code>Start new translation</code> at the bottom of the page.

From the tools menu:

[[File:request-language-tools.png|frameless|400px|center|Request new language]]

From the bottom of the page:

[[File:request-language.png|frameless|400px|center|Request new language]]

Select the language(s) you would like added to the project and click '''Request new translation'''.

[[File:request-language2.png|frameless|500px|center|Request Acholi]]

If the languages listed still do not include one that you want to translate, click the link <code>Can't find your language in the list above?</code>. View a list of all languages supported in AtoM, with their corresponding language codes, here:

* [https://gist.github.com/sevein/d248525a66ef793c93d8 AtoM supported languages]

Complete the Weblate form with as much detail as possible using information from this list and click <code>Send</code>. Your request will be received by Artefactual.

[[File:request-language3.png|frameless|500px|center|Language contact]]

<admonition type="important"> Please review the options available in the list prior to requesting a new language! In many cases, we have had requests for different locales (for example, requesting "fr_FR" for France French, instead of working in the existing "fr" French project), but AtoM does not always support these very well. If at all possible, please work within the existing projects, or try to select the most generic option, without locale codes. We'll work with you if there are no other options, of course - but if you can avoid using a specific locale, it will make merging and maintaining your translations in AtoM much easier! </admonition>

==Begin translating==

'''8.''' From your dashboard you can navigate to the translation screen in two ways.

[[File:weblate-dashboard3.png|frameless|500px|center|Projects dashboard]]

Click on your choice of component and language in the '''Component''' column. This will take you to the '''Overview''' screen of the main translation page for that language. Here you will see links that can take you to the translation screen. Clicking on the <code>Translate</code> button will take you to the set of strings needing action. You can choose different filtered set by clicking any of the links under '''Strings to check'''.

[[File:weblate-translation-links.png|frameless|500px|center|Translating]]

The second way to reach the translation screen from your dashboard is to click on the <code>Translate</code> button to the right of the component/language you want to translate. This will take you directly to the translation screen and strings needing action. You can change the filter on strings for translation from the dropdown menu at the top left.

'''9.''' Once you have reached the translation screen you will see the first item needing translation. The default view is '''Full editor''' mode; the screen shows any watched (secondary) languages you have set, the source string to be translated, and a text field in which you can enter your translation. In this screenshot, there are no watched languages.

[[File:full-editor-mode.png|frameless|500px|center|Full editor]]

Many source strings include variables, e.g. %1%, or (%3% b). These should be included in the translated string in the appropriate position for the destination language, e.g. from the current example
%1%Download%2% (%3% b)
will be translated as
%1%Sækja%2% (%3% b)

When you have entered your translation, click <code>Save</code>. Your translation will be saved and checked by Weblate's quality checks. If there are any failing checks a message will appear. You can then edit your translation and resave, or leave the translation as is and move on to the next source string. You can skip any strings you do not want to translate.

<admonition type="note"> All translations are saved in Weblate regardless of failing checks. Weblate runs a wide range of quality checks on each translation, including syntax, length, consistency, duplication and more, taking into account special rules for different languages. See types of translation checks [https://docs.weblate.org/en/latest/user/checks.html#translation-checks here]. Any translation that has not been approved by a designated reviewer can be edited by any logged in user, including fixing failed checks or editing a saved translation. You can see the status of a translation by hovering over the '''State''' next to a translation on the translation screen. Translation states include <code>Message is approved</code> (green check mark, translation cannot be edited);
<code>Message is translated</code> (blue check mark, translation can be edited); <code>Message has failing checks</code> (brown exclamation mark, translation can be edited); and <code>Message not translated</code> (red x).

[[File:translation-states.png|frameless|300px|center|Translation states]]

</admonition>

'''10.''' For faster translation switch to '''Zen''' mode by clicking <code>Zen</code> at the top right of the screen. In Zen mode each item shows (1) the source string (location in the Artefactual database), (2) translations in any languages you are watching, (3) the term to be translated, and (4) the edit area for your translation.

[[File:edit-screen.png|frameless|500px|center|Adding Translations]]

You can switch from Zen mode back to Full Editor mode by clicking <code>Exit Zen</code>. .

In Zen mode your translation will be saved automatically, and checked, once you move your cursor out of the translation field.

[[File:weblate-translated-word.png|frameless|500px|center|Translated word]]

If your translation fails any checks, a red "x" will appear. Scrolling over the "x" will highlight the syntax error.

[[File:weblate-translation-fail.png|frameless|300px|center|Failed translation]]

You can work through the list of strings needing translation, choosing those you want to translate.

<admonition type="important"> When you are entering translations in '''Zen''' mode, your entries will be saved automatically. When you are in '''Full editor''' mode, however, you need to save the translation in the primary language. </admonition>

'''11.''' You can contribute translations in any language, even those you have not set as primary or secondary. Clicking on a project component will bring up a list of all languages in the project. Click <code>Translate</code> next to any language to go to the translation screen for that language. Click <code>Watched projects</code> from the main menu bar, select <code>atom</code>, and then select the component you want.

[[File:all-languages.png|frameless|500px|center|All languages]]

You can access a particular source string in any other language by starting from the translation screen of one of your primary languages. Exit '''Zen''' mode if necessary. From Full Editor mode you can then enter your translation in the primary language, and by scrolling down to <code>Other languages</code> enter or edit translations for that same string in as many languages as you like by clicking <code>Edit</code> to the right of the translation field for each language. If you do not want to edit the string that is offered, click on <code>Skip</code> in the main translation box. Move to the next string by clicking the counter at the top of the screen.

[[File:weblate-translate-many.png|frameless|500px|center|Translating in several languages]]

<admonition type="note"> Weblate supports keyboard shortcuts to make navigating through the site quicker and more efficient. You can see a complete list of shortcuts [https://docs.weblate.org/en/weblate-3.2.2/user/translating.html#keyboard-shortcuts here]. </admonition>

'''12.''' Your translations are all saved in our database. However, before they can be included into the public branch of AtoM they need to be approved by designated reviewers, and then pushed to AtoM by Artefactual administrators.

==Become a reviewer==

'''13.''' Before translations from Weblate are added to AtoM they must be approved by designated reviewers. Reviewers are community members who are willing the review and approve translations in languages in which they are proficient. Once a translation is approved it cannot be changed (except by an administrator). These approved and locked translations are then ready to be incorporated into the main AtoM site. This will be done periodically by Artefactual.

'''14.''' All logged-in users at https://translations.artefactual.com have translator privileges that allow them to enter translations and edit their own and others' translations prior to approval. Reviewers have the same privileges as translators, as well as privileges that allow them to approve (and therefore lock) translations. If you would like to be a reviewer, log into the [https://translations.artefactual.com translation project]. This will ensure that your email is registered with the site as a translator, and visible to the Artefactual administrators. Then send us an email at [mailto:translate@artefactual.com translate@artefactual.com] so that we can grant you reviewer privileges.

'''15.''' Once you have reviewer privileges you can search for strings to be approved in your primary language(s). Click on <code>Strings waiting for review</code> from the translation screen in your chosen language. In Full editor mode this link appears in the list of strings to check.

[[File:waiting-for-review-full.png|frameless|500px|center|Strings needing approval]]

If you have set Zen mode as your default view, you can select strings waiting for review from the drop down list at the top of the page.

[[File:waiting-for-review-zen.png|frameless|500px|center|Strings needing approval]]

For each string needing approval, you can click the radio button <code>Approved</code> to lock the translation for that string. Remember to click <code>Save</code> if you are using Full editor mode.

'''16.''' Several times through the year Artefactual developers will push approved strings into the main AtoM branch. Reviewers will receive an email several weeks before these events to request that they approve new translations in their designated languages.

==FAQs==

Below you'll find some responses to frequently asked questions about Weblate, and our move from Transifex. You can also explore the Weblate documentation - here are a few handy links:

* [https://docs.weblate.org/en/latest/user/index.html Weblate: Translator's guide]
* [https://docs.weblate.org/en/latest/faq.html#usage Weblate: FAQ on usage]

<admonition type="tip">
Have a question you don't see addressed here? Let us know via the AtoM [https://groups.google.com/forum/#!forum/ica-atom-users User Forum], or send us an email at [mailto:translate@artefactual.com translate@artefactual.com].
</admonition>

===I just got comfortable using Transifex - Why are you moving from Transifex to Weblate?===

Artefactual was previously able to use Transifex because they offered free plans to open source projects. As of 2018, Transifex changed its policy to limit these free accounts to small projects with 10 collaborators or less - and because AtoM has a vibrant translation community with dozens of translators, we no longer qualify. A [https://www.transifex.com/pricing/ paid plan with Transifex] that could support as many collaborators as we need would cost at least $1,500 USD a month to maintain, which would represent a serious drain on the resources we have to maintain the project. Instead, we have chosen to move to an open source platform, Weblate, so we can host and manage the application ourselves.

===Why can I only log in through GitHub?===

Now that Artefactual is hosting and maintaining our translation infrastructure, we expect that many bots, web crawlers, and spam accounts would hit our user registration page, requiring significant time and energy to manage. GitHub is a long-established code repository platform that has existing filters and checks in place to reduce these kinds of spurious registration attempts, so we don't have to do it manually.

Artefactual already makes use of GitHub for AtoM's [https://github.com/artefactual/atom/ code repository] and [https://github.com/artefactual/atom-docs/ documentation], and going forward, the translation strings for each release will also be maintained in a separate [https://github.com/artefactual/atom-translations GitHub repository].

===There are two components in the Weblate AtoM project - which one should I use?===

Generally, Artefactual offers two kinds of releases: a major release (e.g. 2.3, 2.4, 2.5, etc) and sometimes, a minor release (e.g. 2.3.1, 2.4.1, etc). Major releases include new features and enhancements, while in most cases, minor releases will only include bug fixes. Both releases ''may'' include translation updates if they have been provided by our community. In Weblate, components will only have major numbers (e.g. 2.4, 2.5, 2.6, etc) and will be used to prepare any releases, major or minor, relating to the component number.

In most cases, there should only be one unlocked component in Weblate's AtoM project - if we've released 2.5 for example but expect to create a 2.5.1 release, we will likely not open a 2.6 component until 2.5.1 has been released, so that translators don't have add the same translations to both components. However, there may be rare cases where we have two components open and unlocked. This might occur if, for example, we've already added a 2.6 component, but then discover an issue in 2.5 big enough to warrant a 2.5.1 release, and want to allow our translator community an opportunity to supplement or update existing translations in that release as well.

In this rare case, it's up to you which component you choose to work in - but it should be informed by your goals, and a clear understanding of the consequences.

<admonition type="important">
If there are 2 open components in Weblate, then translations added to one component will '''not''' automatically be added to the other, even if it is for an earlier release. The only way to have your translations available in both components (and both releases) will be to manually add your translations to both components.
</admonition>

If there is a 2.5 and a 2.6 AtoM component in Weblate, then the 2.5 component will be used for a 2.5 minor release (i.e. 2.5.1, 2.5.2), and the 2.6 component will be used for the next major release (i.e. 2.6.0). In the case where there are 2 open components, those translation strings added in the earlier version will ''not'' be carried forward into the later component - but the later component ''will'' be used to create the next component in the future, meaning the strings will be carried forward into subsequent releases.

Because of this, we recommend only working in the earlier component if you want to fix poor translations or make other minor improvements in the next minor release so you can access them more quickly (since this will be the next public release), and you don't mind losing them in the next release or manually making the same changes in the later component. Otherwise, we recommend focusing on the latest component available - this ensures that your translations will be included in future releases as well.

===What's the difference between a reviewer and translator?===

Every person who logs into our AtoM translation project through GitHub will automatically be a translator. That means you can choose projects, and primary and secondary languages to watch, add translations in your chosen language(s) and any other languages you have knowledge of, and request that new languages that are currently unavailable in the project be added to it. When you add a translation, that string is automatically saved in the Weblate database and becomes visible to everyone. It can still be edited by you or by other translators. However, it will not be part of the next Artefactual commit until it has been approved. That is the role of a reviewer.

Reviewers have all the same privileges as translators, as well as the ability to approve translations. Once a reviewer has approved a translation it will no longer be editable, and it will be part of the next Artefactual commit.

===Why do I need a reviewer?===

Artefactual has chosen to use this model in order to maintain quality control on translations. If you would like to be a reviewer, please let us know by sending an email to [mailto:translate@artefactual.com translate@artefactual.com].

===What do I do if there are no reviewers on my language?===

We track who is a reviewer for any given language, and will contact translators directly if reviewers are needed for a language. If you find yourself completing translations with no reviewer for your chosen language(s), please feel free to contact us at [mailto:translate@artefactual.com translate@artefactual.com].

===Why can't i translate in a specific sublocale (like ES_es)?===

AtoM was built using the [https://symfony.com/legacy Symfony 1.x] PHP framework, and we borrow its internationalization (or i18n) functionality to implement AtoM's ability to translate content into multiple languages. However, as an older framework, Symfony's support for specific sublocales is limited. AtoM cannot at this time support a language that is not supported by the underlying Symfony i18n framework.

===Where can I find a list of supported languages for translation in AtoM?===

We have a list of all of AtoM's supported languages, and their 2-letter ISO 639-1 language codes, here:

* http://bit.ly/AtoM-langs

===How do I request a new language?===

First, please make sure that the language you would like to request is supported in AtoM - see this list:

* http://bit.ly/AtoM-langs

If it is supported, but you don't see it in Weblate, please see the [[#Requesting new languages|"Requesting new languages"]] section above. You can request a new language via Weblate - here's a quick summary of the steps outlined above:

* Navigate to the AtoM component in which you want to work
* Click the "Start new translation" button at the bottom of the page
* In the Language selection page that will appear, click the "Can't find your language in the list above?" hyperlink
* Weblate will open a Contact form - please fill out the details of your request. Artefactual will receive it and review the request. If you've requested a language that AtoM supports (full list available [http://bit.ly/AtoM-langs here]), we'll approve it!

See the documentation section [[Resources/Translation#Set_your_preferences|above]] for more details and screenshots.

Alternatively, feel free to email us at [mailto:translate@artefactual.com translate@artefactual.com] and we will be happy to add a new language for you!

----

'''Thank you''' for helping us translate AtoM - it is through your participation that we can make AtoM a truly international application!

Got questions, or find something that's not covered below that you think would be helpful? Let us know via the AtoM [https://groups.google.com/forum/#!forum/ica-atom-users User Forum], or send us an email at [mailto:translate@artefactual.com translate@artefactual.com].

-----

* [[Resources|Back to Resources]]
* [[Main_Page|AtoM wiki home]]

[[Category:Resources]]

Resources/Translation

2019-02-04T17:45:50Z

Crogers:

{{#pagetitle:Contribute translations}}
[[Main Page]] > [[Resources]] > Resources/Translation

Thank you for your interest in contributing user interface translations to the AtoM project! Your contributions help to further AtoM as a multilingual application
with a global reach.

In our continuing efforts to make the process of translating the AtoM interface more efficient, Artefactual Systems has moved from its previous translation
service, [https://www.transifex.com/ Transifex] to [https://www.weblate.org/ Weblate], an open source web-based translation management system supporting
continuous translation from multiple sources. More than one translator can contribute translated strings, making the process fast and easy, and
enabling Artefactual Systems to publish translations more often. Everything is web-based using Weblate, meaning you can access your translation work via any
web browser.

This page will introduce you to the AtoM Weblate translation project, so that you can log in and begin translating. If you have contributed through Transifex in the past, you will notice that the log in process with Weblate is slightly different, but contributing translations continues to be easy and flexible.

<admonition type="seealso">
* Interested in contributing to our project documentation? We have a separate page for that! See:[[Resources/Documentation/Contribute|Contribute documentation]]
* Looking to contribute code to AtoM? See: [[Development/Contribute code|Contribute code]]
* Check out our [https://www.accesstomemory.org/docs User Manual] for information on how to translate content or interface elements locally (in your installation only) - see the Multilingual section.
* Got questions, or find something that's not covered below that you think would be helpful? Let us know via the AtoM [https://groups.google.com/forum/#!forum/ica-atom-users User Forum], or send us an email at [mailto:translate@artefactual.com translate@artefactual.com].
</admonition>

__TOC__

==Browsing Artefactual translations==

'''The AtoM project in Weblate lives here:'''

* https://translations.artefactual.com/

[[File:weblate-first-view.png|frameless|500px|center|First view]]

You can browse the project as an anonymous user without logging in, view available languages, and see what has and hasn't been translated. Click on the <code>Browse</code> button or the <code>atom</code> link to begin. This will take you to the list of components within a given project. The project is
'''atom''' and the component(s) are the active versions of AtoM available for translation. For example purposes, this document shows two components for AtoM translations - '''2.4''' and '''2.5'''.

[[File:atom-components.png|frameless|500px|center|Components]]

While anyone can browse and view translations, only logged in users can contribute and save translations, and are credited for every translation made. To contribute translations, keep reading below!

==Log in to contribute to Artefactual translations==

'''1.''' You do not need to set up an account with Weblate to begin translating for AtoM. Artefactual has configured authentication through GitHub. Navigate to https://translations.artefactual.com/ and click '''Login''' at the top right. Use your GitHub account to log in. If you don't have a GitHub account, you can set one up [https://github.com/ here].

[[File:weblate-github.png|frameless|300px|center|GitHub auth]]

The first time you log in you will be asked to grant access to your GitHub account. Click
Authorize translations.artefactual.com by qubot
You will not see this screen on subsequent logins.

[[File:qubot-authorization.png|frameless|500px|center|Authorization]]

==Set your preferences==

'''2.''' When you log in you will see the Dashboard and menu options.

[[File:first-login.png|frameless|500px|center|Weblate dashboard]]

You can set your preferences by clicking on "Manage languages", "Manage watched projects", or "Settings" and selecting your preferences in the navigation tabs.
[[File:weblate-manage-settings.png|frameless|500px|center|Set your preferences]]

Each of these choices takes you to the settings screen. The three navigation tabs you will want to review before you start translating are '''Languages''', '''Subscriptions''', and '''Preferences'''.

'''3.''' From the '''Language''' navigation tab, choose the languages you wish to translate and those you may want to follow. Choose your primary languages from the '''Translated languages''' box. These are the languages you speak fluently and wish to translate. They will show up on your dashboard as "Watched languages" when you log in or navigate to the dashboard. If there are other languages you want to follow, choose those in the '''Secondary languages''' box. Strings that have been translated in these languages will appear on the translation page (see [[#Begin translating]]). When you have made your selections, click <code>Save</code>. You can change these settings at any time by returning to the Languages tab in settings.

[[File:weblate-language-tab.png|frameless|500px|center|Language tab]]

'''4.''' From the '''Subscription''' tab, you can choose translation project(s) you wish to follow and click <code>Save</code>. Currently Artefactual has only one translation project - '''atom'''. Even though there is currently only one project, choose it and click <code>Save</code> so that it will appear in your dashboard.

You can also specify '''notifications''' that you would like to receive. Notifications are selected from the '''Subscription''' tab below the Projects section. Translation notifications apply to your primary languages. This can be especially useful for users who are designated reviewers (see [[#Become a reviewer]]). When you are done, save your selections.

[[File:weblate-subscription-tab.png|frameless|500px|center|Subscription tab]]

These settings can be changed or updated at any time by returning to the Subscriptions tab in settings.

'''5.''' Once you have chosen languages and subscriptions (projects), these will appear on your dashboard, showing the status of translation for each of your chosen languages and projects. You will also see a '''Watched projects''' dropdown list on the main navigation bar at the top of the page; all Artefactual translation projects are available from the '''Projects''' dropdown list, and all available languages from the '''Languages''' dropdown list.

In the screenshot below, the user has selected three primary languages - these will always be shown on the dashboard for the available components of watched projects (subscriptions) when that user logs in.

[[File:weblate-dashboard2.png|frameless|500px|center|Projects dashboard]]

<admonition type="tip">
Don't see a language you would like to provide translations for? We have instructions on how you can request new languages in the section [[#Requesting new languages|below]]!
</admonition>

'''6.''' From the '''Preferences''' tab you can choose how you would like the translation screen to appear. '''Translation editor mode''' offers two choices - '''Full editor''' mode and '''Zen''' mode. These are described below in [[#Begin translating|Begin translating]]. You can also choose what information appears on your dashboard. When you are finished making your selections, click <code>Save</code>.

<admonition type="seealso">
Weblate has its own help documentation - here's a help page on getting started:

* [https://docs.weblate.org/en/latest/user/index.html Weblate Documentation]
</admonition>

===Requesting new languages===

'''7.''' Don't see a language you would like to provide translations for? If you would like to translate in a language that is not currently available in our Weblate project, you can request that it be added. To start a request, click on the project component in which you plan to add translations (currently 2.4 and 2.5). From the '''Tools''' menus select <code>Start new translation</code> or scroll to the bottom of the list of languages and click on <code>Start new translation</code> at the bottom of the page.

From the tools menu:

[[File:request-language-tools.png|frameless|400px|center|Request new language]]

From the bottom of the page:

[[File:request-language.png|frameless|400px|center|Request new language]]

Select the language(s) you would like added to the project and click '''Request new translation'''.

[[File:request-language2.png|frameless|500px|center|Request Acholi]]

If the languages listed still do not include one that you want to translate, click the link <code>Can't find your language in the list above?</code>. View a list of all languages supported in AtoM, with their corresponding language codes, here:

* [https://gist.github.com/sevein/d248525a66ef793c93d8 AtoM supported languages]

Complete the Weblate form with as much detail as possible using information from this list and click <code>Send</code>. Your request will be received by Artefactual.

[[File:request-language3.png|frameless|500px|center|Language contact]]

<admonition type="important"> Please review the options available in the list prior to requesting a new language! In many cases, we have had requests for different locales (for example, requesting "fr_FR" for France French, instead of working in the existing "fr" French project), but AtoM does not always support these very well. If at all possible, please work within the existing projects, or try to select the most generic option, without locale codes. We'll work with you if there are no other options, of course - but if you can avoid using a specific locale, it will make merging and maintaining your translations in AtoM much easier! </admonition>

==Begin translating==

'''8.''' From your dashboard you can navigate to the translation screen in two ways.

[[File:weblate-dashboard3.png|frameless|500px|center|Projects dashboard]]

Click on your choice of component and language in the '''Component''' column. This will take you to the '''Overview''' screen of the main translation page for that language. Here you will see links that can take you to the translation screen. Clicking on the <code>Translate</code> button will take you to the set of strings needing action. You can choose different filtered set by clicking any of the links under '''Strings to check'''.

[[File:weblate-translation-links.png|frameless|500px|center|Translating]]

The second way to reach the translation screen from your dashboard is to click on the <code>Translate</code> button to the right of the component/language you want to translate. This will take you directly to the translation screen and strings needing action. You can change the filter on strings for translation from the dropdown menu at the top left.

'''9.''' Once you have reached the translation screen you will see the first item needing translation. The default view is '''Full editor''' mode; the screen shows any watched (secondary) languages you have set, the source string to be translated, and a text field in which you can enter your translation. In this screenshot, there are no watched languages.

[[File:full-editor-mode.png|frameless|500px|center|Full editor]]

Many source strings include variables, e.g. %1%, or (%3% b). These should be included in the translated string in the appropriate position for the destination language, e.g. from the current example
%1%Download%2% (%3% b)
will be translated as
%1%Sækja%2% (%3% b)

When you have entered your translation, click <code>Save</code>. Your translation will be saved and checked by Weblate's quality checks. If there are any failing checks a message will appear. You can then edit your translation and resave, or leave the translation as is and move on to the next source string. You can skip any strings you do not want to translate.

<admonition type="note"> All translations are saved in Weblate regardless of failing checks. Weblate runs a wide range of quality checks on each translation, including syntax, length, consistency, duplication and more, taking into account special rules for different languages. See types of translation checks [https://docs.weblate.org/en/latest/user/checks.html#translation-checks here]. Any translation that has not been approved by a designated reviewer can be edited by any logged in user, including fixing failed checks or editing a saved translation. You can see the status of a translation by hovering over the '''State''' next to a translation on the translation screen. Translation states include <code>Message is approved</code> (green check mark, translation cannot be edited);
<code>Message is translated</code> (blue check mark, translation can be edited); <code>Message has failing checks</code> (brown exclamation mark, translation can be edited); and <code>Message not translated</code> (red x).

[[File:translation-states.png|frameless|300px|center|Translation states]]

</admonition>

'''10.''' For faster translation switch to '''Zen''' mode by clicking <code>Zen</code> at the top right of the screen. In Zen mode each item shows (1) the source string (location in the Artefactual database), (2) translations in any languages you are watching, (3) the term to be translated, and (4) the edit area for your translation.

[[File:edit-screen.png|frameless|500px|center|Adding Translations]]

You can switch from Zen mode back to Full Editor mode by clicking <code>Exit Zen</code>. .

In Zen mode your translation will be saved automatically, and checked, once you move your cursor out of the translation field.

[[File:weblate-translated-word.png|frameless|500px|center|Translated word]]

If your translation fails any checks, a red "x" will appear. Scrolling over the "x" will highlight the syntax error.

[[File:weblate-translation-fail.png|frameless|300px|center|Failed translation]]

You can work through the list of strings needing translation, choosing those you want to translate.

<admonition type="important"> When you are entering translations in '''Zen''' mode, your entries will be saved automatically. When you are in '''Full editor''' mode, however, you need to save the translation in the primary language. </admonition>

'''11.''' You can contribute translations in any language, even those you have not set as primary or secondary. Clicking on a project component will bring up a list of all languages in the project. Click <code>Translate</code> next to any language to go to the translation screen for that language. Click <code>Watched projects</code> from the main menu bar, select <code>atom</code>, and then select the component you want.

[[File:all-languages.png|frameless|500px|center|All languages]]

You can access a particular source string in any other language by starting from the translation screen of one of your primary languages. Exit '''Zen''' mode if necessary. From Full Editor mode you can then enter your translation in the primary language, and by scrolling down to <code>Other languages</code> enter or edit translations for that same string in as many languages as you like by clicking <code>Edit</code> to the right of the translation field for each language. If you do not want to edit the string that is offered, click on <code>Skip</code> in the main translation box. Move to the next string by clicking the counter at the top of the screen.

[[File:weblate-translate-many.png|frameless|500px|center|Translating in several languages]]

<admonition type="note"> Weblate supports keyboard shortcuts to make navigating through the site quicker and more efficient. You can see a complete list of shortcuts [https://docs.weblate.org/en/weblate-3.2.2/user/translating.html#keyboard-shortcuts here]. </admonition>

'''12.''' Your translations are all saved in our database. However, before they can be included into the public branch of AtoM they need to be approved by designated reviewers, and then pushed to AtoM by Artefactual administrators.

==Become a reviewer==

'''13.''' Before translations from Weblate are added to AtoM they must be approved by designated reviewers. Reviewers are community members who are willing the review and approve translations in languages in which they are proficient. Once a translation is approved it cannot be changed (except by an administrator). These approved and locked translations are then ready to be incorporated into the main AtoM site. This will be done periodically by Artefactual.

'''14.''' All logged-in users at https://translations.artefactual.com have translator privileges that allow them to enter translations and edit their own and others' translations prior to approval. Reviewers have the same privileges as translators, as well as privileges that allow them to approve (and therefore lock) translations. If you would like to be a reviewer, log into the [https://translations.artefactual.com translation project]. This will ensure that your email is registered with the site as a translator, and visible to the Artefactual administrators. Then send us an email at [mailto:translate@artefactual.com translate@artefactual.com] so that we can grant you reviewer privileges.

'''15.''' Once you have reviewer privileges you can search for strings to be approved in your primary language(s). Click on <code>Strings waiting for review</code> from the translation screen in your chosen language. In Full editor mode this link appears in the list of strings to check.

[[File:waiting-for-review-full.png|frameless|500px|center|Strings needing approval]]

If you have set Zen mode as your default view, you can select strings waiting for review from the drop down list at the top of the page.

[[File:waiting-for-review-zen.png|frameless|500px|center|Strings needing approval]]

For each string needing approval, you can click the radio button <code>Approved</code> to lock the translation for that string. Remember to click <code>Save</code> if you are using Full editor mode.

'''16.''' Several times through the year Artefactual developers will push approved strings into the main AtoM branch. Reviewers will receive an email several weeks before these events to request that they approve new translations in their designated languages.

==FAQs==

Below you'll find some responses to frequently asked questions about Weblate, and our move from Transifex. You can also explore the Weblate documentation - here are a few handy links:

* [https://docs.weblate.org/en/latest/user/index.html Weblate: Translator's guide]
* [https://docs.weblate.org/en/latest/faq.html#usage Weblate: FAQ on usage]

<admonition type="tip">
Have a question you don't see addressed here? Let us know via the AtoM [https://groups.google.com/forum/#!forum/ica-atom-users User Forum], or send us an email at [mailto:translate@artefactual.com translate@artefactual.com].
</admonition>

===I just got comfortable using Transifex - Why are you moving from Transifex to Weblate?===

Artefactual was previously able to use Transifex because they offered free plans to open source projects. As of 2018, Transifex changed its policy to limit these free accounts to small projects with 10 collaborators or less - and because AtoM has a vibrant translation community with dozens of translators, we no longer qualify. A [https://www.transifex.com/pricing/ paid plan with Transifex] that could support as many collaborators as we need would cost at least $1,500 USD a month to maintain, which would represent a serious drain on the resources we have to maintain the project. Instead, we have chosen to move to an open source platform, Weblate, so we can host and manage the application ourselves.

===Why can I only log in through GitHub?===

Now that Artefactual is hosting and maintaining our translation infrastructure, we expect that many bots, web crawlers, and spam accounts would hit our user registration page, requiring significant time and energy to manage. GitHub is a long-established code repository platform that has existing filters and checks in place to reduce these kinds of spurious registration attempts, so we don't have to do it manually.

Artefactual already makes use of GitHub for AtoM's [https://github.com/artefactual/atom/ code repository] and [https://github.com/artefactual/atom-docs/ documentation], and going forward, the translation strings for each release will also be maintained in a separate [https://github.com/artefactual/atom-translations GitHub repository].

===Can I test translating strings to see how it works?===

Yes! We have provided a demo test site at [https://weblate.accesstomemory.org] where you can view translations you add at [https://translations.artefactual.com]. The demo site will be automatically updated hourly so you can see the strings you have translated (but see the demo site for supported languages!) Note that your translation strings do not need to be approved to be uploaded to the demo site, but will need to be approved through the review process before being added to the latest release branch of AtoM.

===There are two components in the Weblate AtoM project - which one should I use?===

Generally, Artefactual offers two kinds of releases: a major release (e.g. 2.3, 2.4, 2.5, etc) and sometimes, a minor release (e.g. 2.3.1, 2.4.1, etc). Major releases include new features and enhancements, while in most cases, minor releases will only include bug fixes. Both releases ''may'' include translation updates if they have been provided by our community. In Weblate, components will only have major numbers (e.g. 2.4, 2.5, 2.6, etc) and will be used to prepare any releases, major or minor, relating to the component number.

In most cases, there should only be one unlocked component in Weblate's AtoM project - if we've released 2.5 for example but expect to create a 2.5.1 release, we will likely not open a 2.6 component until 2.5.1 has been released, so that translators don't have add the same translations to both components. However, there may be rare cases where we have two components open and unlocked. This might occur if, for example, we've already added a 2.6 component, but then discover an issue in 2.5 big enough to warrant a 2.5.1 release, and want to allow our translator community an opportunity to supplement or update existing translations in that release as well.

In this rare case, it's up to you which component you choose to work in - but it should be informed by your goals, and a clear understanding of the consequences.

<admonition type="important">
If there are 2 open components in Weblate, then translations added to one component will '''not''' automatically be added to the other, even if it is for an earlier release. The only way to have your translations available in both components (and both releases) will be to manually add your translations to both components.
</admonition>

If there is a 2.5 and a 2.6 AtoM component in Weblate, then the 2.5 component will be used for a 2.5 minor release (i.e. 2.5.1, 2.5.2), and the 2.6 component will be used for the next major release (i.e. 2.6.0). In the case where there are 2 open components, those translation strings added in the earlier version will ''not'' be carried forward into the later component - but the later component ''will'' be used to create the next component in the future, meaning the strings will be carried forward into subsequent releases.

Because of this, we recommend only working in the earlier component if you want to fix poor translations or make other minor improvements in the next minor release so you can access them more quickly (since this will be the next public release), and you don't mind losing them in the next release or manually making the same changes in the later component. Otherwise, we recommend focusing on the latest component available - this ensures that your translations will be included in future releases as well.

===What's the difference between a reviewer and translator?===

Every person who logs into our AtoM translation project through GitHub will automatically be a translator. That means you can choose projects, and primary and secondary languages to watch, add translations in your chosen language(s) and any other languages you have knowledge of, and request that new languages that are currently unavailable in the project be added to it. When you add a translation, that string is automatically saved in the Weblate database and becomes visible to everyone. It can still be edited by you or by other translators. However, it will not be part of the next Artefactual commit until it has been approved. That is the role of a reviewer.

Reviewers have all the same privileges as translators, as well as the ability to approve translations. Once a reviewer has approved a translation it will no longer be editable, and it will be part of the next Artefactual commit.

===Why do I need a reviewer?===

Artefactual has chosen to use this model in order to maintain quality control on translations. If you would like to be a reviewer, please let us know by sending an email to [mailto:translate@artefactual.com translate@artefactual.com].

===What do I do if there are no reviewers on my language?===

We track who is a reviewer for any given language, and will contact translators directly if reviewers are needed for a language. If you find yourself completing translations with no reviewer for your chosen language(s), please feel free to contact us at [mailto:translate@artefactual.com translate@artefactual.com].

===Why can't i translate in a specific sublocale (like ES_es)?===

AtoM was built using the [https://symfony.com/legacy Symfony 1.x] PHP framework, and we borrow its internationalization (or i18n) functionality to implement AtoM's ability to translate content into multiple languages. However, as an older framework, Symfony's support for specific sublocales is limited. AtoM cannot at this time support a language that is not supported by the underlying Symfony i18n framework.

===Where can I find a list of supported languages for translation in AtoM?===

We have a list of all of AtoM's supported languages, and their 2-letter ISO 639-1 language codes, here:

* http://bit.ly/AtoM-langs

===How do I request a new language?===

First, please make sure that the language you would like to request is supported in AtoM - see this list:

* http://bit.ly/AtoM-langs

If it is supported, but you don't see it in Weblate, please see the [[#Requesting new languages|"Requesting new languages"]] section above. You can request a new language via Weblate - here's a quick summary of the steps outlined above:

* Navigate to the AtoM component in which you want to work
* Click the "Start new translation" button at the bottom of the page
* In the Language selection page that will appear, click the "Can't find your language in the list above?" hyperlink
* Weblate will open a Contact form - please fill out the details of your request. Artefactual will receive it and review the request. If you've requested a language that AtoM supports (full list available [http://bit.ly/AtoM-langs here]), we'll approve it!

See the documentation section [[Resources/Translation#Set_your_preferences|above]] for more details and screenshots.

Alternatively, feel free to email us at [mailto:translate@artefactual.com translate@artefactual.com] and we will be happy to add a new language for you!

----

'''Thank you''' for helping us translate AtoM - it is through your participation that we can make AtoM a truly international application!

Got questions, or find something that's not covered below that you think would be helpful? Let us know via the AtoM [https://groups.google.com/forum/#!forum/ica-atom-users User Forum], or send us an email at [mailto:translate@artefactual.com translate@artefactual.com].

-----

* [[Resources|Back to Resources]]
* [[Main_Page|AtoM wiki home]]

[[Category:Resources]]

Workspace

2019-01-07T17:46:38Z

Crogers: /* What's the difference between a reviewer and translator? */

Workspace

2019-01-07T17:46:03Z

Crogers:

Workspace

2019-01-07T17:34:37Z

Crogers:

Workspace

2019-01-07T17:25:47Z

Crogers:

Workspace

2019-01-07T17:16:27Z

Crogers:

Workspace

2018-12-20T23:48:49Z

Crogers: /* FAQs */

File:Weblate-first-view.png

2018-12-20T23:46:32Z

Crogers: Crogers uploaded a new version of File:Weblate-first-view.png

First view an anon user sees.

File:Weblate-first-view.png

2018-12-20T23:43:29Z

Crogers: Crogers uploaded a new version of File:Weblate-first-view.png

First view an anon user sees.

Workspace

2018-12-20T23:24:35Z

Crogers:

Workspace

2018-12-20T23:23:53Z

Crogers:

Workspace

2018-12-20T19:33:04Z

Crogers: /* FAQs */

Workspace

2018-12-20T19:30:04Z

Crogers:

Workspace

2018-12-20T19:13:07Z

Crogers: /* Browsing Artefactual translations */