OPA Authorized User User Interface Design · Web view[Req: 3.13][Req: 3.4.1.2] A column that...
Transcript of OPA Authorized User User Interface Design · Web view[Req: 3.13][Req: 3.4.1.2] A column that...
National Archives and Records Administration
National Archives Catalog (The Catalog)
NARA-Catalog Authorized User Interface Design
– Catalog Perspective –Status-Final
Version 2.9July 24, 2015
National Archives & Records Administration
NARA Catalog Authorized User Interface Design
Kristen Martin
Archana Ballur
Madhu Koneni
Version 2.9
Contract Number GS-35F-0541U
Order Number NAMA-13-F-0120
July 24, 2015
NARA Catalog Authorized User Interface Design
Contents
1 Overview................................................................................................................8
2 Moderator Workbench...........................................................................................92.1 Moderator Permissions.....................................................................................................9
2.2 Moderator Home Page......................................................................................................9
2.3 Moderator Workbench Pages..........................................................................................12
2.3.1 Common Controls...................................................................................................12
2.3.2 Filtering in the Moderator Workbench...................................................................16
2.3.3 Configuring Reason Selector...................................................................................19
2.4 Tags Moderation..............................................................................................................21
2.4.1 Latest Tags Page......................................................................................................21
2.4.2 Removing a Tag.......................................................................................................24
2.4.3 Restoring a Tag........................................................................................................26
2.4.4 Viewing the Reason for Removing or Restoring a Tag.............................................28
2.5 Comments Moderation ...................................................................................................29
2.5.1 Latest Comments Page............................................................................................29
2.5.2 Removing a Comment.............................................................................................32
2.5.3 Restoring a Comment..............................................................................................34
2.5.4 Viewing the Reason for Removing or Restoring a Comment...................................36
2.6 Transcriptions Moderation..............................................................................................37
2.6.1 Latest Transcription Updates Page..........................................................................37
2.6.2 Viewing a Previous Transcription Version...............................................................41
2.6.3 Changing the Current Version.................................................................................43
2.6.4 Removing a Transcription........................................................................................45
2.6.5 Viewing the Reason for Changing a Current Transcription Version or Removing a Transcription.........................................................................................................................47
2.7 Translations Moderation [Implementation: R2/R3].........................................................48
2.7.1 Latest Translation Updates Page.............................................................................48
2.7.2 Viewing a Previous Translation Version..................................................................52
NARA Catalog Authorized User Interface Design
2.7.3 Changing the Current Version.................................................................................54
2.7.4 Removing a Translation...........................................................................................56
2.7.5 Viewing the Reason for Changing a Current Translation Version or Removing a Translation............................................................................................................................58
2.8 Moderator Action Stream................................................................................................58
2.8.1 Viewing the Reason for Removing or Restoring a Public Contribution....................61
2.9 Announcements Management........................................................................................61
2.10 Background Images Management...............................................................................64
2.11 Online Availability Notification Management..............................................................69
3 Account Administrator Workbench.......................................................................783.1 Account Administrator Permissions.................................................................................78
3.2 Account Administrator Home Page.................................................................................78
3.3 Account Administrator Workbench Pages.......................................................................80
3.3.1 Create an Account Page..........................................................................................81
3.3.2 User Account Creation Confirmation Page..............................................................84
3.3.3 Manage Accounts Page...........................................................................................85
3.3.4 Manage Account Page with Results........................................................................87
4 Featured Results...................................................................................................96
5 URL Mapping........................................................................................................975.1 URLs Independent of Physical Location...........................................................................97
5.2 Persistent URLs in the Catalog.........................................................................................98
6 UI Technology.....................................................................................................100
7 List of Figures......................................................................................................101
8 Requirements Index............................................................................................103
NARA Catalog Authorized User Interface Design
Version ControlVersion Date Reviewer Summary Description
1.1 2013-10-29 Paul Nelson Initial Outline
1.2 2014-01-03 Archana Ballur/Kristy Martin
Added Moderator and Account Administrator content. Added requirements public contributions.
1.3 2014-01-09 Kristy Martin/Archana Ballur
Revamped content to use action/event tables.
1.4 2014-01-30 Kristy Martin Updated document to incorporate new mockups and changes.
1.5 2014-02-05 Archana Ballur Updated mockups based on Feb 4 feedback.
1.6 2014-03-03 Kristy Martin Updated mockups and content based on Feb 5-7 meetings/comments. Correlated and indexed requirements. Captioned and referenced figures.
1.7 2014-03-18 Kristy Martin, Archana Ballur
Incorporating feedback from March 12th.
1.8 2014-04-01 Kristy Martin Updated content based on requirements dated March 27, 2014.
1.9 2014-04-04 Kristy Martin Updated content based on requirements dated April 2, 2014.
2.0 2014-04-09 Kristy Martin Updated content based on “ST 3_19_2014 Response to DRCF_OPAProdDesignDocuments_StakeholdersCommentsConsolidated_3_11_14 (4).docx”.
2.1 2014-04-21 Kristy Martin Updated URL Mapping based on NARA feedback April 17, 2014.
2.2 2014-05-16 Kristy Martin Removed some old TBDs and consolidated into one in section 2.3.3.
2.3 2014-09-09 Brandon Stahl Updated URLs in section 5.2.
2.4 2014-11-14 Kristy Martin Removed “Confidential to Search Technologies” text from the footer.
2.5 2014-11-24 Brandon Stahl Replaced https://research.archives.gov url with https://catalog.archives.gov url.
2.6 2015-04-21 Kristy Martin Added content for 1B, URLs info and a couple
6
NARA Catalog Authorized User Interface Design
missing requirements. Also updated “15 minutes” to “15 seconds” for a handful of reqs that had changed in R1.Added table captions per lead.
2.7 2015-05-07 Kristy Martin Updated content for 1b (section 5), fixed https issue (section 5.2).
2.8 2015-07-09 Kristy MartinBrandon Stahl
Changed branding for system name throughout document.Updated screenshots an content for R1P2R2; sections updated: 2, 2.2, 2.3.1, 2.3.2.1, 2.3.2.2, 2.4.2, 2.4.3,
2.4.4, 2.5.2, 2.5.3, 2.5.4, 2.6.1, 2.6.1.1, 2.6.2, 2.6.3, 2.6.4, 2.6.5, 2.8, 2.8.1, 2.9, 2.10, 2.11, 3.2,
3.3, 3.3.1, 3.3.1.1, 3.3.1.2, 3.3.2, 3.3.3, 3.3.4, 3.3.4.1, 3.3.4.1.1, 3.3.4.2, 3.3.4.3
2.9 2015-07-24 Kristy Martin Updated content based on “DRCF_NAC R1P2 combined 1b_Increment 2 Design_IQS_Consolidated_7_21_15V1 (1).docx”
7
NARA Catalog Authorized User Interface Design
1 Overview
This document shows the user interfaces in the National Archives Catalog for authorized users.
Note that these are only the interfaces which are entirely for authorized users’ functions, such as monitoring public contributions and managing user accounts.
Individual features for authorized users (for example, additional buttons and controls they might have as part of a standard user interface) will be described in the NARA Catalog User Interface Design Document.
8
NARA Catalog Authorized User Interface Design
2 Moderator Workbench
[Req: 16.10] All user contributions like transcriptions, translations, tags and comments do not go through an approval process. They are live as soon as a user posts them. Further, National Archives (NARA) administration staff can monitor the latest updates using the Moderator Workbench. [Req: 8.1.1.4] If they find any discrepancies or foul language usage, they can remove the text or revert to a previous version.
In addition to moderating user contributions, Moderators can manage the [Req: 16.10.5] announcement displayed on the Catalog Home page, [Req: 16.10.4] the rotating set of background images displayed in the home page, and [Req: 1.5.5.1.1.3] [Design Enhancement: DE-82a] [Req: 1.5.5.1.1.4] the online availability notifications displayed for some Archival Descriptions in the Content Details page.
2.1 Moderator PermissionsModerators are authorized users, typically NARA staff members, who have permissions that enable them to view and moderate the contributions of other Registered Users, including those of other Moderators and Account Administrators. Moderators are also Registered Users, so they are able to search, save results to lists and add contributions. (These functions are described in the NARA Catalog User Interface Design Document.)
Moderators can also have the Account Administrator role permissions. If so, Account Administrator options appear in the Moderator Home page once they log in using their Moderator user account.
2.2 Moderator Home PageAuthorized NARA staff can login to their account and review user contributions. Once logged into their account, the My Accounts page for the Moderator appears. This page does not appear for any other user but Moderators.
9
NARA Catalog Authorized User Interface Design
Figure 2.2: Moderator Homepage [Design Enhancement: DE-25]
The relevant elements for this page include the following:
Element Validation Behavior
Moderate User Contributions
The logged in user must be a Moderator.
A section header that identifies the section; these actions are specific to the Moderator role.
Moderate User Contributions shows the User contributions which the moderator can moderate.
Clicking on any public contribution under the Moderate User Contributions takes the user to Moderator Workbench.
Tags /Comments / Transcriptions / Translations
The logged in user must be a Moderator.
Links, which when clicked, take the Moderator to the moderator workbench of the selected public contribution.
Manage the Catalog Home Page
A section header that identifies the section; these actions are specific to the Moderator role; links include the following:
[Req: 16.10.5] Announcements: Clicking
10
NARA Catalog Authorized User Interface Design
on this link directs the moderator the Announcements page where they can manage the announcement t bar that can appear in the Catalog Home page.
[Req: 16.10.4] Background Images: Clicking on this link directs the moderator the Background Images page where they can manage the set of images that can appear in the Catalog Home page.
Manage the Online Availability Notification
A section header that identifies the section; this action is specific to the Moderator role; the link available is Online Availability Notification.
[Req: 1.5.5.1.1.3] [Design Enhancement: DE-82a] [Req: 1.5.5.1.1.4] Clicking on this link directs the moderator the Online Availability page where they can manage online availability notifications that appear for some Archival Descriptions in the Content Details page.
My Contributions The logged in user must be any type of Registered User.
A section header that identifies the section; these actions are available for any Registered User role. The behavior of these elements is identical to the behavior of the same functions for Registered Users as described in the NARA Catalog User Interface Design Document.
My Lists The logged in user must be any type of Registered User.
A section header that identifies the section; these actions are available for any Registered User role. The behavior of these elements is identical to the behavior of the same functions for Registered Users as described in the NARA Catalog User Interface Design Document.
Bulk Downloads The logged in user must be any type of Registered User.
A section header that identifies the section; these actions are available for any Registered User role. The behavior of these elements is identical to the behavior of the same functions for Registered Users as described in the NARA Catalog User Interface Design Document.
11
NARA Catalog Authorized User Interface Design
Account Information The logged in user must be any type of Registered User.
A section header that identifies the section; these actions are available for any Registered User role. The behavior of these elements is identical to the behavior of the same functions for Registered Users as described in the NARA Catalog User Interface Design Document.
User Type The logged in user must be a Moderator.
[Req: 16.3.2] A field that identifies the currently logged in user as a Moderator.
Table 2.2: Moderator Homepage elements
2.3 Moderator Workbench PagesAll Moderator Workbench pages are headed by a banner with the phrase, Moderator Workbench. The green banner was selected to help differentiate these pages from the Registered User’s My Account pages and the Account Administrator’s Workbench pages.
Figure 2.3: Moderation Workbench
2.3.1 Common Controls
Four tabs - Tags, Comments, Transcriptions, and Translations, are arranged horizontally across the top, below the Account Administrator Workbench banner. The tab that appears by default when the page is first loaded is the Tags tab. The currently selected tab is indicated by a short horizontal bar, styled using the same green as the banner.
The common controls for these pages include the following:
Element Validation Behavior
Header N/A A non-editable header that identifies the page.
# - # of # New, unmoderated A non-editable text field that indicates the
12
NARA Catalog Authorized User Interface Design
tags must be available for display in this page.
contribution range displayed in the currently viewed page.
The first # is the number of the first contribution displayed on the page. If this is the first page, this number is 1. If this is any page but the first, this number is determined by the currently selected Rows Per Page value, e.g., if 25 rows per page is selected, this number would be 26 on the second page of latest contributions.
The second # is the number of the last contribution displayed on the page. If the number of contributions is less than the currently selected Rows Per Page value, this number is the total number of contributions. If the number of contributions is more than the currently selected Rows Per Page value, this number is the same as the Rows Per Page value, e.g., if Rows Per Page is set to 25 and there are 40 contributions, the second # is 25.
The third # is the total number of latest, unmoderated contributions.
Pagination controls New, unmoderated tags must be available for display in this page.
[Req: 16.10.1] [Req: 16.10.2] [Req: 16.10.3] A set of controls that allow the Moderator to scroll through the current set of latest contributions.
Rows Per Page Options include: 25, 50, 100
New, unmoderated tags must be available for display in this page.
A drop-down list that specifies the number of latest contributions to display on the page.
Data table New, unmoderated contributions must be available for display in the page.
A table that displays the latest, unmoderated contributions as determined by the currently viewed tab.
Table 2.3.1-1: Moderator Workbench common controls
13
NARA Catalog Authorized User Interface Design
The relevant elements for pagination controls include the following:
Element Validation Behavior
Double left arrow icon (<<)
When the user is on the first page, this link is rendered in a medium gray font color to indicate it is inactive.
When the user is on any other page but the first, the font color is the standard link color to indicate it is active.
[Req: 16.10.2] A link, which when clicked, directs the user to the first page of contributions.
Left arrow icon (<) When the user is on the first page, this link is rendered in a medium gray font color to indicate it is inactive.
When the user is on any other page but the first, the font color is the standard link color to indicate it is active.
[Req: 16.10.2] A link, which when clicked, directs the user to the previous page of contributions.
Pagination Numbering
The total number of pages/links is the total number of results divided by the currently set Results per Page value.
When the page link is the currently view page, the text is rendered in bold,
[Req: 16.10.3] A link, which when clicked, directs the user to the selected page of contributions.
14
NARA Catalog Authorized User Interface Design
and the square is filled with a blue background to indicate is the currently viewed page.
Page [field] of # [Req: 16.10.3] A control that combines a dynamic text field with an input field.
Users can enter a number up to and including the last page of the contributions set to “jump” to that page. The default image value is 1 for the first page of contributions. After navigating to a different page, the page value updates to reflect the currently viewed page of contributions.
# represents the total number of pages in the contributions set.
Right arrow icon(>)
When the user is on the last page, this link is rendered in a medium gray font color to indicate it is inactive.
When the user is on any other page but the last, the font color is the standard link color to indicate it is active.
[Req: 16.10.1] A link, which when clicked, directs the user to the next page of contributions.
Double right arrow icon (>>)
When the user is on the last page, this link is rendered in a medium gray font color to indicate it is inactive.
When the user is on any other page but the last, the font
[Req: 16.10.1] A link, which when clicked, directs the user to the last page of r contributions.
15
NARA Catalog Authorized User Interface Design
color is the standard link color to indicate it is active.
Table 2.3.1-2: Moderator Workbench common controls - pagination
2.3.2 Filtering in the Moderator Workbench
[Req: 1.21] A Moderator can filter currently viewed contributions table, i.e., the data table found on the Tags, Comments, Transcriptions, or Translation tabs, by entering text found in the associated title of the archival description or authority record.
[Req: 1.20.1] In addition, a Moderator can search across search engine-indexed data using a NARA Identifier, if know, to locate an object within the currently viewed contributions table. For example, if the Moderator is currently viewing the Tags tab, they can search for a tag based on the NARA Identifier of the object the tag is applied.
[Req: 1.20] If the Moderator doesn’t know the exact NARA Identifier, they can run a search to locate the object they want to use as the filter.
2.3.2.1 Filter by ID
[Req: 1.20.1] A Moderator can search across search engine-indexed data using a specified NARA Identifier.
Figure 2.3.2.1-1: Filter By ID
Relevant elements for this functionality include the following:
Element Validation Behavior
Filter by ID Public contributions must appear in the table.
[Req: 1.20] [Req: 1.21] A text field label and input field that allows the Moderator to specify a NARA Identifier, if known, or text in the
16
NARA Catalog Authorized User Interface Design
associated title of the archival description or authority record.
X icon Characters must have been entered into the Filter by ID field and the Enter key pressed.
A clickable icon, which when clicked, removes the characters, resets the input field back to default, and removes any applied filter on the public contributions table.
Table 2.3.2.1: Moderator Workbench – Filter by ID elements
After the Moderator enters a NARA ID or text and then presses the Enter key on their keyboard, the public contributions table is filtered so that only the matching entries appear. An X icon is added to the Filter by ID input field. The Moderator clicks on the X icon to clear the field and the filter applied to the table.
Figure 2.3.2.1-2: Filter by ID – Filter Applied [Design Enhancement: DE-25]
2.3.2.2 Look Up ID
[Req: 1.20] If the Moderator doesn’t know the exact NARA Identifier, they can run a simple search to locate the object they want to use as the filter.
Relevant elements for this functionality include the following:
Element Validation Behavior
Lookup ID… Public contributions must appear in the
[Req: 1.20.1] A button, which when clicked, launches a pop-up that allows the Moderator to
17
NARA Catalog Authorized User Interface Design
table. run a simple search.
Table 2.3.2.2-1: Moderator Workbench – Lookup ID elements
Figure 2.3.2.2: Look up ID Pop Up [Design Enhancement: DE-601]
Relevant elements for the Lookup ID pop-up include the following:
Element Validation Behavior
Search Online Public Access
The Moderator must have launched the Lookup ID pop-up.
An input field where the Moderator enters a search string.
Search The Moderator must have launched the Lookup ID pop-up.
A button, which when clicked, runs a search using the Moderator’s entered query string.
Common controls The Moderator must have clicked on the Search button. Search results must have been returned.
For more information, please refer to the Common Controls section.
Choose The Moderator must have clicked on the
A button, which when clicked, selects the
18
NARA Catalog Authorized User Interface Design
Search button. Search results must have been returned.
corresponding result and uses that as the filter.
Results list The Moderator must have clicked on the Search button. Search results must have been returned.
A list of results and associated thumbnails and metadata that match the entered query string in the Online Public Access input field. For details on the formatting of the results and the metadata displayed, please refer to the NARA Catalog User Interface Design Document.
Table 2.3.2.2-2: Moderator Workbench – Lookup ID modal elements
After the Moderator clicks on a Choose button, the NARA Identifier of the selected object appears in the Filter by ID input field and the table is filtered as described in the Filter by ID section of this document.
2.3.3 Configuring Reason Selector
[Req: 5.6.2.1.1] [Req: 5.6.2.1] [Req: 5.6.3.1.1] [Req: 5.6.3.1] [Req: 6.4.2.1.1] [Req: 6.4.2.1] [Req: 6.4.3.1.1] [Req: 6.4.3.1] [Req: 3.4.3.1.1] [Req: 3.4.3.1] [Req: 3.4.2.1.1] [Req: 3.4.2.1] [Req: 3.4.2.2.1] [Req: 3.4.3.2.1] [Req: 4.8.3.1.1] [Req: 4.8.3.1] [Req: 4.8.2.1.1] [Req: 4.8.2.1] [Req: 4.8.2.2.1] [Req: 4.8.3.2.1] A set of default reasons are included in the Reason drop-down list, and will be defined during systems configuration.
Moderators can also add reasons that will appear in the Reason drop-down list accessible when removing or restoring any public contribution, i.e., [Req: 5.6.2.3] [Req: 5.6.3.3]Tags, [Req: 6.4.4.2] [Req: 6.4.3.3] Comments, [Req: 3.4.2.3] [Req: 3.4.3.3] Transcriptions, and [Req: 4.8.2.3] [Req: 4.8.3.3]Translations.
19
NARA Catalog Authorized User Interface Design
Figure 2.3.3-1: Reason Drop-down List – “Create new reason…” Option
Relevant elements for the “Create new reason…” function include the following:
Element Validation Behavior
Create new reason… The Moderator must have performed a Remove or Restore action on a public contribution and must have clicked on the Reason drop-down list.
A link, which when clicked, launches the Configure Reason Selector pop-up.
Table 2.3.3-1: “Create new reason” link elements
20
NARA Catalog Authorized User Interface Design
Figure 2.3.3-2: Configure Reason Selector
Relevant elements for the Configure Reason Selector pop-up include the following:
Element Validation Behavior
Header The Moderator must have selected the “Create new reason…” option in the Reason drop-down list.
A text label to identify the pop-up.
Close link The Moderator must have selected the “Create new reason…” option in the Reason drop-down list.
A link, which when clicked, closes the pop-up and reverses any changes made within.
New Reason A text field and an input field that allows the Moderator to enter text to be used as a new reason to select when removing or restoring public contributions.
Add A reason must have been entered in the New Reason field.
A button, which when clicked, saves the reason entered as a new entry in the Reason drop-down list and closes the pop-up.
Cancel N/A A link that, when clicked, reverses any changes made to the previously saved state and closes the pop-up.
Table 2.3.3-2: Configure Reason Selector modal elements
After the Moderator clicks on the Add button, the Configure Reason Selector pop-up closes, and the new entry appears in the Reason drop-down list.
2.4 Tags Moderation[Req: 5.2] [Req: 5.3] Tags can be posted to records that have online holdings, like images, audio, video and other types of media files. Tags can be posted at both the [Req: 5.1] object level and at the [Req: 5.18] description level. [Req: 5.6] [Req: 5.6.1] These tags are fed to the Moderator
21
NARA Catalog Authorized User Interface Design
Workbench within 15 seconds of being submitted by a user where the Moderators can [Req: 5.6.2] delete the tag if they find any discrepancies. [Req: 5.6.3] They can also restore tags.
2.4.1 Latest Tags Page
[Req: 5.6] Authorized NARA staff can login to their account and review user contributions. All user contributed data will be listed under Moderator Workbench. Moderators can select the contributions they want to review using the tabs. To access this page, the Moderator clicks on the Tags link in the Moderator home page or by clicking on the Tags tab from any other Moderator page
Figure 2.4.1: Latest Tags Page
The relevant elements for this page include the following:
Element Validation Behavior
Latest Tags N/A A non-editable header that identifies the page.
Common controls For more information, please refer to the Common Controls section.
Tags table New, unmoderated tags must be available for display in this page.
A table that displays the latest, unmoderated tags.
Table 2.4.1-1: Latest Tags page elements
The following columns are available in the tags table:
Element Validation Behavior
NO. New, unmoderated A column that displays the row number.
22
NARA Catalog Authorized User Interface Design
tags must be available for display in this page.
TAG New, unmoderated tags must be available for display in this page.
A column that contains the unmoderated tag.
TITLE New, unmoderated tags must be available for display in this page.
A column that contains the title of the record where the tag was added. The title is linked; when clicked, the Content Details page for the record opens in a separate browser window/tab.
IMAGE New, unmoderated tags must be available for display in this page.
A column that contains the image number of the record where the tag was added. If the tag was added to an object of a record, the value that appears in this column is #/# where the first number is the image number and the second # is the total number of images associated with the record.
If the tag was added to the description level of the record, Description appears in the column.
The IMAGE value is linked; when clicked, the Content Details page for the record opens in a separate browser window/tab. If the IMAGE value is an image number, e.g., 1/3, the workspace of that image is also displayed and the Tags tab is selected.
USER New, unmoderated tags must be available for display in this page.
[Req: 5.6.1.1] A column that contains the username or full name (dependent on the user’s account settings) of the user who added the tag. The username value is linked to the user’s profile. Clicking on the user name opens a new browser window/tab and displays the user’s contributions page.
MODIFIED New, unmoderated tags must be available for display in this page.
[Req: 5.6.1.2] A column that contains the date and time the tag was added. [Req: 5.6.1.3] By default, the date is relative to the time the Moderator is currently viewing the tag, i.e., if the tag was added at noon and the Moderator views
23
NARA Catalog Authorized User Interface Design
the tag entry at 1:00 pm the same day in the Moderator Workbench, the Modified date appears as 1 hour ago.
ACTION New, unmoderated tags must be available for display in this page.
A column that contains buttons available to perform on the Tag: Remove, Restore.
Remove [Req: 5.6.2] A button, which when clicked, expands the row and displays the tag removal controls; for more information, please refer to the Removing a Tag section.
Restore A button, which when clicked, expands the row and displays the tag restoration controls; for more information, please refer to the Restoring a Tag section.
NOTE New, unmoderated tags must be available for display in this page.
A column that contains a Note icon; this icon only appears if the tag was either removed and/or restored.
Table 2.4.1-2: Latest Tags data columsn
2.4.2 Removing a Tag
[Req: 5.6.2] Clicking on the Remove button in the Latest Tags page expands the row of the corresponding tag; removal controls are displayed.
24
NARA Catalog Authorized User Interface Design
Figure 2.4.2-1: Removing a Tag
The following elements are relevant to the Latest Tags page when in tag-removal mode:
Element Validation Behavior
Reason The Moderator must have clicked on a Remove button for a tag.
[Req: 5.6.2.1.1] A drop-down list that indicates the reason for removal. [Req: 5.6.2.1] The moderator who chooses to remove the tag must select a reason explaining why the tag is being removed.
[Req: 5.6.2.3] Moderators can configure the list of reasons for removing tags. For more information, please refer to the Configuring Reason Selector section of this document.
Enter additional comments…
(grey placeholder)
The Moderator must have clicked on a Remove button for a tag.
[Req: 5.6.2.1.2] A text input field that provides the option for the Moderator to add additional details for the removal of the tag.
Confirm The Moderator must have clicked on a Remove button for a tag.
The moderator must
A button, which, when clicked, confirms the removal of the tag and collapses the row.
25
NARA Catalog Authorized User Interface Design
have selected a reason for removal from the Reason drop-down.
Cancel N/A A link that, when clicked, reverses any changes made to the previously saved state and collapses the row, thus returning the row to its pre-removal mode.
Table 2.4.2: Latest Tags page elements – Edit mode
[Req: 5.6.2.2] After the Moderator removes a tag, the change is available for viewing in the Latest Tags table within 15 seconds after being removed.
In the screenshot below, the first tag was removed. The tag styling changes so that the background is gray, and the text appears in a medium gray to indicate it is no longer clickable. In addition, the text associated with the tag is struck-through. [Req: 5.6.2.1] Since a reason is required for removing a tag, a Note icon appears in the same row.
Figure 2.4.2-2: Tag Has Been Removed [Design Enhancement: DE-25]
26
NARA Catalog Authorized User Interface Design
2.4.3 Restoring a Tag
After a tag is removed, the Remove button toggles to a Restore button. [Req: 5.6.3] Clicking on the Restore button in the Latest Tags page expands the row of the corresponding tag; restoration controls are displayed. This function is almost identical to the Remove function and uses the same controls.
Figure 2.4.3: Restoring a Tag [Design Enhancement: DE-25]
The following elements are relevant to the Latest Tags page when in tag-restoration mode:
Element Validation Behavior
Reason The Moderator must have clicked on a Restore button for a tag.
[Req: 5.6.3.1.1] A drop-down list that indicates the reason for restoration. [Req: 5.6.3.1] The moderator who chooses to restore the tag must select a reason explaining why the tag is being restored.
[Req: 5.6.3.3]Moderators can configure the list of reasons for restoring tags. For more information, please refer to the Configuring Reason Selector section of this document.
Enter additional The Moderator must have clicked on a
[Req: 5.6.3.1.2] A text input field that provides the option for the Moderator to add additional
27
NARA Catalog Authorized User Interface Design
comments…
(grey placeholder)
Restore button for a tag.
details for the restoring of the tag.
Confirm The Moderator must have clicked on a Restore button for a tag.
The moderator must have selected a reason for restoration from the Reason drop-down.
A button, which, when clicked, confirms the restoration of the tag and collapses the row.
Cancel N/A A link that, when clicked, reverses any changes made to the previously saved state and collapses the row.
Table 2.4.3: Latest Tags page elements – Restore mode
[Req: 5.6.3.2] After the Moderator restores a tag, the change is available for viewing in the Latest Tags table within 15 seconds after being restored.
The tag styling changes so that the background is white and the text appears as a blue link. In addition, the text associated with the tag is no longer struck-through. [Req: 5.6.3.1] Since a reason is required for restoring a tag, a Note icon appears in the same row.
2.4.4 Viewing the Reason for Removing or Restoring a Tag
After a tag is removed or restored and the Moderator has provided a reason for the action, a Note icon appears in the NOTE column. [Req: 5.6.3] Clicking on the Note icon expands the row of the corresponding tag.
28
NARA Catalog Authorized User Interface Design
Figure 2.4.4: Viewing the Reason for Removing a Tag [Design Enhancement: DE-25]
The following elements are relevant to the Latest Tags page when in note-viewing mode:
Element Validation Behavior
Moderator Log The Moderator must have removed or restored a tag.
[Req: 5.6.2.2.1] [Req: 5.6.3.2.1] A field that displays the Moderator name who performed the action, the action date/time stamp, the reason selected, and any additional comments about the action.
Table 2.4.4: Latest Tags page elements – Moderation Log
2.5 Comments Moderation [Req: 6.2.1] [Req: 6.2.4] Comments can be posted to records which have online holdings like images, audio, video and other types of media files. Comments can be posted both at the object level [Req: 6.2] and at the description level [Req: 6.1]. [Req: 6.3] Each comment can have unlimited replies. Replies cannot have replies.
[Req: 6.4] [Req: 6.4.1] These comments are fed to the Moderator Workbench within 15 seconds of being submitted by a user where the Moderators can [Req: 6.4.2] delete the comment if they find any discrepancies. [Req: 6.4.3] They can also restore comments.
29
NARA Catalog Authorized User Interface Design
[Req: 6.31] The Catalog System Administrator can configure the length of time in which comments are displayed in the Latest Comments page.
2.5.1 Latest Comments Page
[Req: 6.4] Authorized NARA staff can login to their account and review user contributions. All user contributed data will be listed under Moderator Workbench. Moderators can select the contributions they want to review using the tabs. To access this page, the Moderator clicks on the Comments link in the Moderator home page or by clicking on the Comments tab from any other Moderator page.
Figure 2.5.1: Latest Comments Page
The relevant elements for this page include the following:
Element Validation Behavior
Latest Comments N/A A non-editable header that identifies the page.
Common controls For more information, please refer to the Common Controls section.
Comments table New, unmoderated comments must be available for display in this page.
A table that displays the latest, unmoderated comments.
Table 2.5.1-1: Latest Comments page elements
The following columns are available in the comments table:
30
NARA Catalog Authorized User Interface Design
Element Validation Behavior
NO. New, unmoderated comments must be available for display in this page.
A column that displays the row number.
COMMENT New, unmoderated comments must be available for display in this page.
A column that contains the unmoderated comment.
TITLE New, unmoderated comments must be available for display in this page.
A column that contains the title of the record where the comment was posted. The title is linked; when clicked, the Content Details page for the record opens in a separate browser window/tab.
IMAGE New, unmoderated comments must be available for display in this page.
A column that contains the image number of the record where the comment was posted. If the comment was posted on an object of a record, the value that appears in this column is #/# where the first number is the image number and the second # is the total number of images associated with the record.
If the comment was posted on the description level of the record, Description appears in the column.
The IMAGE value is linked; when clicked, the Content Details page for the record opens in a separate browser window/tab. If the IMAGE value is an image number, e.g., 1/3, the workspace of that image is also displayed and the Comments tab is selected.
USER New, unmoderated comments must be available for display in this page.
[Req: 6.4.1.1] A column that contains the username or full name (dependent on the user’s account settings) of the user who posted the comment. The username value is linked to the user’s profile. Clicking on the user name opens a new browser window/tab and displays the user’s contributions page.
31
NARA Catalog Authorized User Interface Design
MODIFIED New, unmoderated comments must be available for display in this page.
[Req: 6.4.1.2] A column that contains the date and time the comment was posted. [Req: 6.4.1.3] By default, the date is relative to the time the Moderator is currently viewing the comment, i.e., if the comment was posted at noon and the Moderator views the comment entry at 1:00 pm the same day in the Moderator Workbench, the Modified date appears as 1 hour ago.
ACTION New, unmoderated comments must be available for display in this page.
A column that contains buttons available to perform on the comment: Remove, Restore.
Remove [Req: 6.4.2] A button, which when clicked, expands the row and displays the comment removal controls; for more information, please refer to the Removing a Comment section.
Restore A button, which when clicked, expands the row and displays the comment restoration controls; for more information, please refer to the Restoring a Comment section.
NOTE New, unmoderated comments must be available for display in this page.
A column that contains a Note icon; this icon only appears if the comment was either removed and/or restored.
Table 2.5.1-2: Latest Comments data columns
2.5.2 Removing a Comment
[Req: 6.4.2] Clicking on the Remove button in the Latest Comments page expands the row of the corresponding comment; removal controls are displayed.
32
NARA Catalog Authorized User Interface Design
Figure 2.5.2-1: Removing a Comment
The following elements are relevant to the Latest Comments page when in comment-removal mode:
Element Validation Behavior
Reason The Moderator must have clicked on a Remove button for a comment.
[Req: 6.4.2.1.1] A drop-down list that indicates the reason for removal. [Req: 6.4.2.1] The moderator who chooses to remove the comment must select a reason explaining why the comment is being removed.
[Req: 6.4.4.2] Moderators can configure the list of reasons for removing comments. For more information, please refer to the Configuring Reason Selector section of this document.
Reason The Moderator must have clicked on a Remove button for a comment.
[Req: 6.4.2.1.2] A text input field that provides the option for the Moderator to add additional details for the removal of the comment.
Confirm The Moderator must have clicked on a Remove button for a comment.
A button, which, when clicked, confirms the removal of the comment and collapses the row.
33
NARA Catalog Authorized User Interface Design
The moderator must have selected a reason for removal from the Reason drop-down.
Cancel N/A A link that, when clicked, reverses any changes made to the previously saved state and collapses the row, thus returning the row to its pre-removal mode.
Table 2.5.2: Latest Comments page elements – Remove comment
[Req: 6.4.4] After the Moderator removes a comment, the change is available for viewing in the Latest Comments table within 15 seconds after being removed.
In the screenshot below, the first comment was removed. The text associated with the comment is struck-through. [Req: 6.4.2.1] Since a reason is required for removing a comment, a Note icon appears in the same row.
Figure 2.5.2-2: Comment Has Been Removed [Design Enhancement: DE-25]
[Req: 6.4.2.2] Even when the original comment has been removed by a Moderator, any replies remain displayed. For more information, please refer to the NARA Catalog User Interface Design document.
34
NARA Catalog Authorized User Interface Design
2.5.3 Restoring a Comment
After a comment is removed, the Remove button toggles to a Restore button. [Req: 6.4.3] Clicking on the Restore button in the Latest Comments page expands the row of the corresponding comment; restoration controls are displayed. This function is almost identical to the Remove function and uses the same controls.
Figure 2.5.3: Restoring a Comment [Design Enhancement: DE-25]
The following elements are relevant to the Latest Comments page when in comment-restoration mode:
Element Validation Behavior
Reason The Moderator must have clicked on a Restore button for a comment.
[Req: 6.4.3.1.1] A drop-down list that indicates the reason for restoration. [Req: 6.4.3.1] The moderator who chooses to restore the comment must select a reason explaining why the comment is being restored.
[Req: 6.4.3.3] Moderators can configure the list of reasons for restoring comments. For more information, please refer to the Configuring Reason Selector section of this document.
Reason The Moderator must have clicked on a Restore button for a
[Req: 6.4.3.1.2] A text input field that provides the option for the Moderator to add additional
35
NARA Catalog Authorized User Interface Design
comment. details for the restoration of the comment.
Confirm The Moderator must have clicked on a Restore button for a comment.
The moderator must have selected a reason for restoration from the Reason drop-down.
A button, which, when clicked, confirms the restoration of the comment and collapses the row.
Cancel N/A A link that, when clicked, reverses any changes made to the previously saved state and collapses the row.
Table 2.5.3: Latest Comments page elements – Restore comment
[Req: 6.4.3.2] After the Moderator restores a comment, the change is available for viewing in the Latest Comments table within 15 seconds after being restored.
The text associated with the comment is no longer struck-through. [Req: 6.4.3.1] Since a reason is required for restoring a comment, a Note icon appears in the same row.
2.5.4 Viewing the Reason for Removing or Restoring a Comment
After a comment is removed or restored and the Moderator has provided a reason for the action, a Note icon appears in the NOTE column. [Req: 6.4.4.1] [Req: 6.4.3.2.1] Clicking on the Note icon expands the row of the corresponding comment.
36
NARA Catalog Authorized User Interface Design
Figure 2.5.4: Viewing the Reason for Removing a Comment [Design Enhancement: DE-25]
The following elements are relevant to the Latest Comments page when in note-viewing mode:
Element Validation Behavior
Moderator Log The Moderator must have removed or restored a comment.
[Req: 6.4.4.1] [Req: 6.4.3.2.1] A field that displays the Moderator name who performed the action, the action date/time stamp, the reason selected, and any additional comments about the action.
Table 2.5.4: Latest Comments page elements – Moderation Log
2.6 Transcriptions Moderation[Req: 3.1] [Req: 3.1.2.1] Transcriptions can be submitted to records which have online holdings like images, audio, video and other types of media files. [Req: 3.1.2] Transcription is available at object level. [Req: 3.2] Users can edit the transcription posted by another user. At a given time, only one transcription version is active.
For example, if user Alice posts the first version of transcription say v1, user Bob can edit Alice’s version and then the latest version edited by Bob say v2 will become the active version.
[Req: 3.4] [Req: 3.4.1] [Req: 3.4.1.3] These latest transcription versions are fed to the Moderator Workbench within 15 seconds of being submitted by a user where the Moderators can [Req:
37
NARA Catalog Authorized User Interface Design
3.4.2] delete the transcription if they find any discrepancies. [Req: 3.4.3] They can also select a previous version as the current version.
For example, if Bob’s v2 version has foul language or any discrepancies, a Moderator can delete Bob’s version, which will mark Bob’s version as removed. The transcription will still remain in the system for logging purposes or for reverting to a previous version. By default, when Bob’s version is removed, the previous version becomes active. In this case, Alice’s version will become active.
2.6.1 Latest Transcription Updates Page
[Req: 3.4] [Req: 3.4.1] [Req: 3.4.1.3] Authorized NARA staff can login to their account and review user contributions. All user contributed data will be listed under Moderator Workbench. Moderators can select the contributions they want to review using the tabs. To access this page, the Moderator clicks on the Transcriptions link in the Moderator home page or by clicking on the Transcriptions tab from any other Moderator page.
Figure 2.6.1: Latest TranscriptionUpdates Page [Design Enhancement: DE-25]
The relevant elements for this page include the following:
Element Validation Behavior
Latest Transcription Updates
N/A A non-editable header that identifies the page.
Common controls For more information, please refer to the Common Controls section.
Transcriptions table New, unmoderated [Req: 3.4.1.3]A table that displays the latest,
38
NARA Catalog Authorized User Interface Design
transcriptions must be available for display in this page.
unmoderated transcriptions.
Table 2.6.1-1: Latest Transcriptions page elements
The following columns are available in the transcriptions table:
Element Validation Behavior
NO. New, unmoderated transcriptions must be available for display in this page.
A column that displays the row number.
TITLE New, unmoderated transcriptions must be available for display in this page.
A column that contains the title of the record where the transcription was created/edited. The title is linked; when clicked, the Content Details page for the record opens in a separate browser window/tab.
IMAGE New, unmoderated transcriptions must be available for display in this page.
A column that contains the image number of the record where the transcription was created/edited. If the transcription was created/edited on an object of a record, the value that appears in this column is #/# where the first number is the image number and the second # is the total number of images associated with the record.
The IMAGE value is linked; when clicked, the Content Details page for the record opens in a separate browser window/tab and then the workspace of that image is also displayed and the Transcription tab is selected.
USER New, unmoderated transcriptions must be available for display in this page.
[Req: 3.4.1.1] A column that contains the username or full name (dependent on the user’s account settings) of the user who created/edited the transcription. The username value is linked to the user’s profile. Clicking on the user name opens a new browser window/tab and displays the user’s contributions page.
39
NARA Catalog Authorized User Interface Design
MODIFIED New, unmoderated transcriptions must be available for display in this page.
[Req: 3.13][Req: 3.4.1.2] A column that contains the date and time the transcription was created/edited. [Req: 3.4.1.4] By default, the date is relative to the time the Moderator is currently viewing the transcription, i.e., if the transcription was created/edited at noon and the Moderator views the transcription entry at 1:00 pm the same day in the Moderator Workbench, the Modified date appears as 1 hour ago.
TYPE New, unmoderated transcriptions must be available for display in this page.
Options include the following:
New Update
A column that indicates if the transcription text is of type New or Update:
New: When the transcription text was posted for the first time for that object.
Update: When the transcription text was an edit.
NOTE New, unmoderated transcriptions must be available for display in this page.
A column that contains a Note icon; this icon only appears if the transcription was either removed and/or restored.
Transcription text New, unmoderated transcriptions must be available for display in this page.
A non-editable text field that initially displays a snippet of the transcription text.
Review New, unmoderated transcriptions must be available for display in this page.
A link, which when clicked, expands the transcription field to view more text.
Table 2.6.1-2: Latest Transcriptions data columns
2.6.1.1 Expanded Transcription Field
After the Moderator clicks on the Review link, the transcription field expands to display more text.
40
NARA Catalog Authorized User Interface Design
Figure 2.6.1.1: Expanded Transcription field [Design Enhancement: DE-25]
The following elements are available when the transcription is in expanded mode:
Element Validation Behavior
Transcription text N/A Additional text is displayed in the expanded, non-editable transcription text field.
Vertical scrollbar N/A A vertical scrollbar appears on the right side of the transcription text field. Its state is determined by the amount of text to display.
If there is more text than can appear in the field, the scrollbar is active and appears so, but if there is not, the scrollbar is not active and appears grayed out.
View Previous Versions
A previous version for the expanded transcription must exist.
[Req: 3.4.3] A link, which when clicked, launches the Previous Versions pop-up.
Remove N/A [Req: 3.4.2] A button, which when clicked, launches the Remove Transcription pop-up.
Cancel N/A A link that, when clicked, reverses any changes made to the previously saved state and collapses the row.
41
NARA Catalog Authorized User Interface Design
Table 2.6.1.1: Latest Transcriptions page elements – Expanded field
2.6.2 Viewing a Previous Transcription Version
[Req: 3.4.3] Moderator can view previous versions of a transcription text by clicking on View Previous Versions link. The Previous Versions pop-up appears. In this pop-up, the Moderator can view simultaneously the current version and any previous version. The top text field shows the current active transcription text, while the bottom text field shows the immediate previous version.
Figure 2.6.2: Viewing Previous Transcriptions [Design Enhancement: DE-601]
The following elements are relevant to the Previous Versions pop-up:
Element Validation Behavior
Header A previous version for the expanded transcription must exist.
A non-editable text field that identifies the pop-up.
Close A previous version for the expanded transcription must exist.
A link, which when clicked, closes the pop-up.
Title A previous version for the expanded transcription must exist.
A non-editable text field that contains the title of the record where the transcription was created/edited, appended with the image number of the transcribed object.
Current Version – A previous version A non-editable text field that identifies the
42
NARA Catalog Authorized User Interface Design
header for the expanded transcription must exist.
version number of the current version, the username or full name of the user who created the current version, and the general timeframe of when the current was created/edited.
Current Version A previous version for the expanded transcription must exist.
A non-editable text field that displays the current version of the transcription.
Current Version –Vertical scrollbar
A previous version for the expanded transcription must exist.
A vertical scrollbar appears on the right side of the transcription text field. Its state is determined by the amount of text to display.
If there is more text than can appear in the field, the scrollbar is active and appears so, but if there is not, the scrollbar is not active and appears grayed out.
Select Previous Version
A previous version for the expanded transcription must exist.
A drop-down that lists all versions (version number, action type that generated the version, and general timeframe of when that version was created/edited) of the currently viewed transcription.
Make This Current Version
A previous version for the expanded transcription must exist.
[Req: 3.4.3] A link, which when clicked, makes the selected version the current version. This can be used to restore a previously removed transcription.
Previous Version A previous version for the expanded transcription must exist.
A non-editable text field that displays the immediate previous version of the transcription on initial load. If the Moderator selects another previous version, the text of the selected version appears in the text field.
Previous Version – Vertical scrollbar
A previous version for the expanded transcription must exist.
A vertical scrollbar appears on the right side of the transcription text field. Its state is determined by the amount of text to display.
If there is more text than can appear in the field, the scrollbar is active and appears so, but if there is not, the scrollbar is not active and appears grayed out.
43
NARA Catalog Authorized User Interface Design
Table 2.6.2: Previous Versions modal elements
2.6.3 Changing the Current Version
[Req: 3.4.3] A Moderator can make any previous version the current, active version by clicking on the Make This Current Version link. When the link is clicked, an expandable section appears.
Figure 2.6.3: Changing the Currrent Version [Design Enhancement: DE-601]
The following elements are relevant to the Previous Versions pop-up after the Make This Current Version link is clicked:
Element Validation Behavior
Reason The Moderator must have clicked on the Make This Current Version link.
[Req: 3.4.3.1.1] A drop-down list that indicates the reason for activating a previous version. [Req: 3.4.3.1] The moderator who chooses to activate a previous version must select a reason explaining why the transcription is being made current.
[Req: 3.4.3.3] Moderators can configure the list of reasons for restoring transcriptions. For more information, please refer to the Configuring Reason Selector section of this document.
Reason The Moderator must have clicked on the Make This Current Version link.
[Req: 3.4.3.1.2] A text input field that provides the option for the Moderator to add additional details for making the transcript current.
44
NARA Catalog Authorized User Interface Design
Confirm The Moderator must have clicked on the Make This Current Version link.
The moderator must have selected a reason for restoration from the Reason drop-down.
A button, which, when clicked, confirms the activation of the transcription and collapses the row.
Cancel The Moderator must have clicked on the Make This Current Version link.
A link that, when clicked, reverses any changes made to the previously saved state and collapses the row, thus returning the row to its pre-removal mode.
Table 2.6.3: Previous Versions modal elements – Changing versions
After the Moderator clicks on the Confirm button, the Current Version header now displays the new version number, the username or full name of the user who created/edited the transcription and the general timeframe it was created/edited. In addition, the transcription text field is updated to display the associated transcript text. The Previous Version header and text field are now set so that the previous version is now displayed as the Previous Version. For example, assuming a transcription has three versions and Version 3 is current, if the Moderator selects Version 2 to make current, Version 3, the former Current, become the Previous Version displayed in the Previous Version pop-up.
[Req: 3.4.3.2] After the Moderator restores a transcription, the change is available for viewing in the Latest Transcription Updates table within 15 seconds after being restored.
2.6.4 Removing a Transcription
[Req: 3.4.2] A Moderator can remove any current transcription version by clicking on the Review link to expand the row and then clicking on the Remove button. The Remove Transcription pop-up appears.
45
NARA Catalog Authorized User Interface Design
Figure 2.6.4: Removing a Transcription [Design Enhancement: DE-601]
The following elements are relevant to the Previous Versions pop-up after the Make This Current Version link is clicked:
Element Validation Behavior
Reason The Moderator must have clicked on the Make This Current Version link.
[Req: 3.4.2.1.1] A drop-down list that indicates the reason for removing the current version of a transcription. [Req: 3.4.2.1] The moderator who chooses to remove the transcription must select a reason explaining for the removal.
[Req: 3.4.2.3] Moderators can configure the list of reasons for removing transcriptions. For more information, please refer to the Configuring Reason Selector section of this document.
Reason The Moderator must have clicked on the Make This Current Version link.
[Req: 3.4.2.1.2] A text input field that provides the option for the Moderator to add additional details for the transcript removal.
Confirm The Moderator must have clicked on the Make This Current Version link.
A button, which, when clicked, confirms the transcription removal and closes the pop-up.
46
NARA Catalog Authorized User Interface Design
The moderator must have selected a reason for restoration from the Reason drop-down.
Cancel The Moderator must have clicked on the Make This Current Version link.
A link that, when clicked, reverses any changes made to the previously saved state and closes the pop-up.
Table 2.6.4: Remove Transcription modal elements
After the Moderator clicks on the Confirm button, any previously saved version of the removed transcription becomes the current version.
[Req: 3.4.2.2] After the Moderator removes a transcription, the change is available for viewing in the Latest Transcription Updates table within 15 seconds after being removed.
2.6.5 Viewing the Reason for Changing a Current Transcription Version or Removing a Transcription
After a transcription is removed or restored (via changing current version) and the Moderator has provided a reason for the action, a Note icon appears in the NOTE column. [Req: 3.4.2.2.1] [Req: 3.4.3.2.1] Clicking on the Note icon expands the row of the corresponding transcription.
Figure 2.6.5: Viewing the Reason for Removing a Transcription [Design Enhancement: DE-25]
47
NARA Catalog Authorized User Interface Design
The following elements are relevant to the Latest Transcriptions page when in note-viewing mode:
Element Validation Behavior
Moderator Log The Moderator must have removed or restored a transcription.
[Req: 3.4.2.2.1] [Req: 3.4.3.2.1] A field that displays the Moderator name who performed the action, the action date/time stamp, the reason selected, and any additional transcriptions about the action.
Table 2.6.5: Latest Transcriptions page elements – Moderation Log
2.7 Translations Moderation [Implementation: R2/R3][Req: 4.1.1] [Req: 4.2.1] [Req: 4.3] [Req: 4.4] [Req: 4.5] Translations can be submitted to records which have online holdings like images, audio, video and other types of media files. [Req: 4.6] Translations are available at object level one per language. [Req: 4.6.1] [Req: 4.6.2] [Req: 4.6.3] Users can edit the translation posted by another user. [Req: 4.1.1.1] At a given time, only one translation version per language is active.
For example, if user Alice posts the first version of Spanish translation say v1, user Bob can edit Alice’s version and then the latest version edited by Bob say v2 will become the active version.
[Req: 4.8] [Req: 4.8.1] [Req: 4.8.1.3] These translation versions are fed to the Moderator Workbench within 15 seconds of being submitted by a user where the Moderators can [Req: 4.8.2] delete the translation if they find any discrepancies. [Req: 4.8.3] They can also select a previous version as the current version.
[Req: 4.26] The Catalog System Administrator can configure the length of time in which translations are displayed in the Latest Translations page.
For example, if Bob’s v2 version has foul language or some other unacceptable things in it, NARA moderator can delete Bob’s version. This will only mark bob’s version as deleted. It will still remain in the system for logging purposes. By default, when Bob’s version is deleted, the previous version becomes active. In this case, Alice’s version will become active.
2.7.1 Latest Translation Updates Page
[Req: 4.8] [Req: 4.1.4.2] [Req: 4.17] [Req: 4.14] [Req: 4.19] Authorized NARA staff can login to their account and review user contributions. All user contributed data will be listed under Moderator Workbench. Moderators can select the contributions they want to review using the tabs. To access this page, the Moderator clicks on the Translations link in the Moderator home page or by clicking on the Translations tab from any other Moderator page.
48
NARA Catalog Authorized User Interface Design
Figure 2.7.1: Latest Translation Updates Page
The relevant elements for this page include the following:
Element Validation Behavior
Latest Translation Updates
N/A A non-editable header that identifies the page.
Common controls For more information, please refer to the Common Controls section.
Translations table New, unmoderated translations must be available for display in this page.
A table that displays the latest, unmoderated translations.
Table 2.7.1-1: Latest Translations page elements
The following columns are available in the translations table:
Element Validation Behavior
NO. New, unmoderated translations must be available for display in this page.
A column that displays the row number.
TITLE New, unmoderated A column that contains the title of the record
49
NARA Catalog Authorized User Interface Design
translations must be available for display in this page.
where the translation was created/edited. The title is linked; when clicked, the Content Details page for the record opens in a separate browser window/tab.
IMAGE New, unmoderated translations must be available for display in this page.
A column that contains the image number of the record where the translation was created/edited. If the translation was created/edited on an object of a record, the value that appears in this column is #/# where the first number is the image number and the second # is the total number of images associated with the record.
The IMAGE value is linked; when clicked, the Content Details page for the record opens in a separate browser window/tab and then the workspace of that image is also displayed and the Translation tab is selected.
USER New, unmoderated translations must be available for display in this page.
[Req: 4.8.1.1] A column that contains the username or full name (dependent on the user’s account settings) of the user who created/edited the translation. The username value is linked to the user’s profile. Clicking on the user name opens a new browser window/tab and displays the user’s contributions page.
MODIFIED New, unmoderated translations must be available for display in this page.
[Req: 4.8.1.2][Req: 4.17] A column that contains the date and time the translation was created/edited. [Req: 4.8.1.4] By default, the date is relative to the time the Moderator is currently viewing the translation, i.e., if the translation was created/edited at noon and the Moderator views the translation entry at 1:00 pm the same day in the Moderator Workbench, the Modified date appears as 1 hour ago.
LANGUAGE A column that indicates the language of the translation.
TYPE New, unmoderated translations must be available for display
A column that indicates if the translation text is of type New or Update:
New: When the translation text was posted
50
NARA Catalog Authorized User Interface Design
in this page.
Options include the following:
New Update
for the first time for that object.
Update: When the translation text was an edit.
NOTE New, unmoderated translations must be available for display in this page.
A column that contains a Note icon; this icon only appears if the translation was either removed and/or restored.
Translation text New, unmoderated translations must be available for display in this page.
A non-editable text field that initially displays a snippet of the translation text.
Review New, unmoderated translations must be available for display in this page.
A link, which when clicked, expands the translation field to view more text.
Table 2.7.1-2: Latest Translations data columns
2.7.1.1 Expanded Translation Field
After the Moderator clicks on the Review link, the translation field expands to display more text.
51
NARA Catalog Authorized User Interface Design
Figure 2.7.1.1: Expanded Translation Field
The following elements are available when the translation is in expanded mode:
Element Validation Behavior
Translation text N/A Additional text is displayed in the expanded, non-editable translation text field.
Vertical scrollbar N/A A vertical scrollbar appears on the right side of the translation text field. Its state is determined by the amount of text to display.
If there is more text than can appear in the field, the scrollbar is active and appears so, but if there is not, the scrollbar is not active and appears grayed out.
View Previous Versions
A previous version for the expanded translation must exist.
A link, which when clicked, launches the Previous Versions pop-up.
Remove N/A [Req: 4.8.2] A button, which when clicked,
52
NARA Catalog Authorized User Interface Design
launches the Remove Translation pop-up.
Cancel N/A A link that, when clicked, reverses any changes made to the previously saved state and collapses the row.
Table 2.7.1.1: Latest Translations page elements – Expanded field
2.7.2 Viewing a Previous Translation Version
Moderator can view previous versions of a translation text by clicking on View Previous Versions link. The Previous Versions pop-up appears. In this pop-up, the Moderator can view simultaneously the current version and any previous version. The top text field shows the current active translation text, while the bottom text field shows the immediate previous version.
Figure 2.7.2: Viewing Previous Versions
The following elements are relevant to the Previous Versions pop-up:
Element Validation Behavior
Header A previous version for the expanded translation must exist.
A non-editable text field that identifies the pop-up.
Close A previous version A link, which when clicked, closes the pop-up.
53
NARA Catalog Authorized User Interface Design
for the expanded translation must exist.
Title A previous version for the expanded translation must exist.
A non-editable text field that contains the title of the record where the translation was created/edited, appended with the image number of the translated object.
Current Version – header
A previous version for the expanded translation must exist.
A non-editable text field that identifies the version number of the current version, the username or full name of the user who created the current version, and the general timeframe of when the current was created/edited.
Current Version A previous version for the expanded translation must exist.
A non-editable text field that displays the current version of the translation.
Current Version –Vertical scrollbar
A previous version for the expanded translation must exist.
A vertical scrollbar appears on the right side of the translation text field. Its state is determined by the amount of text to display.
If there is more text than can appear in the field, the scrollbar is active and appears so, but if there is not, the scrollbar is not active and appears grayed out.
Select Previous Version
A previous version for the expanded translation must exist.
A drop-down that lists all versions (version number, action type that generated the version, and general timeframe of when that version was created/edited) of the currently viewed translation.
Make This Current Version
A previous version for the expanded translation must exist.
[Req: 4.8.3] A link, which when clicked, makes the selected version the current version. This can be used to restore a previously removed translation.
Previous Version A previous version for the expanded translation must exist.
A non-editable text field that displays the immediate previous version of the translation on initial load. If the Moderator selects another previous version, the text of the selected version
54
NARA Catalog Authorized User Interface Design
appears in the text field.
Previous Version – Vertical scrollbar
A previous version for the expanded translation must exist.
A vertical scrollbar appears on the right side of the translation text field. Its state is determined by the amount of text to display.
If there is more text than can appear in the field, the scrollbar is active and appears so, but if there is not, the scrollbar is not active and appears grayed out.
Table 2.7.2: Previous Versions modal elements
2.7.3 Changing the Current Version
[Req: 4.8.3] A Moderator can make any previous version the current, active version by clicking on the Make This Current Version link. When the link is clicked, an expandable section appears.
Figure 2.7.3: Changing the Currrent Version
The following elements are relevant to the Previous Versions pop-up after the Make This Current Version link is clicked:
Element Validation Behavior
55
NARA Catalog Authorized User Interface Design
Reason The Moderator must have clicked on the Make This Current Version link.
[Req: 4.8.3.1.1] A drop-down list that indicates the reason for activating a previous version. [Req: 4.8.3.1] The moderator who chooses to activate a previous version must select a reason explaining why the translation is being made current.
[Req: 4.8.3.3] Moderators can configure the list of reasons for restoring translations. For more information, please refer to the Configuring Reason Selector section of this document.
Reason The Moderator must have clicked on the Make This Current Version link.
[Req: 4.8.3.1.2] A text input field that provides the option for the Moderator to add additional details for making the transcript current.
Confirm The Moderator must have clicked on the Make This Current Version link.
The moderator must have selected a reason for restoration from the Reason drop-down.
A button, which, when clicked, confirms the activation of the translation and collapses the row.
Cancel The Moderator must have clicked on the Make This Current Version link.
A link that, when clicked, reverses any changes made to the previously saved state and collapses the row, thus returning the row to its pre-removal mode.
Table 2.7.3: Previous Versions modal elements – Changing versions
After the Moderator clicks on the Confirm button, the Current Version header now displays the new version number, the username or full name of the user who created/edited the translation and the general timeframe it was created/edited. In addition, the translation text field is updated to display the associated transcript text. The Previous Version header and text field are now set so that the previous version is now displayed as the Previous Version. For example, assuming a translation has three versions and Version 3 is current, if the Moderator selects Version 2 to make current, Version 3, the former Current, become the Previous Version displayed in the Previous Version pop-up.
56
NARA Catalog Authorized User Interface Design
[Req: 4.8.3.2] After the Moderator restores a translation, the change is available for viewing in the Latest Translation Updates table within 15 seconds after being restored.
2.7.4 Removing a Translation
[Req: 4.8.2] A Moderator can remove any current translation version by clicking on the Review link to expand the row and then clicking on the Remove button. The Remove Translation pop-up appears.
Figure 2.7.4: Removing a Translation
The following elements are relevant to the Previous Versions pop-up after the Make This Current Version link is clicked:
Element Validation Behavior
Reason The Moderator must have clicked on the Make This Current Version link.
[Req: 4.8.2.1.1] A drop-down list that indicates the reason for removing the current version of a translation. [Req: 4.8.2.1] The moderator who chooses to remove the translation must select a reason explaining for the removal.
[Req: 4.8.2.3] Moderators can configure the list of reasons for removing translations. For more information, please refer to the Configuring Reason Selector section of this document.
Reason The Moderator must have clicked on the Make This Current Version link.
[Req: 4.8.2.1.2] A text input field that provides the option for the Moderator to add additional details for the transcript removal.
Confirm The moderator must have selected a reason for restoration from the
A button, which, when clicked, confirms the translation removal and closes the pop-up.
57
NARA Catalog Authorized User Interface Design
Reason drop-down.
Cancel The Moderator must have clicked on the Make This Current Version link.
A link that, when clicked, reverses any changes made to the previously saved state and closes the pop-up.
Table 2.7.4: Previous Versions modal elements – Removing translation
After the Moderator clicks on the Confirm button, any previously saved version of the removed translation becomes the current version.
[Req: 4.8.2.2] After the Moderator removes a translation, the change is available for viewing in the Latest Translation Updates table within 15 seconds after being removed.
2.7.5 Viewing the Reason for Changing a Current Translation Version or Removing a Translation
After a translation is removed or restored (via changing current version) and the Moderator has provided a reason for the action, a Note icon appears in the NOTE column. [Req: 4.8.2.2.1] [Req: 4.8.3.2.1] Clicking on the Note icon expands the row of the corresponding translation.
The following elements are relevant to the Latest Translations page when in note-viewing mode:
Element Validation Behavior
Moderator Log The Moderator must have removed or restored a translation.
[Req: 4.8.2.2.1] [Req: 4.8.3.2.1] A field that displays the Moderator name who performed the action, the action date/time stamp, the reason selected, and any additional translations about the action.
Table 2.7.5: Latest Translations page elements – moderation Log
2.8 Moderator Action Stream
The Moderator Action page displays a “stream” of objects a Moderator has acted upon, either removing a public contribution or restoring one. (The stream does not show public contributions that have not yet been moderated.) The following types of public contributions can appear in the stream within 15 seconds of the moderator action:
[Req: 5.6.2.4] Removed tags;
58
NARA Catalog Authorized User Interface Design
[Req: 5.6.3.4] Restored tags;
[Req: 6.4.4.3] Removed comments;
[Req: 6.4.3.4] Restored comments:
[Req: 3.4.2.4] Removed transcriptions;
[Req: 3.4.3.4] Restored transcriptions;
[Req: 4.8.2.4] Removed translations; and
[Req: 4.8.3.4] Restored translations.
The Catalog System Administrator configures the amount of time in which [Req: 5.30] Tags, [Req: 6.31] Comments, [Req: 3.22] Transcriptions, and [Req: 4.25] Translations are displayed in the Moderator stream after the public contributions have been removed or restored by a Moderator.
In addition, the System Administrator can configure the length of time in which [Req: 3.24] Transcriptions and [Req: 4.26] Translations are displayed in the Moderator stream.
Figure 2.8: Latest Moderator Actions Page [Design Enhancement: DE-25]
The following elements are relevant to this page:
Element Validation Behavior
Latest Moderator Actions
N/A A non-editable header that identifies the page.
59
NARA Catalog Authorized User Interface Design
Common controls For more information, please refer to the Common Controls section.
Public contributions table
A Moderator must have performed an action on at least one public contribution.
A table that displays the latest, moderated public contributions.
Table 2.8-1: Latest Moderator Actions page elements
The following columns are available in the public contributions table:
Element Validation Behavior
NO. New, moderated public contributions must be available for display in this page.
A column that displays the row number.
MODERATOR New, moderated public contributions must be available for display in this page.
A column that contains the full name of the moderator who performed the action on the public contribution.
ACTION TAKEN New, moderated public contributions must be available for display in this page.
A column that contains the type of the action taken. Options include the following: Removed and Restored.
REASON New, moderated public contributions must be available for display in this page.
A column that contains the reason selected from the Reason drop-down list at the time of the action.
CONTRIBUTION New, moderated public contributions must be available for display in this page.
A column that contains the contributed acted upon, i.e., a tag, comment, transcription, or translation.
ACTION New, moderated public contributions must be available for
A column that contains buttons available to perform on the comment: Remove, Restore.
60
NARA Catalog Authorized User Interface Design
display in this page.
Remove New, moderated public contributions that were restored must be available for display in this page.
A button, which when clicked, expands the row and displays the comment removal controls; for more information, please refer to any of the sections on removing a public contribution.
Restore New, moderated public contributions that were removed must be available for display in this page.
A button, which when clicked, expands the row and displays the comment restoration controls; for more information, please refer to any of the sections on restoring a public contribution already described in this document.
NOTE New, moderated public contributions must be available for display in this page.
A column that contains a Note icon; this icon only appears if the translation was either removed and/or restored already described in this document.
Table 2.8-2: Latest Moderator Actions data columns
2.8.1 Viewing the Reason for Removing or Restoring a Public Contribution
[Req: 5.6.2.2.1] [Req: 5.6.3.2.1][Req: 6.4.4.1] [Req: 6.4.3.2.1] [Req: 3.4.2.2.1] [Req: 3.4.3.2.1] [Req: 4.8.2.2.1] [Req: 4.8.3.2.1] As described elsewhere in this document, Moderators are required to select a reason for removing or restoring a public contribution. Once a Moderator selects a reason and completes the action on a public contribution, a Note icon appears in the public contribution table. In the Latest Moderator Actions page, the Note icon is also available. Clicking on the Note icon displays an expandable row with the note text.
61
NARA Catalog Authorized User Interface Design
Figure 2.8.1: Moderator Actions – Viewing a Note [Design Enhancement: DE-25]
2.9 Announcements Management[Design Enhancement: DE-17c] An announcement can appear in the Catalog Home page to deliver information to users of the system. [Req: 16.10.5] Moderators are able to configure the announcement bar via the Moderator Workbench. To access this page, the Moderator clicks on the Announcements link in the Moderator home page.
The announcement bar can be toggled on and off (default) and text can be modified as needed.
Note: Actions related to the management of announcements do not appear in the Moderator Actions page.
Figure 2.9-1: Announcement page, no announcement configured
Relevant elements for this page include the following:
62
NARA Catalog Authorized User Interface Design
Element Validation Behavior
Announcements The logged in user must be a Moderator.
A link, which when clicked, loads the Announcements management page.
When this page is active, a highlight bar appears below the link text.
When this page is not active, no bar appears below the link text.
Background Images A link, which when clicked, loads the Background Images management page.
When this page is active, a highlight bar appears below the link text.
When this page is not active, no bar appears below the link text.
Enter announcement text…
A text input field where the moderator can enter text for the announcement. Only plain text can be entered (i.e., HTML coding or other text formatting is not supported).
Display in Home Page
A checkbox and label that determines whether the announcement bar is displayed in the Home page.
A checked box indicates the announcement bar appears in the Home page; any text entered in the text field will appear in the announcement bar.
An unchecked box indicates the announcement bar does not appear in the Home page.
Moderators can enter text, but leave the checkbox unchecked until they’re ready to make the announcement “go live.”
Save A button, which when clicked, saves the text entered in the text field. It also saves the changed state of the Display in Home Page checkbox, e.g., if the Moderator unchecks the checkbox, they must click on the Save button in
63
NARA Catalog Authorized User Interface Design
order to hide the announcement bar.
Clicking on the Save button does not display the announcement bar. Moderators still must check the Display in Home Page checkbox in order to toggle on the display of the bar.
Cancel A link, which when clicked, reverses any changes made in the text field.
Clicking on the Cancel link does not hide the announcement bar. Moderators still must uncheck the Display in Home Page checkbox in order to toggle off the display of the bar.
Figure 2.9-2: Announcement page, announcement configured
64
NARA Catalog Authorized User Interface Design
Figure 2.9-3: Home page displaying the configured announcement [Design Enhancement: DE-17a] [Design Enhancement: DE-17b] [Design Enhancement: DE-600a]
2.10 Background Images Management[Design Enhancement: DE-17d] Background images can appear in the Catalog Home page. The background image is randomly selected from a configured set of images every time the user loads the Catalog Home page (i.e., when the page is initially displayed, when the page is refreshed, etc.). [Req: 16.10.4] Moderators are able to configure the set of background images via the Moderator Workbench. To access this page, the Moderator clicks on the Background Images link in the Moderator home page.
65
NARA Catalog Authorized User Interface Design
Figure 2.10-1: Background Images page, no images defined, default image set is active
Relevant elements for this page include the following:
Element Validation Behavior
Announcements The logged in user must be a Moderator.
A link, which when clicked, loads the Announcements management page.
When this page is active, a highlight bar appears below the link text.
When this page is not active, no bar appears below the link text.
Background Images A link, which when clicked, loads the Background Images management page.
When this page is active, a highlight bar appears below the link text.
When this page is not active, no bar appears below the link text.
Parent Record NAID A text field in which the moderator enters the NAID (naId) of the record associated with the image to use as a background image.
Object ID A text field in which the moderator enters the Object ID (objectId) of the image to use as a background image.
Add A button, which when clicked, saves the image
66
NARA Catalog Authorized User Interface Design
to the background images set.
Cancel A link, which when clicked, reverses any change made to the background images set.
Data table A list of currently defined background images; each entry displays the parent record NAID, object ID, title of the parent record, and a Remove icon.
If no images are defined, the data table is empty.
Note: The default background images configured in the system configuration do not appear in this list.
If no images are defined in this page, a default set is active. These images are configurable by the System Administrator. For more information, please refer to the NARA Catalog System Administrator Guide.
To define an image for use as a background image, the Moderator specifies the NAID of the parent record and the Object ID of the object and then clicks on the Add button. As the user enters data and clicks on the Add button, the newly added entry is added to the top of the data table.
Note: Unique NAIDs for each object is not scheduled for R1P2R2, therefore, the Moderator must specify the parent record NAID and the objectId in order to identify the image.
67
NARA Catalog Authorized User Interface Design
Figure 2.10-2: Background Images page, images defined, default image set is inactive, new data is entered
Relevant elements for the data table include the following:
Element Validation Behavior
NAID Linked text that displays the NAID of the parent record associated with the image; when clicked, directs the Moderator to the Content Details page for the record.
OBJECT ID Text that displays the Object ID of the image.
Note: This text is not linked because it's not possible to link an Object ID with the Contributions Workspace; the Workspace takes an image/page number, not an objectId field value. Given the objectId, the system doesn't know the object’s position in the objects array of its container.
TITLE Linked text that displays the title of the parent record associated with the image; when clicked, directs the Moderator to the Content Details page for the record.
68
NARA Catalog Authorized User Interface Design
REMOVE An icon, which when clicked, removes the corresponding object from the background images set.
Figure 2.10-3: Background Images page, images defined, default image set is inactive, new data has been added
69
NARA Catalog Authorized User Interface Design
Figure 2.10-4: Home page displaying a defined background image [Design Enhancement: DE-17a] [Design Enhancement: DE-17b] [Design Enhancement: DE-17d] [Design Enhancement: DE-600a]
2.11 Online Availability Notification Management[Req: 1.5.5.1.1.2] Many Catalog Archival Descriptions display in their Content Details pages a disclaimer/warning that indicates that some or all of the Catalog records for the Description may not be available online.
[Req: 1.5.5.1.1.3] [Design Enhancement: DE-82a] Moderators are able to remove the online availability notification from the Content details page of a selected Archival Description via the Moderator Workbench. [Req: 1.5.5.1.1.4] They are also able to modify an online availability notification. To access this page, the Moderator clicks on the Online Availability Notification link in the Moderator home page.
70
NARA Catalog Authorized User Interface Design
Figure 2.11-1: Online Availability page, no notification retrieved
Relevant elements for this page include the following:
Element Validation Behavior
Tags ([#]) The logged in user must be a Moderator.
A link, which when clicked, loads the Latest Tags page.
When this page is active, a highlight bar appears below the link text.
When this page is not active, no bar appears below the link text.
Comments ([#]) A link, which when clicked, loads the Latest Comments page.
When this page is active, a highlight bar appears below the link text.
When this page is not active, no bar appears below the link text.
Transcriptions ([#]) A link, which when clicked, loads the Latest Transcriptions page.
When this page is active, a highlight bar appears below the link text.
When this page is not active, no bar appears below the link text.
Online availability A link, which when clicked, loads the Online Availability page.
71
NARA Catalog Authorized User Interface Design
When this page is active, a highlight bar appears below the link text.
When this page is not active, no bar appears below the link text.
Moderator Actions ([#])
A link, which when clicked, loads the Moderator Actions page.
When this page is active, a highlight bar appears below the link text.
When this page is not active, no bar appears below the link text.
Archival Description NAID
A text field in which the Moderator enters the NAID of the Description that has the notification to be updated.
Retrieve Notification A button, which when clicked, retrieves the Archival Description details and current online availability notification.
Figure 2.11-2: Sample Archival description displaying an online availability notification
72
NARA Catalog Authorized User Interface Design
Once the Moderator retrieves the online availability notification for an Archival description, details for the record appear in a data table below the input form.
Figure 2.11-3: Online Availability page, an online availability notification retrieved
Relevant elements for this table include the following:
Element Validation Behavior
NAID The logged in user must be a Moderator.
Linked text that displays the NAID of the record; when clicked, directs the user to the Content Details page for the record.
TITLE Linked text that displays the title of the record; when clicked, directs the user to the Content Details page for the record.
MODIFIED Plain text that displays the relative timestamp of the most recent action taken, if any, on the online availability notification.
If no action has been taken, this column is left blank.
If action has been taken, the relative timestamp appears, following R1P1 conventions currently in place in the design.
If the user hovers over the relative timestamp, a
73
NARA Catalog Authorized User Interface Design
tooltip appears to display the actual timestamp. This also follows R1P1 convention.
EDIT A clickable icon, which when clicked, moves the result into edit mode.
DISPLAY A clickable icon, which when clicked, determines whether the online availability notification is displayed in the Content Details page for the specified record.
NOTE A clickable icon, which when clicked, displays an expandable section that lists all actions taken on the record’s online availability notification.
If no action has been taken, this column is left blank.
If action has been taken, an icon appears.
After the Moderator clicks on the EDIT icon, the online availability notification form is moved into EDIT mode. Simple text formatting options are available for the Moderator to use to customize the text for display.
Figure 2.11-4: Online Availability page, an online availability notification in EDIT mode
Text formatting options include the following:
74
NARA Catalog Authorized User Interface Design
Font type
o Options include San Serif and Serif
o The option displayed in the toolbar depends on what text the user has selected.
o Users select the text to change, then click on the drop-down and select the type
Figure 2.11-5a: Online Availability page, text formatting options
Font color
o Options include the NARA copper and black
o The option displayed in the toolbar depends on what text the user has selected.
o Users select the text to change, then click on the A icon and select the color
Figure 2.11-5b: Online Availability page, text formatting options
Font weight
o Options include bold and plain
o Users select the text to change, then click on the B icon to apply bolding or to remove it if it’s already applied
After editing the online availability notification text, the Moderator clicks on the Save button to save the changes or the Cancel link to revert the notification text back to its previous state. [Design Enhancement: DE-82c] Each time a Moderator makes any kind of change to a notification, including modifying text or toggling the display on or off, an action is logged in the system; a NOTE icon appears in the interface. [Design Enhancement: DE-82b] Clicking on the NOTE icon displays the moderation log for the notification.
75
NARA Catalog Authorized User Interface Design
Figure 2.11-6: Online Availability page, an online availability notification after saving
[Design Enhancement: DE-82b] The moderation log for online availability notifications display the following details:
Moderator: [Full name of the moderator (when the moderator holds a nara.gov email address) or username of the moderator (if the moderator does not hold a nara.gov email address)]
[action]: [relative timestamp]
o Actions that apply are Updated (text is modified), Removed (notification is hidden), and Restored (notification is redisplayed)
o The relative timestamp follows R1P1 conventions currently in place in the design.
o If the user hovers over the relative timestamp, there is no tooltip that appears to display the actual timestamp. This also follows R1P1 convention for the moderation log.
76
NARA Catalog Authorized User Interface Design
Figure 2.11-7: Online Availability page, moderation log for the online availability notification that was modified
To toggle the display of an online availability notification, the Moderato checks or unchecks the DISPLAY checkbox. Checked indicates the notification is displayed in the Content Details page of the record, while unchecked indicates the notification is not displayed. [Design Enhancement: DE-82c] As with modifying the text of a notification, toggling the display on or off triggers an action to be logged in the system; a NOTE icon appears in the interface. [Design Enhancement: DE-82b] Clicking on the NOTE icon displays the moderation log for the notification.
77
NARA Catalog Authorized User Interface Design
Figure 2.11-8: Online Availability page, an online availability notification toggled off
Figure 2.11-9: Sample Archival description no longer an online availability notification (Moderator toggled it off)
[Design Enhancement: DE-82d] In addition to the moderator action being logged and a NOTE icon appearing the Online Availability page when the Moderator modifies notification text or toggles it on or off, the action is also recorded in the moderator stream and appears in the Moderator Actions page. [Req: 16.10.6] After online availability notification text is modified, the change is available for viewing in the Moderator Actions page within 15 seconds after the notification is modified. [Req: 16.10.7] After an online availability notification is toggled off, or removed from display, the change is available for viewing in the Moderator Actions page within 15 seconds after being removed.
Moderators can remove (toggle off) or restore (toggle on) the notification from that page.
78
NARA Catalog Authorized User Interface Design
Figure 2.11-10: Moderator Actions page
79
NARA Catalog Authorized User Interface Design
3 Account Administrator Workbench
[Req: 8.1] [Req: 8.1.1.4] Account Administrators, i.e., those authorized users given permissions to manage all user accounts, including other authorized users, access the Account Administrator Workbench by logging into the Catalog using their dedicated Account Administrator account.
3.1 Account Administrator Permissions[Req: 8.1.1.4] [Req: 8.1.4.1] Account Administrators are authorized users, typically NARA staff members, who have permissions that enable them to create and manage all types of user accounts, including those of other Account Administrators and Moderators. Account Administrators are also Registered Users, so they are able to search, save results to lists and add contributions. (These functions are described in the NARA Catalog User Interface Design Document.)
Account Administrators can also have the Moderator role permissions. If so, Moderator options appear in the Account Administrator Home page once they log in using their Account Administrator user account.
3.2 Account Administrator Home Page[Req: 8.1] Once logged into their account, the My Accounts page for the Account Administrator appears. This page does not appear for any other user but Account Administrators.
80
NARA Catalog Authorized User Interface Design
Figure 3.2: Account Administrator Home Page [Design Enhancement: DE-25]
The relevant elements for this page include the following:
Element Validation Behavior
Manage User Accounts
The logged in user must be an Account Administrator.
A section header that identifies the section; these actions are specific to the Account Administrator role.
Create a User The logged in user must be an Account Administrator.
A link, which when clicked, takes the Account Administrator to the Create an Account page.
Manage Accounts The logged in user must be an Account Administrator.
A link, which when clicked, takes the Account Administrator to the Manage Account page.
Moderate User Contributions
The logged in user must be a
A section header that identifies the section; these actions are specific to the Moderator role.
81
NARA Catalog Authorized User Interface Design
Moderator.
Tags /Comments / Transcriptions / Translations
The logged in user must be a Moderator.
Links, which when clicked, take the Account Administrator to the selected public contributions page.
My Contributions The logged in user must be any type of Registered User.
A section header that identifies the section; these actions are available for any Registered User role. The behavior of these elements is identical to the behavior of the same functions for Registered Users as described in the NARA Catalog User Interface Design Document.
My Lists The logged in user must be any type of Registered User.
A section header that identifies the section; these actions are available for any Registered User role. The behavior of these elements is identical to the behavior of the same functions for Registered Users as described in the NARA Catalog User Interface Design Document.
Bulk Downloads The logged in user must be any type of Registered User.
A section header that identifies the section; these actions are available for any Registered User role. The behavior of these elements is identical to the behavior of the same functions for Registered Users as described in the NARA Catalog User Interface Design Document.
Account Information The logged in user must be any type of Registered User.
A section header that identifies the section; these actions are available for any Registered User role. The behavior of these elements is identical to the behavior of the same functions for Registered Users as described in the NARA Catalog User Interface Design Document.
User Type The logged in user must be an Account Administrator.
[Req: 16.3.2] A field that identifies the currently logged in user as an Account Administrator.
Table 3.2: Account Administrator Home page elements
82
NARA Catalog Authorized User Interface Design
3.3 Account Administrator Workbench PagesBoth Account Administrator Workbench pages are headed by a banner with the phrase, Account Administrator Workbench. The dark red banner was selected to help differentiate these pages from the Registered User’s My Account pages and the Moderator’s Workbench pages.
Figure 3.3: Account Administrator Workbench [Design Enhancement: DE-601]
Two tabs, Create an Account, and Manage Accounts, are arranged horizontally across the top, below the Account Administrator Workbench banner. The tab that appears by default when the page is first loaded is the Create an Account. The currently selected tab is indicated by a short horizontal bar, styled using the same dark red as the banner.
3.3.1 Create an Account Page
[Req: 8.1.1] The Create an Account page contains elements that allow the Account Administrator to create any type of user account. To access this page, the Account Administrator clicks on the Create an Account link in the Account Administrator page or by clicking on the Create an Account tab from the Manager Accounts page.
Figure 3.3.1: Creating an Account [Design Enhancement: DE-601]
Below the tabs is a vertically stacked set of input fields for the Account Administrator to complete when creating a user account. The relevant elements for this page include the following:
Element Validation Behavior
83
NARA Catalog Authorized User Interface Design
User Type Required; options include:
Registered User
Power User
Moderator
Account Administrator
[Req: 8.1.1.1]
[Req: 8.1.1.2]
[Req: 8.1.1.2.1]
[Req: 8.1.1.1.1] (Required) A drop-down list that indicates the type of user being created.
[Req: 8.1.1.2] Registered User and Power Users are simple selections. Moderator and Account Administrator are checkbox selections and one or both can be selected.
Username Required [Req: 8.1.1.1.1] (Required) A text field that specifies the username for the account; this field value cannot be duplicated (refer to the Duplicated Username or Email Address section for more information).
Full Name Required [Req: 8.1.1.1.1] (Required)A text field that specifies the full name for the account; this field value can be duplicated.
Display full name to public
Optional [Req: 8.7] A checkbox that indicates whether the user’s full name will be displayed anywhere a username is displayed in the system. For example, instead of a username appearing in the Contributor’s section of the Contributions Workspace, the user’s full name would appear. (Refer to the NARA Staff Members’ Users Accounts section to an exception to this option as it relates to NARA staff members’ accounts.)
Email Required [Req: 8.1.1.1.1] (Required)A text field that specifies the email address for the account; this field value cannot be duplicated (refer to the Duplicated Username or Email Address section for more information).
Create N/A A button, which, when clicked, does the
84
NARA Catalog Authorized User Interface Design
following:
processes the entered data;
creates the user account; and
displays the user to the User Account Creation Confirmation page.
Cancel N/A A link that, when clicked, reverses any changes made to their previously saved state.
Table 3.3.1: Creating an Account page elements
After the Account Administrator clicks on the Create button, the user account is created; the Catalog system sends an automatic email to the email address associated with the new account that contains a link to set their password.
3.3.1.1 Creating Moderators and Account Administrators
[Req: 8.1.1.1] [Req: 8.1.1.2] In the User Type drop-down in the Create an Account page, the Moderator and Account Administrators options are checkbox options. One or both can be selected.
Figure 3.3.1.1-1: User Type Drop-down [Design Enhancement: DE-601]
85
NARA Catalog Authorized User Interface Design
Figure 3.3.1.1-2: User Type Field Filled In [Design Enhancement: DE-601]
3.3.1.2 Duplicated Username or Email Address
As stated earlier, the Username and Email values cannot be duplicated; each username and email is unique. [Req: 8.1.1.3] If a duplicate username or email is detected by the system when the Account Administrator clicks on the Create button, a red warning message, “Username already exists” or “Email already exists,” appears in the UI to the right of the respective field.
Figure 3.3.1.2: Creating an Account - Username Exists Error [Design Enhancement: DE-25] [Design Enhancement: DE-601]
3.3.1.3 NARA Staff Members’ Users Accounts
[Req: 8.7.1] When the user account belongs to a NARA staff member, as identified by the email address used for the account, the user accounts automatically displays the Full Name value.
3.3.2 User Account Creation Confirmation Page
[Req: 8.1.1] After the Account Administrator clicks on the Create button, the User Account Creation Confirmation page appears. The Create an Account tab is still shown as selected.
86
NARA Catalog Authorized User Interface Design
Figure 3.3.2: Account Creation Successful Confirmation [Design Enhancement: DE-25] [Design Enhancement: DE-601]
The relevant elements for this page include the following:
Element Validation Behavior
User ID The user account must have been created successfully
A system-assigned non-editable value that is unique to the user account.
Account successfully created.
The user account must have been created successfully
A non-editable text label that appears to the right of the User ID field; provides a visual cue that the account was successfully created.
Text fields as described in the Create an Account Page section
The user account must have been created successfully
All input fields toggle to non-editable text labels that display the entered data.
Create Another Account
The user account must have been created successfully
A button, which when clicked, does the following:
removes the displayed account data; and
displays the Create an Account page (all input fields are reset to default to allow the Account Administrator to create another user account).
Table 3.3.2: Account Creation Successful Confirmation page elements
87
NARA Catalog Authorized User Interface Design
3.3.3 Manage Accounts Page
[Req: 8.1.3] The Manage Accounts page contains elements that allow the Account Administrator to search for and then manage a user account. To access this page, the Account Administrator
clicks on the Manager Accounts tab from the Create an Account page or by clicking on the Manage Accounts link in the Account Administrator page.
Figure 3.3.3: Manage Accounts Page [Design Enhancement: DE-601]
Below the tabs is a vertically stacked set of input fields arranged in two columns for the Account Administrator to complete when searching a user account. [Req: 8.1.3.3] Data does not have to be entered in any field in order to search; one or more fields can be completed to narrow the search.
Pattern matching applies to these values so partial ID numbers or text strings can be entered and searched. For example, entering searchtechnologies.com in the Email field returns all user accounts that have “searchtechnologies.com” as part of their email address.
[Req: 8.1.3.2] The relevant elements for this page include the following:
Element Validation Behavior
User ID None [Req: 8.1.3.2.2] A text field that specifies the User ID to search upon.
User Type Required; options include:
Registered User
Power User
Moderator
Account Administrator
[Req: 8.1.1.1]
[Req: 8.1.1.2]
[Req: 8.1.1.2.1]
A drop-down list that indicates the type of user to search upon.
88
NARA Catalog Authorized User Interface Design
Username None [Req: 8.1.3.2.1]A text field that specifies the username to search upon.
Full Name None [Req: 8.1.3.2.5] A text field that specifies the full name to search upon.
Email None [Req: 8.1.3.2.3] Email – A text field that specifies the email address to search upon.
Account Status None; options include:
Active
Inactive
[Req: 8.1.3.2.4] A drop-down list that indicates the account status to search upon.
Search N/A A button that, when clicked, does the following:
processes the entered data; and
displays the results table in the lower portion of the Manage Account page (returning any user accounts that match the entered search criteria).
Table 3.3.3: Manage Accounts Page elements
[Req: 8.1.3.4] If no results are found, the system indicates this with a warning message, “There are no search results found using the search term: [query string].”
3.3.4 Manage Account Page with Results
[Req: 8.1.3.1.1] [Req: 8.1.3.6] After the Account Administrator clicks on the Search button, the bottom half of the Manage Accounts page populates with search results if any are found based on the entered criteria.
89
NARA Catalog Authorized User Interface Design
Figure 3.3.4-1: Manage Account Page with Results [Design Enhancement: DE-25] [Design Enhancement: DE-601]
The relevant elements for this page include the following:
Element Validation Behavior
Input fields as described in the Manage Accounts Page section
None [Req: 8.1.3.5] The top half of the page persists the search criteria input fields and any entered search data.
Sort by Optional; options include the following:
User ID
User Type
Username
Full Name
Account Status
[Req: 8.1.3.1.1.1] A drop-down list that the Account Administrator can use to sort the results.
Table 3.3.4-1: Manage Account Page with Results page elements
[Req: 8.1.3.1.1.1] Below the “Sort by” drop-down is the results table, capped with a header row; headings include the following: User ID, User Type, Username, Full Name, Email, Account Status, Edit, View Contributions, Reset Password, and Note.
90
NARA Catalog Authorized User Interface Design
Each row in the tale contains the details of one user account result. Active users are rendered in regular text; inactive users are rendered in “struck-through” text. The clickable icons for an inactive user does not have strike-through text applied.
Figure 3.3.4-2: Active versus Inactive User Styling [Design Enhancement: DE-25]
Each column contains the corresponding data as outlined in the Manage Accounts Page section. In addition, the following columns contain clickable icons as follows:
Element Validation Behavior
Edit N/A Clicking on this icon expands the row and displays editable elements (for more information, please refer to the Editing an Account section).
View Contributions N/A [Req: 8.1.2] [Req: 8.1.3.1] Clicking on this icon directs the Account Administrator to the User Account page described elsewhere in this NARA Catalog User Interface Design Document.
Reset Password N/A Clicking on this icon launches a series of pop-ups that allow the Account Administrator to reset the password of a user account (for more information, please refer to the Resetting Passwords section).
Note A note must have been added to the associated user account in order for the Note icon to appear; if there is no note, then no icon.
Clicking on this icon expands the row and displays a non-editable field that contains any notes added to the account by an Account Administrator (for more information, please refer to the Viewing User Account Notes section).
[Req: 8.1.4] [Req: 8.1.4.1] After the Account Administrator clicks on an Edit icon, the row for the user account whose Edit icon was clicked expands. Input fields with the current user data
91
NARA Catalog Authorized User Interface Design
persisted appear in the expandable section. In the screenshot below, the first user is shown in Edit mode.
Figure 3.3.4.1-1: Editing an Account [Design Enhancement: DE-25] [Design Enhancement: DE-601]
The relevant elements for the page in Edit mode include the following:
Element Validation Behavior
User ID None This field is not editable; persists its previously saved value.
User Type Required; options include:
Registered User
Power User
Moderator
Account Administrator
[Req: 8.1.1.1]
[Req: 8.1.1.2]
[Req: 8.1.1.2.1]
Fully editable; must have a value selected; previously saved value can be left or a new value entered.
Username None This field is not editable; persists its previously saved value.
Full Name Required Fully editable; must have a value entered;
92
NARA Catalog Authorized User Interface Design
previously saved value can be left or a new value entered.
Email Required Fully editable; must have a value entered; previously saved value can be left or a new value entered.
Account Status Required; options include:
Active
Inactive
[Req: 8.1.3.2.4]
Fully editable; must have a value selected; previously saved value can be left or a new value entered.
Reason When editing data or re-activating an account, this field is optional.
When deactivating an account, this field is required.
Options are described in the Configuring Reason Selector section.
[Req: 8.1.5.2] [Req: 8.1.6.1] A drop-down list that indicates the reason for editing the account. The Account Administrator who chooses to edit the account must select a reason explaining why.
Reason The Moderator must have clicked on a Remove button for a tag.
[Req: 8.1.5.1] A text input field that provides the option for the Account Administrator to add additional details for editing the account.
Save N/A A button that, when clicked, saves any changes the Account Administrator made to the account data and collapses the row, thus returning the row to its pre-Edit mode.
Cancel N/A A link that, when clicked, reverses any changes made to the previously saved state and collapses the row, thus returning the row to its pre-Edit mode.
93
NARA Catalog Authorized User Interface Design
Table 3.3.4.1: Manage User Accounts page elements – Edit mode
[Req: 8.1.4.1.1] If the edit was successfully completed, a message is shown by the system. If the edit failed, a warning message is shown by the system.
Changes made to the data are immediately apparent in the table data. In the screenshot below, the first user was edited so that the Account Status changed to Inactive. In addition, the Account Administrator added a note. If a note is added to a user account, the Note column populates with a Note icon for that account row. If no note is added, even if the account is edited, no Note icon appears.
Figure 3.3.4.1-2: An Account Has Been Deactivated [Design Enhancement: DE-25]
3.3.4.1.1 Deactivating and Reactivating a User Account
[Req: 8.1.5] Once the Account Administrator moves a user account into Edit mode, they can change the Account Status from Active to Inactive, thus deactivating the user account.
Figure 3.3.4.1.1: User Account in Edit Mode [Design Enhancement: DE-25] [Design Enhancement: DE-601]
[Req: 8.1.6] Following the same process as above, the Account Administrator can change Account Status from Inactive to Active, thus reactivating the user account.
[Req: 8.1.5.2] [Req: 8.1.6.1] When deactivating or reactivating an account, the Account Administrator must select a reason for deactivating the account. [Req: 8.1.5.1] In addition, they can add a note in the Note field, but it is not required.
[Req: 8.1.6.1] When reactivating a user account, once the Account Administrator clicks on the Save button, if a note wasn’t added to the Note field, the system displays a warning message as it is required a note be added when taking this action on an account.
[Req: 8.1.5.2.1] After one year of inactivity, all user accounts will be automatically disabled.
94
NARA Catalog Authorized User Interface Design
3.3.4.2 Resetting Passwords
[Req: 8.1.7] After the Account Administrator clicks on a Reset Password icon, a Reset Password pop-up appears.
Figure 3.3.4.2-1: Reset Password Confirm [Design Enhancement: DE-601]
The relevant elements for the pop-up include the following:
Element Validation Behavior
Reset Password The Account Administrator must have clicked on the Reset Password icon.
The pop-up has styling, a header, and a Close link as defined in the NARA Catalog User Interface Design Document.
Do you wish to reset the password for the following user account: [username]
None Non-editable guidance text that persists the Username value to provide confirmation for the Account Administrator that the password is being reset for the correct user account.
Yes N/A A button that, when clicked, closes this Reset Password pop-up and displays a second pop-up.
Cancel N/A A link that, when clicked, halts the reset-password action; no changes are made to the account password, and the pop-ups closes.
95
NARA Catalog Authorized User Interface Design
Table 3.3.4.2-1: Reset Password modal elements
After the Account Administrator clicks on the Yes button, the content of the first Reset Password is replaced by additional content.
Figure 3.3.4.2-2: Random Password Sent to User’s Email [Design Enhancement: DE-601]
The relevant elements for the pop-up include the following:
Element Validation Behavior
Reset Password The Account Administrator must have clicked on the Yes button in the initial Reset Password pop-up.
The pop-up has styling, a header, and a Close link as defined in the NARA Catalog User Interface Design Document.
A random password has been created and sent to the following user account:
[username] ([email])
None Non-editable guidance text that persists the Username and Email values to provide confirmation for the Account Administrator that the password is being reset for the correct user account.
OK N/A A button that, when clicked, closes this Reset Password pop-up. The system automatically resets the user’s password and sends it via email to the email address associated with the user
96
NARA Catalog Authorized User Interface Design
account.
Table 3.3.4.2-2: Reset Password (confirmation) modal elements
3.3.4.3 Viewing User Account Notes
[Req: 8.1.6.1.1] After the Account Administrator clicks on a Note icon, the row for the user account whose Note icon was clicked expands. The non-editable Note field appears. The Account Administrator can click again on the note icon to collapse the section and hide the Note field.
Figure 3.3.4.3: Viewing User Account Notes [Design Enhancement: DE-25] [Design Enhancement: DE-601]
The relevant elements for the page in this state include the following:
Element Validation Behavior
Note An Account Administrator must have added a note to the user account and clicked on the Note icon.
A non-editable text field that displays any text entered by an Account Administrator in response to changing account data or deceiving the account.
Table 3.3.4.3: Manage User Accounts page elements – Account Notes
97
NARA Catalog Authorized User Interface Design
4 Featured Results
[Req: 1.5.3.2.1] By default, each tab in the Results page displays the most relevant search results per group. [Req: 1.10] To support handling exception cases, the Catalog system Administrator can construct search optimization criteria in order to boost selected results to the top of the Results page and [Req: 1.10.6] can manage those associations.
[Req: 1.10.1] Similar to a “best bet”, the featured “boost” can be associated with a keyword or key phrase so that, if a user runs a search using one of these keywords, the featured result is returned and displayed prominently in the Results List. For example, if a user runs a search on declaration of independence, the landing page for the Declaration of Independence is displayed first in the Results List.
[Req: 1.10.4] Once a featured result has been associated with a keyword, the Catalog System Administrator can review the associated and can then [Req: 1.10.2] modify or [Req: 1.10.3] delete that association.
[Req: 1.10.5] To better organize the associations, related featured results can be ordered based on groupings
98
NARA Catalog Authorized User Interface Design
5 URL Mapping
[Req: 1.15] [Req: 1.5.4.7] [Req: 1.15.3] [Req: 1.15.4] [Req: 1.15.5] [Req: 1.15.6] [Req: 1.15.7] [Req: 1.15.8] [Req: 1.15.9] [Req: 3.18] [Req: 3.20] [Req: 4.22] [Req: 4.23] [Req: 6.26] [Req: 6.27] [Req: 5.28] [Req: 5.29] [Req: 6.25] [Req: 6.26] [Req: 6.27] This section covers the complete URL set for all pages in the Catalog. These URLs are designed to work as stable URLs in order for users to share the URL. “Stable URL” is defined as a consistent URL such that when accessed by one or more users at different times, the same user modifications are provided in each case.
[Req: 1.17.12] URLs in the Catalog display only user-specified parameters in a persistent URL; default parameters are suppressed, or hidden, in the URL. These parameters only become apparent once the user performs an action in the UI that would change the default value of the parameter. The following are actions the user can perform in the UI that would cause a change in the default parameter value and thus display the parameter and the user-specified value:
Turning highlighting off adds the highlight parameter: https://catalog.archives.gov/search?q=ocean&highlight=false
Applying a sort adds the sort parameter: https://catalog.archives.gov/search?q=ocean&sort=titleSort%20asc
Applying expanded terms adds the thesaurus.terms.[query] parameter: https://catalog.archives.gov/search?q=ship&thesaurus.terms.ship=related
Changing tabs adds the tabType parameter: https://catalog.archives.gov/search?q=ship&tabType=online
Paginating through the Results pages adds the offset parameter: https://catalog.archives.gov/search?q=ship&offset=20
Changing the number of results displayed per page adds the rows parameter: https://catalog.archives.gov/search?q=ocean&rows=100&offset=0
Applying a facet adds the facet and f.[facet] parameters: https://catalog.archives.gov/search?q=ocean&facet=true&f.oldScope=online
The suppression of the default parameters is also applied to the Content Details page URLs.a
5.1 URLs Independent of Physical Location[Req: 1.17] There is no change in the URL of an object caused by or despite changes to the underlying physical storage location of the object, i.e., the URL is independent of the physical location of the object.
An example of a URL that is dependent on a physical location is:
99
NARA Catalog Authorized User Interface Design
http://catalog.archives.gov/id/5866505#.UyS3S8t7OYA
This URL could be pointing to the object being stored in OPA storage database 1. After a period of time, it may get moved to OPA storage database 2.
The change in its location should in turn not change any part of the above URL, not even by adding an extra character to it, or any other modification. It should continue being the exact same URL as above for that particular object.
An example of a URL that is independent on a physical location is:
http://catalog.archives.gov/id/7283080
5.2 Persistent URLs in the CatalogThe following is a list of all persistent URLs available in the Catalog system:
Page URL
Simple Search https://catalog.archives.gov
Search Results https://catalog.archives.gov/search?q=truman
Filter on Facet Values https://catalog.archives.gov/search?q=truman &f.level=series
Content Detail Page - Descriptions
https://catalog.archives.gov/id/7283080
Content Detail Page - Person https://catalog.archives.gov/id/10678000
Content Detail Page - Organization
https://catalog.archives.gov/id/10506635
Content Detail Page - Workspace https://catalog.archives.gov/id/2825179/1/public? contributionType=tag
https://catalog.archives.gov/id/2825179/1/public? contributionType=transcription
Advanced Search Home Page https://catalog.archives.gov/advancedsearch
Advanced Search - DataSource All https://catalog.archives.gov/search?q=Truman&SearchType=advanced
Advanced Search - Single Source Selected
https://catalog.archives.gov/search?q=Truman&f.source=authority&SearchType=advanced
100
NARA Catalog Authorized User Interface Design
Advanced Search - Multiple Sources Selected
https://catalog.archives.gov/search? q=Truman&f.source=(online or authority)&SearchType=advanced
My Account - Home Page https://catalog.archives.gov/accounts/{username}
My Account - My Notifications https://catalog.archives.gov/accounts/{username}/notifications
My Account - Bulk Download Summary
https://catalog.archives.gov/accounts/{username}/exports
My Account - My Contributions https://catalog.archives.gov/accounts/{username}/contributions?contributionType={tags/transcriptions}
My Account - My Lists https://catalog.archives.gov/accounts/{username}/lists
Moderator - Homepage https://catalog.archives.gov/accounts/moderator
Moderator - View Public contributions Stream
https://catalog.archives.gov/moderatorWorkbench?tabType={tag/transcription/moderator}
Account Admin - Homepage https://catalog.archives.gov/accounts/accountadmin
Account Admin – Create an Account
https://catalog.archives.gov/administratorWorkbench?tabType=register
Account Admin – Manage Accounts
https://catalog.archives.gov/administratorWorkbench?tabType=manage
Browse https://catalog.archives.gov/browse
Statistics https://catalog.archives.gov/statistics
Table 5.2: Persistent URLs
101
NARA Catalog Authorized User Interface Design
6 UI Technology
For an overview of the guiding principles, overall UI architecture, and the UI project structure of the Catalog system, please refer to the NARA Catalog User Interface Design document.
102
NARA Catalog Authorized User Interface Design
7 List of FiguresFIGURE 2.2: MODERATOR HOMEPAGE [DESIGN ENHANCEMENT: DE-25]..................................................................10FIGURE 2.3: MODERATION WORKBENCH..............................................................................................................12FIGURE 2.3.2.1-1: FILTER BY ID........................................................................................................................16FIGURE 2.3.2.1-2: FILTER BY ID – FILTER APPLIED [DESIGN ENHANCEMENT: DE-25]..................................................17FIGURE 2.3.2.2: LOOK UP ID POP UP [DESIGN ENHANCEMENT: DE-601].................................................................18FIGURE 2.3.3-1: REASON DROP-DOWN LIST – “CREATE NEW REASON…” OPTION.......................................................19FIGURE 2.3.3-2: CONFIGURE REASON SELECTOR...................................................................................................20FIGURE 2.4.1: LATEST TAGS PAGE......................................................................................................................22FIGURE 2.4.2-1: REMOVING A TAG.....................................................................................................................24FIGURE 2.4.2-2: TAG HAS BEEN REMOVED [DESIGN ENHANCEMENT: DE-25]...........................................................26FIGURE 2.4.3: RESTORING A TAG [DESIGN ENHANCEMENT: DE-25].........................................................................27FIGURE 2.4.4: VIEWING THE REASON FOR REMOVING A TAG [DESIGN ENHANCEMENT: DE-25]....................................28FIGURE 2.5.1: LATEST COMMENTS PAGE.............................................................................................................30FIGURE 2.5.2-1: REMOVING A COMMENT............................................................................................................32FIGURE 2.5.2-2: COMMENT HAS BEEN REMOVED [DESIGN ENHANCEMENT: DE-25]...................................................34FIGURE 2.5.3: RESTORING A COMMENT [DESIGN ENHANCEMENT: DE-25]................................................................35FIGURE 2.5.4: VIEWING THE REASON FOR REMOVING A COMMENT [DESIGN ENHANCEMENT: DE-25]...........................36FIGURE 2.6.1: LATEST TRANSCRIPTIONUPDATES PAGE [DESIGN ENHANCEMENT: DE-25]..............................................38FIGURE 2.6.1.1: EXPANDED TRANSCRIPTION FIELD [DESIGN ENHANCEMENT: DE-25]..................................................40FIGURE 2.6.2: VIEWING PREVIOUS TRANSCRIPTIONS [DESIGN ENHANCEMENT: DE-601]..............................................42FIGURE 2.6.3: CHANGING THE CURRRENT VERSION [DESIGN ENHANCEMENT: DE-601]...............................................44FIGURE 2.6.4: REMOVING A TRANSCRIPTION [DESIGN ENHANCEMENT: DE-601]........................................................46FIGURE 2.6.5: VIEWING THE REASON FOR REMOVING A TRANSCRIPTION [DESIGN ENHANCEMENT: DE-25].....................47FIGURE 2.7.1: LATEST TRANSLATION UPDATES PAGE..............................................................................................49FIGURE 2.7.1.1: EXPANDED TRANSLATION FIELD...................................................................................................52FIGURE 2.7.2: VIEWING PREVIOUS VERSIONS........................................................................................................53FIGURE 2.7.3: CHANGING THE CURRRENT VERSION................................................................................................55FIGURE 2.7.4: REMOVING A TRANSLATION...........................................................................................................56FIGURE 2.8: LATEST MODERATOR ACTIONS PAGE [DESIGN ENHANCEMENT: DE-25]....................................................59FIGURE 2.8.1: MODERATOR ACTIONS – VIEWING A NOTE [DESIGN ENHANCEMENT: DE-25]........................................61FIGURE 2.9-1: ANNOUNCEMENT PAGE, NO ANNOUNCEMENT CONFIGURED.................................................................62FIGURE 2.9-2: ANNOUNCEMENT PAGE, ANNOUNCEMENT CONFIGURED......................................................................63FIGURE 2.9-3: HOME PAGE DISPLAYING THE CONFIGURED ANNOUNCEMENT [DESIGN ENHANCEMENT: DE-17A] [DESIGN
ENHANCEMENT: DE-17B] [DESIGN ENHANCEMENT: DE-600A].......................................................................64FIGURE 2.10-1: BACKGROUND IMAGES PAGE, NO IMAGES DEFINED, DEFAULT IMAGE SET IS ACTIVE.................................65FIGURE 2.10-2: BACKGROUND IMAGES PAGE, IMAGES DEFINED, DEFAULT IMAGE SET IS INACTIVE, NEW DATA IS ENTERED. . .67FIGURE 2.10-3: BACKGROUND IMAGES PAGE, IMAGES DEFINED, DEFAULT IMAGE SET IS INACTIVE, NEW DATA HAS BEEN
ADDED...................................................................................................................................................68FIGURE 2.10-4: HOME PAGE DISPLAYING A DEFINED BACKGROUND IMAGE [DESIGN ENHANCEMENT: DE-17A] [DESIGN
ENHANCEMENT: DE-17B] [DESIGN ENHANCEMENT: DE-17D] [DESIGN ENHANCEMENT: DE-600A]......................68FIGURE 2.11-1: ONLINE AVAILABILITY PAGE, NO NOTIFICATION RETRIEVED.................................................................69FIGURE 2.11-2: SAMPLE ARCHIVAL DESCRIPTION DISPLAYING AN ONLINE AVAILABILITY NOTIFICATION..............................71
103
NARA Catalog Authorized User Interface Design
FIGURE 2.11-3: ONLINE AVAILABILITY PAGE, AN ONLINE AVAILABILITY NOTIFICATION RETRIEVED.....................................71FIGURE 2.11-4: ONLINE AVAILABILITY PAGE, AN ONLINE AVAILABILITY NOTIFICATION IN EDIT MODE...............................73FIGURE 2.11-5A: ONLINE AVAILABILITY PAGE, TEXT FORMATTING OPTIONS.................................................................73FIGURE 2.11-5B: ONLINE AVAILABILITY PAGE, TEXT FORMATTING OPTIONS.................................................................74FIGURE 2.11-6: ONLINE AVAILABILITY PAGE, AN ONLINE AVAILABILITY NOTIFICATION AFTER SAVING................................74FIGURE 2.11-7: ONLINE AVAILABILITY PAGE, MODERATION LOG FOR THE ONLINE AVAILABILITY NOTIFICATION THAT WAS
MODIFIED...............................................................................................................................................75FIGURE 2.11-8: ONLINE AVAILABILITY PAGE, AN ONLINE AVAILABILITY NOTIFICATION TOGGLED OFF.................................76FIGURE 2.11-9: SAMPLE ARCHIVAL DESCRIPTION NO LONGER AN ONLINE AVAILABILITY NOTIFICATION (MODERATOR TOGGLED
IT OFF)...................................................................................................................................................76FIGURE 2.11-10: MODERATOR ACTIONS PAGE......................................................................................................77FIGURE 3.2: ACCOUNT ADMINISTRATOR HOME PAGE [DESIGN ENHANCEMENT: DE-25]..............................................79FIGURE 3.3: ACCOUNT ADMINISTRATOR WORKBENCH [DESIGN ENHANCEMENT: DE-601]...........................................81FIGURE 3.3.1: CREATING AN ACCOUNT [DESIGN ENHANCEMENT: DE-601]...............................................................81FIGURE 3.3.1.1-1: USER TYPE DROP-DOWN [DESIGN ENHANCEMENT: DE-601]........................................................83FIGURE 3.3.1.1-2: USER TYPE FIELD FILLED IN [DESIGN ENHANCEMENT: DE-601].....................................................83FIGURE 3.3.1.2: CREATING AN ACCOUNT - USERNAME EXISTS ERROR [DESIGN ENHANCEMENT: DE-25] [DESIGN
ENHANCEMENT: DE-601].........................................................................................................................84FIGURE 3.3.2: ACCOUNT CREATION SUCCESSFUL CONFIRMATION [DESIGN ENHANCEMENT: DE-25] [DESIGN ENHANCEMENT:
DE-601]...............................................................................................................................................84FIGURE 3.3.3: MANAGE ACCOUNTS PAGE [DESIGN ENHANCEMENT: DE-601]...........................................................85FIGURE 3.3.4-1: MANAGE ACCOUNT PAGE WITH RESULTS [DESIGN ENHANCEMENT: DE-25] [DESIGN ENHANCEMENT: DE-
601].....................................................................................................................................................87FIGURE 3.3.4-2: ACTIVE VERSUS INACTIVE USER STYLING [DESIGN ENHANCEMENT: DE-25].........................................88FIGURE 3.3.4.1-1: EDITING AN ACCOUNT [DESIGN ENHANCEMENT: DE-25] [DESIGN ENHANCEMENT: DE-601].............89FIGURE 3.3.4.1-2: AN ACCOUNT HAS BEEN DEACTIVATED [DESIGN ENHANCEMENT: DE-25].......................................91FIGURE 3.3.4.1.1: USER ACCOUNT IN EDIT MODE [DESIGN ENHANCEMENT: DE-25] [DESIGN ENHANCEMENT: DE-601]. 92FIGURE 3.3.4.2-1: RESET PASSWORD CONFIRM [DESIGN ENHANCEMENT: DE-601]...................................................92FIGURE 3.3.4.2-2: RANDOM PASSWORD SENT TO USER’S EMAIL [DESIGN ENHANCEMENT: DE-601]............................93FIGURE 3.3.4.3: VIEWING USER ACCOUNT NOTES [DESIGN ENHANCEMENT: DE-25] [DESIGN ENHANCEMENT: DE-601]..94
104
NARA Catalog Authorized User Interface Design
8 Requirements Index
1.10...............................961.10.1............................961.10.2............................961.10.3............................961.10.4............................961.10.5............................961.10.6............................961.15...............................971.15.3............................971.15.4............................971.15.5............................971.15.6............................971.15.7............................971.15.8............................971.15.9............................971.17...............................971.17.12..........................971.20.........................16, 171.20.1......................16, 171.21...............................161.5.3.2.1........................961.5.4.7...........................971.5.5.1.1.2.....................691.5.5.1.1.3............9, 11, 691.5.5.1.1.4............9, 11, 6916.10...............................916.10.1....................13, 1516.10.2....................13, 1416.10.3...............13, 14, 1516.10.4.................9, 10, 6416.10.5.................9, 10, 6116.10.6..........................7616.10.7..........................7616.3.2......................12, 8016.3.4............................1516.3.5............................1416.3.6......................14, 153.1.................................373.1.2..............................373.1.2.1...........................373.13...............................393.18...............................97
3.2.................................373.20...............................973.22...............................583.24...............................593.4.................................373.4.1..............................373.4.1.1...........................393.4.1.2...........................393.4.1.3.....................37, 383.4.1.4...........................393.4.2...................37, 41, 453.4.2.1.....................19, 463.4.2.1.1..................19, 463.4.2.1.2........................463.4.2.2...........................473.4.2.2.1.......19, 47, 48, 613.4.2.3.....................19, 463.4.2.4...........................583.4.3...................37, 41, 433.4.3.1.....................19, 443.4.3.1.1..................19, 443.4.3.1.2........................443.4.3.2...........................453.4.3.2.1.......19, 47, 48, 613.4.3.3.....................19, 443.4.3.4...........................584.1.1..............................484.1.1.1...........................484.1.4.2...........................484.14...............................484.17.........................48, 504.19...............................484.2.1..............................484.22...............................974.23...............................974.25...............................584.26.........................48, 594.3.................................484.4.................................484.5.................................484.6.................................484.6.1..............................48
4.6.2..............................484.6.3..............................484.8.................................484.8.1..............................484.8.1.1...........................504.8.1.2...........................504.8.1.3...........................484.8.1.4...........................504.8.2...................48, 52, 564.8.2.1.....................19, 574.8.2.1.1..................19, 574.8.2.1.2........................574.8.2.2...........................574.8.2.2.1.............19, 58, 614.8.2.3.....................19, 574.8.2.4...........................584.8.3........................48, 544.8.3.1.....................19, 554.8.3.1.1..................19, 554.8.3.1.2........................554.8.3.2...........................564.8.3.2.1.............19, 58, 614.8.3.3.....................19, 554.8.3.4...........................585.1.................................215.18...............................215.2.................................215.28...............................975.29...............................975.3.................................215.30...............................585.6.................................215.6.1..............................215.6.1.1...........................235.6.1.2...........................235.6.1.3...........................235.6.2...................21, 23, 245.6.2.1................19, 24, 255.6.2.1.1..................19, 245.6.2.1.2........................255.6.2.2...........................255.6.2.2.1..................29, 61
105
NARA Catalog Authorized User Interface Design
5.6.2.3.....................19, 245.6.2.4...........................585.6.3...................21, 26, 285.6.3.1................19, 27, 285.6.3.1.1..................19, 275.6.3.1.2........................275.6.3.2...........................285.6.3.2.1..................29, 615.6.3.3.....................19, 275.6.3.4...........................586.1.................................296.2.................................296.2.1..............................296.2.4..............................296.25...............................976.26...............................976.27...............................976.3.................................296.31.........................29, 586.4.................................296.4.1..............................296.4.1.1...........................316.4.1.2...........................316.4.1.3...........................316.4.2........................29, 326.4.2.1.....................19, 336.4.2.1.1..................19, 336.4.2.1.2........................336.4.2.2...........................346.4.3........................29, 346.4.3.1................19, 35, 36
6.4.3.1.1..................19, 356.4.3.1.2........................356.4.3.2...........................366.4.3.2.1.............36, 37, 616.4.3.3.....................19, 356.4.3.4...........................586.4.4..............................336.4.4.1................36, 37, 616.4.4.2.....................19, 336.4.4.3...........................588.1.................................788.1.1........................81, 848.1.1.1................83, 86, 898.1.1.1.1..................81, 828.1.1.2..........81, 83, 86, 898.1.1.2.1..................86, 898.1.1.3...........................848.1.1.4.......................9, 788.1.2..............................888.1.3..............................858.1.3.1...........................888.1.3.1.1........................878.1.3.1.1.1...............87, 888.1.3.2...........................868.1.3.2.1........................868.1.3.2.2........................868.1.3.2.3........................868.1.3.2.4..................86, 908.1.3.2.5........................868.1.3.3...........................858.1.3.4...........................87
8.1.3.5...........................878.1.3.6...........................878.1.4..............................898.1.4.1.....................78, 898.1.4.1.1........................918.1.5..............................918.1.5.1.....................91, 928.1.5.2.....................90, 928.1.5.2.1........................928.1.6..............................928.1.6.1.....................90, 928.1.6.1.1........................948.1.7..............................928.7.................................828.7.1..............................84DE-17a.....................64, 68DE-17b.....................64, 68DE-17c...........................61DE-17d.....................64, 68DE-25. . .10, 17, 26, 27, 28,
34, 35, 36, 38, 40, 47, 59, 61, 79, 84, 87, 88, 89, 91, 92, 94
DE-600a...................64, 68DE-601. 18, 42, 44, 46, 81,
83, 84, 85, 87, 89, 92, 93, 94
DE-82a.................9, 11, 69DE-82b.....................74, 75DE-82c.....................74, 75DE-82d...........................76
106