ICA-AtoM - User contributions [en]

Edit permissions

2012-02-21T00:08:49Z

Evelyn:

[[Main Page]] > [[User manual]] > [[Administer]] > Edit permissions

<div class="note">
* You should have two or more archival institutions in your system, with several hierarchical descriptions attached and some digital objects uploaded, in order to fully test the scenarios on this page
* You can only modify the user's settings if you are logged in as an administrator. After completing the steps in each scenario, log out and log back in as the user you've been creating and modifying in order to see the results of your modifications
</div>

== Scenario one: In a multi-repository system, add a user who can create, update, edit, delete and publish archival descriptions belonging to one archival institution only (or whatever preferences the Administrator wants to set for the User) ==
<div class=clear fix>
<ol>

[[Image:singlerep_user01.png|300px|right|thumb|Fig.1. Leave group field blank. User automatically becomes an authenticated user.]]
<li> When refining user permissions you can begin by creating a User, but do not assign them to a unique User group. Leave this blank and it will automatically assign the User to the parent group of authenticated (which is all users who have successfully logged-in)(See fig.1)</li>
<br style="clear:both" />
[[Image:singlerep_user02.png|300px|right|thumb|Fig.2.View User permissions screen]]
<li>
In order to restrict permissions to descriptions of a particular institution, we need to go to Admin menu > Users. Select the User you want to restrict to specific repository permissions.(See fig.2)</li>
<br style="clear:both" />
[[Image:singlerep_user03.png|300px|right|thumb|Fig.3 View permissions by repository.]]
<li>Click Edit. Select Permissions by Repository and click Add Repository. Select Repository name from list. Click on Submit.(See fig.3)</li>
<br style="clear:both" />
[[Image:singlerep_user04.png|300px|right|thumb|Fig.4]]
<li>Click on the circles to Grant Permissions to read, create, update, delete, view draft, publish, access master and access reference.(See fig.4)</li>
<br style="clear:both" />
[[Image:singlerep_user05.png|300px|right|thumb|Fig.5 View permissions for User]]
<li>Click on Save.The Administrator can now view the User and their permissions in relation to a specific Repository.(See fig.5)</li>
<br style="clear:both" />
<li>To test your permissions, try logging out and logging back in as the user you created. You should be able to create, edit, delete and publish descriptions belonging to the specified institution only.If you want this User to have permissions to create, update and delete Authority Records and create, update and delete Taxonomies you must "grant" those as well.The default for authenticated group does not grant those permissions.</li>

</ol>
</div>

== Scenario two: Add user to the contributor group as an alternative approach ==

<div class="note">

When refining user permissions, it is often useful to start with the group to which the user belongs. You can refine permissions for the group, then add users to the group, all of whom will inherit the modified permissions. Any permission that has not been "granted" by the current group (e.g., contributor, editor) or its parent group (authenticated) is considered "denied" by default. In other words the default for the system is to deny permission unless a rule explicitly grants it.

In the main menu bar, go to admin > groups > contributor. Click on Archival description permissions in the grey menu above the title bar. Your screen will show the default "Grant" permissions for the contributor group - i.e. it shows you everything the user is permitted to do. The contributor group inherits some of its settings from its parent group, authenticated (which is all users who have successfully logged-in).

Click Edit. In the edit screen, you will get a better sense of the group's permission settings. The contributor has the following permissions:
* Read: Grant (inherited from authenticated group)
* Create: Grant
* Update: Grant
* Delete: Deny (default deny)
* View draft: Grant
* Publish: Deny (default deny)
* Access master digital object: Grant
* Access reference digital object: Grant (inherited from authenticated group).

In other words, any user belonging to the contributor group automatically has been ''granted'' the ability to read, create and update descriptions, view draft descriptions, and access digital objects. However, the user has been ''denied'' the ability to delete or publish descriptions.

</div>

== Scenario three: Remove the ability to create and update authority records ==
</div class="note">
Permissions for authority records can be refined in some of the same ways they can be refined for archival descriptions. In a multi-repository setting it may be desirable to prevent users from creating and/or updating authority records, because one authority record may be linked to archival descriptions belonging to more than one archival institution.

</div>

== Scenario four: Add the ability to translate to a specified language ==

<div class="note">
There are two ways to grant translate permissions to non-administrators:

* Make the user a translator by adding them to the translator group (the same way that you added a user to the contributor group). This means that they will be able to translate to any language.
* Instead of making the user a translator, which would allow them to translate to any language, add a language to which a user can translate. This means that they will be able to translate only to the specified language, and only those archival descriptions and authority records they are allowed to update. In this scenario, we will add the ability of the user to translate to Dutch.

Go to admin > users > "UserName". You should be in looking at the View user profile screen; if not, click Profile (to the left of Archival description permissions). Click Edit, then click on the blue "Access control" link. In allowed languages for translation, select Dutch. Click Save. The user will now be able to translate from any source language to Dutch. Note that the list of languages is derived from the languages added in the settings menu. See [[add/remove languages]]. Note also that you can add more languages from this list as needed.
</div>

== Scenario five: Remove the ability to view and download master digital objects ==

<div class="note">

Users belonging to the contributor group automatically inherit the ability to view and download master digital objects.

</div>

Go to admin > users > "UserName". Click on Archival description permissions. Click Edit. Under ''All archival descriptions'' next to Access master click Deny. Save the record. This will allow the user to view thumbnail and reference display copies of digital objects, but not to view or download the master objects. Note that if you do not wish to have any users belonging to the Contributor group viewing or downloading masters digital objects, deny permission for this activity at the level of the group - i.e. go to admin > groups > contributor and make the change at that level instead of the level of the individual user.

== Scenario six: Add ability to create, update, and delete subject terms ==

<div class="note">

Users belonging to the contributor group do not automatically inherit the ability to create, update, and delete taxonomy terms. You can change these permissions for either the contributor group or an individual user. In this case, we will add the ability to create, update and delete subject terms to our individual user.

</div>

Go to admin > users > "UserName". Click on Taxonomy permissions (next to Authority record permissions). Click Edit. Click the blue link "Permissions by taxonomy", then click "Add taxonomy". Select Subjects as the taxonomy name from the auto-complete list. Next to Create, Update and Delete select Grant, then save the record. The user should now be able to create, update and delete subject terms but not other kinds of taxonomy terms.

[[Category:User manual]]

__NOTOC__

User manual

2011-04-26T22:00:15Z

Evelyn:

{| style="width:95%; border="0"
|-valign="top"
| style="width:500px; border: 1px solid rgb(255, 201, 201); padding: 0.5em 1em 1em; color: rgb(0, 0, 0); background-color: rgb(255, 243, 243);" |

== [[Overview]] ==

* [[What is ICA-AtoM?]]
* [[Technical requirements]]
* [[Entity types]]
* [[Descriptive standards]]

== [[Getting started]] ==

* [[Home page]]
* [[Log in]]
* [[User roles]]
* [[Page types]]
* [[Choose language]]
* [[Change password]]

== [[Add/edit content]] ==

* [[Add/edit archival descriptions]]
* [[Add/edit authority records]]
* [[Add/edit archival institutions]]
* [[Control area]]
* [[Add/edit functions]]
* [[Add/edit terms]]
* [[Exit edit mode]]

== [[Access content]] ==

* [[Search]]
* [[Browse]]
* [[Navigate]]

== [[Translate]] ==

* [[Multilingual design principles]]
* [[Translate content]]
* [[Translate interface]]
* [[Translate static pages]]

| style="width: 500px; border: 1px solid rgb(198, 201, 255); padding: 0.5em 1em 1em; color: rgb(0, 0, 0); background-color: rgb(240, 240, 255);" |

== [[Import/export]] ==

* [[Upload digital objects]]
* [[Import descriptions and terms]]
* [[Export descriptions and terms]]
* [[OAI-PMH]]

== [[Administer]] ==

* [[Install]]
* [[Manage user accounts]]
* [[Edit permissions]]
* [[Manage static pages]]
* [[Settings]]
* [[Themes]]
* [[Default language]]
* [[Back up]]
* [[Search for updates]]

== [[Glossary]] ==

Glossary of terms used throughout this user manual

== [[:Category:User manual|Index]] ==

Index of pages in this user manual

== Questions? ==

Please post them to [http://groups.google.ca/group/ica-atom-users the discussion group]

__NOEDITSECTION__
__NOTOC__

Main Page

2011-04-07T23:42:57Z

Evelyn:

{|style="width:95%; border="0"
|-valign="top"
|style="width: 500px; border: 1px solid rgb(255, 201, 201); padding: 0.5em 1em 1em; color: rgb(0, 0, 0); background-color: rgb(255, 243, 243)"|

== [[User manual]] ==

User guide to creating, editing, accessing, importing, exporting, and translating content in ICA-AtoM; includes administering the system

== [[:Category:Releases|Release history]] ==

Chronology of new features, changes and bug fixes for each ICA-AtoM release

== [[MemoryBC-tutorial|Tutorial]] ==

A workshop tutorial created by the Archives Association of British Columbia which can be freely modified and reused

== [[Requirement sources]] ==

The ICA standards from which software requirements are drawn

|style="width: 500px; border: 1px solid rgb(198, 201, 255); padding: 0.5em 1em 1em; color: rgb(0, 0, 0); background-color: rgb(240, 240, 255)"|

== [[Glossary]] ==

Definitions and explanations of terms used throughout documentation; terms that are defined in the glossary are hyperlinked in the documentation

== [[ICA-AtoM virtual appliance|Download virtual appliance]] ==

Run ICA-AtoM as a virtual appliance on any operating system. Great option if you want to try ICA-AtoM on your personal computer but are having trouble installing the web server or database server that a web-based application like ICA-AtoM requires.

== [[Translate this wiki]] ==

Page for ICA-AtoM project participants who are translating the documentation in this wiki

|}

== Questions? ==

Please post them to [http://groups.google.ca/group/ica-atom-users the discussion group]

__NOEDITSECTION__
__NOTOC__

Main Page/pl

2011-02-15T18:42:48Z

Evelyn:

{|style="width:95%; border="0"
|-valign="top"
|style="width: 500px; border: 1px solid rgb(255, 201, 201); padding: 0.5em 1em 1em; color: rgb(0, 0, 0); background-color: rgb(255, 243, 243)"|

== [[User manual/pl|User manual]] ==

User guide to creating, editing, accessing, importing, exporting, and translating content in ICA-AtoM; includes administering the system

== [[:Category:Releases|Release history]] ==

Chronology of new features, changes and bug fixes for each ICA-AtoM release

== [[MemoryBC-tutorial|Tutorial]] ==

A workshop tutorial created by the Archives Association of British Columbia which can be freely modified and reused

== [[Requirement sources]] ==

The ICA standards from which software requirements are drawn

== [[Glossary]] ==

Definitions and explanations of terms used throughout documentation; terms that are defined in the glossary are hyperlinked in the documentation

|style="width: 500px; border: 1px solid rgb(198, 201, 255); padding: 0.5em 1em 1em; color: rgb(0, 0, 0); background-color: rgb(240, 240, 255)"|

== [[ICA-AtoM virtual appliance|Download virtual appliance]] ==

Run ICA-AtoM as a virtual appliance on any operating system. Great option if you want to try ICA-AtoM on your personal computer but are having trouble installing the web server or database server that a web-based application like ICA-AtoM requires.

== [[Beta testing]] ==

Page for the institutions that are beta testing the software

== [[Translate this wiki]] ==

Page for ICA-AtoM project participants who are translating the documentation in this wiki

|}

== Questions? ==

Please post them to [http://groups.google.ca/group/ica-atom-users the discussion group]

__NOEDITSECTION__
__NOTOC__

User manual/pl

2011-02-15T18:39:51Z

Evelyn: Created page with '{| style="width:95%; border="0" |-valign="top" | style="width:500px; border: 1px solid rgb(255, 201, 201); padding: 0.5em 1em 1em; color: rgb(0, 0, 0); background-color: rgb(255,...'

{| style="width:95%; border="0"
|-valign="top"
| style="width:500px; border: 1px solid rgb(255, 201, 201); padding: 0.5em 1em 1em; color: rgb(0, 0, 0); background-color: rgb(255, 243, 243);" |

== [[Overview]] ==

* [[What is ICA-AtoM?]]
* [[Technical requirements]]
* [[Entity types]]
* [[Descriptive standards]]

== [[Getting started]] ==

* [[Home page]]
* [[Log in]]
* [[User roles]]
* [[Page types]]
* [[Choose language]]
* [[Change password]]

== [[Add/edit content]] ==

* [[Add/edit archival descriptions]]
* [[Add/edit authority records]]
* [[Add/edit archival institutions]]
* [[Add/edit functions]]
* [[Add/edit terms]]
* [[Exit edit mode]]

== [[Access content]] ==

* [[Search]]
* [[Browse]]
* [[Navigate]]

== [[Translate]] ==

* [[Multilingual design principles]]
* [[Translate content]]
* [[Translate interface]]
* [[Translate static pages]]

| style="width: 500px; border: 1px solid rgb(198, 201, 255); padding: 0.5em 1em 1em; color: rgb(0, 0, 0); background-color: rgb(240, 240, 255);" |

== [[Import/export]] ==

* [[Upload digital objects]]
* [[Import descriptions and terms]]
* [[Export descriptions and terms]]
* [[OAI-PMH]]

== [[Administer]] ==

* [[Install]]
* [[Manage user accounts]]
* [[Edit permissions]]
* [[Manage static pages]]
* [[Settings]]
* [[Themes]]
* [[Default language]]
* [[Back up]]
* [[Search for updates]]

== [[Glossary]] ==

Glossary of terms used throughout this user manual

== [[:Category:User manual|Index]] ==

Index of pages in this user manual

== Questions? ==

Please post them to [http://groups.google.ca/group/ica-atom-users the discussion group]

__NOEDITSECTION__
__NOTOC__

Main Page/pl

2011-02-15T18:26:21Z

Evelyn: Created page with 'Polish'

Polish

Search for updates

2010-11-23T17:27:13Z

Evelyn:

[[Main Page]] > [[User manual]] > Administer

This feature allows a user logged in as an [[Glossary#Administrator|administrator]] to search for new and updated records.

[[Image:searchForUpdates.png|500px|right|thumb|A search for new authority records]]

1. Click on Admin > Description updates.

2. Under Type, select Archival description, Authority record, Archival institution, Term or Function.

3. Select a date range.

4. Select Creation for new records, Revision for updated records, or All for both.

5. If searching for [[Glossary#Archival description|archival descriptions]], set Publication status to search for either [[Glossary#Draft record|draft]] or [[Glossary#Published record|published records]] or both.

6. Click Search.

Search for updates

2010-11-23T17:26:47Z

Evelyn:

[[Main Page]] > [[User manual]] > Administer

This feature allows a user logged in as an [[Glossary#Administrator|administrator]] to search for new and updated records.

[[Image:searchForUpdates.png|500px|right|thumb|A search for updated authority records]]

1. Click on Admin > Description updates.

2. Under Type, select Archival description, Authority record, Archival institution, Term or Function.

3. Select a date range.

4. Select Creation for new records, Revision for updated records, or All for both.

5. If searching for [[Glossary#Archival description|archival descriptions]], set Publication status to search for either [[Glossary#Draft record|draft]] or [[Glossary#Published record|published records]] or both.

6. Click Search.

Upload digital objects

2010-11-23T00:49:55Z

Evelyn:

[[Main Page]] > [[User manual]] > [[Import/export]] > Upload digital objects

[[Image:upload.png|500px|right|thumb|Archival description view page showing reference display copy of an uploaded audio file: the user can click on the play button to hear the recording]]

ICA-AtoM allows the user to upload [[Glossary#Digital object|digital objects]], such as scanned images, sound and moving image files, and other scanned or born-digital items. Every [[Glossary#Digital object|digital object]] must be associated with an [[Glossary#Archival description|archival description]], typically at the file or item level.

For every object uploaded, ICA-AtoM creates two derivative objects, a [[Glossary#Thumbnail|thumbnail]] image and a [[Glossary#Reference display copy|reference display copy]].

<div class="note">

At higher [[Glossary#Level of description|levels of description]], the [[Glossary#Context menu|context menu]] includes [[Glossary#Thumbnail|thumbnails]] of all files registered at lower levels. The [[Glossary#Thumbnail|thumbnails]] are displayed using [[Glossary#Cover flow|cover flow]] so you can easily scroll through the set using your keyboard's arrow keys.

</div>

To upload a single [[Glossary#Digital object|digital object]]:
# Open an [[Glossary#Archival description|archival description]] in [[Glossary#View mode|view mode]]
# Click on the Link digital object button in the [[Glossary#Button block|button block]]
# Click the Browse button to navigate to and select a file. Click the Open button.
# Click the Save button in the [[Glossary#Button block|button block]]. When you return to the [[Glossary#View page|view page]], the [[Glossary#Reference display copy|reference display copy]] will be displayed in the digital object field. Users can view or play the [[Glossary#Reference display copy|reference display copy]] (depending on the type of [[Glossary#Digital object|digital object]]). Logged in users can also download the [[Glossary#Master digital object|master digital object]].
# Objects with multiple pages, such as multi-page TIFFs or PDF files, will by default be displayed with single-page [[Glossary#Reference display copy|reference display copies]]. To have them viewed with a pager to allow the user to browse through the pages, go to Admin > Settings > Global > Upload multi-page files as multiple descriptions and select yes; this will also cause all pages of a multi-page object to appear individually as [[Glossary#Child record|child records]] of the description to which the object was uploaded.

You can upload any file format, but only supported formats can be viewed or played directly in ICA-AtoM. For a list of formats, see [[File formats]]. Formats that are not supported can still be uploaded: clicking the object will download it to the user's desktop where (assuming the user has the required software) it can be viewed or played.

== Upload multiple files ==

A user can upload multiple files at once, attaching them all to the same [[Glossary#Archival description|archival description]].

# Open an [[Glossary#Archival description|archival description]] in [[Glossary#View mode|view mode]].
# Click on the Import digital objects button in the [[Glossary#Button block|button block]].
# Select a title for the objects; all the objects will have the title plus a number. Currently the default is image 01, image 02, etc.
# Choose a level of description.
# Click the blue Select files link and select multiple files to upload. The page will show previews of all the objects.
# If you like you can edit the title for each object next to the preview.
# Click Import in the [[Glossary#Button block|button block]]. When you return to the [[Glossary#View page|view page]] you will see that the objects have all been attached to the archival description as [[Glossary#Child record|child records]] of that description.

[[Category:User manual]]

Upload digital objects

2010-11-23T00:48:48Z

Evelyn:

[[Main Page]] > [[User manual]] > [[Import/export]] > Upload digital objects

[[Image:upload.png|500px|right|thumb|Archival description view page showing reference display copy of an uploaded audio file: the user can click on the play button to hear the recording]]

ICA-AtoM allows the user to upload [[Glossary#Digital object|digital objects]], such as scanned images, sound and moving image files, and other scanned or born-digital items. Every [[Glossary#Digital object|digital object]] must be associated with an [[Glossary#Archival description|archival description]], typically at the file or item level.

For every object uploaded, ICA-AtoM creates two derivative objects, a [[Glossary#Thumbnail|thumbnail]] image and a [[Glossary#Reference display copy|reference display copy]].

<div class="note">

At higher [[Glossary#Level of description|levels of description]], the [[Glossary#Context menu|context menu]] includes [[Glossary#Thumbnail|thumbnails]] of all files registered at lower levels. The [[Glossary#Thumbnail|thumbnails]] are displayed using [[Glossary#Cover flow|cover flow]] so you can easily scroll through the set using your keyboard's arrow keys.

</div>

To upload a single [[Glossary#Digital object|digital object]]:
# Open an [[Glossary#Archival description|archival description]] in [[Glossary#View mode|view mode]]
# Click on the Link digital object button in the [[Glossary#Button block|button block]]
# Click the Browse button to navigate to and select a file. Click the Open button.
# Click the Save button in the [[Glossary#Button block|button block]]. When you return to the [[Glossary#View page|view page]], the [[Glossary#Reference display copy|reference display copy]] will be displayed in the digital object field. Users can view or play the [[Glossary#Reference display copy|reference display copy]] (depending on the type of [[Glossary#Digital object|digital object]]). Logged in users can also download the [[Glossary#Master digital object|master digital object]].
# Objects with multiple pages, such as multi-page TIFFs or PDF files, will by default be displayed with single-page [[Glossary#Reference display copy|reference display copies]]. To have them viewed with a pager to allow the user to browse through the pages, go to Admin > Settings > Global > Upload multi-page files as multiple descriptions and select yes; this will also cause all pages of a multi-page object also appear individually as [[Glossary#Child record|child records]] of the description to which the object was uploaded.

You can upload any file format, but only supported formats can be viewed or played directly in ICA-AtoM. For a list of formats, see [[File formats]]. Formats that are not supported can still be uploaded: clicking the object will download it to the user's desktop where (assuming the user has the required software) it can be viewed or played.

== Upload multiple files ==

A user can upload multiple files at once, attaching them all to the same [[Glossary#Archival description|archival description]].

# Open an [[Glossary#Archival description|archival description]] in [[Glossary#View mode|view mode]].
# Click on the Import digital objects button in the [[Glossary#Button block|button block]].
# Select a title for the objects; all the objects will have the title plus a number. Currently the default is image 01, image 02, etc.
# Choose a level of description.
# Click the blue Select files link and select multiple files to upload. The page will show previews of all the objects.
# If you like you can edit the title for each object next to the preview.
# Click Import in the [[Glossary#Button block|button block]]. When you return to the [[Glossary#View page|view page]] you will see that the objects have all been attached to the archival description as [[Glossary#Child record|child records]] of that description.

[[Category:User manual]]

Export descriptions and terms

2010-11-23T00:35:51Z

Evelyn:

[[Main Page]] > [[User manual]] > [[Import/export]] > Export descriptions and terms

[[Image:export2.png|500px|right|thumb|Excerpt of exported archival description in EAD 2002 XML format]]

ICA-AtoM provides an export functionality that can be used to export [[Glossary#Archival description|archival descriptions]], [[Glossary#Authority record|authority records]], [[Glossary#Archival institution|archival institutions]] and [[Glossary#Term|terms]]. Exported descriptions and taxonomies will be displayed in your web browser window. To save the XML export file, use your browser's save functionality. To exit the XML export file, click on your browser's back button.

The following file types can be exported:
* EAD (hierarchical archival descriptions and associated authority records, archival institution descriptions and taxonomy terms)
* Dublin Core XML, MODS XML (archival descriptions and associated taxonomy terms)
* EAC (authority records)
* SKOS (hierarchical taxonomies)

== EAD export ==

In the [[Glossary#Archival description|archival description]] [[Glossary#View page|view page]], select EAD 2002 XML under Export in the [[Glossary#Context menu|context menu]]. This will export the current archival description plus all its [[Glossary#Child record|child records]] and associated authority records, archival institution descriptions and taxonomy terms.

== Dublin Core XML export ==

In the [[Glossary#Archival description|archival description]] [[Glossary#View page|view page]], select Dublin Core 1.1 XML under Export in the [[Glossary#Context menu|context menu]]. This will export the current archival description plus associated taxonomy terms.

== MODS XML export ==

Go to an [[Glossary#Archival description|archival description]] [[Glossary#View page|view page]] using the MODS description template. Select MODS 3.3 XML under Export in the [[Glossary#Context menu|context menu]]. This will export the current archival description plus associated taxonomy terms.

== EAC export ==

In an [[Glossary#Authority record|authority record]] [[Glossary#View page|view page]], select EAC under Export in the [[Glossary#Context menu|context menu]]. This will export the authority record currently being viewed.

== SKOS export ==

In a [[Glossary#Term|term]] [[Glossary#View page|view page]], select SKOS under Export in the [[Glossary#Context menu|context menu]]. This will export the current term and all its narrow terms.

__NOTOC__

[[Category:User manual]]

Export descriptions and terms

2010-11-23T00:33:19Z

Evelyn:

[[Main Page]] > [[User manual]] > [[Import/export]] > Export descriptions and terms

[[Image:export2.png|500px|right|thumb|Excerpt of exported archival description in EAD 2002 XML format]]

ICA-AtoM provides an export functionality that can be used to import [[Glossary#Archival description|archival descriptions]], [[Glossary#Authority record|authority records]], [[Glossary#Archival institution|archival institutions]] and [[Glossary#Term|terms]]. Exported descriptions and taxonomies will be displayed in your web browser window. To save the XML export file, use your browser's save functionality. To exit the XML export file, click on your browser's back button.

The following filetypes can be exported:
* EAD (hierarchical archival descriptions and associated authority records, archival institution descriptions and taxonomy terms)
* Dublin Core XML, MODS XML (archival descriptions and associated taxonomy terms)
* EAC (authority records)
* SKOS (hierarchical taxonomies)

== EAD export ==

In the [[Glossary#Archival description|archival description]] [[Glossary#View page|view page]], select EAD 2002 XML under Export in the [[Glossary#Context menu|context menu]]. This will export the current archival description plus all its [[Glossary#Child record|child records]] and associated authority records, archival institution descriptions and taxonomy terms.

== Dublin Core XML export ==

In the [[Glossary#Archival description|archival description]] [[Glossary#View page|view page]], select Dublin Core 1.1 XML under Export in the [[Glossary#Context menu|context menu]]. This will export the current archival description plus associated taxonomy terms.

== MODS XML export ==

Go to an [[Glossary#Archival description|archival description]] [[Glossary#View page|view page]] using the MODS description template. Select MODS 3.3 XML under Export in the [[Glossary#Context menu|context menu]]. This will export the current archival description plus associated taxonomy terms.

== EAC export ==

In an [[Glossary#Authority record|authority record]] [[Glossary#View page|view page]], select EAC under Export in the [[Glossary#Context menu|context menu]].

== SKOS export ==

In a [[Glossary#Term|term]] [[Glossary#View page|view page]], select SKOS under Export in the [[Glossary#Context menu|context menu]]. This will export the current term and all its narrow terms.

__NOTOC__

[[Category:User manual]]

Export descriptions and terms

2010-11-23T00:27:46Z

Evelyn:

[[Main Page]] > [[User manual]] > [[Import/export]] > Export descriptions and terms

ICA-AtoM provides an import functionality that can be used to import [[Glossary#Archival description|archival descriptions]], [[Glossary#Authority record|authority records]], [[Glossary#Archival institution|archival institutions]] and [[Glossary#Term|terms]].

The following filetypes can be exported:
* EAD (hierarchical archival descriptions and associated authority records, archival institution descriptions and taxonomy terms)
* Dublin Core XML, MODS XML (archival descriptions and associated taxonomy terms)
* EAC (authority records)
* SKOS (hierarchical taxonomies)

<p>[[Image:export.png|500px|right|thumb|Exporting an Archival description as EAD]]

== EAD export ==

In the [[Glossary#Archival description|archival description]] [[Glossary#View page|view page]], select EAD 2002 XML under Export in the [[Glossary#Context menu|context menu]]. This will export the current archival description plus all its [[Glossary#Child record|child records]] and associated authority records, archival institution descriptions and taxonomy terms.

== Dublin Core XML export ==

In the [[Glossary#Archival description|archival description]] [[Glossary#View page|view page]], select Dublin Core 1.1 XML under Export in the [[Glossary#Context menu|context menu]]. This will export the current archival description plus associated taxonomy terms.

== MODS XML export ==

Go to an [[Glossary#Archival description|archival description]] [[Glossary#View page|view page]] using the MODS description template. Select MODS 3.3 XML under Export in the [[Glossary#Context menu|context menu]]. This will export the current archival description plus associated taxonomy terms.

== EAC export ==

In an [[Glossary#Authority record|authority record]] [[Glossary#View page|view page]], select EAC under Export in the [[Glossary#Context menu|context menu]].

== SKOS export ==

In a [[Glossary#Term|term]] [[Glossary#View page|view page]], select SKOS under Export in the [[Glossary#Context menu|context menu]]. This will export the current term and all its narrow terms.

[[Image:export2.png|500px|right|thumb|Excerpt of exported description in EAD 2002 XML format]]The description will be exported to an XML format and displayed in your web browser window.

<li>

<p>To save the XML export file, use your browser's save functionality. To exit the XML export file, click on your browser's back button.

</ol>

[[Category:User manual]]

Import/export

2010-11-23T00:02:42Z

Evelyn:

[[Main Page]] > [[User manual]] > Import/export content

This section describes automated methods for getting data in and out of an ICA-AtoM application.
* [[Upload digital objects]]
* [[Import descriptions and terms]]
* [[Export descriptions and terms]]
* [[OAI-PMH]]

[[Category:User manual]]

Export descriptions

2010-11-23T00:02:25Z

Evelyn: moved Export descriptions to Export descriptions and terms

#REDIRECT [[Export descriptions and terms]]

Export descriptions and terms

2010-11-23T00:02:25Z

Evelyn: moved Export descriptions to Export descriptions and terms

[[Main Page]] > [[User manual]] > [[Import/export]] > Export descriptions

ICA-AtoM allows users to export records in EAD, Dublin Core, and MODS XML formats.

<div class="note">

Exporting in EAD format will result in associated [[Glossary#Child record|child records]], [[Glossary#Authority record|authority records]], and [[Glossary#Archival institution|archival institution]] records being exported along with the [[Glossary#Archival description|archival descriptions]].

</div>

<ol>

<li>

<p>[[Image:export.png|500px|right|thumb|In the archival description view page, select an export format]]Go to the [[Glossary#View page|view page]] for the archival description you wish to export. For EAD export, go to the highest level of description. For example, to export a fonds and all its series and files, go to the [[Glossary#View page|view page]] for the fonds-level description.

<li>

<p>In the [[Glossary#Context menu|context menu]], under "Export" click Dublin Core 1.1 XML, EAD 2002 XML, or MODS 3.3 XML.

<div class="note">

The MODS 3.3 XML export option is only available from the MODS [[Glossary#View page|view page]]; for information on switching [[Glossary#Archival description|archival description]] templates, see [[Default templates]].

</div>

<li>

<p>[[Image:export2.png|500px|right|thumb|Excerpt of exported description in EAD 2002 XML format]]The description will be exported to an XML format and displayed in your web browser window.

<li>

<p>To save the XML export file, use your browser's save functionality. To exit the XML export file, click on your browser's back button.

</ol>

[[Category:User manual]]

User manual

2010-11-23T00:02:05Z

Evelyn:

{| style="width:95%; border="0"
|-valign="top"
| style="width:500px; border: 1px solid rgb(255, 201, 201); padding: 0.5em 1em 1em; color: rgb(0, 0, 0); background-color: rgb(255, 243, 243);" |

== [[Overview]] ==

* [[What is ICA-AtoM?]]
* [[Technical requirements]]
* [[Entity types]]
* [[Descriptive standards]]

== [[Getting started]] ==

* [[Home page]]
* [[Log in]]
* [[User roles]]
* [[Page types]]
* [[Choose language]]
* [[Change password]]

== [[Add/edit content]] ==

* [[Add/edit archival descriptions]]
* [[Add/edit authority records]]
* [[Add/edit archival institutions]]
* [[Add/edit functions]]
* [[Add/edit terms]]
* [[Exit edit mode]]

== [[Access content]] ==

* [[Search]]
* [[Browse]]
* [[Navigate]]

== [[Translate]] ==

* [[Multilingual design principles]]
* [[Translate content]]
* [[Translate interface]]
* [[Translate static pages]]

| style="width: 500px; border: 1px solid rgb(198, 201, 255); padding: 0.5em 1em 1em; color: rgb(0, 0, 0); background-color: rgb(240, 240, 255);" |

== [[Import/export]] ==

* [[Upload digital objects]]
* [[Import descriptions and terms]]
* [[Export descriptions and terms]]
* [[OAI-PMH]]

== [[Administer]] ==

* [[Install]]
* [[Manage user accounts]]
* [[Edit permissions]]
* [[Manage static pages]]
* [[Settings]]
* [[Themes]]
* [[Default language]]
* [[Back up]]
* [[Search for updates]]

== [[Glossary]] ==

Glossary of terms used throughout this user manual

== [[:Category:User manual|Index]] ==

Index of pages in this user manual

== Questions? ==

Please post them to [http://groups.google.ca/group/ica-atom-users the discussion group]

__NOEDITSECTION__
__NOTOC__

Import/export

2010-11-23T00:01:31Z

Evelyn:

Import descriptions

2010-11-23T00:01:03Z

Evelyn: moved Import descriptions to Import descriptions and terms

#REDIRECT [[Import descriptions and terms]]

Import descriptions and terms

2010-11-23T00:01:03Z

Evelyn: moved Import descriptions to Import descriptions and terms

[[Main Page]] > [[User manual]] > [[Import/export]] > Import descriptions and terms

[[Image:import.png|500px|right|thumb|Select an XML fle to import]]

ICA-AtoM provides an import functionality that can be used to import [[Glossary#Archival description|archival descriptions]], [[Glossary#Authority record|authority records]], [[Glossary#Archival institution|archival institutions]] and [[Glossary#Term|terms]].

The following filetypes can be imported:
* EAD (hierarchical archival descriptions and associated authority records, archival institution descriptions and taxonomy terms)
* Dublin Core XML, MODS XML (archival descriptions and associated taxonomy terms)
* EAC (authority records)
* SKOS (hierarchical taxonomies)

# In the [[Glossary#Main menu|main menu]], hover your cursor over the "Import" menu and select "XML".
# Click Browse to select a file
# Click Import
# If the file is successfully uploaded, the page will show the elapsed time. If there are errors in the file, the page will display a message describing the errors. However, it should still be possible to edit and view the imported descriptions. You will need to review them carefully to determine whether the errors in the import file were serious enough to affect the display of the descriptions.
# Click the "View" button in the [[Glossary#Button block|button block]] to go to the [[Glossary#View page|view page]] of the highest level of description of the imported object(s) (i.e., the fonds description for an [[Glossary#Archival description|archival description]] or the top-level term in a hierarchical taxonomy). You will be able to view and edit this description and any [[Glossary#Child record|child records]] just as you would if you had entered them in ICA-AtoM instead of importing them.

<div class="note">

You can also import SKOS files from the [[Glossary#view page|view page]] of a taxonomy [[Glossary#Term|term]]. Doing so will result in the highest level term in the SKOS file being imported as a child level of the term currently being viewed.

</div>

[[Category:User manual]]

Import descriptions and terms

2010-11-23T00:00:18Z

Evelyn:

Import descriptions and terms

2010-11-22T23:56:43Z

Evelyn:

[[Main Page]] > [[User manual]] > [[Import/export]] > Import descriptions

[[Image:import.png|500px|right|thumb|Select an XML fle to import]]

ICA-AtoM provides an import functionality that can be used to import [[Glossary#Archival description|archival descriptions]], [[Glossary#Authority record|authority records]], [[Glossary#Archival institution|archival institutions]] and [[Glossary#Term|terms]].

The following filetypes can be imported:
* EAD (hierarchical archival descriptions and associated authority records, archival institution descriptions and taxonomy terms)
* Dublin Core XML, MODS XML (archival descriptions and associated taxonomy terms)
* EAC (authority records)
* SKOS (hierarchical taxonomies)

# In the [[Glossary#Main menu|main menu]], hover your cursor over the "Import" menu and select "XML".
# Click Browse to select a file
# Click Import
# If the file is successfully uploaded, the page will show the elapsed time. If there are errors in the file, the page will display a message describing the errors. However, it should still be possible to edit and view the imported descriptions. You will need to review them carefully to determine whether the errors in the import file were serious enough to affect the display of the descriptions.
# Click the "View" button in the [[Glossary#Button block|button block]] to go to the [[Glossary#View page|view page]] of the highest level of description of the imported object(s) (i.e., the fonds description for an [[Glossary#Archival description|archival description]] or the top-level term in a hierarchical taxonomy). You will be able to view and edit this description and any [[Glossary#Child record|child records]] just as you would if you had entered them in ICA-AtoM instead of importing them.

[[Category:User manual]]

Import descriptions and terms

2010-11-22T23:52:57Z

Evelyn:

[[Main Page]] > [[User manual]] > [[Import/export]] > Import descriptions

[[Image:import.png|500px|right|thumb|Select an XML fle to import]]

ICA-AtoM provides an import functionality that can be used to import [[Glossary#Archival description|archival descriptions]], [[Glossary#Authority record|authority records]], [[Glossary#Archival institution|archival institutions]] and [[Glossary#Term|terms]].

The following filetypes can be imported:
* EAD (hierarchical archival descriptions and associated authority records, repositories and taxonomy terms)
* Dublin Core XML, MODS XML (archival descriptions and associated taxonomy terms)
* EAC (authority records)
* SKOS (hierarchical taxonomies)

# In the [[Glossary#Main menu|main menu]], hover your cursor over the "Import" menu and select "XML".
# Click Browse to select a file
# Click Import
# If the file is successfully uploaded, the page will show the elapsed time. If there are errors in the file, the page will display a message describing the errors. However, it should still be possible to edit and view the imported descriptions. You will need to review them carefully to determine whether the errors in the import file were serious enough to affect the display of the descriptions.
# Click the "View" button in the [[Glossary#Button block|button block]] to go to the [[Glossary#View page|view page]] of the highest level of description of the imported object(s) (i.e., the fonds description for an [[Glossary#Archival description|archival description]] or the top-level term in a hierarchical taxonomy). You will be able to view and edit this description and any [[Glossary#Child record|child records]] just as you would if you had entered them in ICA-AtoM instead of importing them.

[[Category:User manual]]

Import descriptions and terms

2010-11-22T23:42:15Z

Evelyn:

[[Main Page]] > [[User manual]] > [[Import/export]] > Import descriptions

ICA-AtoM provides an import functionality that can be used to import [[Glossary#Archival description|archival descriptions]], [[Glossary#Authority record|authority records]], [[Glossary#Archival institution|archival institutions]] and [[Glossary#Term|terms]].

The following filetypes can be imported:
* EAD (hierarchical archival descriptions and associated authority records, repositories and taxonomy terms)
* Dublin Core XML, MODS XML (archival descriptions and associated taxonomy terms)
* EAC (authority records)
* SKOS (hierarchical taxonomies)

[[Image:import.png|500px|right|thumb|Select an XML fle to import]]
# In the [[Glossary#Main menu|main menu]], hover your cursor over the "Import" menu and select "XML".
# Click Browse to select a file
# Click Import
# If the file is successfully uploaded, the page will read "import completed." If there are errors in the file, the page will display a message describing the errors. However, it should still be possible to edit and view the imported descriptions. You will need to review them carefully to determine whether the errors in the import file were serious enough to affect the display of the descriptions.
# Click the "View archival description" button to go to the [[Glossary#Edit page|edit page]] of the highest level of description in the imported [[Glossary#Archival description|archival descriptions]]. You will be able to view and edit this description and its [[Glossary#Child record|child records]] just as you would if you had entered them in ICA-AtoM instead of importing them.

[[Category:User manual]]

Import descriptions and terms

2010-11-22T23:39:50Z

Evelyn:

[[Main Page]] > [[User manual]] > [[Import/export]] > Import descriptions

ICA-AtoM provides an import functionality that can be used to import hierarchical [[Glossary#Archival description|archival descriptions]], [[Glossary#Authority record|authority records]], [[Glossary#Archival institution|archival institutions]] and [[Glossary#Term|terms]].

The following filetypes can be imported:
* EAD (archival descriptions and associated authority records, repositories and taxonomy terms)
* Dublin Core XML, MODS XML (archival descriptions and associated taxonomy terms)
* EAC (authority records)
* SKOS (hierarchical taxonomies)

[[Image:import.png|500px|right|thumb|Select an XML fle to import]]
# In the [[Glossary#Main menu|main menu]], hover your cursor over the "Import" menu and select "XML".
# Click Browse to select a file
# Click Import
# If the file is successfully uploaded, the page will read "import completed." If there are errors in the file, the page will display a message describing the errors. However, it should still be possible to edit and view the imported descriptions. You will need to review them carefully to determine whether the errors in the import file were serious enough to affect the display of the descriptions.
# Click the "View archival description" button to go to the [[Glossary#Edit page|edit page]] of the highest level of description in the imported [[Glossary#Archival description|archival descriptions]]. You will be able to view and edit this description and its [[Glossary#Child record|child records]] just as you would if you had entered them in ICA-AtoM instead of importing them.

[[Category:User manual]]

Search for updates

2010-11-22T23:22:31Z

Evelyn:

[[Main Page]] > [[User manual]] > Administer

This feature allows a user logged in as an [[Glossary#Administrator|administrator]] to search for new and updated records.

[[Image:searchForUpdates.png|500px|right|thumb|A search for updated authority records]]

1. Clicking on Admin > Description updates.

2. Under Type, select Archival description, Authority record, Archival institution, Term or Function.

3. Select a date range.

4. Select Creation for new records, Revision for updated records, or All for both.

5. If searching for [[Glossary#Archival description|archival descriptions]], set Publication status to search for either [[Glossary#Draft record|draft]] or [[Glossary#Published record|published records]] or both.

6. Click Search.

Search for updates

2010-11-22T23:21:37Z

Evelyn:

[[Main Page]] > [[User manual]] > Administer

This feature allows a user logged in as an [[Glossary#Administrator|administrator]] to search for new and updated records.

[[Image:searchForUpdates.png|500px|right|thumb|A search for updated authority records]]

1. Clicking on Admin > Description updates.

2. Under Type, select Archival description, Authority record, Archival institution, Term or Function.

3. Select a date range.

4. Select Creation for new records, Revision for updated records, or All for both.

5. If searching for [[Glossary#Archival description|archival descriptions]], set publication status to search for either [[Glossary#Draft record|draft]] or [[Glossary#Published record|published records]] or both.

6. Click Search.

Search for updates

2010-11-22T23:20:28Z

Evelyn:

[[Main Page]] > [[User manual]] > Administer

This feature allows a user logged in as an [[Glossary#Administrator|administrator]] to search for new and updated records.

[[Image:searchForUpdates.png|500px|right|thumb|A search for updated authority records]]

1. Clicking on Admin > Description updates.

2. Under Type, select Archival description, Authority record, Archival institution, Term or Function.

3. Select a date range.

4. Select Creation for new records, Revision for updated records, or both.

5. If searching for [[Glossary#Archival description|archival descriptions]], set publication status to search for either [[Glossary#Draft record|draft]] or [[Glossary#Published record|published records]] or both.

6. Click Search.

File:SearchForUpdates.png

2010-11-22T23:15:14Z

Evelyn:

Search for updates

2010-11-22T23:14:02Z

Evelyn:

[[Main Page]] > [[User manual]] > Administer

A user logged in as an [[Glossary#Administrator|administrator]] can search for new and updated records by clicking on Admin > Description updates.

[[Image:searchForUpdates.png|500px|right|thumb|A search for updated authority records]]

User manual

2010-11-22T23:12:54Z

Evelyn:

{| style="width:95%; border="0"
|-valign="top"
| style="width:500px; border: 1px solid rgb(255, 201, 201); padding: 0.5em 1em 1em; color: rgb(0, 0, 0); background-color: rgb(255, 243, 243);" |

== [[Overview]] ==

* [[What is ICA-AtoM?]]
* [[Technical requirements]]
* [[Entity types]]
* [[Descriptive standards]]

== [[Getting started]] ==

* [[Home page]]
* [[Log in]]
* [[User roles]]
* [[Page types]]
* [[Choose language]]
* [[Change password]]

== [[Add/edit content]] ==

* [[Add/edit archival descriptions]]
* [[Add/edit authority records]]
* [[Add/edit archival institutions]]
* [[Add/edit functions]]
* [[Add/edit terms]]
* [[Exit edit mode]]

== [[Access content]] ==

* [[Search]]
* [[Browse]]
* [[Navigate]]

== [[Translate]] ==

* [[Multilingual design principles]]
* [[Translate content]]
* [[Translate interface]]
* [[Translate static pages]]

| style="width: 500px; border: 1px solid rgb(198, 201, 255); padding: 0.5em 1em 1em; color: rgb(0, 0, 0); background-color: rgb(240, 240, 255);" |

== [[Import/export]] ==

* [[Upload digital objects]]
* [[Import descriptions]]
* [[Export descriptions]]
* [[OAI-PMH]]

== [[Administer]] ==

* [[Install]]
* [[Manage user accounts]]
* [[Edit permissions]]
* [[Manage static pages]]
* [[Settings]]
* [[Themes]]
* [[Default language]]
* [[Back up]]
* [[Search for updates]]

== [[Glossary]] ==

Glossary of terms used throughout this user manual

== [[:Category:User manual|Index]] ==

Index of pages in this user manual

== Questions? ==

Please post them to [http://groups.google.ca/group/ica-atom-users the discussion group]

__NOEDITSECTION__
__NOTOC__

Search for updates

2010-11-22T23:12:15Z

Evelyn: Created page with 'Main Page > User manual > Administer A user logged in as an administrator can search for new and updated records by clicking on Admin > Descri...'

[[Main Page]] > [[User manual]] > Administer

A user logged in as an [[Glossary#Administrator|administrator]] can search for new and updated records by clicking on Admin > Description updates.

Administer

2010-11-22T23:10:45Z

Evelyn:

[[Main Page]] > [[User manual]] > Administer

This section describes how to administer ICA-AtoM, whether for a single institution or for a [[Glossary#Network|network]].

* [[Install]]
* [[Manage user accounts]]
* [[Edit permissions]]
* [[Manage static pages]]
* [[Manage menus]]
* [[Settings]]
* [[Themes]]
* [[Default language]]
* [[Site logo]]
* [[Back up]]
* [[Search for updates]]

[[Category:User manual]]

Global settings

2010-11-22T23:03:36Z

Evelyn:

[[Main Page]] > [[User manual]] > [[Administer]] > [[Settings]] > Global settings

[[Image:globalSettings.png|500px|right|thumb|Edit global settings]]

Global settings allow [[Glossary#Administrator|administrators]] to control certain aspects of how ICA-AtoM appears and behaves. Features currently controlled by global settings include:
* Automatic notification if a new version of the software has been released
* The default display size of uploaded digital objects
* The number of search results that will be displayed on results pages
* Whether or not the reference code of an [[Glossary#Archival description|archival description]] is inherited by lower levels attached to that description
* The ability to sort [[Glossary#Archival description|archival descriptions]] by title or identifier in the [[Glossary#Context menu|context menu]] treeview
* Whether or not the application is a [[Glossary#Multi-repository system|multi-repository]] or single-institution system
* Whether or not uploading multi-page [[Glossary#Digital object|digital objects]] results in an [[Glossary#Archival description|archival description]] being generated for each page in the object
* The ability to turn [[#GlossaryTooltips|tooltips]] on or off
* Whether new [[Glossary#Archival description|archival descriptions]] are draft or published by default

# Click the "Admin > Settings" menu
# Click the "Global" [[Glossary#Information area|information area]] to display global settings

== Application version ==

This field shows the current version of the software.

The value is pre-set, ships with the application, and cannot be edited.

The version number is automatically updated when you upgrade ICA-AtoM to a newer release.

== Check for updates ==

If yes is selected, an administrator will automatically receive a notification if a newer version of the software has been released.

== Upload directory ==

This field shows the name of the directory in which ICA-AtoM stores files when users upload them.

The value is pre-set, ships with the application, and cannot be edited.

<div class="clearfix">

== Maximum image width (pixels) ==

[[Image:imageWidth.png|500px|right|thumb|Archival description view page showing reference display copy]]

One of ICA-AtoM's design assumptions is that the display dimensions of files users upload typically will be too large to fit into the [[Glossary#View page|view page]] for an [[Glossary#Archival description|archival description]]. Therefore, when you upload a file, ICA-AtoM creates a [[Glossary#Reference display copy|reference display copy]] for displaying in the [[Glossary#View page|view page]].

ICA-AtoM ships with a default setting specifying the maximum width of the [[Glossary#Reference display copy|reference display copy]] at 480 pixels. This is the optimized width given ICA-AtoM's [[Glossary#Field|field]] width. [[Glossary#Administrator|Administrators]], however, can increase or decrease the maximum reference image width to suit the requirements of their institution or [[Glossary#Network|network]].

</div>

<div class="clearfix">

== Results per page ==

By default, ICA-AtoM lists objects in list pages and [[Page types#Search results|search results]] ten at a time, with a pager at the bottom of the page to allow users to navigate through long lists of objects.

[[Glossary#Administrator|Administrators]] can increase or decrease this default number.

</div>

== Inherit reference code (information object) ==

When this is set to "yes", the reference code string will be built using the [[Glossary#Archival description|archival description]] identifier plus the identifier of all its ancestors ([[Glossary#Parent record|parent records]]). For more information about how the reference code works, see [[ISAD#Reference_code|Reference code]].

== Sort tree view (information object) ==

This setting determines how lower-level descriptions are sorted in an [[Glossary#Archival description|archival description's]] [[Glossary#Context menu|context menu]].

Selecting "none" means the descriptions will appear in the order in which they were entered into the DCB.

Selecting "title" sorts the descriptions by title.

Selecting "identifier - title" sorts the descriptions by identifier, then by title.

== Multiple repositories ==

Select Yes if your ICA-AtoM application is acting as a union list or portal for descriptions of materials held at more than one archival institution or repository.

The repository will appear as a column on the Browse archival descriptions page.

The repository will appear as a link in the [[Glossary#Context menu|context menu]].

Select No if your ICA-AtoM application is being used only by a single institution.

The [[Glossary#Creator|creator]] rather than the repository will now appear as a column on the list archival description page.

No repository link will appear in the [[Glossary#Context menu|context menu]].

== Upload multi-page files as multiple descriptions ==

Select yes if you would like each page of a multi-page file to be attached to a separate child-level description. For example, a PDF file with 10 pages uploaded to a description would result in 10 individual descriptions, one for each page in the file.

== Show Tooltips ==

Select yes to to have [[Glossary#Tooltips|tooltips]] appear in [[Glossary#edit page|edit pages]] as the user enters data.

== Default publication status ==

This setting determines whether new [[Glossary#Archival description|archival descriptions]] will automatically appear as [[Glossary#Draft record|draft records]] or [[Glossary#Published|published records]]. Note that this setting also affects imported descriptions.

[[Category:User manual]]

__NOTOC__

Global settings

2010-11-22T22:31:12Z

Evelyn: /* Default publication status */

[[Main Page]] > [[User manual]] > [[Administer]] > [[Settings]] > Global settings

Global settings allow [[Glossary#Administrator|administrators]] to control certain aspects of how ICA-AtoM appears and behaves. Features currently controlled by global settings include:
* The default display size of uploaded files
* The number of search results that will be displayed on results pages
* Whether or not the application is a [[Glossary#Multi-repository system|multi-repository]] or single-institution system

[[Image:globalSettings.png|500px|right|thumb|Edit global settings]]

# Click the "Admin > Settings" menu
# Click the "Global" [[Glossary#Information area|information area]] to display global settings

== Application version ==

This field shows the current version of the software.

The value is pre-set, ships with the application, and cannot be edited.

The version number is automatically updated when you upgrade ICA-AtoM to a newer release.

== Check for updates ==

== Upload directory ==

This field shows the name of the directory in which ICA-AtoM stores files when users upload them.

The value is pre-set, ships with the application, and cannot be edited.

<div class="clearfix">

== Maximum image width (pixels) ==

[[Image:imageWidth.png|500px|right|thumb|Archival description view page showing reference display copy]]

One of ICA-AtoM's design assumptions is that the display dimensions of files users upload typically will be too large to fit into the [[Glossary#View page|view page]] for an [[Glossary#Archival description|archival description]]. Therefore, when you upload a file, ICA-AtoM creates a [[Glossary#Reference display copy|reference display copy]] for displaying in the [[Glossary#View page|view page]].

ICA-AtoM ships with a default setting specifying the maximum width of the [[Glossary#Reference display copy|reference display copy]] at 480 pixels. This is the optimized width given ICA-AtoM's [[Glossary#Field|field]] width. [[Glossary#Administrator|Administrators]], however, can increase or decrease the maximum reference image width to suit the requirements of their institution or [[Glossary#Network|network]].

</div>

<div class="clearfix">

== Results per page ==

By default, ICA-AtoM lists objects in list pages and [[Page types#Search results|search results]] ten at a time, with a pager at the bottom of the page to allow users to navigate through long lists of objects.

[[Glossary#Administrator|Administrators]] can increase or decrease this default number.

</div>

== Inherit reference code (information object) ==

When this is set to "yes", the reference code string will be built using the [[Glossary#Archival description|archival description]] identifier plus the identifier of all its ancestors ([[Glossary#Parent record|parent records]]). For more information about how the reference code works, see [[ISAD#Reference_code|Reference code]].

== Sort tree view (information object) ==

This setting determines how lower-level descriptions are sorted in an [[Glossary#Archival description|archival description's]] [[Glossary#Context menu|context menu]].

Selecting "none" means the descriptions will appear in the order in which they were entered into the DCB.

Selecting "title" sorts the descriptions by title.

Selecting "identifier - title" sorts the descriptions by identifier, then by title.

== Multiple repositories ==

Select Yes if your ICA-AtoM application is acting as a union list or portal for descriptions of materials held at more than one archival institution or repository.

The repository will appear as a column on the Browse archival descriptions page.

The repository will appear as a link in the [[Glossary#Context menu|context menu]].

Select No if your ICA-AtoM application is being used only by a single institution.

The [[Glossary#Creator|creator]] rather than the repository will now appear as a column on the list archival description page.

No repository link will appear in the [[Glossary#Context menu|context menu]].

== Upload multi-page files as multiple descriptions ==

Select yes if you would like each page of a multi-page file to be attached to a separate child-level description. For example, a PDF file with 10 pages uploaded to a description would result in 10 individual descriptions, one for each page in the file.

== Show Tooltips ==

Select yes to to have [[Glossary#Tooltips|tooltips]] appear in [[Glossary#edit page|edit pages]] as the user enters data.

== Default publication status ==

This setting determines whether new [[Glossary#Archival description|archival descriptions]] will automatically appear as [[Glossary#Draft record|draft records]] or [[Glossary#Published|published records]]. Note that this setting also affects imported descriptions.

[[Category:User manual]]

__NOTOC__

Global settings

2010-11-22T22:27:05Z

Evelyn:

[[Main Page]] > [[User manual]] > [[Administer]] > [[Settings]] > Global settings

Global settings allow [[Glossary#Administrator|administrators]] to control certain aspects of how ICA-AtoM appears and behaves. Features currently controlled by global settings include:
* The default display size of uploaded files
* The number of search results that will be displayed on results pages
* Whether or not the application is a [[Glossary#Multi-repository system|multi-repository]] or single-institution system

[[Image:globalSettings.png|500px|right|thumb|Edit global settings]]

# Click the "Admin > Settings" menu
# Click the "Global" [[Glossary#Information area|information area]] to display global settings

== Application version ==

This field shows the current version of the software.

The value is pre-set, ships with the application, and cannot be edited.

The version number is automatically updated when you upgrade ICA-AtoM to a newer release.

== Check for updates ==

== Upload directory ==

This field shows the name of the directory in which ICA-AtoM stores files when users upload them.

The value is pre-set, ships with the application, and cannot be edited.

<div class="clearfix">

== Maximum image width (pixels) ==

[[Image:imageWidth.png|500px|right|thumb|Archival description view page showing reference display copy]]

One of ICA-AtoM's design assumptions is that the display dimensions of files users upload typically will be too large to fit into the [[Glossary#View page|view page]] for an [[Glossary#Archival description|archival description]]. Therefore, when you upload a file, ICA-AtoM creates a [[Glossary#Reference display copy|reference display copy]] for displaying in the [[Glossary#View page|view page]].

ICA-AtoM ships with a default setting specifying the maximum width of the [[Glossary#Reference display copy|reference display copy]] at 480 pixels. This is the optimized width given ICA-AtoM's [[Glossary#Field|field]] width. [[Glossary#Administrator|Administrators]], however, can increase or decrease the maximum reference image width to suit the requirements of their institution or [[Glossary#Network|network]].

</div>

<div class="clearfix">

== Results per page ==

By default, ICA-AtoM lists objects in list pages and [[Page types#Search results|search results]] ten at a time, with a pager at the bottom of the page to allow users to navigate through long lists of objects.

[[Glossary#Administrator|Administrators]] can increase or decrease this default number.

</div>

== Inherit reference code (information object) ==

When this is set to "yes", the reference code string will be built using the [[Glossary#Archival description|archival description]] identifier plus the identifier of all its ancestors ([[Glossary#Parent record|parent records]]). For more information about how the reference code works, see [[ISAD#Reference_code|Reference code]].

== Sort tree view (information object) ==

This setting determines how lower-level descriptions are sorted in an [[Glossary#Archival description|archival description's]] [[Glossary#Context menu|context menu]].

Selecting "none" means the descriptions will appear in the order in which they were entered into the DCB.

Selecting "title" sorts the descriptions by title.

Selecting "identifier - title" sorts the descriptions by identifier, then by title.

== Multiple repositories ==

Select Yes if your ICA-AtoM application is acting as a union list or portal for descriptions of materials held at more than one archival institution or repository.

The repository will appear as a column on the Browse archival descriptions page.

The repository will appear as a link in the [[Glossary#Context menu|context menu]].

Select No if your ICA-AtoM application is being used only by a single institution.

The [[Glossary#Creator|creator]] rather than the repository will now appear as a column on the list archival description page.

No repository link will appear in the [[Glossary#Context menu|context menu]].

== Upload multi-page files as multiple descriptions ==

Select yes if you would like each page of a multi-page file to be attached to a separate child-level description. For example, a PDF file with 10 pages uploaded to a description would result in 10 individual descriptions, one for each page in the file.

== Show Tooltips ==

Select yes to to have [[Glossary#Tooltips|tooltips]] appear in [[Glossary#edit page|edit pages]] as the user enters data.

== Default publication status ==

This setting determines whether new [[Glossary#Archival description|archival descriptions]] will automatically appear as a draft or a published record. Note that this setting also affects imported descriptions

[[Category:User manual]]

__NOTOC__

Glossary

2010-11-22T22:23:41Z

Evelyn:

This page provides definitions of terms used throughout ICA-AtoM's system and user documentation.

== About page ==

The about page provides general information on ICA-AtoM. It can be reached via the [[#User menu|user menu]] in the top right-hand corner of the page. The content of the about page can be edited by [[#Administrator|administrators]] (see [[Manage static pages]]).

== Access point ==

An access point is "A name, term, keyword, phrase or code that may be used to search, identify and locate an archival description." (ISAD glossary). In ICA-AtoM, access points are derived from [[#Authority record|authority records]] and [[#Taxonomy|taxonomies]] created and customized by users. See [[Add/edit terms]].

== Access privilege ==

Access privileges control the ways a user is able to interact with ICA-AtoM. For example, some users are able to add and edit content while others may only be able to search and browse content. Access privileges are based on defined [[#User role|user roles]] (see [[User roles]]).

<div class="clearfix">

== Add menu ==

[[Image:addMenu.png|500px|right|thumb|Add menu]]

The "Add" menu allows authorized users to add new [[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], [[#Term|terms]], and [[Glossary#Function|functions]]. Only logged-in users can see the "Add" menu.

</div>

<div class="clearfix">

== Add new button ==

[[Image:archDescButtonBlockSmall.png|500px|right|thumb|Add new button in archival description button block - top center]]

The add new button is located in the [[#Button block|button block]] of the [[#View page|view page]] and allows users to add new records ([[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], and [[#Term|terms]]) to ICA-AtoM.

</div>

<div class="clearfix">

== Admin menu ==

[[Image:adminMenu.png|500px|right|thumb|Admin menu]]

The admin menu allows users with [[#Administrator|administrator]] access to customize ICA-AtoM to meet institution-specific requirements and to manage [[#User account|user accounts]] and [[#User profile|user profiles]] (see [[Administer]]).

</div>

== Administrator ==

The administrator is a type of user who has [[#Access privilege|access privileges]] to do the following: install or uninstall ICA-AtoM; create, read, update, or delete any record; customize ICA-AtoM to institution-specific requirements; and manage [[#User account|user accounts]] and [[#User profile|user profiles]] (see [[User roles]] and [[Administer]]).

== Archival description ==

An archival description is a body of information about an archival record or records. The descriptions provide contextual information about the archival materials and are arranged into hierarchical levels ([[#Fonds|fonds]], series, files, items, and variations of these in accordance with institutional standards). In ICA-AtoM the [[#Data element|data elements]] used for describing archival records are derived from the ICA's General International Standard Archival Description (ISAD). See [[Entity types]] and [[Add/edit archival descriptions]].

== Archival institution ==

An archival institution is "An organization which keeps and preserves archival material and makes it accessible to the public" (ISDIAH glossary). In ICA-AtoM the [[#Data element|data elements]] used to describe such institutions are based on the ICA's International Standard for Describing Institutions with Archival Holdings (ISDIAH). See [[entity types]] and [[Add/edit archival institutions]].

== Archival unit ==

Archival unit is a generic term for an aggregation of archival materials. A unit can be a [[#Fonds|fonds]], series, file, item, or variation thereof, depending on institutional standards. A unit may be divided into sub-units for the purposes of description: e.g. a [[#Fonds|fonds]] may contain several series, each of which may contain several files, and so forth. The smallest (and therefore indivisible) unit is the item.

== Authority record ==

In ICA-AtoM, authority records are collections of information about actors - corporate bodies, persons, or families - who interact with archival materials, typically as [[#Creator|creators]]. The [[#Data element|data elements]] used to describe authority records are based on the ICA's International Standard Archival Authority Record for Corporate Bodies, Persons and Families (ISAAR). ISAAR defines authority record as "The authorized form of name combined with othr information elements that identify and describe the named entity and may also point to other related authority records." See [[Entity types]] and [[Add/edit authority records]].

<div class="clearfix">

== Browse menu ==

[[Image:browseOptions.png|500px|right|thumb|Browse menu just below the search box in the default Caribou theme]]

Browsing allows a user to see all records that have a certain type of [[#Access point|access point]] (such as [[#Subject|subject]], [[#Name|name]], or [[#Place|place]]) or other type of filter, such as [[#Media type|media type]] or type of [[#Entity|entity]]. In ICA-AtoM's default theme (the Caribou theme) the browse menu appears in a horizontal row below the [[#Search box|search box]]; in the Alouette and Columbia themes the browse menu is displayed in a vertical box above and to the right of the [[#Search box|search box]].

</div>

<div class="clearfix">

== Button block ==

[[Image:archDescButtonBlockSmall.png|500px|right|thumb|Button block - archival description view page]]

The button block allows authorized users to add or delete content and to save or reject changes made in the [[#Edit page|edit pages]].

</div>

== Child record ==

Child record refers to a description of the [[#Archival unit|archival unit]] that is one [[#Level of description|level of description]] lower than the current unit, e.g. if a series belongs to a fonds, the series is the child record of the fonds.

== Collection ==

In ISAD, a collection is "[a]n artificial assemblage of documents accumulated on the basis of some common characteristic without regard to the provenance of those documents. Not to be confused with an archival fonds." In Rules for Archival Description, it is "[a] grouping of documents of any provenance intentionally assembled on the basis of some common characteristic." In Dublin Core, a collection is "[a]n aggregation of resources. A collection is described as a group; its parts may also be separately described."

<div class="clearfix">

== Column header ==

[[Image:columnHeader.png|500px|right|thumb|Column header (the orange bar at the top of the list)]]

Column headers appear at the top of the lists on list pages and [[Page types#Browse results|browse results]] and give the name of the [[#Field|field]] for whatever is being listed below.

</div>

<div class="clearfix">

== Context menu ==

[[Image:context.png|500px|right|thumb|Context menu for an archival description showing archival institution, name of creator and other records in the same fonds]]

The context menu appears on all [[#View page|view]] and [[#Edit page|edit pages]] to show the current record's relationships to other records, with links, e.g. they show the hierarchical placement of [[#Archival description|archival descriptions]] within a [[#Fonds|fonds]] and the relationship between [[#Archival institution|archival institutions]], [[#Authority record|authority records]], and archival holdings. See [[Context menu]].

</div>

== Contributor ==

A contributor is a type of user who can search, browse, create, and edit descriptions. See [[User roles]].

== Controlled vocabulary ==

A controlled vocabulary is a set of pre-defined, authorized [[#Term|terms]] grouped into [[#Taxonomy|taxonomies]] or entered into [[#Authority record|authority records]] and used for generating [[#Value list|value lists]] and [[#Access point|access points]]. See [[Add/edit terms]].

<div class="clearfix">

== Cover flow ==

[[Image:coverFlow.png|500px|right|thumb|Cover flow: scroll through the images by moving the black dot or by using your keyboard arrows]]

[[wikipedia:Cover flow|Cover flow]] show sets of [[#Thumbnail|thumbnails]] of [[#Digital object|digital objects]] and allows the user to scroll through the [[#Thumbnail|thumbnails]] using a mouse or keyboard scroll arrows. In ICA-AtoM a cover flow viewer appears in the [[#Context menu|context menu]] of [[#Archival description|archival descriptions]] whenever there are associated lower-level descriptions that have digital objects attached.

</div>

== Create button ==

The create button, located on the [[#Button block|button block]], is used to save new [[#Entity|entities]]. Once an entity has been saved for the first time, the create button disappears and is replaced by the "Save" button, which is used to save all subsequent changes.

== Creator ==

A creator is "Any entity (corporate body, family or person) that created, accumulated and/or maintained records in the conduct of personal or corporate activity" (ISAAR glossary). In ICA-AtoM, the creator is described in an [[#Authority record|authority record]] linked to an [[#Archival description|archival description]], usually at the highest [[#Level of description|level of description]] only. Lower levels inherit the creator from the [[#Parent record|parent record]], unless a different creator is specified. ICA-AtoM can accommodate multiple creators at all [[#Level of description|levels of description]]. See [[ISAD#Context area|Context area]].

== Current language ==

Refers to the language in which the [[#User interface|user interface]] elements and [[#Database content|database content]] are displayed. Users can switch between languages by using the [[#Language menu|language menu]].

== Data element ==

Data elements, or elements of description, are ICA standards-based units of information applied to [[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], and [[#Term|terms]]. The elements are entered into [[#Field|fields]] in ICA-AtoM's [[#Edit page|edit pages]].

== Database content ==

Database content refers to information stored in ICA-Atom's database tables, including [[#Data element|data elements]], [[#Static page|static page]] content, and [[#User profile|user profile]] information.

<div class="clearfix">

== Default content ==

[[Image:defaultContent.png|500px|right|thumb|Default values for levels of description. These can be modified to suit institutional requirements.]]

Default content is any [[#Database content|database content]] that is included by default when ICA-AtoM is installed. This includes things like the default [[#Home page|home page]] and [[#Drop-down menu|drop-down menu]] values that are stored in [[#Taxonomy|taxonomies]].

</div>

== Default language ==

The default language is the language in which all [[#User interface|user interface]] elements are displayed when ICA-AtoM is opened. The language is specified when the application is installed. Users can switch to other [[#Supported language|supported languages]] and [[#Translator|translators]] can translate [[#Database content|database content]] and [[#User interface|user interface]] elements. See [[Choose language]] and [[Translate]].

<div class="clearfix">

== Delete button ==

[[Image:archDescButtonBlockSmall.png|500px|right|thumb|Delete button in archival description button block - second from left on the top]]

The delete button appears in the [[#Button block|button block]]. Clicking on the delete button will prompt a warning to appear asking whether the user really intends to delete the [[#Entity|entity]].

</div>

<div class="clearfix">

== Delete icon ==

[[Image:deleteIcon.png|500px|right|thumb|Delete icons to the right of data entry fields: click on the X to delete the content]]

Delete icons are small buttons in [[#Edit page|edit pages]] used to delete values from [[#Multi-value field|multi-value fields]], such as those containing [[#Event|event]] dates or [[#Access point|access points]].

</div>

== Developer ==

A developer is a programmer who is able to modify the underlying software code of an ICA-AtoM application. In the beta version of ICA-AtoM (1.0.9), much of the customization of the application can only be done by developers. In future releases of the software, more and more features will be customizable via [[#User interface|user interface]] elements available to [[#Administrator|administrators]].

== Digital object ==

Digital objects are computer files that can be uploaded into and displayed by ICA-AtoM. They include scanned images, digital photographs, sound and moving image files, and other scanned or born-digital items. See [[Upload digital objects]] and [[File formats]].

== Draft record ==

A draft record is an [[#Archival description|archival description]] that has not been published. All new and imported [[#Archival description|archival descriptions]] have draft status until the user changes that status to published in the gray box at the bottom of the [[#Archival description|archival description]] [[#Edit page|edit page]].

<div class="note">

The status is inherited from the highest [[#Level of description|level of description]]. Users who are not authenticated cannot view draft records.

</div>

<div class="clearfix">

== Drop-down menu ==

[[Image:valueList.png|500px|right|thumb|A drop-down menu in an edit page]]

A drop-down list menu is a list of data-entry options that appears below certain [[#Field|fields]] in [[#Edit page|edit pages]]. Values are drawn from [[#Controlled vocabulary|controlled-vocabulary]] [[#Term|terms]], [[#Authority record|authority records]], and default data contained in ICA-AtoM's database tables.

</div>

<div class="clearfix">

== Edit button ==

[[Image:archDescButtonBlockSmall.png|500px|right|thumb|Edit button in archival description button block - top left]]

The edit button appears at the bottom of [[#View page|view pages]]; clicking the button takes the user to the [[#Edit page|edit page]] for that record.

<div class="note">

The user can also switch between view and edit pages by clicking the [[#Title bar|title bar]].

</div>

</div>

<div class="clearfix">

== Edit icon ==

[[Image:editIcon.png|500px|right|thumb|Edit icon: click on the the little pencil to edit the data]]

The edit icon appears in [[#Edit page|edit pages]] next to [[#Field|fields]] that derive data from a related record. The user clicks the icon to edit the text in the related record, e.g. to edit the "Administrative/biographical history" in an [[#Archival description|archival description]], the user must click the edit icon because the data resides in the [[#Creator|creator's]] [[#Authority record|authority record]].

</div>

== Edit mode ==

Edit mode allows the user to add, modify, or delete the contents of [[#Archival description|archival descriptions,]] [[#Authority record|authority records]], [[#Archival institution|archival institutions]], [[#Term|terms]], and other [[#Database content|database content]] using [[#Edit page|edit pages]]. In edit mode, ICA-AtoM displays all [[#Field|fields]] in a record for data entry.

<div class="clearfix">

== Edit page ==

[[Image:editPage1.png|500px|right|thumb|Edit page for an archival institution: Identity area expanded]]

Edit pages allow users to add, edit and delete the contents of [[#Archival description|archival descriptions,]] [[#Authority record|authority records]], [[#Archival institution|archival institutions]], [[#Function|functions]] and [[#Term|terms]]. They are also used to carry out administrative functions such as changing [[#User profile|user profiles]] and editing [[#Static page|static pages]].

</div>

== Editor ==

An editor is a type of user who can search, browse, add, edit and delete [[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], [[#Function|functions]] and [[#Term|terms]]. See [[User roles]].

== Entity ==

An entity is an object about which an information system collects data. From the user's perspective, in ICA-AtoM there are four main entities: [[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], and [[#Term|terms]]. See [[Entity types]].

== Error message ==

An error message will display when ICA-AtoM is unable to execute an action. See [[Page types#Error|error]] for examples of types of error messages.

== Event ==

In ICA-AtoM, an event registers an action by an actor (corporate body, person, or family) at a particular time or over a span of time and may establish a relationship between the actor and other actors or [[#Entity|entities]]. This is accomplished through the use of start and end dates in the context area of the [[#Archival description|archival description]], which links the [[#Creator|creator]] or other actor to the records for the period of time delimited by the dates. See [[Entity types]] and [[ISAD#Context area|context area]].

== Field ==

A field is a container for a [[#Data element|data element]]. Content is added to or modified in fields in [[#Edit page|edit pages]].

<div class="clearfix">

== Field label ==

[[Image:fieldLabel.png|500px|right|thumb|Field labels appear in the grey area to the left of the content in the archival description view page]]

Field labels identify [[#Field|fields]] in [[#View page|view pages]] and [[#Edit page|edit pages]]. In ICA-AtoM 1.0 beta, field labels can only be customized by developers working directly with the code; in a future release an interface for customizing labels will be available to [[#Administrator|administrators]].

</div>

== Fonds ==

Fonds is an [[#Archival unit|archival unit]] defined as "The whole of the records, regardless of form or medium, organically created and/or accumulated and used by a particular person, family, or corporate body in the course of that creator's activities and functions." (ISAD glossary). In ICA-AtoM, the fonds is by default the highest [[#Level of description|level of description]]. This default can be changed by [[#Administrator|administrators]] (see [[User interface labels]]).

== Function ==

A function is a type of [[Glossary#Entity|entity]] that describes activities linked to records creation, maintenance and use. Functions in ICA-AtoM are linked to [[Glossary#Archival description|archival descriptions]], [[Glossary#Authority record|authority records]] and other functions. In ICA-AtoM the [[Glossary#Field|fields]] for describing functions are taken from the ICA's International Standard for Describing Functions (ISDF). See [[Entity types]].

<div class="clearfix">

== Holdings ==

[[Image:holdings.png|500px|right|thumb|Context menu showing list of archival holdings as blue links on the right of the page]]

Holdings is a generic term referring to the records and other materials held by [[#Archival institution|archival institutions]]. In ICA-AtoM a list of holdings is displayed in the [[#Context menu|context menu]] on [[#Archival institution|archival institution]] [[#View page|view pages]]. The list is generated from the titles of [[#Archival description|archival descriptions]] that have the [[#Archival institution|archival institution]] selected as a repository (see [[ISAD#Context area|Context area]]).

</div>

== Home page ==

The home page is the first page the user sees when opening the ICA-AtoM application. It can also be accessed via the "Home" link on the [[#User menu|user menu]] or by clicking the [[#Site logo|site logo]]. The content of the home page can be edited by [[#Administrator|administrators]] (see [[Manage static pages]]).

<div class="clearfix">

== Information area ==

[[Image:infoArea.png|500px|right|thumb|Edit page showing information areas: Identity area, Context area, Content and structure area, etc.]]

Information areas appear on [[#Edit page|edit pages]] and group related [[#Field|fields]] based on the organization of elements of description in ICA descriptive standards. Clicking on an information area toggles it between closed (all [[#Field|fields]] in that area hidden) and open (all [[#Field|fields]] visible).

</div>

<div class="clearfix">

== Language menu ==

[[Image:languageMenu.png|500px|right|thumb|Language menu at the top left of the page above the application logo: English selected]]

The language menu, located in the top-left corner of the page, allows the user to switch to any of the [[#Supported language|supported languages]] in ICA-AtoM. The current language is always underlined. See [[Choose language]].

</div>

== Level of description ==

The level of description is "the position of the unit of description in the hierarchy of the fonds" (ISAD glossary). In ICA-AtoM, the level of description is selected from a [[#Value list|value list]] in the "Identity" area of an [[#Archival description|archival description]]. See [[ISAD#Identity area|Identity area]].

<div class="clearfix">

== Main menu ==

[[Image:addMenu.png|500px|right|thumb|Main menu with Add menu expanded]]

The main menu is the the navigational tool located near the top of all pages for authenticated users, right below the [[#Search box|search box]]. It allows the user to navigate to all the main areas of ICA-AtoM.

</div>

== Master digital object ==

The master digital object is the unaltered version of a [[#Digital object|digital object]] that has been uploaded to ICA-AtoM. ICA-AtoM automatically generates a [[#Thumbnail|thumbnail]] and a [[#Reference display copy|reference display copy]] of the object. Only authenticated users may view master digital objects. See [[Upload digital objects]].

== Media type ==

Media type refers to the format of uploaded [[#Digital object|digital objects]]. The media type is selected automatically by ICA-AtoM when a digital object is uploaded and the [[#Thumbnail|thumbnail]] and [[#Reference display copy|reference display copies]] of the object are generated. See [[Upload digital objects]].

<div class="note">

Media type [[#Term|terms]] are controlled by the media type [[#Taxonomy|taxonomy]]. ICA-AtoM ships with five [[#Term|terms]] (audio, image, text, video, other) that are locked; these cannot be edited or deleted because they are referenced by ICA-AtoM's code. [[#Editor|Editors]] and [[#Administrator|administrators]] can add new media type [[#Term|terms]], but unless developers incorporate these into the code, the system will not be able to do anything with them.

</div>

== Multi-repository system ==

A multi-repository system exists when a single instance of ICA-AtoM is used by a [[#Network|network]] of [[#Archival institution|archival institutions]].

<div class="clearfix">

== Multi-value field ==

[[Image:G Multi-value field.png|500px|right|thumb|Multi-value field showing three subject terms in an archival description.]]

A multi-value field is a [[#Field|field]] that is structured to contain more than one data entry.

</div>

== Name ==

In ICA-AtoM, names are registered in [[#Authority record|authority records]] for corporate bodies, persons, and families who interact with archival materials as e.g. [[#Creator|creators]], custodians and publishers. Names can be applied as access points to [[#Archival description|archival descriptions]]. See [[ISAD#Access points|access points]].

== Network ==

A network is an aggregation of institutions using one instance of ICA-AtoM to produce a union list of archival holdings (a [[#Multi-repository system|multi-repository system]]).

<div class="clearfix">

== Page title ==

[[Image:holdings.png|500px|right|thumb|The light grey text which says "View Archival institution" is the page title]]

The page title indicates what kind of page a user is viewing; for example, it indicates whether [[#Archival description|archival descriptions]], [[#Authority record|authority records]] or [[#Archival institution|archival institutions]] are being displayed in a [[#View page|view page]] or an [[#Edit page|edit page]].

</div>

== Parent record ==

The parent record refers to the description of the [[#Archival unit|archival unit]] that is one [[#Level of description|level of description]] higher than the current unit. For example, a fonds may be the parent record of a series.

== Password ==

Passwords are required by every user of the system who needs to be able to add, edit, or delete content. The initial passwords are set by the [[#Administrator|system administrator]] (see [[Manage user accounts#Add a new user|add a new user]]) and can subsequently be changed by the user (see [[Change password]]).

== Place ==

In ICA-AtoM, a place is a geographic location registered in a [[#Taxonomy|taxonomy]] and used as an [[#Access point|access point]] in [[#Archival description|archival descriptions]], [[#Authority record|authority records]], and [[#Archival institution|archival institutions]].

== Physical storage ==

Physical storage is a grouping of [[#Field|fields]] relating to the management of physical objects such as folders, boxes, shelves, and cabinets. In ICA-AtoM, users can create and edit information about physical objects by clicking on the "Link physical storage" button in the [[#Button block|button block]] of an [[#Archival description|archival description]]. See [[Physical storage]].

== Published record ==

A published record is an [[#Archival description|archival description]] that has had its status changed from draft to published in the gray box at the bottom of the [[#Archival description|archival description]] [[#Edit page|edit page]].

<div class="note">

The status is inherited from the highest [[#Level of description|level of description]]; e.g. when a [[#Fonds|fonds]] description is changed from draft to published, all [[#Child record|child records]] within the fonds are automatically changed as well. Once [[#Archival description|archival descriptions]] have been published, users who are not logged in can view them.

</div>

== Reference display copy ==

A reference display copy is a low-resolution version of a [[#Master digital object|master digital object]] generated automatically by ICA-AtoM on upload. It is used to display images on the [[#Digital object|digital object]] [[#View page|view page]] when the user clicks on a [[#Thumbnail|thumbnail]] and in the digital object area of [[#Edit page|edit pages]]. See [[Upload digital objects]].

== Researcher ==

A researcher is a type of user who is limited to searching and browsing descriptions. See [[User roles]].

<div class="clearfix">

== Search box ==

[[Image:browseOptions.png|500px|right|thumb|Search box - the user enters a query and clicks on the magnifying glass icon]]

The search box is used to find descriptions in ICA-AtoM that contain text matching a search query. The search box is located over the [[#Main menu|main menu]] on all ICA-AtoM pages, including the [[#Home page|home page]]. See [[Access content]].

</div>

== Setting ==

Settings is a broad term used to describe the properties that affect the way a program looks and functions. In ICA-AtoM, certain settings can be changed by an [[#Administrator|administrator]] in order to customize ICA-AtoM to institution-specific requirements. See [[Settings]].

<div class="clearfix">

== Site description ==

[[Image:siteTitle.png|500px|right|thumb|Site description reading "Historic Archives of the District of New Caledonia, British Columbia". Note use of Columbia theme (see [[Themes]]).]]

The site description appears at the top of the page directly under the [[#Site title|site title]]. It is a configurable element - the text can be changed or removed (see [[Themes]]).

</div>

<div class="clearfix">

== Site logo ==

[[Image:browseOptions.png|500px|right|thumb|Default red and white site logo]]

The site logo is the graphic that appears at the top of all pages in ICA-AtoM. Clicking on the logo will take the user to the [[#Home page|home page]]. ICA-AtoM ships with a default logo that can be replaced by [[#Administrator|administrators]] to theme the application to their own institution or [[#Network|network]] if desired: see [[Site logo]].

</div>

<div class="clearfix">

== Site title ==

[[Image:siteTitle.png|500px|right|thumb|Site title reading "New Caledonia Archives". Note use of Columbia theme (see [[themes]]).]]

The site title appears at the top of the page next to the [[#Site logo|site logo]] and over the [[#Site description|site description]]. It is a configurable element - the text can be changed or removed (see [[Themes]]).

</div>

== Static page ==

Static pages are pages that are designed to look the same each time they are accessed, in contrast to dynamic pages such as [[Page types#Search results|search results]], [[#View page|view pages]], or [[#Edit page|edit pages]]. ICA-AtoM has two static pages, the [[#Home page|home page]] and the [[#About page|about page]]. Static pages can be edited by an [[#Administrator|administrator]] (see [[Manage static pages]]).

== Subject ==

In ICA-AtoM, subjects are [[#Controlled vocabulary|controlled-vocabulary]] [[#Term|terms]] grouped in a [[#Taxonomy|taxonomy]] and used as [[#Access point|access points]] in [[#Archival description|archival descriptions]].

== Supported language ==

In ICA-AtoM, a supported language is one into which both [[#Data element|data elements]] and [[#User interface |user interface]] elements can be translated. In ICA-AtoM version 1.0 beta, the supported languages are Arabic, Dutch, English, Farsi, French, German, Greek, Icelandic, Italian, Japanese, Korean, Portuguese, Spanish and Slovenian.

== Taxonomy ==

A taxonomy is a grouping of [[#Controlled vocabulary|controlled-vocabulary]] [[#Term|terms]] used to generate [[#Value list|value lists]] and [[#Access point|access points]]. See [[Add/edit terms]].

== Term ==

Terms are the values that make up [[#Controlled vocabulary|controlled vocabularies]]. In ICA-AtoM, terms are grouped into [[#Taxonomy|taxonomies]] that can be added, edited, and deleted through the "Term" item of the [[#Add menu|add menu]]. See [[Add/edit terms]].

== Thumbnail ==

A thumbnail is a small, low-resolution version of a [[#Master digital object|master digital object]] generated automatically by ICA-AtoM on upload. Thumbnails are displayed in search and browse results and in [[#Cover flow|cover flow]] views at higher levels of description. See [[Upload digital objects]].

<div class="clearfix">

== Title bar ==

[[Image:titleBar.png|500px|right|thumb|Title bar in an archival description show page reading "Fonds PR-84 - New Caledonia City Clerk fonds"]]

The title appears at the top of [[#Archival description|archival descriptions]], [[#Authority record|authority records]], and [[#Archival institution|archival institutions]] and [[#Functions|functions]].

</div>

<div class="clearfix">

== Tooltips ==

[[Image:tooltips.png|500px|right|thumb|Tooltip text in an archival description edit page (the blue box on the right)]]

Tooltips are online text designed to assist users to enter data in [[#Edit page|edit pages]]. Tooltip text is derived from the standards on which the edit templates are based. Note that administrators can tooltips on or off - see [[Global settings]].

</div>

<div class="clearfix">

== Translation bar ==

[[Image:translationBar.png|500px|right|thumb|Translation bar]]

The translation bar appears at the bottom of the page when users with [[#Translator|translator]] [[#Access privilege|access privileges]] select a language from the [[#Language menu|language menu]]. Clicking on "Translate user interface" in the bottom right-hand corner of the bar opens up the [[#Translation panel|translation panel]], where the user translates [[#User interface|user interface]] elements. See [[Translate interface]].

</div>

<div class="clearfix">

== Translation panel ==

[[Image:G Translation panel.png|500px|right|thumb|Translation panel]]

The translation panel is used by [[#Translator|translators]] to edit [[#User interface|user interface]] elements and is accessed via the [[#Translation bar|translation bar]]. See [[Translate interface]].

</div>

== Translator ==

A translator is a type of user who can translate [[#Data element|data elements]] and [[#User interface|user interface]] elements. See [[User roles]].

== User account ==

User accounts are established in order to manage [[#Access privilege|access privileges]] through the assignment of [[#User role|user roles]]. Every user who must be able to add, edit, delete, or translate content must have a user account. In ICA-AtoM user accounts are established and maintained by [[#Administrator|administrators]]. See [[Manage user accounts]].

== User interface ==

The user interface is the set of elements that allow the user to interact with the ICA-AtoM application. These elements include the [[#Main menu|main menu]], [[#Drop-down menu|drop-down menus]], [[#Context menu|context menu]], [[#Title bar|title bar]], [[#Column header|column headers]], buttons, [[#Field|fields]], and [[#Field label|field labels]], and any other elements used to navigate ICA-AtoM or to search for, view, add, edit, and delete [[#Database content|database content]]. The labels of some user interface elements can be customized by [[#Administrator|administrators]] (see [[User interface labels]]).

<div class="clearfix>

== User menu ==

[[Image:languageMenu.png|500px|right|thumb|User menu in upper right-hand corner of the page (user is not logged in)]]

The user menu, located in the upper right hand corner of the page, contains basic navigational links. These allow the user to go to the [[#Home page|home page]] and [[#About page|about page]], user documentation (help pages) and the log in page. Authenticated users can also use it to navigate to their [[#User profile|user profiles]].

</div>

== Username ==

The username is a name supplied by an [[#Administrator|administrator]] to any user (other than a [[#Researcher|researcher]]) of the ICA-AtoM application as part of the [[#User account|user account]]. See [[Manage user accounts]].

== User profile ==

A user profile is information about a user managed in a [[#User account|user account]]. User profiles are created and maintained by [[#Administrator|administrators]] (see [[manage user accounts]]), although authenticated users can view their own profiles (and change their [[#Password|passwords]]) by going through the [[#User menu|user menu]].

== User role ==

User roles define levels of access to functions in ICA-AtoM, ranging from view-only access to full administration rights. User roles are defined by groups that an [[#Administrator|administrator]] can add and edit. See [[User roles]] and [[Manage user accounts#Add a new group|Add a new group]].

<div class="clearfix">

== Value list ==

[[Image:valueList.png|500px|right|thumb|Value list derived from Levels of description taxonomy]]

Value lists restrict data entry in certain [[#Field|fields]] to [[#Controlled vocabulary|controlled vocabulary]] [[#Term|terms]] or terms derived from [[#Authority record|authority records]]. They appear as [[#Drop-down menu|drop-down menus]] in [[#Edit page|edit pages]].

</div>

== View mode ==

View mode provides read-only access to the contents of [[#Archival description|archival descriptions,]] [[#Authority record|authority records]], [[#Function|functions]] and [[#Archival institution|archival institutions]] using [[#View page|view pages]]. In view mode, ICA-AtoM displays only those [[#Field|fields]] in a record which contain data.

<div class="clearfix">

== View page ==

[[Image:viewPage.png|500px|right|thumb|View page for an archival description]]

View pages allow users to view in detail the contents of [[#Archival description|archival descriptions,]] [[#Authority record|authority records]], [[#Archival institution|archival institutions]], and [[#Function|functions]]

</div>

[[Category:User manual]]

Glossary

2010-11-22T22:20:39Z

Evelyn: /* Tooltips */

This page provides definitions of terms used throughout ICA-AtoM's system and user documentation.

== About page ==

The about page provides general information on ICA-AtoM. It can be reached via the [[#User menu|user menu]] in the top right-hand corner of the page. The content of the about page can be edited by [[#Administrator|administrators]] (see [[Manage static pages]]).

== Access point ==

An access point is "A name, term, keyword, phrase or code that may be used to search, identify and locate an archival description." (ISAD glossary). In ICA-AtoM, access points are derived from [[#Authority record|authority records]] and [[#Taxonomy|taxonomies]] created and customized by users. See [[Add/edit terms]].

== Access privilege ==

Access privileges control the ways a user is able to interact with ICA-AtoM. For example, some users are able to add and edit content while others may only be able to search and browse content. Access privileges are based on defined [[#User role|user roles]] (see [[User roles]]).

<div class="clearfix">

== Add menu ==

[[Image:addMenu.png|500px|right|thumb|Add menu]]

The "Add" menu allows authorized users to add new [[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], [[#Term|terms]], and [[Glossary#Function|functions]]. Only logged-in users can see the "Add" menu.

</div>

<div class="clearfix">

== Add new button ==

[[Image:archDescButtonBlockSmall.png|500px|right|thumb|Add new button in archival description button block - top center]]

The add new button is located in the [[#Button block|button block]] of the [[#View page|view page]] and allows users to add new records ([[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], and [[#Term|terms]]) to ICA-AtoM.

</div>

<div class="clearfix">

== Admin menu ==

[[Image:adminMenu.png|500px|right|thumb|Admin menu]]

The admin menu allows users with [[#Administrator|administrator]] access to customize ICA-AtoM to meet institution-specific requirements and to manage [[#User account|user accounts]] and [[#User profile|user profiles]] (see [[Administer]]).

</div>

== Administrator ==

The administrator is a type of user who has [[#Access privilege|access privileges]] to do the following: install or uninstall ICA-AtoM; create, read, update, or delete any record; customize ICA-AtoM to institution-specific requirements; and manage [[#User account|user accounts]] and [[#User profile|user profiles]] (see [[User roles]] and [[Administer]]).

== Archival description ==

An archival description is a body of information about an archival record or records. The descriptions provide contextual information about the archival materials and are arranged into hierarchical levels ([[#Fonds|fonds]], series, files, items, and variations of these in accordance with institutional standards). In ICA-AtoM the [[#Data element|data elements]] used for describing archival records are derived from the ICA's General International Standard Archival Description (ISAD). See [[Entity types]] and [[Add/edit archival descriptions]].

== Archival institution ==

An archival institution is "An organization which keeps and preserves archival material and makes it accessible to the public" (ISDIAH glossary). In ICA-AtoM the [[#Data element|data elements]] used to describe such institutions are based on the ICA's International Standard for Describing Institutions with Archival Holdings (ISDIAH). See [[entity types]] and [[Add/edit archival institutions]].

== Archival unit ==

Archival unit is a generic term for an aggregation of archival materials. A unit can be a [[#Fonds|fonds]], series, file, item, or variation thereof, depending on institutional standards. A unit may be divided into sub-units for the purposes of description: e.g. a [[#Fonds|fonds]] may contain several series, each of which may contain several files, and so forth. The smallest (and therefore indivisible) unit is the item.

== Authority record ==

In ICA-AtoM, authority records are collections of information about actors - corporate bodies, persons, or families - who interact with archival materials, typically as [[#Creator|creators]]. The [[#Data element|data elements]] used to describe authority records are based on the ICA's International Standard Archival Authority Record for Corporate Bodies, Persons and Families (ISAAR). ISAAR defines authority record as "The authorized form of name combined with othr information elements that identify and describe the named entity and may also point to other related authority records." See [[Entity types]] and [[Add/edit authority records]].

<div class="clearfix">

== Browse menu ==

[[Image:browseOptions.png|500px|right|thumb|Browse menu just below the search box in the default Caribou theme]]

Browsing allows a user to see all records that have a certain type of [[#Access point|access point]] (such as [[#Subject|subject]], [[#Name|name]], or [[#Place|place]]) or other type of filter, such as [[#Media type|media type]] or type of [[#Entity|entity]]. In ICA-AtoM's default theme (the Caribou theme) the browse menu appears in a horizontal row below the [[#Search box|search box]]; in the Alouette and Columbia themes the browse menu is displayed in a vertical box above and to the right of the [[#Search box|search box]].

</div>

<div class="clearfix">

== Button block ==

[[Image:archDescButtonBlockSmall.png|500px|right|thumb|Button block - archival description view page]]

The button block allows authorized users to add or delete content and to save or reject changes made in the [[#Edit page|edit pages]].

</div>

== Child record ==

Child record refers to a description of the [[#Archival unit|archival unit]] that is one [[#Level of description|level of description]] lower than the current unit, e.g. if a series belongs to a fonds, the series is the child record of the fonds.

== Collection ==

In ISAD, a collection is "[a]n artificial assemblage of documents accumulated on the basis of some common characteristic without regard to the provenance of those documents. Not to be confused with an archival fonds." In Rules for Archival Description, it is "[a] grouping of documents of any provenance intentionally assembled on the basis of some common characteristic." In Dublin Core, a collection is "[a]n aggregation of resources. A collection is described as a group; its parts may also be separately described."

<div class="clearfix">

== Column header ==

[[Image:columnHeader.png|500px|right|thumb|Column header (the orange bar at the top of the list)]]

Column headers appear at the top of the lists on list pages and [[Page types#Browse results|browse results]] and give the name of the [[#Field|field]] for whatever is being listed below.

</div>

<div class="clearfix">

== Context menu ==

[[Image:context.png|500px|right|thumb|Context menu for an archival description showing archival institution, name of creator and other records in the same fonds]]

The context menu appears on all [[#View page|view]] and [[#Edit page|edit pages]] to show the current record's relationships to other records, with links, e.g. they show the hierarchical placement of [[#Archival description|archival descriptions]] within a [[#Fonds|fonds]] and the relationship between [[#Archival institution|archival institutions]], [[#Authority record|authority records]], and archival holdings. See [[Context menu]].

</div>

== Contributor ==

A contributor is a type of user who can search, browse, create, and edit descriptions. See [[User roles]].

== Controlled vocabulary ==

A controlled vocabulary is a set of pre-defined, authorized [[#Term|terms]] grouped into [[#Taxonomy|taxonomies]] or entered into [[#Authority record|authority records]] and used for generating [[#Value list|value lists]] and [[#Access point|access points]]. See [[Add/edit terms]].

<div class="clearfix">

== Cover flow ==

[[Image:coverFlow.png|500px|right|thumb|Cover flow: scroll through the images by moving the black dot or by using your keyboard arrows]]

[[wikipedia:Cover flow|Cover flow]] show sets of [[#Thumbnail|thumbnails]] of [[#Digital object|digital objects]] and allows the user to scroll through the [[#Thumbnail|thumbnails]] using a mouse or keyboard scroll arrows. In ICA-AtoM a cover flow viewer appears in the [[#Context menu|context menu]] of [[#Archival description|archival descriptions]] whenever there are associated lower-level descriptions that have digital objects attached.

</div>

== Create button ==

The create button, located on the [[#Button block|button block]], is used to save new [[#Entity|entities]]. Once an entity has been saved for the first time, the create button disappears and is replaced by the "Save" button, which is used to save all subsequent changes.

== Creator ==

A creator is "Any entity (corporate body, family or person) that created, accumulated and/or maintained records in the conduct of personal or corporate activity" (ISAAR glossary). In ICA-AtoM, the creator is described in an [[#Authority record|authority record]] linked to an [[#Archival description|archival description]], usually at the highest [[#Level of description|level of description]] only. Lower levels inherit the creator from the [[#Parent record|parent record]], unless a different creator is specified. ICA-AtoM can accommodate multiple creators at all [[#Level of description|levels of description]]. See [[ISAD#Context area|Context area]].

== Current language ==

Refers to the language in which the [[#User interface|user interface]] elements and [[#Database content|database content]] are displayed. Users can switch between languages by using the [[#Language menu|language menu]].

== Data element ==

Data elements, or elements of description, are ICA standards-based units of information applied to [[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], and [[#Term|terms]]. The elements are entered into [[#Field|fields]] in ICA-AtoM's [[#Edit page|edit pages]].

== Database content ==

Database content refers to information stored in ICA-Atom's database tables, including [[#Data element|data elements]], [[#Static page|static page]] content, and [[#User profile|user profile]] information.

<div class="clearfix">

== Default content ==

[[Image:defaultContent.png|500px|right|thumb|Default values for levels of description. These can be modified to suit institutional requirements.]]

Default content is any [[#Database content|database content]] that is included by default when ICA-AtoM is installed. This includes things like the default [[#Home page|home page]] and [[#Drop-down menu|drop-down menu]] values that are stored in [[#Taxonomy|taxonomies]].

</div>

== Default language ==

The default language is the language in which all [[#User interface|user interface]] elements are displayed when ICA-AtoM is opened. The language is specified when the application is installed. Users can switch to other [[#Supported language|supported languages]] and [[#Translator|translators]] can translate [[#Database content|database content]] and [[#User interface|user interface]] elements. See [[Choose language]] and [[Translate]].

<div class="clearfix">

== Delete button ==

[[Image:archDescButtonBlockSmall.png|500px|right|thumb|Delete button in archival description button block - second from left on the top]]

The delete button appears in the [[#Button block|button block]]. Clicking on the delete button will prompt a warning to appear asking whether the user really intends to delete the [[#Entity|entity]].

</div>

<div class="clearfix">

== Delete icon ==

[[Image:deleteIcon.png|500px|right|thumb|Delete icons to the right of data entry fields: click on the X to delete the content]]

Delete icons are small buttons in [[#Edit page|edit pages]] used to delete values from [[#Multi-value field|multi-value fields]], such as those containing [[#Event|event]] dates or [[#Access point|access points]].

</div>

== Developer ==

A developer is a programmer who is able to modify the underlying software code of an ICA-AtoM application. In the beta version of ICA-AtoM (1.0.9), much of the customization of the application can only be done by developers. In future releases of the software, more and more features will be customizable via [[#User interface|user interface]] elements available to [[#Administrator|administrators]].

== Digital object ==

Digital objects are computer files that can be uploaded into and displayed by ICA-AtoM. They include scanned images, digital photographs, sound and moving image files, and other scanned or born-digital items. See [[Upload digital objects]] and [[File formats]].

== Draft record ==

A draft record is an [[#Archival description|archival description]] that has not been published. All new and imported [[#Archival description|archival descriptions]] have draft status until the user changes that status to published in the gray box at the bottom of the [[#Archival description|archival description]] [[#Edit page|edit page]].

<div class="note">

The status is inherited from the highest [[#Level of description|level of description]]. Users who are not authenticated cannot view draft records.

</div>

<div class="clearfix">

== Drop-down menu ==

[[Image:valueList.png|500px|right|thumb|A drop-down menu in an edit page]]

A drop-down list menu is a list of data-entry options that appears below certain [[#Field|fields]] in [[#Edit page|edit pages]]. Values are drawn from [[#Controlled vocabulary|controlled-vocabulary]] [[#Term|terms]], [[#Authority record|authority records]], and default data contained in ICA-AtoM's database tables.

</div>

<div class="clearfix">

== Edit button ==

[[Image:archDescButtonBlockSmall.png|500px|right|thumb|Edit button in archival description button block - top left]]

The edit button appears at the bottom of [[#View page|view pages]]; clicking the button takes the user to the [[#Edit page|edit page]] for that record.

<div class="note">

The user can also switch between view and edit pages by clicking the [[#Title bar|title bar]].

</div>

</div>

<div class="clearfix">

== Edit icon ==

[[Image:editIcon.png|500px|right|thumb|Edit icon: click on the the little pencil to edit the data]]

The edit icon appears in [[#Edit page|edit pages]] next to [[#Field|fields]] that derive data from a related record. The user clicks the icon to edit the text in the related record, e.g. to edit the "Administrative/biographical history" in an [[#Archival description|archival description]], the user must click the edit icon because the data resides in the [[#Creator|creator's]] [[#Authority record|authority record]].

</div>

== Edit mode ==

Edit mode allows the user to add, modify, or delete the contents of [[#Archival description|archival descriptions,]] [[#Authority record|authority records]], [[#Archival institution|archival institutions]], [[#Term|terms]], and other [[#Database content|database content]] using [[#Edit page|edit pages]]. In edit mode, ICA-AtoM displays all [[#Field|fields]] in a record for data entry.

<div class="clearfix">

== Edit page ==

[[Image:editPage1.png|500px|right|thumb|Edit page for an archival institution: Identity area expanded]]

Edit pages allow users to add, edit and delete the contents of [[#Archival description|archival descriptions,]] [[#Authority record|authority records]], [[#Archival institution|archival institutions]], [[#Function|functions]] and [[#Term|terms]]. They are also used to carry out administrative functions such as changing [[#User profile|user profiles]] and editing [[#Static page|static pages]].

</div>

== Editor ==

An editor is a type of user who can search, browse, add, edit and delete [[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], [[#Function|functions]] and [[#Term|terms]]. See [[User roles]].

== Entity ==

An entity is an object about which an information system collects data. From the user's perspective, in ICA-AtoM there are four main entities: [[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], and [[#Term|terms]]. See [[Entity types]].

== Error message ==

An error message will display when ICA-AtoM is unable to execute an action. See [[Page types#Error|error]] for examples of types of error messages.

== Event ==

In ICA-AtoM, an event registers an action by an actor (corporate body, person, or family) at a particular time or over a span of time and may establish a relationship between the actor and other actors or [[#Entity|entities]]. This is accomplished through the use of start and end dates in the context area of the [[#Archival description|archival description]], which links the [[#Creator|creator]] or other actor to the records for the period of time delimited by the dates. See [[Entity types]] and [[ISAD#Context area|context area]].

== Field ==

A field is a container for a [[#Data element|data element]]. Content is added to or modified in fields in [[#Edit page|edit pages]].

<div class="clearfix">

== Field label ==

[[Image:fieldLabel.png|500px|right|thumb|Field labels appear in the grey area to the left of the content in the archival description view page]]

Field labels identify [[#Field|fields]] in [[#View page|view pages]] and [[#Edit page|edit pages]]. In ICA-AtoM 1.0 beta, field labels can only be customized by developers working directly with the code; in a future release an interface for customizing labels will be available to [[#Administrator|administrators]].

</div>

== Fonds ==

Fonds is an [[#Archival unit|archival unit]] defined as "The whole of the records, regardless of form or medium, organically created and/or accumulated and used by a particular person, family, or corporate body in the course of that creator's activities and functions." (ISAD glossary). In ICA-AtoM, the fonds is by default the highest [[#Level of description|level of description]]. This default can be changed by [[#Administrator|administrators]] (see [[User interface labels]]).

== Function ==

A function is a type of [[Glossary#Entity|entity]] that describes activities linked to records creation, maintenance and use. Functions in ICA-AtoM are linked to [[Glossary#Archival description|archival descriptions]], [[Glossary#Authority record|authority records]] and other functions. In ICA-AtoM the [[Glossary#Field|fields]] for describing functions are taken from the ICA's International Standard for Describing Functions (ISDF). See [[Entity types]].

<div class="clearfix">

== Holdings ==

[[Image:holdings.png|500px|right|thumb|Context menu showing list of archival holdings as blue links on the right of the page]]

Holdings is a generic term referring to the records and other materials held by [[#Archival institution|archival institutions]]. In ICA-AtoM a list of holdings is displayed in the [[#Context menu|context menu]] on [[#Archival institution|archival institution]] [[#View page|view pages]]. The list is generated from the titles of [[#Archival description|archival descriptions]] that have the [[#Archival institution|archival institution]] selected as a repository (see [[ISAD#Context area|Context area]]).

</div>

== Home page ==

The home page is the first page the user sees when opening the ICA-AtoM application. It can also be accessed via the "Home" link on the [[#User menu|user menu]] or by clicking the [[#Site logo|site logo]]. The content of the home page can be edited by [[#Administrator|administrators]] (see [[Manage static pages]]).

<div class="clearfix">

== Information area ==

[[Image:infoArea.png|500px|right|thumb|Edit page showing information areas: Identity area, Context area, Content and structure area, etc.]]

Information areas appear on [[#Edit page|edit pages]] and group related [[#Field|fields]] based on the organization of elements of description in ICA descriptive standards. Clicking on an information area toggles it between closed (all [[#Field|fields]] in that area hidden) and open (all [[#Field|fields]] visible).

</div>

<div class="clearfix">

== Language menu ==

[[Image:languageMenu.png|500px|right|thumb|Language menu at the top left of the page above the application logo: English selected]]

The language menu, located in the top-left corner of the page, allows the user to switch to any of the [[#Supported language|supported languages]] in ICA-AtoM. The current language is always underlined. See [[Choose language]].

</div>

== Level of description ==

The level of description is "the position of the unit of description in the hierarchy of the fonds" (ISAD glossary). In ICA-AtoM, the level of description is selected from a [[#Value list|value list]] in the "Identity" area of an [[#Archival description|archival description]]. See [[ISAD#Identity area|Identity area]].

<div class="clearfix">

== Main menu ==

[[Image:addMenu.png|500px|right|thumb|Main menu with Add menu expanded]]

The main menu is the the navigational tool located near the top of all pages for authenticated users, right below the [[#Search box|search box]]. It allows the user to navigate to all the main areas of ICA-AtoM.

</div>

== Master digital object ==

The master digital object is the unaltered version of a [[#Digital object|digital object]] that has been uploaded to ICA-AtoM. ICA-AtoM automatically generates a [[#Thumbnail|thumbnail]] and a [[#Reference display copy|reference display copy]] of the object. Only authenticated users may view master digital objects. See [[Upload digital objects]].

== Media type ==

Media type refers to the format of uploaded [[#Digital object|digital objects]]. The media type is selected automatically by ICA-AtoM when a digital object is uploaded and the [[#Thumbnail|thumbnail]] and [[#Reference display copy|reference display copies]] of the object are generated. See [[Upload digital objects]].

<div class="note">

Media type [[#Term|terms]] are controlled by the media type [[#Taxonomy|taxonomy]]. ICA-AtoM ships with five [[#Term|terms]] (audio, image, text, video, other) that are locked; these cannot be edited or deleted because they are referenced by ICA-AtoM's code. [[#Editor|Editors]] and [[#Administrator|administrators]] can add new media type [[#Term|terms]], but unless developers incorporate these into the code, the system will not be able to do anything with them.

</div>

== Multi-repository system ==

A multi-repository system exists when a single instance of ICA-AtoM is used by a [[#Network|network]] of [[#Archival institution|archival institutions]].

<div class="clearfix">

== Multi-value field ==

[[Image:G Multi-value field.png|500px|right|thumb|Multi-value field showing three subject terms in an archival description.]]

A multi-value field is a [[#Field|field]] that is structured to contain more than one data entry.

</div>

== Name ==

In ICA-AtoM, names are registered in [[#Authority record|authority records]] for corporate bodies, persons, and families who interact with archival materials as e.g. [[#Creator|creators]], custodians and publishers. Names can be applied as access points to [[#Archival description|archival descriptions]]. See [[ISAD#Access points|access points]].

== Network ==

A network is an aggregation of institutions using one instance of ICA-AtoM to produce a union list of archival holdings (a [[#Multi-repository system|multi-repository system]]).

<div class="clearfix">

== Page title ==

[[Image:holdings.png|500px|right|thumb|The light grey text which says "View Archival institution" is the page title]]

The page title indicates what kind of page a user is viewing; for example, it indicates whether [[#Archival description|archival descriptions]], [[#Authority record|authority records]] or [[#Archival institution|archival institutions]] are being displayed in a [[#View page|view page]] or an [[#Edit page|edit page]].

</div>

== Parent record ==

The parent record refers to the description of the [[#Archival unit|archival unit]] that is one [[#Level of description|level of description]] higher than the current unit. For example, a fonds may be the parent record of a series.

== Password ==

Passwords are required by every user of the system who needs to be able to add, edit, or delete content. The initial passwords are set by the [[#Administrator|system administrator]] (see [[Manage user accounts#Add a new user|add a new user]]) and can subsequently be changed by the user (see [[Change password]]).

== Place ==

In ICA-AtoM, a place is a geographic location registered in a [[#Taxonomy|taxonomy]] and used as an [[#Access point|access point]] in [[#Archival description|archival descriptions]], [[#Authority record|authority records]], and [[#Archival institution|archival institutions]].

== Physical storage ==

Physical storage is a grouping of [[#Field|fields]] relating to the management of physical objects such as folders, boxes, shelves, and cabinets. In ICA-AtoM, users can create and edit information about physical objects by clicking on the "Link physical storage" button in the [[#Button block|button block]] of an [[#Archival description|archival description]]. See [[Physical storage]].

== Published record ==

A published record is an [[#Archival description|archival description]] that has had its status changed from draft to published in the gray box at the bottom of the [[#Archival description|archival description]] [[#Edit page|edit page]].

<div class="note">

The status is inherited from the highest [[#Level of description|level of description]]; e.g. when a [[#Fonds|fonds]] description is changed from draft to published, all [[#Child record|child records]] within the fonds are automatically changed as well. Once [[#Archival description|archival descriptions]] have been published, users who are not logged in can view them.

</div>

== Reference display copy ==

A reference display copy is a low-resolution version of a [[#Master digital object|master digital object]] generated automatically by ICA-AtoM on upload. It is used to display images on the [[#Digital object|digital object]] [[#View page|view page]] when the user clicks on a [[#Thumbnail|thumbnail]] and in the digital object area of [[#Edit page|edit pages]]. See [[Upload digital objects]].

== Researcher ==

A researcher is a type of user who is limited to searching and browsing descriptions. See [[User roles]].

<div class="clearfix">

== Search box ==

[[Image:browseOptions.png|500px|right|thumb|Search box - the user enters a query and clicks on the magnifying glass icon]]

The search box is used to find descriptions in ICA-AtoM that contain text matching a search query. The search box is located over the [[#Main menu|main menu]] on all ICA-AtoM pages, including the [[#Home page|home page]]. See [[Access content]].

</div>

== Setting ==

Settings is a broad term used to describe the properties that affect the way a program looks and functions. In ICA-AtoM, certain settings can be changed by an [[#Administrator|administrator]] in order to customize ICA-AtoM to institution-specific requirements. See [[Settings]].

<div class="clearfix">

== Site description ==

[[Image:siteTitle.png|500px|right|thumb|Site description reading "Historic Archives of the District of New Caledonia, British Columbia". Note use of Columbia theme (see [[Themes]]).]]

The site description appears at the top of the page directly under the [[#Site title|site title]]. It is a configurable element - the text can be changed or removed (see [[Themes]]).

</div>

<div class="clearfix">

== Site logo ==

[[Image:browseOptions.png|500px|right|thumb|Default red and white site logo]]

The site logo is the graphic that appears at the top of all pages in ICA-AtoM. Clicking on the logo will take the user to the [[#Home page|home page]]. ICA-AtoM ships with a default logo that can be replaced by [[#Administrator|administrators]] to theme the application to their own institution or [[#Network|network]] if desired: see [[Site logo]].

</div>

<div class="clearfix">

== Site title ==

[[Image:siteTitle.png|500px|right|thumb|Site title reading "New Caledonia Archives". Note use of Columbia theme (see [[themes]]).]]

The site title appears at the top of the page next to the [[#Site logo|site logo]] and over the [[#Site description|site description]]. It is a configurable element - the text can be changed or removed (see [[Themes]]).

</div>

== Static page ==

Static pages are pages that are designed to look the same each time they are accessed, in contrast to dynamic pages such as [[Page types#Search results|search results]], [[#View page|view pages]], or [[#Edit page|edit pages]]. ICA-AtoM has two static pages, the [[#Home page|home page]] and the [[#About page|about page]]. Static pages can be edited by an [[#Administrator|administrator]] (see [[Manage static pages]]).

== Subject ==

In ICA-AtoM, subjects are [[#Controlled vocabulary|controlled-vocabulary]] [[#Term|terms]] grouped in a [[#Taxonomy|taxonomy]] and used as [[#Access point|access points]] in [[#Archival description|archival descriptions]].

== Supported language ==

In ICA-AtoM, a supported language is one into which both [[#Data element|data elements]] and [[#User interface |user interface]] elements can be translated. In ICA-AtoM version 1.0 beta, the supported languages are Arabic, Dutch, English, Farsi, French, German, Greek, Icelandic, Italian, Japanese, Korean, Portuguese, Spanish and Slovenian.

== Taxonomy ==

A taxonomy is a grouping of [[#Controlled vocabulary|controlled-vocabulary]] [[#Term|terms]] used to generate [[#Value list|value lists]] and [[#Access point|access points]]. See [[Add/edit terms]].

== Term ==

Terms are the values that make up [[#Controlled vocabulary|controlled vocabularies]]. In ICA-AtoM, terms are grouped into [[#Taxonomy|taxonomies]] that can be added, edited, and deleted through the "Term" item of the [[#Add menu|add menu]]. See [[Add/edit terms]].

== Thumbnail ==

A thumbnail is a small, low-resolution version of a [[#Master digital object|master digital object]] generated automatically by ICA-AtoM on upload. Thumbnails are displayed in search and browse results and in [[#Cover flow|cover flow]] views at higher levels of description. See [[Upload digital objects]].

<div class="clearfix">

== Title bar ==

[[Image:titleBar.png|500px|right|thumb|Title bar in an archival description show page reading "Fonds PR-84 - New Caledonia City Clerk fonds"]]

The title appears at the top of [[#Archival description|archival descriptions]], [[#Authority record|authority records]], and [[#Archival institution|archival institutions]] and [[#Functions|functions]].

</div>

<div class="clearfix">

== Tooltips ==

[[Image:tooltips.png|500px|right|thumb|Tooltip text in an archival description edit page (the blue box on the right)]]

Tooltips are online text designed to assist users to enter data in [[#Edit page|edit pages]]. Tooltip text is derived from the standards on which the edit templates are based. Note that administrators can turn tooltip text on or off - see [[Global settings]].

<div class="clearfix">

== Translation bar ==

[[Image:translationBar.png|500px|right|thumb|Translation bar]]

The translation bar appears at the bottom of the page when users with [[#Translator|translator]] [[#Access privilege|access privileges]] select a language from the [[#Language menu|language menu]]. Clicking on "Translate user interface" in the bottom right-hand corner of the bar opens up the [[#Translation panel|translation panel]], where the user translates [[#User interface|user interface]] elements. See [[Translate interface]].

</div>

<div class="clearfix">

== Translation panel ==

[[Image:G Translation panel.png|500px|right|thumb|Translation panel]]

The translation panel is used by [[#Translator|translators]] to edit [[#User interface|user interface]] elements and is accessed via the [[#Translation bar|translation bar]]. See [[Translate interface]].

</div>

== Translator ==

A translator is a type of user who can translate [[#Data element|data elements]] and [[#User interface|user interface]] elements. See [[User roles]].

== User account ==

User accounts are established in order to manage [[#Access privilege|access privileges]] through the assignment of [[#User role|user roles]]. Every user who must be able to add, edit, delete, or translate content must have a user account. In ICA-AtoM user accounts are established and maintained by [[#Administrator|administrators]]. See [[Manage user accounts]].

== User interface ==

The user interface is the set of elements that allow the user to interact with the ICA-AtoM application. These elements include the [[#Main menu|main menu]], [[#Drop-down menu|drop-down menus]], [[#Context menu|context menu]], [[#Title bar|title bar]], [[#Column header|column headers]], buttons, [[#Field|fields]], and [[#Field label|field labels]], and any other elements used to navigate ICA-AtoM or to search for, view, add, edit, and delete [[#Database content|database content]]. The labels of some user interface elements can be customized by [[#Administrator|administrators]] (see [[User interface labels]]).

<div class="clearfix>

== User menu ==

[[Image:languageMenu.png|500px|right|thumb|User menu in upper right-hand corner of the page (user is not logged in)]]

The user menu, located in the upper right hand corner of the page, contains basic navigational links. These allow the user to go to the [[#Home page|home page]] and [[#About page|about page]], user documentation (help pages) and the log in page. Authenticated users can also use it to navigate to their [[#User profile|user profiles]].

</div>

== Username ==

The username is a name supplied by an [[#Administrator|administrator]] to any user (other than a [[#Researcher|researcher]]) of the ICA-AtoM application as part of the [[#User account|user account]]. See [[Manage user accounts]].

== User profile ==

A user profile is information about a user managed in a [[#User account|user account]]. User profiles are created and maintained by [[#Administrator|administrators]] (see [[manage user accounts]]), although authenticated users can view their own profiles (and change their [[#Password|passwords]]) by going through the [[#User menu|user menu]].

== User role ==

User roles define levels of access to functions in ICA-AtoM, ranging from view-only access to full administration rights. User roles are defined by groups that an [[#Administrator|administrator]] can add and edit. See [[User roles]] and [[Manage user accounts#Add a new group|Add a new group]].

<div class="clearfix">

== Value list ==

[[Image:valueList.png|500px|right|thumb|Value list derived from Levels of description taxonomy]]

Value lists restrict data entry in certain [[#Field|fields]] to [[#Controlled vocabulary|controlled vocabulary]] [[#Term|terms]] or terms derived from [[#Authority record|authority records]]. They appear as [[#Drop-down menu|drop-down menus]] in [[#Edit page|edit pages]].

</div>

== View mode ==

View mode provides read-only access to the contents of [[#Archival description|archival descriptions,]] [[#Authority record|authority records]], [[#Function|functions]] and [[#Archival institution|archival institutions]] using [[#View page|view pages]]. In view mode, ICA-AtoM displays only those [[#Field|fields]] in a record which contain data.

<div class="clearfix">

== View page ==

[[Image:viewPage.png|500px|right|thumb|View page for an archival description]]

View pages allow users to view in detail the contents of [[#Archival description|archival descriptions,]] [[#Authority record|authority records]], [[#Archival institution|archival institutions]], and [[#Function|functions]]

</div>

[[Category:User manual]]

Glossary

2010-11-22T22:18:26Z

Evelyn: /* Tooltips */

This page provides definitions of terms used throughout ICA-AtoM's system and user documentation.

== About page ==

The about page provides general information on ICA-AtoM. It can be reached via the [[#User menu|user menu]] in the top right-hand corner of the page. The content of the about page can be edited by [[#Administrator|administrators]] (see [[Manage static pages]]).

== Access point ==

An access point is "A name, term, keyword, phrase or code that may be used to search, identify and locate an archival description." (ISAD glossary). In ICA-AtoM, access points are derived from [[#Authority record|authority records]] and [[#Taxonomy|taxonomies]] created and customized by users. See [[Add/edit terms]].

== Access privilege ==

Access privileges control the ways a user is able to interact with ICA-AtoM. For example, some users are able to add and edit content while others may only be able to search and browse content. Access privileges are based on defined [[#User role|user roles]] (see [[User roles]]).

<div class="clearfix">

== Add menu ==

[[Image:addMenu.png|500px|right|thumb|Add menu]]

The "Add" menu allows authorized users to add new [[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], [[#Term|terms]], and [[Glossary#Function|functions]]. Only logged-in users can see the "Add" menu.

</div>

<div class="clearfix">

== Add new button ==

[[Image:archDescButtonBlockSmall.png|500px|right|thumb|Add new button in archival description button block - top center]]

The add new button is located in the [[#Button block|button block]] of the [[#View page|view page]] and allows users to add new records ([[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], and [[#Term|terms]]) to ICA-AtoM.

</div>

<div class="clearfix">

== Admin menu ==

[[Image:adminMenu.png|500px|right|thumb|Admin menu]]

The admin menu allows users with [[#Administrator|administrator]] access to customize ICA-AtoM to meet institution-specific requirements and to manage [[#User account|user accounts]] and [[#User profile|user profiles]] (see [[Administer]]).

</div>

== Administrator ==

The administrator is a type of user who has [[#Access privilege|access privileges]] to do the following: install or uninstall ICA-AtoM; create, read, update, or delete any record; customize ICA-AtoM to institution-specific requirements; and manage [[#User account|user accounts]] and [[#User profile|user profiles]] (see [[User roles]] and [[Administer]]).

== Archival description ==

An archival description is a body of information about an archival record or records. The descriptions provide contextual information about the archival materials and are arranged into hierarchical levels ([[#Fonds|fonds]], series, files, items, and variations of these in accordance with institutional standards). In ICA-AtoM the [[#Data element|data elements]] used for describing archival records are derived from the ICA's General International Standard Archival Description (ISAD). See [[Entity types]] and [[Add/edit archival descriptions]].

== Archival institution ==

An archival institution is "An organization which keeps and preserves archival material and makes it accessible to the public" (ISDIAH glossary). In ICA-AtoM the [[#Data element|data elements]] used to describe such institutions are based on the ICA's International Standard for Describing Institutions with Archival Holdings (ISDIAH). See [[entity types]] and [[Add/edit archival institutions]].

== Archival unit ==

Archival unit is a generic term for an aggregation of archival materials. A unit can be a [[#Fonds|fonds]], series, file, item, or variation thereof, depending on institutional standards. A unit may be divided into sub-units for the purposes of description: e.g. a [[#Fonds|fonds]] may contain several series, each of which may contain several files, and so forth. The smallest (and therefore indivisible) unit is the item.

== Authority record ==

In ICA-AtoM, authority records are collections of information about actors - corporate bodies, persons, or families - who interact with archival materials, typically as [[#Creator|creators]]. The [[#Data element|data elements]] used to describe authority records are based on the ICA's International Standard Archival Authority Record for Corporate Bodies, Persons and Families (ISAAR). ISAAR defines authority record as "The authorized form of name combined with othr information elements that identify and describe the named entity and may also point to other related authority records." See [[Entity types]] and [[Add/edit authority records]].

<div class="clearfix">

== Browse menu ==

[[Image:browseOptions.png|500px|right|thumb|Browse menu just below the search box in the default Caribou theme]]

Browsing allows a user to see all records that have a certain type of [[#Access point|access point]] (such as [[#Subject|subject]], [[#Name|name]], or [[#Place|place]]) or other type of filter, such as [[#Media type|media type]] or type of [[#Entity|entity]]. In ICA-AtoM's default theme (the Caribou theme) the browse menu appears in a horizontal row below the [[#Search box|search box]]; in the Alouette and Columbia themes the browse menu is displayed in a vertical box above and to the right of the [[#Search box|search box]].

</div>

<div class="clearfix">

== Button block ==

[[Image:archDescButtonBlockSmall.png|500px|right|thumb|Button block - archival description view page]]

The button block allows authorized users to add or delete content and to save or reject changes made in the [[#Edit page|edit pages]].

</div>

== Child record ==

Child record refers to a description of the [[#Archival unit|archival unit]] that is one [[#Level of description|level of description]] lower than the current unit, e.g. if a series belongs to a fonds, the series is the child record of the fonds.

== Collection ==

In ISAD, a collection is "[a]n artificial assemblage of documents accumulated on the basis of some common characteristic without regard to the provenance of those documents. Not to be confused with an archival fonds." In Rules for Archival Description, it is "[a] grouping of documents of any provenance intentionally assembled on the basis of some common characteristic." In Dublin Core, a collection is "[a]n aggregation of resources. A collection is described as a group; its parts may also be separately described."

<div class="clearfix">

== Column header ==

[[Image:columnHeader.png|500px|right|thumb|Column header (the orange bar at the top of the list)]]

Column headers appear at the top of the lists on list pages and [[Page types#Browse results|browse results]] and give the name of the [[#Field|field]] for whatever is being listed below.

</div>

<div class="clearfix">

== Context menu ==

[[Image:context.png|500px|right|thumb|Context menu for an archival description showing archival institution, name of creator and other records in the same fonds]]

The context menu appears on all [[#View page|view]] and [[#Edit page|edit pages]] to show the current record's relationships to other records, with links, e.g. they show the hierarchical placement of [[#Archival description|archival descriptions]] within a [[#Fonds|fonds]] and the relationship between [[#Archival institution|archival institutions]], [[#Authority record|authority records]], and archival holdings. See [[Context menu]].

</div>

== Contributor ==

A contributor is a type of user who can search, browse, create, and edit descriptions. See [[User roles]].

== Controlled vocabulary ==

A controlled vocabulary is a set of pre-defined, authorized [[#Term|terms]] grouped into [[#Taxonomy|taxonomies]] or entered into [[#Authority record|authority records]] and used for generating [[#Value list|value lists]] and [[#Access point|access points]]. See [[Add/edit terms]].

<div class="clearfix">

== Cover flow ==

[[Image:coverFlow.png|500px|right|thumb|Cover flow: scroll through the images by moving the black dot or by using your keyboard arrows]]

[[wikipedia:Cover flow|Cover flow]] show sets of [[#Thumbnail|thumbnails]] of [[#Digital object|digital objects]] and allows the user to scroll through the [[#Thumbnail|thumbnails]] using a mouse or keyboard scroll arrows. In ICA-AtoM a cover flow viewer appears in the [[#Context menu|context menu]] of [[#Archival description|archival descriptions]] whenever there are associated lower-level descriptions that have digital objects attached.

</div>

== Create button ==

The create button, located on the [[#Button block|button block]], is used to save new [[#Entity|entities]]. Once an entity has been saved for the first time, the create button disappears and is replaced by the "Save" button, which is used to save all subsequent changes.

== Creator ==

A creator is "Any entity (corporate body, family or person) that created, accumulated and/or maintained records in the conduct of personal or corporate activity" (ISAAR glossary). In ICA-AtoM, the creator is described in an [[#Authority record|authority record]] linked to an [[#Archival description|archival description]], usually at the highest [[#Level of description|level of description]] only. Lower levels inherit the creator from the [[#Parent record|parent record]], unless a different creator is specified. ICA-AtoM can accommodate multiple creators at all [[#Level of description|levels of description]]. See [[ISAD#Context area|Context area]].

== Current language ==

Refers to the language in which the [[#User interface|user interface]] elements and [[#Database content|database content]] are displayed. Users can switch between languages by using the [[#Language menu|language menu]].

== Data element ==

Data elements, or elements of description, are ICA standards-based units of information applied to [[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], and [[#Term|terms]]. The elements are entered into [[#Field|fields]] in ICA-AtoM's [[#Edit page|edit pages]].

== Database content ==

Database content refers to information stored in ICA-Atom's database tables, including [[#Data element|data elements]], [[#Static page|static page]] content, and [[#User profile|user profile]] information.

<div class="clearfix">

== Default content ==

[[Image:defaultContent.png|500px|right|thumb|Default values for levels of description. These can be modified to suit institutional requirements.]]

Default content is any [[#Database content|database content]] that is included by default when ICA-AtoM is installed. This includes things like the default [[#Home page|home page]] and [[#Drop-down menu|drop-down menu]] values that are stored in [[#Taxonomy|taxonomies]].

</div>

== Default language ==

The default language is the language in which all [[#User interface|user interface]] elements are displayed when ICA-AtoM is opened. The language is specified when the application is installed. Users can switch to other [[#Supported language|supported languages]] and [[#Translator|translators]] can translate [[#Database content|database content]] and [[#User interface|user interface]] elements. See [[Choose language]] and [[Translate]].

<div class="clearfix">

== Delete button ==

[[Image:archDescButtonBlockSmall.png|500px|right|thumb|Delete button in archival description button block - second from left on the top]]

The delete button appears in the [[#Button block|button block]]. Clicking on the delete button will prompt a warning to appear asking whether the user really intends to delete the [[#Entity|entity]].

</div>

<div class="clearfix">

== Delete icon ==

[[Image:deleteIcon.png|500px|right|thumb|Delete icons to the right of data entry fields: click on the X to delete the content]]

Delete icons are small buttons in [[#Edit page|edit pages]] used to delete values from [[#Multi-value field|multi-value fields]], such as those containing [[#Event|event]] dates or [[#Access point|access points]].

</div>

== Developer ==

A developer is a programmer who is able to modify the underlying software code of an ICA-AtoM application. In the beta version of ICA-AtoM (1.0.9), much of the customization of the application can only be done by developers. In future releases of the software, more and more features will be customizable via [[#User interface|user interface]] elements available to [[#Administrator|administrators]].

== Digital object ==

Digital objects are computer files that can be uploaded into and displayed by ICA-AtoM. They include scanned images, digital photographs, sound and moving image files, and other scanned or born-digital items. See [[Upload digital objects]] and [[File formats]].

== Draft record ==

A draft record is an [[#Archival description|archival description]] that has not been published. All new and imported [[#Archival description|archival descriptions]] have draft status until the user changes that status to published in the gray box at the bottom of the [[#Archival description|archival description]] [[#Edit page|edit page]].

<div class="note">

The status is inherited from the highest [[#Level of description|level of description]]. Users who are not authenticated cannot view draft records.

</div>

<div class="clearfix">

== Drop-down menu ==

[[Image:valueList.png|500px|right|thumb|A drop-down menu in an edit page]]

A drop-down list menu is a list of data-entry options that appears below certain [[#Field|fields]] in [[#Edit page|edit pages]]. Values are drawn from [[#Controlled vocabulary|controlled-vocabulary]] [[#Term|terms]], [[#Authority record|authority records]], and default data contained in ICA-AtoM's database tables.

</div>

<div class="clearfix">

== Edit button ==

[[Image:archDescButtonBlockSmall.png|500px|right|thumb|Edit button in archival description button block - top left]]

The edit button appears at the bottom of [[#View page|view pages]]; clicking the button takes the user to the [[#Edit page|edit page]] for that record.

<div class="note">

The user can also switch between view and edit pages by clicking the [[#Title bar|title bar]].

</div>

</div>

<div class="clearfix">

== Edit icon ==

[[Image:editIcon.png|500px|right|thumb|Edit icon: click on the the little pencil to edit the data]]

The edit icon appears in [[#Edit page|edit pages]] next to [[#Field|fields]] that derive data from a related record. The user clicks the icon to edit the text in the related record, e.g. to edit the "Administrative/biographical history" in an [[#Archival description|archival description]], the user must click the edit icon because the data resides in the [[#Creator|creator's]] [[#Authority record|authority record]].

</div>

== Edit mode ==

Edit mode allows the user to add, modify, or delete the contents of [[#Archival description|archival descriptions,]] [[#Authority record|authority records]], [[#Archival institution|archival institutions]], [[#Term|terms]], and other [[#Database content|database content]] using [[#Edit page|edit pages]]. In edit mode, ICA-AtoM displays all [[#Field|fields]] in a record for data entry.

<div class="clearfix">

== Edit page ==

[[Image:editPage1.png|500px|right|thumb|Edit page for an archival institution: Identity area expanded]]

Edit pages allow users to add, edit and delete the contents of [[#Archival description|archival descriptions,]] [[#Authority record|authority records]], [[#Archival institution|archival institutions]], [[#Function|functions]] and [[#Term|terms]]. They are also used to carry out administrative functions such as changing [[#User profile|user profiles]] and editing [[#Static page|static pages]].

</div>

== Editor ==

An editor is a type of user who can search, browse, add, edit and delete [[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], [[#Function|functions]] and [[#Term|terms]]. See [[User roles]].

== Entity ==

An entity is an object about which an information system collects data. From the user's perspective, in ICA-AtoM there are four main entities: [[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], and [[#Term|terms]]. See [[Entity types]].

== Error message ==

An error message will display when ICA-AtoM is unable to execute an action. See [[Page types#Error|error]] for examples of types of error messages.

== Event ==

In ICA-AtoM, an event registers an action by an actor (corporate body, person, or family) at a particular time or over a span of time and may establish a relationship between the actor and other actors or [[#Entity|entities]]. This is accomplished through the use of start and end dates in the context area of the [[#Archival description|archival description]], which links the [[#Creator|creator]] or other actor to the records for the period of time delimited by the dates. See [[Entity types]] and [[ISAD#Context area|context area]].

== Field ==

A field is a container for a [[#Data element|data element]]. Content is added to or modified in fields in [[#Edit page|edit pages]].

<div class="clearfix">

== Field label ==

[[Image:fieldLabel.png|500px|right|thumb|Field labels appear in the grey area to the left of the content in the archival description view page]]

Field labels identify [[#Field|fields]] in [[#View page|view pages]] and [[#Edit page|edit pages]]. In ICA-AtoM 1.0 beta, field labels can only be customized by developers working directly with the code; in a future release an interface for customizing labels will be available to [[#Administrator|administrators]].

</div>

== Fonds ==

Fonds is an [[#Archival unit|archival unit]] defined as "The whole of the records, regardless of form or medium, organically created and/or accumulated and used by a particular person, family, or corporate body in the course of that creator's activities and functions." (ISAD glossary). In ICA-AtoM, the fonds is by default the highest [[#Level of description|level of description]]. This default can be changed by [[#Administrator|administrators]] (see [[User interface labels]]).

== Function ==

A function is a type of [[Glossary#Entity|entity]] that describes activities linked to records creation, maintenance and use. Functions in ICA-AtoM are linked to [[Glossary#Archival description|archival descriptions]], [[Glossary#Authority record|authority records]] and other functions. In ICA-AtoM the [[Glossary#Field|fields]] for describing functions are taken from the ICA's International Standard for Describing Functions (ISDF). See [[Entity types]].

<div class="clearfix">

== Holdings ==

[[Image:holdings.png|500px|right|thumb|Context menu showing list of archival holdings as blue links on the right of the page]]

Holdings is a generic term referring to the records and other materials held by [[#Archival institution|archival institutions]]. In ICA-AtoM a list of holdings is displayed in the [[#Context menu|context menu]] on [[#Archival institution|archival institution]] [[#View page|view pages]]. The list is generated from the titles of [[#Archival description|archival descriptions]] that have the [[#Archival institution|archival institution]] selected as a repository (see [[ISAD#Context area|Context area]]).

</div>

== Home page ==

The home page is the first page the user sees when opening the ICA-AtoM application. It can also be accessed via the "Home" link on the [[#User menu|user menu]] or by clicking the [[#Site logo|site logo]]. The content of the home page can be edited by [[#Administrator|administrators]] (see [[Manage static pages]]).

<div class="clearfix">

== Information area ==

[[Image:infoArea.png|500px|right|thumb|Edit page showing information areas: Identity area, Context area, Content and structure area, etc.]]

Information areas appear on [[#Edit page|edit pages]] and group related [[#Field|fields]] based on the organization of elements of description in ICA descriptive standards. Clicking on an information area toggles it between closed (all [[#Field|fields]] in that area hidden) and open (all [[#Field|fields]] visible).

</div>

<div class="clearfix">

== Language menu ==

[[Image:languageMenu.png|500px|right|thumb|Language menu at the top left of the page above the application logo: English selected]]

The language menu, located in the top-left corner of the page, allows the user to switch to any of the [[#Supported language|supported languages]] in ICA-AtoM. The current language is always underlined. See [[Choose language]].

</div>

== Level of description ==

The level of description is "the position of the unit of description in the hierarchy of the fonds" (ISAD glossary). In ICA-AtoM, the level of description is selected from a [[#Value list|value list]] in the "Identity" area of an [[#Archival description|archival description]]. See [[ISAD#Identity area|Identity area]].

<div class="clearfix">

== Main menu ==

[[Image:addMenu.png|500px|right|thumb|Main menu with Add menu expanded]]

The main menu is the the navigational tool located near the top of all pages for authenticated users, right below the [[#Search box|search box]]. It allows the user to navigate to all the main areas of ICA-AtoM.

</div>

== Master digital object ==

The master digital object is the unaltered version of a [[#Digital object|digital object]] that has been uploaded to ICA-AtoM. ICA-AtoM automatically generates a [[#Thumbnail|thumbnail]] and a [[#Reference display copy|reference display copy]] of the object. Only authenticated users may view master digital objects. See [[Upload digital objects]].

== Media type ==

Media type refers to the format of uploaded [[#Digital object|digital objects]]. The media type is selected automatically by ICA-AtoM when a digital object is uploaded and the [[#Thumbnail|thumbnail]] and [[#Reference display copy|reference display copies]] of the object are generated. See [[Upload digital objects]].

<div class="note">

Media type [[#Term|terms]] are controlled by the media type [[#Taxonomy|taxonomy]]. ICA-AtoM ships with five [[#Term|terms]] (audio, image, text, video, other) that are locked; these cannot be edited or deleted because they are referenced by ICA-AtoM's code. [[#Editor|Editors]] and [[#Administrator|administrators]] can add new media type [[#Term|terms]], but unless developers incorporate these into the code, the system will not be able to do anything with them.

</div>

== Multi-repository system ==

A multi-repository system exists when a single instance of ICA-AtoM is used by a [[#Network|network]] of [[#Archival institution|archival institutions]].

<div class="clearfix">

== Multi-value field ==

[[Image:G Multi-value field.png|500px|right|thumb|Multi-value field showing three subject terms in an archival description.]]

A multi-value field is a [[#Field|field]] that is structured to contain more than one data entry.

</div>

== Name ==

In ICA-AtoM, names are registered in [[#Authority record|authority records]] for corporate bodies, persons, and families who interact with archival materials as e.g. [[#Creator|creators]], custodians and publishers. Names can be applied as access points to [[#Archival description|archival descriptions]]. See [[ISAD#Access points|access points]].

== Network ==

A network is an aggregation of institutions using one instance of ICA-AtoM to produce a union list of archival holdings (a [[#Multi-repository system|multi-repository system]]).

<div class="clearfix">

== Page title ==

[[Image:holdings.png|500px|right|thumb|The light grey text which says "View Archival institution" is the page title]]

The page title indicates what kind of page a user is viewing; for example, it indicates whether [[#Archival description|archival descriptions]], [[#Authority record|authority records]] or [[#Archival institution|archival institutions]] are being displayed in a [[#View page|view page]] or an [[#Edit page|edit page]].

</div>

== Parent record ==

The parent record refers to the description of the [[#Archival unit|archival unit]] that is one [[#Level of description|level of description]] higher than the current unit. For example, a fonds may be the parent record of a series.

== Password ==

Passwords are required by every user of the system who needs to be able to add, edit, or delete content. The initial passwords are set by the [[#Administrator|system administrator]] (see [[Manage user accounts#Add a new user|add a new user]]) and can subsequently be changed by the user (see [[Change password]]).

== Place ==

In ICA-AtoM, a place is a geographic location registered in a [[#Taxonomy|taxonomy]] and used as an [[#Access point|access point]] in [[#Archival description|archival descriptions]], [[#Authority record|authority records]], and [[#Archival institution|archival institutions]].

== Physical storage ==

Physical storage is a grouping of [[#Field|fields]] relating to the management of physical objects such as folders, boxes, shelves, and cabinets. In ICA-AtoM, users can create and edit information about physical objects by clicking on the "Link physical storage" button in the [[#Button block|button block]] of an [[#Archival description|archival description]]. See [[Physical storage]].

== Published record ==

A published record is an [[#Archival description|archival description]] that has had its status changed from draft to published in the gray box at the bottom of the [[#Archival description|archival description]] [[#Edit page|edit page]].

<div class="note">

The status is inherited from the highest [[#Level of description|level of description]]; e.g. when a [[#Fonds|fonds]] description is changed from draft to published, all [[#Child record|child records]] within the fonds are automatically changed as well. Once [[#Archival description|archival descriptions]] have been published, users who are not logged in can view them.

</div>

== Reference display copy ==

A reference display copy is a low-resolution version of a [[#Master digital object|master digital object]] generated automatically by ICA-AtoM on upload. It is used to display images on the [[#Digital object|digital object]] [[#View page|view page]] when the user clicks on a [[#Thumbnail|thumbnail]] and in the digital object area of [[#Edit page|edit pages]]. See [[Upload digital objects]].

== Researcher ==

A researcher is a type of user who is limited to searching and browsing descriptions. See [[User roles]].

<div class="clearfix">

== Search box ==

[[Image:browseOptions.png|500px|right|thumb|Search box - the user enters a query and clicks on the magnifying glass icon]]

The search box is used to find descriptions in ICA-AtoM that contain text matching a search query. The search box is located over the [[#Main menu|main menu]] on all ICA-AtoM pages, including the [[#Home page|home page]]. See [[Access content]].

</div>

== Setting ==

Settings is a broad term used to describe the properties that affect the way a program looks and functions. In ICA-AtoM, certain settings can be changed by an [[#Administrator|administrator]] in order to customize ICA-AtoM to institution-specific requirements. See [[Settings]].

<div class="clearfix">

== Site description ==

[[Image:siteTitle.png|500px|right|thumb|Site description reading "Historic Archives of the District of New Caledonia, British Columbia". Note use of Columbia theme (see [[Themes]]).]]

The site description appears at the top of the page directly under the [[#Site title|site title]]. It is a configurable element - the text can be changed or removed (see [[Themes]]).

</div>

<div class="clearfix">

== Site logo ==

[[Image:browseOptions.png|500px|right|thumb|Default red and white site logo]]

The site logo is the graphic that appears at the top of all pages in ICA-AtoM. Clicking on the logo will take the user to the [[#Home page|home page]]. ICA-AtoM ships with a default logo that can be replaced by [[#Administrator|administrators]] to theme the application to their own institution or [[#Network|network]] if desired: see [[Site logo]].

</div>

<div class="clearfix">

== Site title ==

[[Image:siteTitle.png|500px|right|thumb|Site title reading "New Caledonia Archives". Note use of Columbia theme (see [[themes]]).]]

The site title appears at the top of the page next to the [[#Site logo|site logo]] and over the [[#Site description|site description]]. It is a configurable element - the text can be changed or removed (see [[Themes]]).

</div>

== Static page ==

Static pages are pages that are designed to look the same each time they are accessed, in contrast to dynamic pages such as [[Page types#Search results|search results]], [[#View page|view pages]], or [[#Edit page|edit pages]]. ICA-AtoM has two static pages, the [[#Home page|home page]] and the [[#About page|about page]]. Static pages can be edited by an [[#Administrator|administrator]] (see [[Manage static pages]]).

== Subject ==

In ICA-AtoM, subjects are [[#Controlled vocabulary|controlled-vocabulary]] [[#Term|terms]] grouped in a [[#Taxonomy|taxonomy]] and used as [[#Access point|access points]] in [[#Archival description|archival descriptions]].

== Supported language ==

In ICA-AtoM, a supported language is one into which both [[#Data element|data elements]] and [[#User interface |user interface]] elements can be translated. In ICA-AtoM version 1.0 beta, the supported languages are Arabic, Dutch, English, Farsi, French, German, Greek, Icelandic, Italian, Japanese, Korean, Portuguese, Spanish and Slovenian.

== Taxonomy ==

A taxonomy is a grouping of [[#Controlled vocabulary|controlled-vocabulary]] [[#Term|terms]] used to generate [[#Value list|value lists]] and [[#Access point|access points]]. See [[Add/edit terms]].

== Term ==

Terms are the values that make up [[#Controlled vocabulary|controlled vocabularies]]. In ICA-AtoM, terms are grouped into [[#Taxonomy|taxonomies]] that can be added, edited, and deleted through the "Term" item of the [[#Add menu|add menu]]. See [[Add/edit terms]].

== Thumbnail ==

A thumbnail is a small, low-resolution version of a [[#Master digital object|master digital object]] generated automatically by ICA-AtoM on upload. Thumbnails are displayed in search and browse results and in [[#Cover flow|cover flow]] views at higher levels of description. See [[Upload digital objects]].

<div class="clearfix">

== Title bar ==

[[Image:titleBar.png|500px|right|thumb|Title bar in an archival description show page reading "Fonds PR-84 - New Caledonia City Clerk fonds"]]

The title appears at the top of [[#Archival description|archival descriptions]], [[#Authority record|authority records]], and [[#Archival institution|archival institutions]] and [[#Functions|functions]].

</div>

<div class="clearfix">

== Tooltips ==

[[Image:tooltips.png|500px|right|thumb|Tooltip text in an archival description edit page]]

Tooltips are online text designed to assist users to enter data in [[#Edit page|edit pages]]. Tooltip text is derived from the standards on which the edit templates are based. Note that administrators can turn tooltip text on or off - see [Global settings] > [Global] > Show tooltips.

<div class="clearfix">

== Translation bar ==

[[Image:translationBar.png|500px|right|thumb|Translation bar]]

The translation bar appears at the bottom of the page when users with [[#Translator|translator]] [[#Access privilege|access privileges]] select a language from the [[#Language menu|language menu]]. Clicking on "Translate user interface" in the bottom right-hand corner of the bar opens up the [[#Translation panel|translation panel]], where the user translates [[#User interface|user interface]] elements. See [[Translate interface]].

</div>

<div class="clearfix">

== Translation panel ==

[[Image:G Translation panel.png|500px|right|thumb|Translation panel]]

The translation panel is used by [[#Translator|translators]] to edit [[#User interface|user interface]] elements and is accessed via the [[#Translation bar|translation bar]]. See [[Translate interface]].

</div>

== Translator ==

A translator is a type of user who can translate [[#Data element|data elements]] and [[#User interface|user interface]] elements. See [[User roles]].

== User account ==

User accounts are established in order to manage [[#Access privilege|access privileges]] through the assignment of [[#User role|user roles]]. Every user who must be able to add, edit, delete, or translate content must have a user account. In ICA-AtoM user accounts are established and maintained by [[#Administrator|administrators]]. See [[Manage user accounts]].

== User interface ==

The user interface is the set of elements that allow the user to interact with the ICA-AtoM application. These elements include the [[#Main menu|main menu]], [[#Drop-down menu|drop-down menus]], [[#Context menu|context menu]], [[#Title bar|title bar]], [[#Column header|column headers]], buttons, [[#Field|fields]], and [[#Field label|field labels]], and any other elements used to navigate ICA-AtoM or to search for, view, add, edit, and delete [[#Database content|database content]]. The labels of some user interface elements can be customized by [[#Administrator|administrators]] (see [[User interface labels]]).

<div class="clearfix>

== User menu ==

[[Image:languageMenu.png|500px|right|thumb|User menu in upper right-hand corner of the page (user is not logged in)]]

The user menu, located in the upper right hand corner of the page, contains basic navigational links. These allow the user to go to the [[#Home page|home page]] and [[#About page|about page]], user documentation (help pages) and the log in page. Authenticated users can also use it to navigate to their [[#User profile|user profiles]].

</div>

== Username ==

The username is a name supplied by an [[#Administrator|administrator]] to any user (other than a [[#Researcher|researcher]]) of the ICA-AtoM application as part of the [[#User account|user account]]. See [[Manage user accounts]].

== User profile ==

A user profile is information about a user managed in a [[#User account|user account]]. User profiles are created and maintained by [[#Administrator|administrators]] (see [[manage user accounts]]), although authenticated users can view their own profiles (and change their [[#Password|passwords]]) by going through the [[#User menu|user menu]].

== User role ==

User roles define levels of access to functions in ICA-AtoM, ranging from view-only access to full administration rights. User roles are defined by groups that an [[#Administrator|administrator]] can add and edit. See [[User roles]] and [[Manage user accounts#Add a new group|Add a new group]].

<div class="clearfix">

== Value list ==

[[Image:valueList.png|500px|right|thumb|Value list derived from Levels of description taxonomy]]

Value lists restrict data entry in certain [[#Field|fields]] to [[#Controlled vocabulary|controlled vocabulary]] [[#Term|terms]] or terms derived from [[#Authority record|authority records]]. They appear as [[#Drop-down menu|drop-down menus]] in [[#Edit page|edit pages]].

</div>

== View mode ==

View mode provides read-only access to the contents of [[#Archival description|archival descriptions,]] [[#Authority record|authority records]], [[#Function|functions]] and [[#Archival institution|archival institutions]] using [[#View page|view pages]]. In view mode, ICA-AtoM displays only those [[#Field|fields]] in a record which contain data.

<div class="clearfix">

== View page ==

[[Image:viewPage.png|500px|right|thumb|View page for an archival description]]

View pages allow users to view in detail the contents of [[#Archival description|archival descriptions,]] [[#Authority record|authority records]], [[#Archival institution|archival institutions]], and [[#Function|functions]]

</div>

[[Category:User manual]]

File:Tooltips.png

2010-11-22T22:10:40Z

Evelyn:

Glossary

2010-11-22T22:08:12Z

Evelyn:

This page provides definitions of terms used throughout ICA-AtoM's system and user documentation.

== About page ==

The about page provides general information on ICA-AtoM. It can be reached via the [[#User menu|user menu]] in the top right-hand corner of the page. The content of the about page can be edited by [[#Administrator|administrators]] (see [[Manage static pages]]).

== Access point ==

An access point is "A name, term, keyword, phrase or code that may be used to search, identify and locate an archival description." (ISAD glossary). In ICA-AtoM, access points are derived from [[#Authority record|authority records]] and [[#Taxonomy|taxonomies]] created and customized by users. See [[Add/edit terms]].

== Access privilege ==

Access privileges control the ways a user is able to interact with ICA-AtoM. For example, some users are able to add and edit content while others may only be able to search and browse content. Access privileges are based on defined [[#User role|user roles]] (see [[User roles]]).

<div class="clearfix">

== Add menu ==

[[Image:addMenu.png|500px|right|thumb|Add menu]]

The "Add" menu allows authorized users to add new [[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], [[#Term|terms]], and [[Glossary#Function|functions]]. Only logged-in users can see the "Add" menu.

</div>

<div class="clearfix">

== Add new button ==

[[Image:archDescButtonBlockSmall.png|500px|right|thumb|Add new button in archival description button block - top center]]

The add new button is located in the [[#Button block|button block]] of the [[#View page|view page]] and allows users to add new records ([[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], and [[#Term|terms]]) to ICA-AtoM.

</div>

<div class="clearfix">

== Admin menu ==

[[Image:adminMenu.png|500px|right|thumb|Admin menu]]

The admin menu allows users with [[#Administrator|administrator]] access to customize ICA-AtoM to meet institution-specific requirements and to manage [[#User account|user accounts]] and [[#User profile|user profiles]] (see [[Administer]]).

</div>

== Administrator ==

The administrator is a type of user who has [[#Access privilege|access privileges]] to do the following: install or uninstall ICA-AtoM; create, read, update, or delete any record; customize ICA-AtoM to institution-specific requirements; and manage [[#User account|user accounts]] and [[#User profile|user profiles]] (see [[User roles]] and [[Administer]]).

== Archival description ==

An archival description is a body of information about an archival record or records. The descriptions provide contextual information about the archival materials and are arranged into hierarchical levels ([[#Fonds|fonds]], series, files, items, and variations of these in accordance with institutional standards). In ICA-AtoM the [[#Data element|data elements]] used for describing archival records are derived from the ICA's General International Standard Archival Description (ISAD). See [[Entity types]] and [[Add/edit archival descriptions]].

== Archival institution ==

An archival institution is "An organization which keeps and preserves archival material and makes it accessible to the public" (ISDIAH glossary). In ICA-AtoM the [[#Data element|data elements]] used to describe such institutions are based on the ICA's International Standard for Describing Institutions with Archival Holdings (ISDIAH). See [[entity types]] and [[Add/edit archival institutions]].

== Archival unit ==

Archival unit is a generic term for an aggregation of archival materials. A unit can be a [[#Fonds|fonds]], series, file, item, or variation thereof, depending on institutional standards. A unit may be divided into sub-units for the purposes of description: e.g. a [[#Fonds|fonds]] may contain several series, each of which may contain several files, and so forth. The smallest (and therefore indivisible) unit is the item.

== Authority record ==

In ICA-AtoM, authority records are collections of information about actors - corporate bodies, persons, or families - who interact with archival materials, typically as [[#Creator|creators]]. The [[#Data element|data elements]] used to describe authority records are based on the ICA's International Standard Archival Authority Record for Corporate Bodies, Persons and Families (ISAAR). ISAAR defines authority record as "The authorized form of name combined with othr information elements that identify and describe the named entity and may also point to other related authority records." See [[Entity types]] and [[Add/edit authority records]].

<div class="clearfix">

== Browse menu ==

[[Image:browseOptions.png|500px|right|thumb|Browse menu just below the search box in the default Caribou theme]]

Browsing allows a user to see all records that have a certain type of [[#Access point|access point]] (such as [[#Subject|subject]], [[#Name|name]], or [[#Place|place]]) or other type of filter, such as [[#Media type|media type]] or type of [[#Entity|entity]]. In ICA-AtoM's default theme (the Caribou theme) the browse menu appears in a horizontal row below the [[#Search box|search box]]; in the Alouette and Columbia themes the browse menu is displayed in a vertical box above and to the right of the [[#Search box|search box]].

</div>

<div class="clearfix">

== Button block ==

[[Image:archDescButtonBlockSmall.png|500px|right|thumb|Button block - archival description view page]]

The button block allows authorized users to add or delete content and to save or reject changes made in the [[#Edit page|edit pages]].

</div>

== Child record ==

Child record refers to a description of the [[#Archival unit|archival unit]] that is one [[#Level of description|level of description]] lower than the current unit, e.g. if a series belongs to a fonds, the series is the child record of the fonds.

== Collection ==

In ISAD, a collection is "[a]n artificial assemblage of documents accumulated on the basis of some common characteristic without regard to the provenance of those documents. Not to be confused with an archival fonds." In Rules for Archival Description, it is "[a] grouping of documents of any provenance intentionally assembled on the basis of some common characteristic." In Dublin Core, a collection is "[a]n aggregation of resources. A collection is described as a group; its parts may also be separately described."

<div class="clearfix">

== Column header ==

[[Image:columnHeader.png|500px|right|thumb|Column header (the orange bar at the top of the list)]]

Column headers appear at the top of the lists on list pages and [[Page types#Browse results|browse results]] and give the name of the [[#Field|field]] for whatever is being listed below.

</div>

<div class="clearfix">

== Context menu ==

[[Image:context.png|500px|right|thumb|Context menu for an archival description showing archival institution, name of creator and other records in the same fonds]]

The context menu appears on all [[#View page|view]] and [[#Edit page|edit pages]] to show the current record's relationships to other records, with links, e.g. they show the hierarchical placement of [[#Archival description|archival descriptions]] within a [[#Fonds|fonds]] and the relationship between [[#Archival institution|archival institutions]], [[#Authority record|authority records]], and archival holdings. See [[Context menu]].

</div>

== Contributor ==

A contributor is a type of user who can search, browse, create, and edit descriptions. See [[User roles]].

== Controlled vocabulary ==

A controlled vocabulary is a set of pre-defined, authorized [[#Term|terms]] grouped into [[#Taxonomy|taxonomies]] or entered into [[#Authority record|authority records]] and used for generating [[#Value list|value lists]] and [[#Access point|access points]]. See [[Add/edit terms]].

<div class="clearfix">

== Cover flow ==

[[Image:coverFlow.png|500px|right|thumb|Cover flow: scroll through the images by moving the black dot or by using your keyboard arrows]]

[[wikipedia:Cover flow|Cover flow]] show sets of [[#Thumbnail|thumbnails]] of [[#Digital object|digital objects]] and allows the user to scroll through the [[#Thumbnail|thumbnails]] using a mouse or keyboard scroll arrows. In ICA-AtoM a cover flow viewer appears in the [[#Context menu|context menu]] of [[#Archival description|archival descriptions]] whenever there are associated lower-level descriptions that have digital objects attached.

</div>

== Create button ==

The create button, located on the [[#Button block|button block]], is used to save new [[#Entity|entities]]. Once an entity has been saved for the first time, the create button disappears and is replaced by the "Save" button, which is used to save all subsequent changes.

== Creator ==

A creator is "Any entity (corporate body, family or person) that created, accumulated and/or maintained records in the conduct of personal or corporate activity" (ISAAR glossary). In ICA-AtoM, the creator is described in an [[#Authority record|authority record]] linked to an [[#Archival description|archival description]], usually at the highest [[#Level of description|level of description]] only. Lower levels inherit the creator from the [[#Parent record|parent record]], unless a different creator is specified. ICA-AtoM can accommodate multiple creators at all [[#Level of description|levels of description]]. See [[ISAD#Context area|Context area]].

== Current language ==

Refers to the language in which the [[#User interface|user interface]] elements and [[#Database content|database content]] are displayed. Users can switch between languages by using the [[#Language menu|language menu]].

== Data element ==

Data elements, or elements of description, are ICA standards-based units of information applied to [[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], and [[#Term|terms]]. The elements are entered into [[#Field|fields]] in ICA-AtoM's [[#Edit page|edit pages]].

== Database content ==

Database content refers to information stored in ICA-Atom's database tables, including [[#Data element|data elements]], [[#Static page|static page]] content, and [[#User profile|user profile]] information.

<div class="clearfix">

== Default content ==

[[Image:defaultContent.png|500px|right|thumb|Default values for levels of description. These can be modified to suit institutional requirements.]]

Default content is any [[#Database content|database content]] that is included by default when ICA-AtoM is installed. This includes things like the default [[#Home page|home page]] and [[#Drop-down menu|drop-down menu]] values that are stored in [[#Taxonomy|taxonomies]].

</div>

== Default language ==

The default language is the language in which all [[#User interface|user interface]] elements are displayed when ICA-AtoM is opened. The language is specified when the application is installed. Users can switch to other [[#Supported language|supported languages]] and [[#Translator|translators]] can translate [[#Database content|database content]] and [[#User interface|user interface]] elements. See [[Choose language]] and [[Translate]].

<div class="clearfix">

== Delete button ==

[[Image:archDescButtonBlockSmall.png|500px|right|thumb|Delete button in archival description button block - second from left on the top]]

The delete button appears in the [[#Button block|button block]]. Clicking on the delete button will prompt a warning to appear asking whether the user really intends to delete the [[#Entity|entity]].

</div>

<div class="clearfix">

== Delete icon ==

[[Image:deleteIcon.png|500px|right|thumb|Delete icons to the right of data entry fields: click on the X to delete the content]]

Delete icons are small buttons in [[#Edit page|edit pages]] used to delete values from [[#Multi-value field|multi-value fields]], such as those containing [[#Event|event]] dates or [[#Access point|access points]].

</div>

== Developer ==

A developer is a programmer who is able to modify the underlying software code of an ICA-AtoM application. In the beta version of ICA-AtoM (1.0.9), much of the customization of the application can only be done by developers. In future releases of the software, more and more features will be customizable via [[#User interface|user interface]] elements available to [[#Administrator|administrators]].

== Digital object ==

Digital objects are computer files that can be uploaded into and displayed by ICA-AtoM. They include scanned images, digital photographs, sound and moving image files, and other scanned or born-digital items. See [[Upload digital objects]] and [[File formats]].

== Draft record ==

A draft record is an [[#Archival description|archival description]] that has not been published. All new and imported [[#Archival description|archival descriptions]] have draft status until the user changes that status to published in the gray box at the bottom of the [[#Archival description|archival description]] [[#Edit page|edit page]].

<div class="note">

The status is inherited from the highest [[#Level of description|level of description]]. Users who are not authenticated cannot view draft records.

</div>

<div class="clearfix">

== Drop-down menu ==

[[Image:valueList.png|500px|right|thumb|A drop-down menu in an edit page]]

A drop-down list menu is a list of data-entry options that appears below certain [[#Field|fields]] in [[#Edit page|edit pages]]. Values are drawn from [[#Controlled vocabulary|controlled-vocabulary]] [[#Term|terms]], [[#Authority record|authority records]], and default data contained in ICA-AtoM's database tables.

</div>

<div class="clearfix">

== Edit button ==

[[Image:archDescButtonBlockSmall.png|500px|right|thumb|Edit button in archival description button block - top left]]

The edit button appears at the bottom of [[#View page|view pages]]; clicking the button takes the user to the [[#Edit page|edit page]] for that record.

<div class="note">

The user can also switch between view and edit pages by clicking the [[#Title bar|title bar]].

</div>

</div>

<div class="clearfix">

== Edit icon ==

[[Image:editIcon.png|500px|right|thumb|Edit icon: click on the the little pencil to edit the data]]

The edit icon appears in [[#Edit page|edit pages]] next to [[#Field|fields]] that derive data from a related record. The user clicks the icon to edit the text in the related record, e.g. to edit the "Administrative/biographical history" in an [[#Archival description|archival description]], the user must click the edit icon because the data resides in the [[#Creator|creator's]] [[#Authority record|authority record]].

</div>

== Edit mode ==

Edit mode allows the user to add, modify, or delete the contents of [[#Archival description|archival descriptions,]] [[#Authority record|authority records]], [[#Archival institution|archival institutions]], [[#Term|terms]], and other [[#Database content|database content]] using [[#Edit page|edit pages]]. In edit mode, ICA-AtoM displays all [[#Field|fields]] in a record for data entry.

<div class="clearfix">

== Edit page ==

[[Image:editPage1.png|500px|right|thumb|Edit page for an archival institution: Identity area expanded]]

Edit pages allow users to add, edit and delete the contents of [[#Archival description|archival descriptions,]] [[#Authority record|authority records]], [[#Archival institution|archival institutions]], [[#Function|functions]] and [[#Term|terms]]. They are also used to carry out administrative functions such as changing [[#User profile|user profiles]] and editing [[#Static page|static pages]].

</div>

== Editor ==

An editor is a type of user who can search, browse, add, edit and delete [[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], [[#Function|functions]] and [[#Term|terms]]. See [[User roles]].

== Entity ==

An entity is an object about which an information system collects data. From the user's perspective, in ICA-AtoM there are four main entities: [[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], and [[#Term|terms]]. See [[Entity types]].

== Error message ==

An error message will display when ICA-AtoM is unable to execute an action. See [[Page types#Error|error]] for examples of types of error messages.

== Event ==

In ICA-AtoM, an event registers an action by an actor (corporate body, person, or family) at a particular time or over a span of time and may establish a relationship between the actor and other actors or [[#Entity|entities]]. This is accomplished through the use of start and end dates in the context area of the [[#Archival description|archival description]], which links the [[#Creator|creator]] or other actor to the records for the period of time delimited by the dates. See [[Entity types]] and [[ISAD#Context area|context area]].

== Field ==

A field is a container for a [[#Data element|data element]]. Content is added to or modified in fields in [[#Edit page|edit pages]].

<div class="clearfix">

== Field label ==

[[Image:fieldLabel.png|500px|right|thumb|Field labels appear in the grey area to the left of the content in the archival description view page]]

Field labels identify [[#Field|fields]] in [[#View page|view pages]] and [[#Edit page|edit pages]]. In ICA-AtoM 1.0 beta, field labels can only be customized by developers working directly with the code; in a future release an interface for customizing labels will be available to [[#Administrator|administrators]].

</div>

== Fonds ==

Fonds is an [[#Archival unit|archival unit]] defined as "The whole of the records, regardless of form or medium, organically created and/or accumulated and used by a particular person, family, or corporate body in the course of that creator's activities and functions." (ISAD glossary). In ICA-AtoM, the fonds is by default the highest [[#Level of description|level of description]]. This default can be changed by [[#Administrator|administrators]] (see [[User interface labels]]).

== Function ==

A function is a type of [[Glossary#Entity|entity]] that describes activities linked to records creation, maintenance and use. Functions in ICA-AtoM are linked to [[Glossary#Archival description|archival descriptions]], [[Glossary#Authority record|authority records]] and other functions. In ICA-AtoM the [[Glossary#Field|fields]] for describing functions are taken from the ICA's International Standard for Describing Functions (ISDF). See [[Entity types]].

<div class="clearfix">

== Holdings ==

[[Image:holdings.png|500px|right|thumb|Context menu showing list of archival holdings as blue links on the right of the page]]

Holdings is a generic term referring to the records and other materials held by [[#Archival institution|archival institutions]]. In ICA-AtoM a list of holdings is displayed in the [[#Context menu|context menu]] on [[#Archival institution|archival institution]] [[#View page|view pages]]. The list is generated from the titles of [[#Archival description|archival descriptions]] that have the [[#Archival institution|archival institution]] selected as a repository (see [[ISAD#Context area|Context area]]).

</div>

== Home page ==

The home page is the first page the user sees when opening the ICA-AtoM application. It can also be accessed via the "Home" link on the [[#User menu|user menu]] or by clicking the [[#Site logo|site logo]]. The content of the home page can be edited by [[#Administrator|administrators]] (see [[Manage static pages]]).

<div class="clearfix">

== Information area ==

[[Image:infoArea.png|500px|right|thumb|Edit page showing information areas: Identity area, Context area, Content and structure area, etc.]]

Information areas appear on [[#Edit page|edit pages]] and group related [[#Field|fields]] based on the organization of elements of description in ICA descriptive standards. Clicking on an information area toggles it between closed (all [[#Field|fields]] in that area hidden) and open (all [[#Field|fields]] visible).

</div>

<div class="clearfix">

== Language menu ==

[[Image:languageMenu.png|500px|right|thumb|Language menu at the top left of the page above the application logo: English selected]]

The language menu, located in the top-left corner of the page, allows the user to switch to any of the [[#Supported language|supported languages]] in ICA-AtoM. The current language is always underlined. See [[Choose language]].

</div>

== Level of description ==

The level of description is "the position of the unit of description in the hierarchy of the fonds" (ISAD glossary). In ICA-AtoM, the level of description is selected from a [[#Value list|value list]] in the "Identity" area of an [[#Archival description|archival description]]. See [[ISAD#Identity area|Identity area]].

<div class="clearfix">

== Main menu ==

[[Image:addMenu.png|500px|right|thumb|Main menu with Add menu expanded]]

The main menu is the the navigational tool located near the top of all pages for authenticated users, right below the [[#Search box|search box]]. It allows the user to navigate to all the main areas of ICA-AtoM.

</div>

== Master digital object ==

The master digital object is the unaltered version of a [[#Digital object|digital object]] that has been uploaded to ICA-AtoM. ICA-AtoM automatically generates a [[#Thumbnail|thumbnail]] and a [[#Reference display copy|reference display copy]] of the object. Only authenticated users may view master digital objects. See [[Upload digital objects]].

== Media type ==

Media type refers to the format of uploaded [[#Digital object|digital objects]]. The media type is selected automatically by ICA-AtoM when a digital object is uploaded and the [[#Thumbnail|thumbnail]] and [[#Reference display copy|reference display copies]] of the object are generated. See [[Upload digital objects]].

<div class="note">

Media type [[#Term|terms]] are controlled by the media type [[#Taxonomy|taxonomy]]. ICA-AtoM ships with five [[#Term|terms]] (audio, image, text, video, other) that are locked; these cannot be edited or deleted because they are referenced by ICA-AtoM's code. [[#Editor|Editors]] and [[#Administrator|administrators]] can add new media type [[#Term|terms]], but unless developers incorporate these into the code, the system will not be able to do anything with them.

</div>

== Multi-repository system ==

A multi-repository system exists when a single instance of ICA-AtoM is used by a [[#Network|network]] of [[#Archival institution|archival institutions]].

<div class="clearfix">

== Multi-value field ==

[[Image:G Multi-value field.png|500px|right|thumb|Multi-value field showing three subject terms in an archival description.]]

A multi-value field is a [[#Field|field]] that is structured to contain more than one data entry.

</div>

== Name ==

In ICA-AtoM, names are registered in [[#Authority record|authority records]] for corporate bodies, persons, and families who interact with archival materials as e.g. [[#Creator|creators]], custodians and publishers. Names can be applied as access points to [[#Archival description|archival descriptions]]. See [[ISAD#Access points|access points]].

== Network ==

A network is an aggregation of institutions using one instance of ICA-AtoM to produce a union list of archival holdings (a [[#Multi-repository system|multi-repository system]]).

<div class="clearfix">

== Page title ==

[[Image:holdings.png|500px|right|thumb|The light grey text which says "View Archival institution" is the page title]]

The page title indicates what kind of page a user is viewing; for example, it indicates whether [[#Archival description|archival descriptions]], [[#Authority record|authority records]] or [[#Archival institution|archival institutions]] are being displayed in a [[#View page|view page]] or an [[#Edit page|edit page]].

</div>

== Parent record ==

The parent record refers to the description of the [[#Archival unit|archival unit]] that is one [[#Level of description|level of description]] higher than the current unit. For example, a fonds may be the parent record of a series.

== Password ==

Passwords are required by every user of the system who needs to be able to add, edit, or delete content. The initial passwords are set by the [[#Administrator|system administrator]] (see [[Manage user accounts#Add a new user|add a new user]]) and can subsequently be changed by the user (see [[Change password]]).

== Place ==

In ICA-AtoM, a place is a geographic location registered in a [[#Taxonomy|taxonomy]] and used as an [[#Access point|access point]] in [[#Archival description|archival descriptions]], [[#Authority record|authority records]], and [[#Archival institution|archival institutions]].

== Physical storage ==

Physical storage is a grouping of [[#Field|fields]] relating to the management of physical objects such as folders, boxes, shelves, and cabinets. In ICA-AtoM, users can create and edit information about physical objects by clicking on the "Link physical storage" button in the [[#Button block|button block]] of an [[#Archival description|archival description]]. See [[Physical storage]].

== Published record ==

A published record is an [[#Archival description|archival description]] that has had its status changed from draft to published in the gray box at the bottom of the [[#Archival description|archival description]] [[#Edit page|edit page]].

<div class="note">

The status is inherited from the highest [[#Level of description|level of description]]; e.g. when a [[#Fonds|fonds]] description is changed from draft to published, all [[#Child record|child records]] within the fonds are automatically changed as well. Once [[#Archival description|archival descriptions]] have been published, users who are not logged in can view them.

</div>

== Reference display copy ==

A reference display copy is a low-resolution version of a [[#Master digital object|master digital object]] generated automatically by ICA-AtoM on upload. It is used to display images on the [[#Digital object|digital object]] [[#View page|view page]] when the user clicks on a [[#Thumbnail|thumbnail]] and in the digital object area of [[#Edit page|edit pages]]. See [[Upload digital objects]].

== Researcher ==

A researcher is a type of user who is limited to searching and browsing descriptions. See [[User roles]].

<div class="clearfix">

== Search box ==

[[Image:browseOptions.png|500px|right|thumb|Search box - the user enters a query and clicks on the magnifying glass icon]]

The search box is used to find descriptions in ICA-AtoM that contain text matching a search query. The search box is located over the [[#Main menu|main menu]] on all ICA-AtoM pages, including the [[#Home page|home page]]. See [[Access content]].

</div>

== Setting ==

Settings is a broad term used to describe the properties that affect the way a program looks and functions. In ICA-AtoM, certain settings can be changed by an [[#Administrator|administrator]] in order to customize ICA-AtoM to institution-specific requirements. See [[Settings]].

<div class="clearfix">

== Site description ==

[[Image:siteTitle.png|500px|right|thumb|Site description reading "Historic Archives of the District of New Caledonia, British Columbia". Note use of Columbia theme (see [[Themes]]).]]

The site description appears at the top of the page directly under the [[#Site title|site title]]. It is a configurable element - the text can be changed or removed (see [[Themes]]).

</div>

<div class="clearfix">

== Site logo ==

[[Image:browseOptions.png|500px|right|thumb|Default red and white site logo]]

The site logo is the graphic that appears at the top of all pages in ICA-AtoM. Clicking on the logo will take the user to the [[#Home page|home page]]. ICA-AtoM ships with a default logo that can be replaced by [[#Administrator|administrators]] to theme the application to their own institution or [[#Network|network]] if desired: see [[Site logo]].

</div>

<div class="clearfix">

== Site title ==

[[Image:siteTitle.png|500px|right|thumb|Site title reading "New Caledonia Archives". Note use of Columbia theme (see [[themes]]).]]

The site title appears at the top of the page next to the [[#Site logo|site logo]] and over the [[#Site description|site description]]. It is a configurable element - the text can be changed or removed (see [[Themes]]).

</div>

== Static page ==

Static pages are pages that are designed to look the same each time they are accessed, in contrast to dynamic pages such as [[Page types#Search results|search results]], [[#View page|view pages]], or [[#Edit page|edit pages]]. ICA-AtoM has two static pages, the [[#Home page|home page]] and the [[#About page|about page]]. Static pages can be edited by an [[#Administrator|administrator]] (see [[Manage static pages]]).

== Subject ==

In ICA-AtoM, subjects are [[#Controlled vocabulary|controlled-vocabulary]] [[#Term|terms]] grouped in a [[#Taxonomy|taxonomy]] and used as [[#Access point|access points]] in [[#Archival description|archival descriptions]].

== Supported language ==

In ICA-AtoM, a supported language is one into which both [[#Data element|data elements]] and [[#User interface |user interface]] elements can be translated. In ICA-AtoM version 1.0 beta, the supported languages are Arabic, Dutch, English, Farsi, French, German, Greek, Icelandic, Italian, Japanese, Korean, Portuguese, Spanish and Slovenian.

== Taxonomy ==

A taxonomy is a grouping of [[#Controlled vocabulary|controlled-vocabulary]] [[#Term|terms]] used to generate [[#Value list|value lists]] and [[#Access point|access points]]. See [[Add/edit terms]].

== Term ==

Terms are the values that make up [[#Controlled vocabulary|controlled vocabularies]]. In ICA-AtoM, terms are grouped into [[#Taxonomy|taxonomies]] that can be added, edited, and deleted through the "Term" item of the [[#Add menu|add menu]]. See [[Add/edit terms]].

== Thumbnail ==

A thumbnail is a small, low-resolution version of a [[#Master digital object|master digital object]] generated automatically by ICA-AtoM on upload. Thumbnails are displayed in search and browse results and in [[#Cover flow|cover flow]] views at higher levels of description. See [[Upload digital objects]].

<div class="clearfix">

== Title bar ==

[[Image:titleBar.png|500px|right|thumb|Title bar in an archival description show page reading "Fonds PR-84 - New Caledonia City Clerk fonds"]]

The title appears at the top of [[#Archival description|archival descriptions]], [[#Authority record|authority records]], and [[#Archival institution|archival institutions]] and [[#Functions|functions]].

</div>

<div class="clearfix">

== Tooltips ==

[[Image:tooltips.png|500px|right|thumb|Tooltip text in an archival description edit page]]

Tooltips are online text designed to assist users to enter data in [[#Edit page|edit pages]].

<div class="clearfix">

== Translation bar ==

[[Image:translationBar.png|500px|right|thumb|Translation bar]]

The translation bar appears at the bottom of the page when users with [[#Translator|translator]] [[#Access privilege|access privileges]] select a language from the [[#Language menu|language menu]]. Clicking on "Translate user interface" in the bottom right-hand corner of the bar opens up the [[#Translation panel|translation panel]], where the user translates [[#User interface|user interface]] elements. See [[Translate interface]].

</div>

<div class="clearfix">

== Translation panel ==

[[Image:G Translation panel.png|500px|right|thumb|Translation panel]]

The translation panel is used by [[#Translator|translators]] to edit [[#User interface|user interface]] elements and is accessed via the [[#Translation bar|translation bar]]. See [[Translate interface]].

</div>

== Translator ==

A translator is a type of user who can translate [[#Data element|data elements]] and [[#User interface|user interface]] elements. See [[User roles]].

== User account ==

User accounts are established in order to manage [[#Access privilege|access privileges]] through the assignment of [[#User role|user roles]]. Every user who must be able to add, edit, delete, or translate content must have a user account. In ICA-AtoM user accounts are established and maintained by [[#Administrator|administrators]]. See [[Manage user accounts]].

== User interface ==

The user interface is the set of elements that allow the user to interact with the ICA-AtoM application. These elements include the [[#Main menu|main menu]], [[#Drop-down menu|drop-down menus]], [[#Context menu|context menu]], [[#Title bar|title bar]], [[#Column header|column headers]], buttons, [[#Field|fields]], and [[#Field label|field labels]], and any other elements used to navigate ICA-AtoM or to search for, view, add, edit, and delete [[#Database content|database content]]. The labels of some user interface elements can be customized by [[#Administrator|administrators]] (see [[User interface labels]]).

<div class="clearfix>

== User menu ==

[[Image:languageMenu.png|500px|right|thumb|User menu in upper right-hand corner of the page (user is not logged in)]]

The user menu, located in the upper right hand corner of the page, contains basic navigational links. These allow the user to go to the [[#Home page|home page]] and [[#About page|about page]], user documentation (help pages) and the log in page. Authenticated users can also use it to navigate to their [[#User profile|user profiles]].

</div>

== Username ==

The username is a name supplied by an [[#Administrator|administrator]] to any user (other than a [[#Researcher|researcher]]) of the ICA-AtoM application as part of the [[#User account|user account]]. See [[Manage user accounts]].

== User profile ==

A user profile is information about a user managed in a [[#User account|user account]]. User profiles are created and maintained by [[#Administrator|administrators]] (see [[manage user accounts]]), although authenticated users can view their own profiles (and change their [[#Password|passwords]]) by going through the [[#User menu|user menu]].

== User role ==

User roles define levels of access to functions in ICA-AtoM, ranging from view-only access to full administration rights. User roles are defined by groups that an [[#Administrator|administrator]] can add and edit. See [[User roles]] and [[Manage user accounts#Add a new group|Add a new group]].

<div class="clearfix">

== Value list ==

[[Image:valueList.png|500px|right|thumb|Value list derived from Levels of description taxonomy]]

Value lists restrict data entry in certain [[#Field|fields]] to [[#Controlled vocabulary|controlled vocabulary]] [[#Term|terms]] or terms derived from [[#Authority record|authority records]]. They appear as [[#Drop-down menu|drop-down menus]] in [[#Edit page|edit pages]].

</div>

== View mode ==

View mode provides read-only access to the contents of [[#Archival description|archival descriptions,]] [[#Authority record|authority records]], [[#Function|functions]] and [[#Archival institution|archival institutions]] using [[#View page|view pages]]. In view mode, ICA-AtoM displays only those [[#Field|fields]] in a record which contain data.

<div class="clearfix">

== View page ==

[[Image:viewPage.png|500px|right|thumb|View page for an archival description]]

View pages allow users to view in detail the contents of [[#Archival description|archival descriptions,]] [[#Authority record|authority records]], [[#Archival institution|archival institutions]], and [[#Function|functions]]

</div>

[[Category:User manual]]

Glossary

2010-11-22T22:06:54Z

Evelyn:

This page provides definitions of terms used throughout ICA-AtoM's system and user documentation.

== About page ==

The about page provides general information on ICA-AtoM. It can be reached via the [[#User menu|user menu]] in the top right-hand corner of the page. The content of the about page can be edited by [[#Administrator|administrators]] (see [[Manage static pages]]).

== Access point ==

An access point is "A name, term, keyword, phrase or code that may be used to search, identify and locate an archival description." (ISAD glossary). In ICA-AtoM, access points are derived from [[#Authority record|authority records]] and [[#Taxonomy|taxonomies]] created and customized by users. See [[Add/edit terms]].

== Access privilege ==

Access privileges control the ways a user is able to interact with ICA-AtoM. For example, some users are able to add and edit content while others may only be able to search and browse content. Access privileges are based on defined [[#User role|user roles]] (see [[User roles]]).

<div class="clearfix">

== Add menu ==

[[Image:addMenu.png|500px|right|thumb|Add menu]]

The "Add" menu allows authorized users to add new [[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], [[#Term|terms]], and [[Glossary#Function|functions]]. Only logged-in users can see the "Add" menu.

</div>

<div class="clearfix">

== Add new button ==

[[Image:archDescButtonBlockSmall.png|500px|right|thumb|Add new button in archival description button block - top center]]

The add new button is located in the [[#Button block|button block]] of the [[#View page|view page]] and allows users to add new records ([[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], and [[#Term|terms]]) to ICA-AtoM.

</div>

<div class="clearfix">

== Admin menu ==

[[Image:adminMenu.png|500px|right|thumb|Admin menu]]

The admin menu allows users with [[#Administrator|administrator]] access to customize ICA-AtoM to meet institution-specific requirements and to manage [[#User account|user accounts]] and [[#User profile|user profiles]] (see [[Administer]]).

</div>

== Administrator ==

The administrator is a type of user who has [[#Access privilege|access privileges]] to do the following: install or uninstall ICA-AtoM; create, read, update, or delete any record; customize ICA-AtoM to institution-specific requirements; and manage [[#User account|user accounts]] and [[#User profile|user profiles]] (see [[User roles]] and [[Administer]]).

== Archival description ==

An archival description is a body of information about an archival record or records. The descriptions provide contextual information about the archival materials and are arranged into hierarchical levels ([[#Fonds|fonds]], series, files, items, and variations of these in accordance with institutional standards). In ICA-AtoM the [[#Data element|data elements]] used for describing archival records are derived from the ICA's General International Standard Archival Description (ISAD). See [[Entity types]] and [[Add/edit archival descriptions]].

== Archival institution ==

An archival institution is "An organization which keeps and preserves archival material and makes it accessible to the public" (ISDIAH glossary). In ICA-AtoM the [[#Data element|data elements]] used to describe such institutions are based on the ICA's International Standard for Describing Institutions with Archival Holdings (ISDIAH). See [[entity types]] and [[Add/edit archival institutions]].

== Archival unit ==

Archival unit is a generic term for an aggregation of archival materials. A unit can be a [[#Fonds|fonds]], series, file, item, or variation thereof, depending on institutional standards. A unit may be divided into sub-units for the purposes of description: e.g. a [[#Fonds|fonds]] may contain several series, each of which may contain several files, and so forth. The smallest (and therefore indivisible) unit is the item.

== Authority record ==

In ICA-AtoM, authority records are collections of information about actors - corporate bodies, persons, or families - who interact with archival materials, typically as [[#Creator|creators]]. The [[#Data element|data elements]] used to describe authority records are based on the ICA's International Standard Archival Authority Record for Corporate Bodies, Persons and Families (ISAAR). ISAAR defines authority record as "The authorized form of name combined with othr information elements that identify and describe the named entity and may also point to other related authority records." See [[Entity types]] and [[Add/edit authority records]].

<div class="clearfix">

== Browse menu ==

[[Image:browseOptions.png|500px|right|thumb|Browse menu just below the search box in the default Caribou theme]]

Browsing allows a user to see all records that have a certain type of [[#Access point|access point]] (such as [[#Subject|subject]], [[#Name|name]], or [[#Place|place]]) or other type of filter, such as [[#Media type|media type]] or type of [[#Entity|entity]]. In ICA-AtoM's default theme (the Caribou theme) the browse menu appears in a horizontal row below the [[#Search box|search box]]; in the Alouette and Columbia themes the browse menu is displayed in a vertical box above and to the right of the [[#Search box|search box]].

</div>

<div class="clearfix">

== Button block ==

[[Image:archDescButtonBlockSmall.png|500px|right|thumb|Button block - archival description view page]]

The button block allows authorized users to add or delete content and to save or reject changes made in the [[#Edit page|edit pages]].

</div>

== Child record ==

Child record refers to a description of the [[#Archival unit|archival unit]] that is one [[#Level of description|level of description]] lower than the current unit, e.g. if a series belongs to a fonds, the series is the child record of the fonds.

== Collection ==

In ISAD, a collection is "[a]n artificial assemblage of documents accumulated on the basis of some common characteristic without regard to the provenance of those documents. Not to be confused with an archival fonds." In Rules for Archival Description, it is "[a] grouping of documents of any provenance intentionally assembled on the basis of some common characteristic." In Dublin Core, a collection is "[a]n aggregation of resources. A collection is described as a group; its parts may also be separately described."

<div class="clearfix">

== Column header ==

[[Image:columnHeader.png|500px|right|thumb|Column header (the orange bar at the top of the list)]]

Column headers appear at the top of the lists on list pages and [[Page types#Browse results|browse results]] and give the name of the [[#Field|field]] for whatever is being listed below.

</div>

<div class="clearfix">

== Context menu ==

[[Image:context.png|500px|right|thumb|Context menu for an archival description showing archival institution, name of creator and other records in the same fonds]]

The context menu appears on all [[#View page|view]] and [[#Edit page|edit pages]] to show the current record's relationships to other records, with links, e.g. they show the hierarchical placement of [[#Archival description|archival descriptions]] within a [[#Fonds|fonds]] and the relationship between [[#Archival institution|archival institutions]], [[#Authority record|authority records]], and archival holdings. See [[Context menu]].

</div>

== Contributor ==

A contributor is a type of user who can search, browse, create, and edit descriptions. See [[User roles]].

== Controlled vocabulary ==

A controlled vocabulary is a set of pre-defined, authorized [[#Term|terms]] grouped into [[#Taxonomy|taxonomies]] or entered into [[#Authority record|authority records]] and used for generating [[#Value list|value lists]] and [[#Access point|access points]]. See [[Add/edit terms]].

<div class="clearfix">

== Cover flow ==

[[Image:coverFlow.png|500px|right|thumb|Cover flow: scroll through the images by moving the black dot or by using your keyboard arrows]]

[[wikipedia:Cover flow|Cover flow]] show sets of [[#Thumbnail|thumbnails]] of [[#Digital object|digital objects]] and allows the user to scroll through the [[#Thumbnail|thumbnails]] using a mouse or keyboard scroll arrows. In ICA-AtoM a cover flow viewer appears in the [[#Context menu|context menu]] of [[#Archival description|archival descriptions]] whenever there are associated lower-level descriptions that have digital objects attached.

</div>

== Create button ==

The create button, located on the [[#Button block|button block]], is used to save new [[#Entity|entities]]. Once an entity has been saved for the first time, the create button disappears and is replaced by the "Save" button, which is used to save all subsequent changes.

== Creator ==

A creator is "Any entity (corporate body, family or person) that created, accumulated and/or maintained records in the conduct of personal or corporate activity" (ISAAR glossary). In ICA-AtoM, the creator is described in an [[#Authority record|authority record]] linked to an [[#Archival description|archival description]], usually at the highest [[#Level of description|level of description]] only. Lower levels inherit the creator from the [[#Parent record|parent record]], unless a different creator is specified. ICA-AtoM can accommodate multiple creators at all [[#Level of description|levels of description]]. See [[ISAD#Context area|Context area]].

== Current language ==

Refers to the language in which the [[#User interface|user interface]] elements and [[#Database content|database content]] are displayed. Users can switch between languages by using the [[#Language menu|language menu]].

== Data element ==

Data elements, or elements of description, are ICA standards-based units of information applied to [[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], and [[#Term|terms]]. The elements are entered into [[#Field|fields]] in ICA-AtoM's [[#Edit page|edit pages]].

== Database content ==

Database content refers to information stored in ICA-Atom's database tables, including [[#Data element|data elements]], [[#Static page|static page]] content, and [[#User profile|user profile]] information.

<div class="clearfix">

== Default content ==

[[Image:defaultContent.png|500px|right|thumb|Default values for levels of description. These can be modified to suit institutional requirements.]]

Default content is any [[#Database content|database content]] that is included by default when ICA-AtoM is installed. This includes things like the default [[#Home page|home page]] and [[#Drop-down menu|drop-down menu]] values that are stored in [[#Taxonomy|taxonomies]].

</div>

== Default language ==

The default language is the language in which all [[#User interface|user interface]] elements are displayed when ICA-AtoM is opened. The language is specified when the application is installed. Users can switch to other [[#Supported language|supported languages]] and [[#Translator|translators]] can translate [[#Database content|database content]] and [[#User interface|user interface]] elements. See [[Choose language]] and [[Translate]].

<div class="clearfix">

== Delete button ==

[[Image:archDescButtonBlockSmall.png|500px|right|thumb|Delete button in archival description button block - second from left on the top]]

The delete button appears in the [[#Button block|button block]]. Clicking on the delete button will prompt a warning to appear asking whether the user really intends to delete the [[#Entity|entity]].

</div>

<div class="clearfix">

== Delete icon ==

[[Image:deleteIcon.png|500px|right|thumb|Delete icons to the right of data entry fields: click on the X to delete the content]]

Delete icons are small buttons in [[#Edit page|edit pages]] used to delete values from [[#Multi-value field|multi-value fields]], such as those containing [[#Event|event]] dates or [[#Access point|access points]].

</div>

== Developer ==

A developer is a programmer who is able to modify the underlying software code of an ICA-AtoM application. In the beta version of ICA-AtoM (1.0.9), much of the customization of the application can only be done by developers. In future releases of the software, more and more features will be customizable via [[#User interface|user interface]] elements available to [[#Administrator|administrators]].

== Digital object ==

Digital objects are computer files that can be uploaded into and displayed by ICA-AtoM. They include scanned images, digital photographs, sound and moving image files, and other scanned or born-digital items. See [[Upload digital objects]] and [[File formats]].

== Draft record ==

A draft record is an [[#Archival description|archival description]] that has not been published. All new and imported [[#Archival description|archival descriptions]] have draft status until the user changes that status to published in the gray box at the bottom of the [[#Archival description|archival description]] [[#Edit page|edit page]].

<div class="note">

The status is inherited from the highest [[#Level of description|level of description]]. Users who are not authenticated cannot view draft records.

</div>

<div class="clearfix">

== Drop-down menu ==

[[Image:valueList.png|500px|right|thumb|A drop-down menu in an edit page]]

A drop-down list menu is a list of data-entry options that appears below certain [[#Field|fields]] in [[#Edit page|edit pages]]. Values are drawn from [[#Controlled vocabulary|controlled-vocabulary]] [[#Term|terms]], [[#Authority record|authority records]], and default data contained in ICA-AtoM's database tables.

</div>

<div class="clearfix">

== Edit button ==

[[Image:archDescButtonBlockSmall.png|500px|right|thumb|Edit button in archival description button block - top left]]

The edit button appears at the bottom of [[#View page|view pages]]; clicking the button takes the user to the [[#Edit page|edit page]] for that record.

<div class="note">

The user can also switch between view and edit pages by clicking the [[#Title bar|title bar]].

</div>

</div>

<div class="clearfix">

== Edit icon ==

[[Image:editIcon.png|500px|right|thumb|Edit icon: click on the the little pencil to edit the data]]

The edit icon appears in [[#Edit page|edit pages]] next to [[#Field|fields]] that derive data from a related record. The user clicks the icon to edit the text in the related record, e.g. to edit the "Administrative/biographical history" in an [[#Archival description|archival description]], the user must click the edit icon because the data resides in the [[#Creator|creator's]] [[#Authority record|authority record]].

</div>

== Edit mode ==

Edit mode allows the user to add, modify, or delete the contents of [[#Archival description|archival descriptions,]] [[#Authority record|authority records]], [[#Archival institution|archival institutions]], [[#Term|terms]], and other [[#Database content|database content]] using [[#Edit page|edit pages]]. In edit mode, ICA-AtoM displays all [[#Field|fields]] in a record for data entry.

<div class="clearfix">

== Edit page ==

[[Image:editPage1.png|500px|right|thumb|Edit page for an archival institution: Identity area expanded]]

Edit pages allow users to add, edit and delete the contents of [[#Archival description|archival descriptions,]] [[#Authority record|authority records]], [[#Archival institution|archival institutions]], [[#Function|functions]] and [[#Term|terms]]. They are also used to carry out administrative functions such as changing [[#User profile|user profiles]] and editing [[#Static page|static pages]].

</div>

== Editor ==

An editor is a type of user who can search, browse, add, edit and delete [[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], [[#Function|functions]] and [[#Term|terms]]. See [[User roles]].

== Entity ==

An entity is an object about which an information system collects data. From the user's perspective, in ICA-AtoM there are four main entities: [[#Archival description|archival descriptions]], [[#Authority record|authority records]], [[#Archival institution|archival institutions]], and [[#Term|terms]]. See [[Entity types]].

== Error message ==

An error message will display when ICA-AtoM is unable to execute an action. See [[Page types#Error|error]] for examples of types of error messages.

== Event ==

In ICA-AtoM, an event registers an action by an actor (corporate body, person, or family) at a particular time or over a span of time and may establish a relationship between the actor and other actors or [[#Entity|entities]]. This is accomplished through the use of start and end dates in the context area of the [[#Archival description|archival description]], which links the [[#Creator|creator]] or other actor to the records for the period of time delimited by the dates. See [[Entity types]] and [[ISAD#Context area|context area]].

== Field ==

A field is a container for a [[#Data element|data element]]. Content is added to or modified in fields in [[#Edit page|edit pages]].

<div class="clearfix">

== Field label ==

[[Image:fieldLabel.png|500px|right|thumb|Field labels appear in the grey area to the left of the content in the archival description view page]]

Field labels identify [[#Field|fields]] in [[#View page|view pages]] and [[#Edit page|edit pages]]. In ICA-AtoM 1.0 beta, field labels can only be customized by developers working directly with the code; in a future release an interface for customizing labels will be available to [[#Administrator|administrators]].

</div>

== Fonds ==

Fonds is an [[#Archival unit|archival unit]] defined as "The whole of the records, regardless of form or medium, organically created and/or accumulated and used by a particular person, family, or corporate body in the course of that creator's activities and functions." (ISAD glossary). In ICA-AtoM, the fonds is by default the highest [[#Level of description|level of description]]. This default can be changed by [[#Administrator|administrators]] (see [[User interface labels]]).

== Function ==

A function is a type of [[Glossary#Entity|entity]] that describes activities linked to records creation, maintenance and use. Functions in ICA-AtoM are linked to [[Glossary#Archival description|archival descriptions]], [[Glossary#Authority record|authority records]] and other functions. In ICA-AtoM the [[Glossary#Field|fields]] for describing functions are taken from the ICA's International Standard for Describing Functions (ISDF). See [[Entity types]].

<div class="clearfix">

== Holdings ==

[[Image:holdings.png|500px|right|thumb|Context menu showing list of archival holdings as blue links on the right of the page]]

Holdings is a generic term referring to the records and other materials held by [[#Archival institution|archival institutions]]. In ICA-AtoM a list of holdings is displayed in the [[#Context menu|context menu]] on [[#Archival institution|archival institution]] [[#View page|view pages]]. The list is generated from the titles of [[#Archival description|archival descriptions]] that have the [[#Archival institution|archival institution]] selected as a repository (see [[ISAD#Context area|Context area]]).

</div>

== Home page ==

The home page is the first page the user sees when opening the ICA-AtoM application. It can also be accessed via the "Home" link on the [[#User menu|user menu]] or by clicking the [[#Site logo|site logo]]. The content of the home page can be edited by [[#Administrator|administrators]] (see [[Manage static pages]]).

<div class="clearfix">

== Information area ==

[[Image:infoArea.png|500px|right|thumb|Edit page showing information areas: Identity area, Context area, Content and structure area, etc.]]

Information areas appear on [[#Edit page|edit pages]] and group related [[#Field|fields]] based on the organization of elements of description in ICA descriptive standards. Clicking on an information area toggles it between closed (all [[#Field|fields]] in that area hidden) and open (all [[#Field|fields]] visible).

</div>

<div class="clearfix">

== Language menu ==

[[Image:languageMenu.png|500px|right|thumb|Language menu at the top left of the page above the application logo: English selected]]

The language menu, located in the top-left corner of the page, allows the user to switch to any of the [[#Supported language|supported languages]] in ICA-AtoM. The current language is always underlined. See [[Choose language]].

</div>

== Level of description ==

The level of description is "the position of the unit of description in the hierarchy of the fonds" (ISAD glossary). In ICA-AtoM, the level of description is selected from a [[#Value list|value list]] in the "Identity" area of an [[#Archival description|archival description]]. See [[ISAD#Identity area|Identity area]].

<div class="clearfix">

== Main menu ==

[[Image:addMenu.png|500px|right|thumb|Main menu with Add menu expanded]]

The main menu is the the navigational tool located near the top of all pages for authenticated users, right below the [[#Search box|search box]]. It allows the user to navigate to all the main areas of ICA-AtoM.

</div>

== Master digital object ==

The master digital object is the unaltered version of a [[#Digital object|digital object]] that has been uploaded to ICA-AtoM. ICA-AtoM automatically generates a [[#Thumbnail|thumbnail]] and a [[#Reference display copy|reference display copy]] of the object. Only authenticated users may view master digital objects. See [[Upload digital objects]].

== Media type ==

Media type refers to the format of uploaded [[#Digital object|digital objects]]. The media type is selected automatically by ICA-AtoM when a digital object is uploaded and the [[#Thumbnail|thumbnail]] and [[#Reference display copy|reference display copies]] of the object are generated. See [[Upload digital objects]].

<div class="note">

Media type [[#Term|terms]] are controlled by the media type [[#Taxonomy|taxonomy]]. ICA-AtoM ships with five [[#Term|terms]] (audio, image, text, video, other) that are locked; these cannot be edited or deleted because they are referenced by ICA-AtoM's code. [[#Editor|Editors]] and [[#Administrator|administrators]] can add new media type [[#Term|terms]], but unless developers incorporate these into the code, the system will not be able to do anything with them.

</div>

== Multi-repository system ==

A multi-repository system exists when a single instance of ICA-AtoM is used by a [[#Network|network]] of [[#Archival institution|archival institutions]].

<div class="clearfix">

== Multi-value field ==

[[Image:G Multi-value field.png|500px|right|thumb|Multi-value field showing three subject terms in an archival description.]]

A multi-value field is a [[#Field|field]] that is structured to contain more than one data entry.

</div>

== Name ==

In ICA-AtoM, names are registered in [[#Authority record|authority records]] for corporate bodies, persons, and families who interact with archival materials as e.g. [[#Creator|creators]], custodians and publishers. Names can be applied as access points to [[#Archival description|archival descriptions]]. See [[ISAD#Access points|access points]].

== Network ==

A network is an aggregation of institutions using one instance of ICA-AtoM to produce a union list of archival holdings (a [[#Multi-repository system|multi-repository system]]).

<div class="clearfix">

== Page title ==

[[Image:holdings.png|500px|right|thumb|The light grey text which says "View Archival institution" is the page title]]

The page title indicates what kind of page a user is viewing; for example, it indicates whether [[#Archival description|archival descriptions]], [[#Authority record|authority records]] or [[#Archival institution|archival institutions]] are being displayed in a [[#View page|view page]] or an [[#Edit page|edit page]].

</div>

== Parent record ==

The parent record refers to the description of the [[#Archival unit|archival unit]] that is one [[#Level of description|level of description]] higher than the current unit. For example, a fonds may be the parent record of a series.

== Password ==

Passwords are required by every user of the system who needs to be able to add, edit, or delete content. The initial passwords are set by the [[#Administrator|system administrator]] (see [[Manage user accounts#Add a new user|add a new user]]) and can subsequently be changed by the user (see [[Change password]]).

== Place ==

In ICA-AtoM, a place is a geographic location registered in a [[#Taxonomy|taxonomy]] and used as an [[#Access point|access point]] in [[#Archival description|archival descriptions]], [[#Authority record|authority records]], and [[#Archival institution|archival institutions]].

== Physical storage ==

Physical storage is a grouping of [[#Field|fields]] relating to the management of physical objects such as folders, boxes, shelves, and cabinets. In ICA-AtoM, users can create and edit information about physical objects by clicking on the "Link physical storage" button in the [[#Button block|button block]] of an [[#Archival description|archival description]]. See [[Physical storage]].

== Published record ==

A published record is an [[#Archival description|archival description]] that has had its status changed from draft to published in the gray box at the bottom of the [[#Archival description|archival description]] [[#Edit page|edit page]].

<div class="note">

The status is inherited from the highest [[#Level of description|level of description]]; e.g. when a [[#Fonds|fonds]] description is changed from draft to published, all [[#Child record|child records]] within the fonds are automatically changed as well. Once [[#Archival description|archival descriptions]] have been published, users who are not logged in can view them.

</div>

== Reference display copy ==

A reference display copy is a low-resolution version of a [[#Master digital object|master digital object]] generated automatically by ICA-AtoM on upload. It is used to display images on the [[#Digital object|digital object]] [[#View page|view page]] when the user clicks on a [[#Thumbnail|thumbnail]] and in the digital object area of [[#Edit page|edit pages]]. See [[Upload digital objects]].

== Researcher ==

A researcher is a type of user who is limited to searching and browsing descriptions. See [[User roles]].

<div class="clearfix">

== Search box ==

[[Image:browseOptions.png|500px|right|thumb|Search box - the user enters a query and clicks on the magnifying glass icon]]

The search box is used to find descriptions in ICA-AtoM that contain text matching a search query. The search box is located over the [[#Main menu|main menu]] on all ICA-AtoM pages, including the [[#Home page|home page]]. See [[Access content]].

</div>

== Setting ==

Settings is a broad term used to describe the properties that affect the way a program looks and functions. In ICA-AtoM, certain settings can be changed by an [[#Administrator|administrator]] in order to customize ICA-AtoM to institution-specific requirements. See [[Settings]].

<div class="clearfix">

== Site description ==

[[Image:siteTitle.png|500px|right|thumb|Site description reading "Historic Archives of the District of New Caledonia, British Columbia". Note use of Columbia theme (see [[Themes]]).]]

The site description appears at the top of the page directly under the [[#Site title|site title]]. It is a configurable element - the text can be changed or removed (see [[Themes]]).

</div>

<div class="clearfix">

== Site logo ==

[[Image:browseOptions.png|500px|right|thumb|Default red and white site logo]]

The site logo is the graphic that appears at the top of all pages in ICA-AtoM. Clicking on the logo will take the user to the [[#Home page|home page]]. ICA-AtoM ships with a default logo that can be replaced by [[#Administrator|administrators]] to theme the application to their own institution or [[#Network|network]] if desired: see [[Site logo]].

</div>

<div class="clearfix">

== Site title ==

[[Image:siteTitle.png|500px|right|thumb|Site title reading "New Caledonia Archives". Note use of Columbia theme (see [[themes]]).]]

The site title appears at the top of the page next to the [[#Site logo|site logo]] and over the [[#Site description|site description]]. It is a configurable element - the text can be changed or removed (see [[Themes]]).

</div>

== Static page ==

Static pages are pages that are designed to look the same each time they are accessed, in contrast to dynamic pages such as [[Page types#Search results|search results]], [[#View page|view pages]], or [[#Edit page|edit pages]]. ICA-AtoM has two static pages, the [[#Home page|home page]] and the [[#About page|about page]]. Static pages can be edited by an [[#Administrator|administrator]] (see [[Manage static pages]]).

== Subject ==

In ICA-AtoM, subjects are [[#Controlled vocabulary|controlled-vocabulary]] [[#Term|terms]] grouped in a [[#Taxonomy|taxonomy]] and used as [[#Access point|access points]] in [[#Archival description|archival descriptions]].

== Supported language ==

In ICA-AtoM, a supported language is one into which both [[#Data element|data elements]] and [[#User interface |user interface]] elements can be translated. In ICA-AtoM version 1.0 beta, the supported languages are Arabic, Dutch, English, Farsi, French, German, Greek, Icelandic, Italian, Japanese, Korean, Portuguese, Spanish and Slovenian.

== Taxonomy ==

A taxonomy is a grouping of [[#Controlled vocabulary|controlled-vocabulary]] [[#Term|terms]] used to generate [[#Value list|value lists]] and [[#Access point|access points]]. See [[Add/edit terms]].

== Term ==

Terms are the values that make up [[#Controlled vocabulary|controlled vocabularies]]. In ICA-AtoM, terms are grouped into [[#Taxonomy|taxonomies]] that can be added, edited, and deleted through the "Term" item of the [[#Add menu|add menu]]. See [[Add/edit terms]].

== Thumbnail ==

A thumbnail is a small, low-resolution version of a [[#Master digital object|master digital object]] generated automatically by ICA-AtoM on upload. Thumbnails are displayed in search and browse results and in [[#Cover flow|cover flow]] views at higher levels of description. See [[Upload digital objects]].

<div class="clearfix">

== Title bar ==

[[Image:titleBar.png|500px|right|thumb|Title bar in an archival description show page reading "Fonds PR-84 - New Caledonia City Clerk fonds"]]

The title appears at the top of [[#Archival description|archival descriptions]], [[#Authority record|authority records]], and [[#Archival institution|archival institutions]] and [[#Functions|functions]].

</div>

<div class="clearfix">

[[Image:tooltips.png|500px|right|thumb|Tooltip text in an archival description edit page]]

Tooltips are online text designed to assist users to enter data in [[#Edit page|edit pages]].

<div class="clearfix">

== Translation bar ==

[[Image:translationBar.png|500px|right|thumb|Translation bar]]

The translation bar appears at the bottom of the page when users with [[#Translator|translator]] [[#Access privilege|access privileges]] select a language from the [[#Language menu|language menu]]. Clicking on "Translate user interface" in the bottom right-hand corner of the bar opens up the [[#Translation panel|translation panel]], where the user translates [[#User interface|user interface]] elements. See [[Translate interface]].

</div>

<div class="clearfix">

== Translation panel ==

[[Image:G Translation panel.png|500px|right|thumb|Translation panel]]

The translation panel is used by [[#Translator|translators]] to edit [[#User interface|user interface]] elements and is accessed via the [[#Translation bar|translation bar]]. See [[Translate interface]].

</div>

== Translator ==

A translator is a type of user who can translate [[#Data element|data elements]] and [[#User interface|user interface]] elements. See [[User roles]].

== User account ==

User accounts are established in order to manage [[#Access privilege|access privileges]] through the assignment of [[#User role|user roles]]. Every user who must be able to add, edit, delete, or translate content must have a user account. In ICA-AtoM user accounts are established and maintained by [[#Administrator|administrators]]. See [[Manage user accounts]].

== User interface ==

The user interface is the set of elements that allow the user to interact with the ICA-AtoM application. These elements include the [[#Main menu|main menu]], [[#Drop-down menu|drop-down menus]], [[#Context menu|context menu]], [[#Title bar|title bar]], [[#Column header|column headers]], buttons, [[#Field|fields]], and [[#Field label|field labels]], and any other elements used to navigate ICA-AtoM or to search for, view, add, edit, and delete [[#Database content|database content]]. The labels of some user interface elements can be customized by [[#Administrator|administrators]] (see [[User interface labels]]).

<div class="clearfix>

== User menu ==

[[Image:languageMenu.png|500px|right|thumb|User menu in upper right-hand corner of the page (user is not logged in)]]

The user menu, located in the upper right hand corner of the page, contains basic navigational links. These allow the user to go to the [[#Home page|home page]] and [[#About page|about page]], user documentation (help pages) and the log in page. Authenticated users can also use it to navigate to their [[#User profile|user profiles]].

</div>

== Username ==

The username is a name supplied by an [[#Administrator|administrator]] to any user (other than a [[#Researcher|researcher]]) of the ICA-AtoM application as part of the [[#User account|user account]]. See [[Manage user accounts]].

== User profile ==

A user profile is information about a user managed in a [[#User account|user account]]. User profiles are created and maintained by [[#Administrator|administrators]] (see [[manage user accounts]]), although authenticated users can view their own profiles (and change their [[#Password|passwords]]) by going through the [[#User menu|user menu]].

== User role ==

User roles define levels of access to functions in ICA-AtoM, ranging from view-only access to full administration rights. User roles are defined by groups that an [[#Administrator|administrator]] can add and edit. See [[User roles]] and [[Manage user accounts#Add a new group|Add a new group]].

<div class="clearfix">

== Value list ==

[[Image:valueList.png|500px|right|thumb|Value list derived from Levels of description taxonomy]]

Value lists restrict data entry in certain [[#Field|fields]] to [[#Controlled vocabulary|controlled vocabulary]] [[#Term|terms]] or terms derived from [[#Authority record|authority records]]. They appear as [[#Drop-down menu|drop-down menus]] in [[#Edit page|edit pages]].

</div>

== View mode ==

View mode provides read-only access to the contents of [[#Archival description|archival descriptions,]] [[#Authority record|authority records]], [[#Function|functions]] and [[#Archival institution|archival institutions]] using [[#View page|view pages]]. In view mode, ICA-AtoM displays only those [[#Field|fields]] in a record which contain data.

<div class="clearfix">

== View page ==

[[Image:viewPage.png|500px|right|thumb|View page for an archival description]]

View pages allow users to view in detail the contents of [[#Archival description|archival descriptions,]] [[#Authority record|authority records]], [[#Archival institution|archival institutions]], and [[#Function|functions]]

</div>

[[Category:User manual]]

Global settings

2010-11-22T22:03:53Z

Evelyn:

[[Main Page]] > [[User manual]] > [[Administer]] > [[Settings]] > Global settings

Global settings allow [[Glossary#Administrator|administrators]] to control certain aspects of how ICA-AtoM appears and behaves. Features currently controlled by global settings include:
* The default display size of uploaded files
* The number of search results that will be displayed on results pages
* Whether or not the application is a [[Glossary#Multi-repository system|multi-repository]] or single-institution system

[[Image:globalSettings.png|500px|right|thumb|Edit global settings]]

# Click the "Admin > Settings" menu
# Click the "Global" [[Glossary#Information area|information area]] to display global settings

== Application version ==

This field shows the current version of the software.

The value is pre-set, ships with the application, and cannot be edited.

The version number is automatically updated when you upgrade ICA-AtoM to a newer release.

== Check for updates ==

== Upload directory ==

This field shows the name of the directory in which ICA-AtoM stores files when users upload them.

The value is pre-set, ships with the application, and cannot be edited.

<div class="clearfix">

== Maximum image width (pixels) ==

[[Image:imageWidth.png|500px|right|thumb|Archival description view page showing reference display copy]]

One of ICA-AtoM's design assumptions is that the display dimensions of files users upload typically will be too large to fit into the [[Glossary#View page|view page]] for an [[Glossary#Archival description|archival description]]. Therefore, when you upload a file, ICA-AtoM creates a [[Glossary#Reference display copy|reference display copy]] for displaying in the [[Glossary#View page|view page]].

ICA-AtoM ships with a default setting specifying the maximum width of the [[Glossary#Reference display copy|reference display copy]] at 480 pixels. This is the optimized width given ICA-AtoM's [[Glossary#Field|field]] width. [[Glossary#Administrator|Administrators]], however, can increase or decrease the maximum reference image width to suit the requirements of their institution or [[Glossary#Network|network]].

</div>

<div class="clearfix">

== Results per page ==

By default, ICA-AtoM lists objects in list pages and [[Page types#Search results|search results]] ten at a time, with a pager at the bottom of the page to allow users to navigate through long lists of objects.

[[Glossary#Administrator|Administrators]] can increase or decrease this default number.

</div>

== Inherit reference code (information object) ==

When this is set to "yes", the reference code string will be built using the [[Glossary#Archival description|archival description]] identifier plus the identifier of all its ancestors ([[Glossary#Parent record|parent records]]). For more information about how the reference code works, see [[ISAD#Reference_code|Reference code]].

== Sort tree view ==

This setting determines how lower-level descriptions are sorted in an [[Glossary#Archival description|archival description's]] [[Glossary#Context menu|context menu]].

Selecting "none" means the descriptions will appear in the order in which they were entered into the DCB.

Selecting "title" sorts the descriptions by title.

Selecting "identifier - title" sorts the descriptions by identifier, then by title.

== Multiple repositories ==

Select Yes if your ICA-AtoM application is acting as a union list or portal for descriptions of materials held at more than one archival institution or repository.

The repository will appear as a column on the Browse archival descriptions page.

The repository will appear as a link in the [[Glossary#Context menu|context menu]].

Select No if your ICA-AtoM application is being used only by a single institution.

The [[Glossary#Creator|creator]] rather than the repository will now appear as a column on the list archival description page.

No repository link will appear in the [[Glossary#Context menu|context menu]].

== Upload multi-page files as multiple descriptions ==

Select yes if you would like each page of a multi-page file to be attached to a separate child-level description. For example, a PDF file with 10 pages uploaded to a description would result in 10 individual descriptions, one for each page in the file.

== Show Tooltips ==

Select yes to to have [[Glossary#Tooltips|tooltips]] appear in [[Glossary#edit page|edit pages]] as the user enters data.

== Default publication status ==

This setting determines whether new [[Glossary#Archival description|archival description]] will automatically appear as a draft or a published record. Note that this setting also affects imported descriptions

[[Category:User manual]]

__NOTOC__

Global settings

2010-11-22T22:01:36Z

Evelyn:

[[Main Page]] > [[User manual]] > [[Administer]] > [[Settings]] > Global settings

Global settings allow [[Glossary#Administrator|administrators]] to control certain aspects of how ICA-AtoM appears and behaves. Features currently controlled by global settings include:
* The default display size of uploaded files
* The number of search results that will be displayed on results pages
* Whether or not the application is a [[Glossary#Multi-repository system|multi-repository]] or single-institution system

[[Image:globalSettings.png|500px|right|thumb|Edit global settings]]

# Click the "Admin > Settings" menu
# Click the "Global" [[Glossary#Information area|information area]] to display global settings

== Application version ==

This field shows the current version of the software.

The value is pre-set, ships with the application, and cannot be edited.

The version number is automatically updated when you upgrade ICA-AtoM to a newer release.

== Check for updates ==

== Upload directory ==

This field shows the name of the directory in which ICA-AtoM stores files when users upload them.

The value is pre-set, ships with the application, and cannot be edited.

<div class="clearfix">

== Maximum image width (pixels) ==

[[Image:imageWidth.png|500px|right|thumb|Archival description view page showing reference display copy]]

One of ICA-AtoM's design assumptions is that the display dimensions of files users upload typically will be too large to fit into the [[Glossary#View page|view page]] for an [[Glossary#Archival description|archival description]]. Therefore, when you upload a file, ICA-AtoM creates a [[Glossary#Reference display copy|reference display copy]] for displaying in the [[Glossary#View page|view page]].

ICA-AtoM ships with a default setting specifying the maximum width of the [[Glossary#Reference display copy|reference display copy]] at 480 pixels. This is the optimized width given ICA-AtoM's [[Glossary#Field|field]] width. [[Glossary#Administrator|Administrators]], however, can increase or decrease the maximum reference image width to suit the requirements of their institution or [[Glossary#Network|network]].

</div>

<div class="clearfix">

== Results per page ==

By default, ICA-AtoM lists objects in list pages and [[Page types#Search results|search results]] ten at a time, with a pager at the bottom of the page to allow users to navigate through long lists of objects.

[[Glossary#Administrator|Administrators]] can increase or decrease this default number.

</div>

== Inherit reference code (information object) ==

When this is set to "yes", the reference code string will be built using the [[Glossary#Archival description|archival description]] identifier plus the identifier of all its ancestors ([[Glossary#Parent record|parent records]]). For more information about how the reference code works, see [[ISAD#Reference_code|Reference code]].

== Sort tree view ==

This setting determines how lower-level descriptions are sorted in an [[Glossary#Archival description|archival description's]] [[Glossary#Context menu|context menu]].

Selecting "none" means the descriptions will appear in the order in which they were entered into the DCB.

Selecting "title" sorts the descriptions by title.

Selecting "identifier - title" sorts the descriptions by identifier, then by title.

== Multiple repositories ==

Select Yes if your ICA-AtoM application is acting as a union list or portal for descriptions of materials held at more than one archival institution or repository.

The repository will appear as a column on the Browse archival descriptions page.

The repository will appear as a link in the [[Glossary#Context menu|context menu]].

Select No if your ICA-AtoM application is being used only by a single institution.

The [[Glossary#Creator|creator]] rather than the repository will now appear as a column on the list archival description page.

No repository link will appear in the [[Glossary#Context menu|context menu]].

== Upload multi-page files as multiple descriptions ==

Select yes if you would like each page of a multi-page file to be attached to a separate child-level description. For example, a PDF file with 10 pages uploaded to a description would result in 10 individual descriptions, one for each page in the file.

== Show Tooltips ==

Select yes to to have [[Glossary#tooltips]] appear in [[Glossary#edit page|edit pages]] as the user enters data.

== Default publication status ==

This setting determines whether new [[Glossary#archival description]] will automatically appear as a draft or a published record. Note that this setting also affects imported descriptions

[[Category:User manual]]

__NOTOC__

Global settings

2010-11-22T22:00:36Z

Evelyn:

[[Main Page]] > [[User manual]] > [[Administer]] > [[Settings]] > Global settings

Global settings allow [[Glossary#Administrator|administrators]] to control certain aspects of how ICA-AtoM appears and behaves. Features currently controlled by global settings include:
* The default display size of uploaded files
* The number of search results that will be displayed on results pages
* Whether or not the application is a [[Glossary#Multi-repository system|multi-repository]] or single-institution system

[[Image:globalSettings.png|500px|right|thumb|Edit global settings]]

# Click the "Admin > Settings" menu
# Click the "Global" [[Glossary#Information area|information area]] to display global settings

== Application version ==

This field shows the current version of the software.

The value is pre-set, ships with the application, and cannot be edited.

The version number is automatically updated when you upgrade ICA-AtoM to a newer release.

== Check for updates ==

== Upload directory ==

This field shows the name of the directory in which ICA-AtoM stores files when users upload them.

The value is pre-set, ships with the application, and cannot be edited.

<div class="clearfix">

== Maximum image width (pixels) ==

[[Image:imageWidth.png|500px|right|thumb|Archival description view page showing reference display copy]]

One of ICA-AtoM's design assumptions is that the display dimensions of files users upload typically will be too large to fit into the [[Glossary#View page|view page]] for an [[Glossary#Archival description|archival description]]. Therefore, when you upload a file, ICA-AtoM creates a [[Glossary#Reference display copy|reference display copy]] for displaying in the [[Glossary#View page|view page]].

ICA-AtoM ships with a default setting specifying the maximum width of the [[Glossary#Reference display copy|reference display copy]] at 480 pixels. This is the optimized width given ICA-AtoM's [[Glossary#Field|field]] width. [[Glossary#Administrator|Administrators]], however, can increase or decrease the maximum reference image width to suit the requirements of their institution or [[Glossary#Network|network]].

</div>

<div class="clearfix">

== Results per page ==

By default, ICA-AtoM lists objects in list pages and [[Page types#Search results|search results]] ten at a time, with a pager at the bottom of the page to allow users to navigate through long lists of objects.

[[Glossary#Administrator|Administrators]] can increase or decrease this default number.

</div>

== Inherit reference code (information object) ==

When this is set to "yes", the reference code string will be built using the [[Glossary#Archival description|archival description]] identifier plus the identifier of all its ancestors ([[Glossary#Parent record|parent records]]). For more information about how the reference code works, see [[ISAD#Reference_code|Reference code]].

== Sort tree view ==

This setting determines how lower-level descriptions are sorted in an [[Glossary#Archival description|archival description's]] [[Glossary#Context menu|context menu]].

Selecting "none" means the descriptions will appear in the order in which they were entered into the DCB.

Selecting "title" sorts the descriptions by title.

Selecting "identifier - title" sorts the descriptions by identifier, then by title.

== Multiple repositories ==

Select Yes if your ICA-AtoM application is acting as a union list or portal for descriptions of materials held at more than one archival institution or repository.

The repository will appear as a column on the Browse archival descriptions page.

The repository will appear as a link in the [[Glossary#Context menu|context menu]].

Select No if your ICA-AtoM application is being used only by a single institution.

The [[Glossary#Creator|creator]] rather than the repository will now appear as a column on the list archival description page.

No repository link will appear in the [[Glossary#Context menu|context menu]].

== Upload multi-page files as multiple descriptions ==

Select yes if you would like each page of a multi-page file to be attached to a separate child-level description. For example, a PDF file with 10 pages uploaded to a description would result in 10 individual descriptions, one for each page in the file.

== Show Tooltips ==

Select yes to to have [[tooltips]] appear in [[edit page|edit pages]] as the user enters data.

== Default publication status ==

This setting determines whether new [[archival description]] will automatically appear as a draft or a published record. Note that this setting also affects imported descriptions

[[Category:User manual]]

__NOTOC__

File:GlobalSettings.png

2010-11-22T21:51:48Z

Evelyn: uploaded a new version of "File:GlobalSettings.png"

User manual

2010-10-12T22:06:59Z

Evelyn:

{| style="width:95%; border="0"
|-valign="top"
| style="width:500px; border: 1px solid rgb(255, 201, 201); padding: 0.5em 1em 1em; color: rgb(0, 0, 0); background-color: rgb(255, 243, 243);" |

== [[Overview]] ==

* [[What is ICA-AtoM?]]
* [[Technical requirements]]
* [[Entity types]]
* [[Descriptive standards]]

== [[Getting started]] ==

* [[Home page]]
* [[Log in]]
* [[User roles]]
* [[Page types]]
* [[Choose language]]
* [[Change password]]

== [[Add/edit content]] ==

* [[Add/edit archival descriptions]]
* [[Add/edit authority records]]
* [[Add/edit archival institutions]]
* [[Add/edit functions]]
* [[Add/edit terms]]
* [[Exit edit mode]]

== [[Access content]] ==

* [[Search]]
* [[Browse]]
* [[Navigate]]

== [[Translate]] ==

* [[Multilingual design principles]]
* [[Translate content]]
* [[Translate interface]]
* [[Translate static pages]]

| style="width: 500px; border: 1px solid rgb(198, 201, 255); padding: 0.5em 1em 1em; color: rgb(0, 0, 0); background-color: rgb(240, 240, 255);" |

== [[Import/export]] ==

* [[Upload digital objects]]
* [[Import descriptions]]
* [[Export descriptions]]
* [[OAI-PMH]]

== [[Administer]] ==

* [[Install]]
* [[Manage user accounts]]
* [[Edit permissions]]
* [[Manage static pages]]
* [[Settings]]
* [[Themes]]
* [[Default language]]
* [[Back up]]

== [[Glossary]] ==

Glossary of terms used throughout this user manual

== [[:Category:User manual|Index]] ==

Index of pages in this user manual

== Questions? ==

Please post them to [http://groups.google.ca/group/ica-atom-users the discussion group]

__NOEDITSECTION__
__NOTOC__

Beta testing

2010-09-22T00:06:24Z

Evelyn:

[[Main Page]] > Beta testing
__NOTOC__

==When?==
*We formally began the beta testing phase of the ICA-AtoM project during the week of October 6, 2008. It will end with release 1.1 (October 2010), since 1.1 will be the first non-beta, production version of the software.

==Participation Requirements==
*The only requirement to participate in beta testing is to have one or more representatives from your institution enter some of your archival description data into ICA-AtoM and provide feedback to the ICA-AtoM development team on how to improve the software.

*You can determine for yourself how much time and how much data to contribute to this process.

*Please note that you can either have your institution host its own version of the software or we can host it on our server at no cost during the beta testing phase. '''**Note**''' If you host it on your own server, we do ask that you make the site publicly available, since we are hoping that beta testers will learn from each other's work.

==Become a Beta Tester==
If you are considering having your institution participate in ICA-AtoM beta testing please contact [mailto:evelyn@artefactual.com Evelyn McLellan], ICA-AtoM Community Manager, for more information.

==Discussion List==
Questions and comments about using ICA-AtoM should be posted to the [http://groups.google.ca/group/ica-atom-users ICA-AtoM discussion group] so that other users can add their responses and suggestions and learn from each other during this process.

==Participating Institutions==

The following institutions have been beta-testing as of March 18, 2010. Please feel free to add your own institution to this list if you are beta testing or contact [mailto:evelyn@artefactual.com Evelyn McLellan], ICA-AtoM Community Manager, to be added to this list.

{| border="1" cellpadding="20" cellspacing="0"
!Institution
!Beta Test Website
!Type
!Country
!Languages
!Institution Website
|-
|Archdiocese of Vancouver
|[http://www.ica-atom.org/archdiocese www.ica-atom.org/archdiocese]
|Religious
|Canada
|English
|[http://www.rcav.org/catholicarchives http://www.rcav.org/catholicarchives]
|-
|Archiefschool, Netherlands Institute for Archival Education and Research (Archiefschool, Nederlands Instituut voor Archiefonderwijs en -onderzoek)
|[http://www.ica-atom.org/archiefschool www.ica-atom.org/archiefschool]
|Educational
|Netherlands
|Dutch
|[http://www.archiefschool.nl http://www.archiefschool.nl]
|-
|Arquivo Central do Sistema de Arquivos, UNICAMP - Universidade Estadual de Campinas
|TBA
|University
|Brazil
|Portuguese
|http://www.unicamp.br/siarq
|-
|Australian National University Archives/Noel Butlin Archives Centre
|[http://www.ica-atom.org/anu www.ica-atom.org/anu]
|University/National
|Australia
|English
|[http://www.archives.anu.edu.au/nbac/html/index.php http://www.archives.anu.edu.au/nbac/html/index.php]
|-
|Bahia State Archives (Arquivo Público da Bahia)
|[http://www.ica-atom.org/bahia www.ica-atom.org/bahia]
|State/provincial
|Brazil
|Portuguese
|[http://www.bahiacultural.com.br/Template.asp?nivel=00070003&identidade=33&id_equipamento=392 http://www.bahiacultural.com.br/Template.asp?nivel=00070003&identidade=33&id_equipamento=392]
|-
|British Columbia Archival Union List (BCAUL)
|[http://www.ica-atom.org/bcaul www.ica-atom.org/bcaul]
|Union list
|Canada
|English
|[http://www.aabc.bc.ca http://www.aabc.bc.ca]
|-
|City of Vancouver Archives
|[http://www.ica-atom.org/vancouver www.ica-atom.org/vancouver]
|Municipal
|Canada
|English
|[http://city.vancouver.bc.ca/ctyclerk/archives/ http://city.vancouver.bc.ca/ctyclerk/archives/]
|-
|Directorate of Historical Archives of Romania (DANIC)/Directia Arhive Nationale Istorice Centrale (DANIC)
|[http://www.ica-atom.org/danic www.ica-atom.org/danic]
|National
|Romania
|Romanian
|[http://arhivelenationale.ro/index.php?lan=0&jud=162 http://arhivelenationale.ro/index.php?lan=0&jud=162]
|-
|HumanRightsArchives.org (ICA Task Force on Human Rights)
|[http://humanrightsarchives.org http://humanrightsarchives.org]
|Union list
|International
|English, Spanish
|[http://www.ica.org/ http://www.ica.org/]
|-
|International Council on Archives Section on Archival Education and Training
|[http://www.ica-atom.org/sae www.ica-atom.org/sae]
|Educational
|International
|English
|[http://www.ica.org/ http://www.ica.org/]
|-
|Memoria Abierta - Acción Coordinada de Organizaciones de Derechos Humanos
|[http://www.ica-atom.org/memoria_abierta www.ica-atom.org/memoria_abierta]
|Educational, cultural, research
|Argentina
|Spanish
|[http://www.memoriaabierta.org.ar http://www.memoriaabierta.org.ar]
|-
|Morris and Helen Belkin Art Gallery
|[http://www.ica-atom.org/belkin www.ica-atom.org/belkin]
|Cultural, university
|Canada
|English
|[http://www.belkin.ubc.ca/ http://www.belkin.ubc.ca/]
|-
|National Archives of Iran
|[http://217.218.78.251:8080/icaatom-ir http://217.218.78.251:8080/icaatom-ir]
|National
|Iran
|Farsi
|[http://www.nlai.ir/Default.aspx?tabid=471 http://www.nlai.ir/Default.aspx?tabid=471]
|-
|National Archives of Iceland (Þjóðskjalasafn Íslands)
|[http://www.ica-atom.org/skjalasafn www.ica-atom.org/skjalasafn]
|National
|Iceland
|Icelandic
|[http://www.archives.is/ http://www.archives.is/]
|-
|The National Archives of Scotland
|[http://www.ica-atom.org/nas www.ica-atom.org/nas]
|National
|Scotland
|English
|[http://www.nas.gov.uk/ http://www.nas.gov.uk/]
|-
|National General Archive-México (Archivo General de la Nación-México)
|TBA
|National
|Mexico
|Spanish
|[http://www.agn.gob.mx/ http://www.agn.gob.mx/]
|-
|National Overseas Archives (Archives nationales d'outre-mer (ANOM))
|[http://www.ica-atom.org/anom ww.ica-atom.org/anom]
|National
|France
|French
|[http://www.archivesnationales.culture.gouv.fr/ http://www.archivesnationales.culture.gouv.fr/]
|-
|Oswalso Cruz Foundation (Fundação Oswaldo Cruz)
|[http://arquivos-coc.homolog.bireme.org/web/ http://arquivos-coc.homolog.bireme.org/web/]
|Research
|Brazil
|Portuguese
|[http://www.fiocruz.br/cgi/cgilua.exe/sys/start.htm?tpl=home http://www.fiocruz.br/cgi/cgilua.exe/sys/start.htm?tpl=home]
|-
|Prime Minister’s Office Archives (Archivio della Presidenza del Consiglio dei Ministri)
|[http://www.ica-atom.org/archpcm www.ica-atom.org/archpcm]
|Government
|Italy
|Italian
|[http://www.governo.it/ http://www.governo.it/]
|-
|Queen's University Archives
|[http://your.archives.queensu.ca:8080/ica-atom http://your.archives.queensu.ca:8080/ica-atom]
|University
|Canada
|English
|[http://archives.queensu.ca/index.html http://archives.queensu.ca/index.html]
|-
|Reference and Information Center of Arts, Entertainment and Brazilian Culture (CRIAR - Centro de Referência e Informação em Artes, Entretenimento e Cultura Brasileira)
|TBA
|Union list
|Brazil
|Portuguese
|None available
|-
|Regional Archives of Maribor (Pokrajinski arhiv Maribor)
|[http://www.ica-atom.org/mar www.ica-atom.org/mar]
|Provincial
|Slovenia
|Slovenian
|[http://www.pokarh-mb.si/ http://www.pokarh-mb.si/]
|-
|Regional Archives of Nova Gorica (Pokrajinski arhiv v Novi Gorici)
|[http://www.ica-atom.org/pang www.ica-atom.org/pang]
|Provincial
|Slovenia
|Slovenian
|[http://www.pa-ng.si/ http://www.pa-ng.si/]
|-
|Rui Barbosa´s House Foundation (Fundação Casa de Rui Barbosa)
|[http://139.82.199.1/web/index.php http://139.82.199.1/web/index.php]
|Research, cultural
|Brazil
|Portuguese
|[http://www.casaruibarbosa.gov.br/ http://www.casaruibarbosa.gov.br/]
|-
|Ministry of Education (وزارة التربية والتعليم)
|[http://www.ica-atom.org/moe www.ica-atom.org/moe]
|Educational
|United Arab Emirates
|Arabic, English
|[http://www.uaeinteract.com/education/ http://www.uaeinteract.com/education/]
|-
|Simon Fraser University Archives
|TBA
|University
|Canada
|English
|[http://www.sfu.ca/archives/ http://www.sfu.ca/archives/]
|-
|United Nations Educational, Scientific and Cultural Organization (UNESCO)
|[http://www.ica-atom.org/unesco www.ica-atom.org/unesco]
|International
|France
|English, French, Spanish, Arabic, Chinese, Russian.
|[http://portal.unesco.org/en/ev.php-URL_ID=29008&URL_DO=DO_TOPIC&URL_SECTION=201.html http://portal.unesco.org/en/ev.php-URL_ID=29008&URL_DO=DO_TOPIC&URL_SECTION=201.html]
|-
|University Archives, Vienna University of Technology (Universitätsarchiv der Technischen Universität Wien)
|[http://www.ica-atom.org/tuwa www.ica-atom.org/tuwa]
|University
|Austria
|German
|[http://www.univie.ac.at/Wissenschaftstheorie/wiss-archive/daten/archiv21.html http://www.univie.ac.at/Wissenschaftstheorie/wiss-archive/daten/archiv21.html]
|-
|University of British Columbia Museum of Anthropology
|[http://www.ica-atom.org/moa www.ica-atom.org/moa]
|University, cultural
|Canada
|English
|[http://www.moa.ubc.ca/ http://www.moa.ubc.ca/]
|-

|University of Edinburgh: Special Collections
|[http://129.215.248.158/icaatom-1.0.9/ http://129.215.248.158/icaatom-1.0.9/]
|University
|United Kingdom
|English
|[http://www.lib.ed.ac.uk/speccoll/ http://www.lib.ed.ac.uk/speccoll/]
|-
|University of Strathclyde Archives and Special Collections
|[http://www.ica-atom.org/strathclyde www.ica-atom.org/strathclyde]
|University
|United Kingdom
|English
|[http://www.strath.ac.uk/archives www.strath.ac.uk/archives]
|-
|University of Victoria Archives (as part of bcaul project)
|[http://www.ica-atom.org/bcaul www.ica-atom.org/bcaul]
|Union List
|Canada
|English
|[http://library.uvic.ca/site/archives/default.html http://library.uvic.ca/site/archives/default.html]
|-
|World Bank Group Archives
|[http://www.ica-atom.org/wbga www.ica-atom.org/wbga]
|International
|USA
|English
|[http://web.worldbank.org/WBSITE/EXTERNAL/EXTABOUTUS/EXTARCHIVES/0,,pagePK:38167~theSitePK:29506,00.html http://web.worldbank.org/WBSITE/EXTERNAL/EXTABOUTUS/EXTARCHIVES/0,,pagePK:38167~theSitePK:29506,00.html]
|-
|}

Upload digital objects

2010-07-27T18:31:21Z

Evelyn:

[[Main Page]] > [[User manual]] > [[Import/export]] > Upload digital objects

[[Image:upload.png|500px|right|thumb|Archival description view page showing reference display copy of an uploaded audio file: the user can click on the play button to hear the recording]]

ICA-AtoM allows the user to upload [[Glossary#Digital object|digital objects]], such as scanned images, sound and moving image files, and other scanned or born-digital items. Every [[Glossary#Digital object|digital object]] must be associated with an [[Glossary#Archival description|archival description]], typically at the file or item level.

For every object uploaded, ICA-AtoM creates two derivative objects, a [[Glossary#Thumbnail|thumbnail]] image and a [[Glossary#Reference display copy|reference display copy]].

<div class="note">

At higher [[Glossary#Level of description|levels of description]], the [[Glossary#Context menu|context menu]] includes [[Glossary#Thumbnail|thumbnails]] of all files registered at lower levels. The [[Glossary#Thumbnail|thumbnails]] are displayed using [[Glossary#Cover flow|cover flow]] so you can easily scroll through the set using your keyboard's arrow keys.

</div>

To upload a single [[Glossary#Digital object|digital object]]:
# Open an [[Glossary#Archival description|archival description]] in [[Glossary#View mode|view mode]]
# Click on the Link digital object button in the [[Glossary#Button block|button block]]
# Click the Browse button to navigate to and select a file. Click the Open button.
# Click the Save button in the [[Glossary#Button block|button block]]. When you return to the [[Glossary#View page|view page]], the [[Glossary#Reference display copy|reference display copy]] will be displayed in the digital object field. Users can view or play the [[Glossary#Reference display copy|reference display copy]] (depending on the type of [[Glossary#Digital object|digital object]]). Logged in users can also download the [[Glossary#Master digital object|master digital object]].
# Objects with multiple pages, such as multi-page TIFFs or PDF files, will be displayed with a pager to allow the user to browse through the pages; all pages will also appear individually as [[Glossary#Child record|child records]] of the description to which the object was uploaded.

You can upload any file format, but only supported formats can be viewed or played directly in ICA-AtoM. For a list of formats, see [[File formats]]. Formats that are not supported can still be uploaded: clicking the object will download it to the user's desktop where (assuming the user has the required software) it can be viewed or played.

== Upload multiple files ==

A user can upload multiple files at once, attaching them all to the same [[Glossary#Archival description|archival description]].

# Open an [[Glossary#Archival description|archival description]] in [[Glossary#View mode|view mode]].
# Click on the Import digital objects button in the [[Glossary#Button block|button block]].
# Select a title for the objects; all the objects will have the title plus a number. Currently the default is image 01, image 02, etc.
# Choose a level of description.
# Click the blue Select files link and select multiple files to upload. The page will show previews of all the objects.
# If you like you can edit the title for each object next to the preview.
# Click Import in the [[Glossary#Button block|button block]]. When you return to the [[Glossary#View page|view page]] you will see that the objects have all been attached to the archival description as [[Glossary#Child record|child records]] of that description.

[[Category:User manual]]

Export descriptions and terms

2010-07-27T18:27:01Z

Evelyn: