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: @@
-<span class="pageTitle">Page types</span>
+[[Main Page]] > [[User manual]] > [[Getting started]] > Page types
-[[Main Page]] > [[User manual]] > [[UM-2|UM-2 Getting started]] > UM-2.4 Page types
+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 page|Home page]]
+* [[#View|View]]
+* [[#Edit|Edit]]
+* [[#Search results|Search results]]
+* [[#Browse results|Browse results]]
+* [[#Error|Error]]
+<div class="clearfix">
+== Home page ==
+[[Image:homePage_1.png|500px|right|thumb|Home page: user is logged in]]
+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.
+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]].
+</div>
-This section describe 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:
+<div class="clearfix">
-* [[#Home page|Home page]]
+== View ==
-* [[#List page|List page]]
-* [[#View page|View page]]
+[[Image:viewPage.png|500px|right|thumb|View page for an archival description]]
-* [[#Edit page|Edit page]]
-* [[#Search results page|Search results page]]
+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.).
-* [[#Error page|Error page]]
+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.
+</div>
+== Edit ==
+[[Image:editPage.png|500px|right|thumb|Edit page for an archival description]]
+* 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]].
+</div>
+<div class="clearfix">
+== Edit digital object ==
+[[Image:digitalobjectpage.png|500px|right|thumb| 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.)
+</div>
+<div note="clearfix">
-== Home page ==
+== Search results ==
-[[Image:UM-2.4_1.png|500px|right|thumb|Home page: user is logged in]]
+[[Image:searchResults.png|500px|right|thumb|Search results page]]
-* Start page when user opens the application
+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]].
-* Provides links/buttons for user actions (search, browse, log in, log out, get help, switch language, add/edit content, translate, administer system)
-* Provides basic information about the application
-* Accessible to all users, but only shows elements relevant to user's role (e.g. the [[Glossary#Admin link|admin link]] is only available to [[Glossary#Editor|editors]] and [[Glossary#Administrator|administrators]]
-* Accessible from any other page by clicking the "home" link in the [[Glossary#User menu|user menu]]
-== List page ==
+</div>
-[[Image:UM-2.4_2.png|500px|right|thumb|List page showing archival descriptions]]
-* Displays a set of records in list form
+<div class="clearfix">
-* There are separate list pages for each of the main [[Glossary#Entity|entity]] types in the system ([[Glossary#Archival description|archival descriptions]], [[Glossary#Authority record|authority records]], [[Glossary#Archival institution|archival institutions]], and [[Glossary#Term|terms]])
-* Displays minimal information about each record (e.g. title)
-* Clicking on the [[Glossary#Field|field]] names in the [[Glossary#Column header|column headers]] will sort the list alphabetically
-* By default ICA-AtoM lists records ten at a time, providing pagination at the bottom of the page to allow users to navigate through long lists of records. [[Glossary#Administrator|Administrators]] can increase or decrease this default number (see [[UM-7.4.1|UM-7.4.1 Administer ICA-AtoM > Customize settings > Customize global settings]])
-* Allows user to click entry to go to full record in [[Glossary#View mode|view mode]]
-* Provides [[Glossary#Add new button|add new button]] to create new record of same type
-* Accessible to all users, but [[Glossary#Add new button|add new button]] not available to [[Glossary#Researcher|researchers]] (read-only access)
+== Browse results ==
-== View page ==
+[[Image:browseResults.png|500px|right|thumb|Browse results page; user is browsing authority records. Note browse menu directly below search box.]]
-[[Image:UM-2.4_3.png|500px|right|thumb|View page for an archival description]]
+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.
-* Displays an individual record in full in [[Glossary#View mode|view mode]] (read-only)
+</div>
-* Shows only [[Glossary#Field|fields]] that contain data
-* Allows user to click [[Glossary#Title bar|title bar]] or [[Glossary#Edit button|edit button]] to switch to [[Glossary#Edit mode|edit mode]] (data entry on [[Glossary#Edit page|edit page]])
-* Accessible to all users, but [[Glossary#Edit button|edit button]] not available to [[Glossary#Researcher|researchers]] (read-only access)
+== Error ==
-== Edit page ==
+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]]:
-[[Image:UM-2.4_4.png|500px|right|thumb|Edit page for an archival description]]
+Page not found: broken link, report to system [[Glossary#Administrator|administrator]] and to ICA-AtoM support team.
-* Displays an individual record in [[Glossary#Edit mode|edit mode]] for data entry
+No access permission: your [[Glossary#User account|user account]] does not give you [[Glossary#Access privilege|access privileges]] to the requested page.
-* Shows all [[Glossary#Field|fields]]
-* Groups [[Glossary#Field|fields]] by collapsible [[Glossary#Information area|information areas]]: [[Glossary#Field|fields]] can be hidden or displayed by section
-* Provides floating [[Glossary#Button block|button block]] that contains buttons for saving or canceling changes or deleting the record as a whole
-* Allows user to toggle between [[Glossary#View mode|view mode]] or [[Glossary#Edit mode|edit mode]] by clicking the [[Glossary#Title bar|title bar]]
-* Accessible to [[Glossary#Contributor|contributors]], [[Glossary#Editor|editors]], [[Glossary#Administrator|administrators]]; not accessible to [[Glossary#Researcher|researchers]] (read-only access)
+Locked term: [[Glossary#Term|term]] cannot be edited because it is referenced in the underlying code.
-== Search results page ==
+No translation permission: you do not have [[Glossary#Translator|translator]] access in the current language.
-[[Image:UM-2.4_5.png|500px|right|thumb|Search results page]]
+System error (error 500): indicates a fairly major system-wide problem, or problem with data corruption; report to [[Glossary#Administrator|administrator]].
-* Displays set of records that match search criteria and summarizes search (number of "hits" returned)
+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.
-* As of the current version of ICA-AtoM, only available for [[Glossary#Archival description|archival descriptions]]
-* Includes the first three lines of the Dublin Core "description" [[Glossary#Field|field]] (if entered)
-* Allows user to click title to go to full record in [[Glossary#View mode|view mode]]
-* Accessible to all users
+</div>
-== Error page ==
+[[Category:User manual]]
-* Displays an [[Glossary#Error message|error message]] when ICA-AtoM is unable to execute an action
+__NOTOC__
-* Page not found: broken link, report to system [[Glossary#Administrator|administrator]] and to ICA-AtoM support team
-* No access permission: your [[Glossary#User account|user account]] does not give you [[Glossary#Access privilege|access privileges]] to the requested page
-* 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