Difference between revisions of "Page types"

Latest revision as of 16:56, 5 September 2012

Please note that ICA-AtoM is no longer actively supported by Artefactual Systems.
Visit https://www.accesstomemory.org for information about AtoM, the currently supported version.

Main Page > User manual > Getting started > Page types

This section describes the main page types users of ICA-AtoM will encounter. Page titles throughout the system indicate the type of page being displayed. The main page types are:

Home page
View
Edit
Search results
Browse results
Error

Home page

Home page: user is logged in

The home page is the first page the user sees when opening the application. It provides basic information about the application and links and buttons for user actions (search, browse, log in, log out, get help, switch language). When the user logs in, the main menu becomes visible.

The home page is accessible from any other page by clicking the site title, the site logo or the "home" link in the user menu.

View

View page for an archival description

A view page displays an individual record in full in view mode, showing only those fields that contain data. Logged in users can toggle between edit mode and view mode by clicking the title bar and can also use the button block to edit or add to the record (i.e. to upload digital objects, add physical storage, etc.).

Introduced in Release 1.3, view pages now include ellipses in text boxes that have a large number of characters (e.g., scope and content). The ellipses allow the User to expand the text box to read the entire body of text. The collapsed position provides a concise and tidy look to the record so User don't have to scroll down to understand what they are viewing.

Edit

Edit page for an archival description

Displays an individual record in edit mode for data entry.
Shows all fields, including the administration area.
Groups fields by collapsible information areas: fields can be hidden or displayed by section.
Provides button block that contains buttons for saving or canceling changes.
Accessible to contributors, editors, and administrators; not accessible to researchers.

Edit digital object

Edit digital object page

The Edit digital object page allows the authorized User to control the rights applied to the Master (original uploaded to ICA-AtoM), the Reference representation (copy) and the Thumbnail representation (copy used within the database for search results, image gallery, cover viewer etc.)

Search results

Search results page

A search results page displays set of records that match search criteria. Users can click on a title to open the record in view mode.

Browse results

Browse results page; user is browsing authority records. Note browse menu directly below search box.

Browse results show lists of descriptions retrieved by clicking on an item in the browse menu. By default, results for archival description, authority record, archival institution and function are sorted by most recently updated; however, the user can select alphabetic sort if desired. Users can also browse by subject, place, and digital object type.

Error

An error message displays when ICA-AtoM is unable to execute an action. The following are typical types of error messages:

Page not found: broken link, report to system administrator and to ICA-AtoM support team.

No access permission: your user account does not give you access privileges to the requested page.

Locked term: term cannot be edited because it is referenced in the underlying code.

No translation permission: you do not have translator access in the current language.

System error (error 500): indicates a fairly major system-wide problem, or problem with data corruption; report to administrator.

Blank page: indicates a fairly major system-wide problem, or problem with data corruption; report to administrator and to ICA-AtoM support team.

@@ Line 1: / Line 1: @@
-[[Main Page]] > [[User manual]] > [[UM-2 | UM-2 Getting started]] > UM-2.4 Screen types
+[[Main Page]] > [[User manual]] > [[Getting started]] > Page types
-== Screen types ==
-This section describe the main types of screen users of ICA-AtoM will encounter. Screen titles throughout the system indicate the type of screen being displayed.
+This section describes the main page types users of ICA-AtoM will encounter. [[Glossary#Page title|Page titles]] throughout the system indicate the type of page being displayed. The main page types are:
-*[[#Home screen | Home screen]]: default opening screen when user accesses the application.
+* [[#Home page|Home page]]
-*[[#List screen | List screen]]: displays a set of records in list form.
+* [[#View|View]]
-*[[#View screen | View screen]]: displays a single record, showing only fields that contain data, read-only.
+* [[#Edit|Edit]]
-*[[#Edit screen | Edit screen]]: displays a single record, showing all fields for data entry / editing.
+* [[#Search results|Search results]]
-*[[#Search results screen | Search results screen]]: displays hits matching a search.
+* [[#Browse results|Browse results]]
+* [[#Error|Error]]
-=== Home screen ===
+<div class="clearfix">
-[[Image:image.png|500px|right|thumb|Home screen]]
+== Home page ==
-'''Purpose:'''
+[[Image:homePage_1.png|500px|right|thumb|Home page: user is logged in]]
-*Start screen when user accesses the application.
-*Provides links / buttons for user actions.
-*Provides information about the application.
+The [[Glossary#Home page|home page]] is the first page the user sees when opening the application. It provides basic information about the application and links and buttons for user actions (search, browse, log in, log out, get help, switch language). When the user logs in, the [[Glossary#Main menu|main menu]] becomes visible.
-'''Availability:'''
+The [[Glossary#Home page|home page]] is accessible from any other page by clicking the [[Glossary#Site title|site title]], the [[Glossary#Site logo|site logo]] or the "home" link in the [[Glossary#User menu|user menu]].
-*Accessible to all users, but only shows elements relevant to user's role (e.g. <span class="button">Admin</span> button only available to <span class="role">Editors</span> and <span class="role">Administrators</span>).
-| width="500" align="right" |
+</div>
-[[Image:HomeAfterLogIn.png|500px|right]]
-|}
+<div class="clearfix">
+== View ==
-=== List screen ===
+[[Image:viewPage.png|500px|right|thumb|View page for an archival description]]
-<div class="headerBar">List screen</div>
+A [[Glossary#View page|view page]] displays an individual record in full in [[Glossary#View mode|view mode]], showing only those [[Glossary#Field|fields]] that contain data. Logged in users can toggle between [[Glossary#Edit mode|edit mode]] and [[Glossary#View mode|view mode]] by clicking the [[Glossary#Title bar|title bar]] and can also use the [[Glossary#Button block|button block]] to edit or add to the record (i.e. to upload [[Glossary#Digital object|digital objects]], add [[Glossary#Physical storage|physical storage]], etc.).
-{| border="0" cellpadding="2"
+Introduced in Release 1.3,  view pages now include ellipses in text boxes that have a large number of characters (e.g., scope and content). The ellipses allow the User to expand the text box to read the entire body of text. The collapsed position provides a concise and tidy look to the record so User don't have to scroll down to understand what they are viewing.
-|- valign="top"
+</div>
-|width="600" |
-'''Purpose:'''
+== Edit ==
-*Displays set of records in list form.
-*Displays records by type (archival material, authority records, institutions, terms).
-*Displays minimal information about each record (e.g. <span class="field">Title, ID</span>).
-*Provides links to full view of each record displayed.
-*Provides button to create new record of same type.
+[[Image:editPage.png|500px|right|thumb|Edit page for an archival description]]
-'''Availability:'''
-*Accessible to all users, but <span class="button">AddNew</span> button not available to <span class="role">Researchers</span>.
+* Displays an individual record in [[Glossary#Edit mode|edit mode]] for data entry.
+* Shows all [[Glossary#Field|fields]], including the [[Glossary#Administration area|administration area]].
+* Groups [[Glossary#Field|fields]] by collapsible [[Glossary#Information area|information areas]]: [[Glossary#Field|fields]] can be hidden or displayed by section.
+* Provides [[Glossary#Button block|button block]] that contains buttons for saving or canceling changes.
+* Accessible to [[Glossary#Contributor|contributors]], [[Glossary#Editor|editors]], and [[Glossary#Administrator|administrators]]; not accessible to [[Glossary#Researcher|researchers]].
-| width="500" align="right" |
-[[Image:ListArchival.png|500px|right]]
+</div>
-|}
+<div class="clearfix">
+== Edit digital object ==
-=== View screen ===
+[[Image:digitalobjectpage.png|500px|right|thumb| Edit digital object page]]
-<div class="headerBar">View screen</div>
+The Edit digital object page allows the authorized User to control the rights applied to the Master (original uploaded to ICA-AtoM), the Reference representation (copy) and the Thumbnail representation (copy used within the database for search results, image gallery, cover viewer etc.)
-{| border="0" cellpadding="2"
+</div>
-|- valign="top"
+<div note="clearfix">
-|width="600" |
-'''Purpose:'''
+== Search results ==
-*Displays an individual record in full in read-only view.
-*Shows only fields that contain data.
-*Provides an <span class="button">Edit</span> button to route users to data entry screen.
+[[Image:searchResults.png|500px|right|thumb|Search results page]]
-'''Availability:'''
+A search results page displays set of records that match search criteria. Users can click on a title to open the record in [[Glossary#View mode|view mode]].
-*Accessible to all users, but no <span class="button">Edit</span> button for <span class="role">Researchers</span>.
-| width="500" align="right" |
-[[Image:ViewArchival.png|500px|right]]
+</div>
-|}
+<div class="clearfix">
-=== Edit screen ===
+== Browse results ==
-<div class="headerBar">Edit screen</div>
+[[Image:browseResults.png|500px|right|thumb|Browse results page; user is browsing authority records. Note browse menu directly below search box.]]
-{| border="0" cellpadding="2"
+Browse results show lists of descriptions retrieved by clicking on an item in the [[Glossary#Browse menu|browse menu]]. By default, results for [[Glossary#Archival description|archival description]], [[Glossary#Authority record|authority record]], [[Glossary#Archival institution|archival institution]] and [[Glossary#Function|function]] are sorted by most recently updated; however, the user can select alphabetic sort if desired. Users can also browse by [[Glossary#Subject|subject]], [[Glossary#Place|place]], and [[Glossary#Digital object|digital object]] type.
-|- valign="top"
+</div>
-|width="600" |
-'''Purpose:'''
+== Error ==
-*Displays an individual record in full for data entry / editing.
-*Shows all fields.
-*Groups fields by collapsible sections: fields can be hidden or displayed by section.
-*Changes entered can be saved or cancelled.
-*Users can toggle between <span class="screen">View</span> or <span class="screen">Edit</span> screen.
+An [[Glossary#Error message|error message]] displays when ICA-AtoM is unable to execute an action. The following are typical types of [[Glossary#Error message|error messages]]:
-'''Availability:'''
+Page not found: broken link, report to system [[Glossary#Administrator|administrator]] and to ICA-AtoM support team.
-*Accessible to <span class="role">Contributors, Editors, Administrators</span>.
-*Not accessible to <span class="role">Researchers</span>.
-| width="500" align="right" |
+No access permission: your [[Glossary#User account|user account]] does not give you [[Glossary#Access privilege|access privileges]] to the requested page.
-[[Image:EditArchival.png|500px|right]]
+Locked term: [[Glossary#Term|term]] cannot be edited because it is referenced in the underlying code.
-|}
+No translation permission: you do not have [[Glossary#Translator|translator]] access in the current language.
+System error (error 500): indicates a fairly major system-wide problem, or problem with data corruption; report to [[Glossary#Administrator|administrator]].
+Blank page: indicates a fairly major system-wide problem, or problem with data corruption; report to [[Glossary#Administrator|administrator]] and to ICA-AtoM support team.
+</div>
+[[Category:User manual]]
+__NOTOC__