view tool rating and review - nitrc.org cases … · web viewthis document contains all use cases...

Neuroimaging Informatics Tools and Resources Clearinghouse (NITRC)

Release 2010-05

Use Cases

Note: Please note that should there be conflicts between functionality noted in Section 2 and Section 3, the functionality described in Section 3: Specific UI Enhancements supercedes Section 2.

document.docx 10-May-23

Table of Contents1. PURPOSE..............................................................................................................................................................4

2. USE CASES...........................................................................................................................................................4

2.1 CREATE TOOL RATING AND REVIEW..............................................................................................................42.2 VIEW TOOL RATING AND REVIEW..................................................................................................................62.3 VIEW PUBLISHED PROFESSIONAL REVIEWS....................................................................................................72.4 NAVIGATE TOPIC TREE...................................................................................................................................82.5 VIEW TOOL SUMMARY..................................................................................................................................102.6 EDIT TOOL/RESOURCE TREE ATTRIBUTES....................................................................................................132.7 CREATE/EDIT TOOL RELEASES.....................................................................................................................142.8 DOWNLOAD TOOL RELEASES........................................................................................................................152.9 EDIT PROJECT PUBLIC INFORMATION...........................................................................................................162.10 VIEW TOOL DOCUMENTS...............................................................................................................................182.11 REQUEST TOOL DOCUMENT DELETION........................................................................................................192.12 SEARCH NITRC............................................................................................................................................202.13 EDIT PROJECT GROUP MEMBERS..................................................................................................................212.14 REQUEST TO JOIN TOOL/RESOURCE...............................................................................................................222.15 DOWNLOAD COMPLETE PROJECT RESOURCES..............................................................................................222.16 SUBMIT NEWS...............................................................................................................................................232.17 SEARCH FOR TOOL/RESOURCE......................................................................................................................242.18 COLLABORATE WITH MEDIAWIKI PLUG-IN..................................................................................................242.19 EMAIL USERS................................................................................................................................................252.20 MAIL MEMBERS OF A PROJECT.....................................................................................................................262.21 REGISTER NEW TOOL OR RESOURCE............................................................................................................272.22 ASSOCIATE PROJECT WITH ANOTHER TOOL/RESOURCE...............................................................................282.23 SUBMIT COMMENTS / SUGGESTIONS TO NITRC...........................................................................................292.24 DISPLAY HOME PAGE....................................................................................................................................292.25 VIEW TOOL TRACKER LIST...........................................................................................................................322.26 VIEW/SUBMIT FORUM ARTICLES..................................................................................................................332.27 ADMINISTER TOOL TRACKER........................................................................................................................332.28 UPDATE FEATURED TOOL/RESOURCE...........................................................................................................34

3. SPECIFIC UI ENHANCEMENTS...................................................................................................................35

3.1 DESCRIBE MOST ACTIVE ORDER..................................................................................................................353.2 CONTEXT HELP..............................................................................................................................................353.3 LINK TO FAQ................................................................................................................................................363.4 DYNAMIC SITE THEME..................................................................................................................................363.5 DISPLAY NEWS..............................................................................................................................................363.6 ENHANCED BOOKMARKING...........................................................................................................................373.7 LINK UPLOADED DOCUMENTS TO A DEFAULT MEDIAWIKI DISCUSSION....................................................373.8 BIOSITEMAPS DOWNLOAD.............................................................................................................................383.9 TOOL/RESOURCE SEARCH.............................................................................................................................383.10 CONFIGURE ATTRIBUTE GROUPS FOR TOOL/RESOURCE SEARCH................................................................423.11 SET CUSTOM SCM INSTRUCTIONS................................................................................................................423.12 COMPARE TOOLS/RESOURCES.......................................................................................................................43


NITRC Release 2010-05 Use Cases

1. PurposeThis document contains all use cases describing the system behavior of the Neuroimaging Informatics Tools and Resources Clearinghouse (NITRC). Since NITRC is built from the existing GForge system, whenever possible use cases are described as differences from default GForge functionality.

Once the code supporting the use cases described has been implemented, tested, and put into production, tracked changes are accepted and the process starts anew with the next set of Iterations. For ease of review, use cases that have no changes (e.g., tracked changes) have been hidden from view, as they are already developed and in production on www.nitrc.org.

The section “Requirement/Feature Request Reference” is formatted differently for the most recent rows. Originally, the NITRC team was developing off a Baseline Requirements List ID number with traceability to a Gap Analysis worksheet. After NITRC was launched, the tracking process was modified to utilize the inherent nitrc.org tracker functionality to cross reference requirements with software development. In addition, after the most recent Change Control Board meeting August 2008, the CCB part number was added as a cross reference. Finally, traceability is ensured by cross referencing the use case number with the nitrc.org Feature Request tracker item.

2. Use Cases

2.1 Create Tool Rating and Review

2.1.1 Description:A registered user wants to rate and review a NITRC tool/resource. Non registered users cannot rate and review, only browse tool reviews.

2.1.2 Actors:Registered User

2.1.3 Preconditions:1. The user is a registered user.2. The user must be logged in.3. The user navigates to the “create tool rating and review’ page for a particular tool/resource

link.

2.1.4 Flow of Events:1. The user navigates to the “create tool rating and review” page for a particular NITRC

tool/resource through a link that is associated with that project (please see the “View Tool Rating and Review” use case).

2. The system presents a form with both rating select boxes and review text fields that present a review and rating survey (please see Special Requirements).

3. The user fills and submits the survey or cancels:a. If the user presses cancel, return the user to the “View Tool Rating and Review” use

caseb. If the user submits the form, proceed to the next step

4. The system checks the data type and length of appropriate fields and the existence of mandatory fields (please see Special Requirements):

a. If there is a data type mismatch or a mandatory field is empty, we return to step 2 with the form still populated with the submitted data and an appropriate error


http://www.nitrc.org/


message at the top of the page.b. If there is no error, we proceed to the next step...

5. The system adds the rating and review to the database. This review overwrites any existing review that the user has for the project (which is important to avoid ballot stuffing).

6. The system updates the aggregate rating scores for the reviewed project.7. The system sends the user to the “View Tool Rating and Review” use case with an

appropriate success message.

2.1.5 Alternate Flow: The user presses cancel in the form:

o Return the user to the “View Tool Rating and Review” use case

The user submits a form whose fields data type, length, or existence do not match form requirements (please see Special Requirements):

o Return to step 2 of the flow of events with an appropriate error message

2.1.6 Post Conditions:1. A new rating and review is added to the database.2. The aggregate rating scores are updated for a project.3. The system internally tracks the user_id indefinitely in case follow-up is needed later due to

malicious reviews.

2.1.7 Special Requirements:Please see Documentation\Web Page Content\ToolRatingQuestions.doc for the introductory rating and review text regarding NITRC’s default position on review anonymity versus the ability to elect to enter in contact information, review questions, mandatory rating versus optional comment fields, and field data types.

The default rating/review functionality requires users to submit a new tool review to replace their existing review if they would like to change it. This will be enhanced so a user can edit a tool rating/review they have submitted.

2.1.8 Requirement/Feature Request ReferenceGap ID/ FR ID

BRL ID/ CCB PART Requirement

7.1.5 6.3.3.2.1.1 Accept input to a standard tool and resource rating system from users

7.1.5-1 Users will be able to complete a review survey with results associated with an individual project

7.1.5-2 Project review results are aggregated for each project

7.1.6 6.3.3.2.1.2.2 Accept ratings of resources and tools from users

7.1.6-1 Ratings include "Overall", "Ease of Installation", "Performs Expected Functions"

7.1.7 6.3.3.2.1.2.3 Accept reviews of resources and tools from users

7.1.8 6.3.3.2.1.2.5 Accept information regarding the perceived long-term prospects for the resource or tool from tool users.

7.1.9 6.3.3.2.1.3 Allow users to record what they were using before they switched to a given resource or tool and how they made the transition



7.1.19 6.3.3.2.3.1 Accept ratings on ease of installation of tools and resources from users

7.3.18 6.1.1.2 Store comments about tools and resources from users

7.3.22 6.3.3.2.1.2.2 Record user ratings of resources and tools

7.3.23 6.3.3.2.1.2.3 Store user reviews of resources and tools

7.3.24 6.3.3.2.1.2.5 Store tool user input regarding the perceived long-term prospects for the resource or tool

7.3.25 6.3.3.2.1.3 Record user conversion information

7.3.34 6.3.3.2.3.1 Store user ratings on ease of installation of tools and resources

8.1.1 6.3.8.1.6 The Contractor shall provide a concise and simple to understand system for rating Neuroimaging informatics tools and resources

333 Rating P1 Ability to edit one's own review of a tool instead of submitting a new review to replace the existing one

2.2 View Tool Rating and Review

2.2.1 Description:A user (observer) wants to view the detailed ratings and reviews for a NITRC tool/resource

2.2.2 Actors:Observer

2.2.3 Preconditions:1. The user navigates to the tool rating and review page for a particular NITRC tool/resource.

2.2.4 Flow of Events:1. The user navigates to the tool rating and review page for a particular NITRC tool/resource.

This can be done through:a. A tool-level menu for reviewsb. A link from the tool summary page (see the View Tool Summary use case)c. A link from the results page of the search results from the tool tree (see the

Navigate Topic Tree use case)2. The system generates a report of the ratings and reviews for a NITRC tool containing:

d. Aggregate scores for the ratingse. A link for the user to write their own review (see the Create Tool Rating and

Review use case)f. All of the individual rating and review responses starting from the most recent

i. These responses will be paged in groups of 10 (i.e. displaying at most 10 reviews and providing links to navigate forward and backward in the result set)

2.2.5 Alternate Flow: The user clicks on a link to write their own review for the tool

o Send the user to the Create Tool Rating and Review use case

The user clicks on a link to page through the results



o Return to step 2 of the flow of events with the appropriate page of results

2.2.6 Post Conditions:1. The user is presented a report of the ratings and reviews for a NITRC tool

2.2.7 Special Requirements: This use case generates a new tool-level menu entry for NITRC tools and resources See Documentation\Web Page Content\ToolRatingQuestions.doc for the headings used for

the rating and review responses The authors of displayed ratings and reviews will be kept anonymous (unless the author

places identifying information within the review)

2.2.8 Requirement/Feature Request ReferenceGap ID/ FR

IDBRL ID/ CCB

PART Requirement7.2.25 6.3.3.2.1.1 Display user ratings of tools and resources

7.2.25-1 Aggregate overall ratings are displayed with project tree properties in project summary page and project tree search results

7.2.25-2 Overall ratings link to a View Project Reviews page that allows users to view other users’ reviews for the tool or resource

7.2.27 6.3.3.2.1.2.2 Display user ratings of resources and tools

7.2.28 6.3.3.2.1.2.3 Display user reviews of resources and tools.

7.2.29 6.3.3.2.1.2.5 Display tool user input regarding the perceived long-term prospects for the resource or tool

7.2.30 6.3.3.2.1.3 Display user conversion information

7.2.40 6.3.3.2.1.3.1 Display user ratings on ease of installation

2945 Browse/Site Nav. 2 Compact display review information to maximize page real estate

2.3 View Published Professional Reviews

2.3.1 Description:A user (observer) wants to view the published professional review documents for a NITRC tool/resource


2.3.3 Preconditions: The user navigates to the “Read Professional Reviews” page for a particular NITRC

tool/resource.

2.3.4 Flow of Events: The user navigates to the professional reviews page for a particular NITRC tool/resource.

This can be done through: A tool-level menu for professional reviews A link from the tool's user ratings page (see the View Tool Rating and Review use case)

The system takes the user to a folder in the NITRC Community project document manager containing:



Documents that the NITRC site wide moderator has added as published professional reviews

2.3.5 Alternate Flow:None

2.3.6 Post Conditions: The user is presented a list of professional review documents pertaining to that tool /

resource

2.3.7 Special Requirements: A new folder in the NITRC Community project is generated for every project in the system The link to professional reviews is to be shown only if there are documents in the professional reviews folder for a particular tool / resource

2.3.8 Requirement/Feature Request Reference

Gap ID/ FR ID


469 This feature request addresses the issue of easy access to professional reviews of tools and resources. Implementing this feature request would benefit tool users.Professional Reviews button on projects linked to default folder in Docs

2.4 Navigate Topic Tree

2.4.1 Description:A user (observer) uses a search box or tool/resource tree to find suitable tools and resources. This Use Case describes changes in functionality from the basic GForge functionality, in order to

Display other categories in the tool/resource tree as well as higher level categories, similar to Microsoft's Windows Explorer.

Display all projects in the current search category and below

Display aggregate reviews in the topic tree results, and.

Allow the user to display topic tree results in a matrix.


2.4.3 Preconditions: The user navigates to the tool/resource tree

2.4.4 Flow of Events: In addition to the existing flow of events, when a user chooses a category from the

tool/resource tree:a. The tree expands to show other categories that exist in the same branch, as well as

all categories that exist above the currently selected category branchb. All projects contained in that category are displayed, as well as all projects contained

within subfolders of that category.document.docx 10-May-23


c. The results are displayed in the standard GForge (vertical) form, and a system provides a link to display the results in “matrix form”.

d. The results include aggregate user rating scores (please see Special Requirements)i. The aggregate rating scores link to the View Tool Rating and Review use

case for that project.e. The results include a link from project licenses to a detailed text description of the

license (please see the Edit Tool Tree Categories use case).f. When the user clicks on the “matrix form” link, the system presents the same search

results as the standard form, but in a table with individual tools aligned as columns and the project attributes and categories aligned as rows.

i. The matrix view should separate the topics that are assigned to each tool into separate rows with an x under each column/tool indicating that topic applies

2.4.5 Alternate Flow: If no data is available for the search parameters, an appropriate error message is displayed.

2.4.6 Post Conditions: The user is presented aggregate rating scores The user is presented an opportunity to navigate to a page through which they can write their

own reviews The user is able to view the search results in matrix form.

2.4.7 Special Requirements:The system will display all the aggregate rating scores for the project and the number of ratings with the tool/resource tree categories and in the same format as the tree categories. Please see Documentation/Web Page Content/ToolRatingQuestions.doc for the rating headings.


Gap ID/ FR ID

BRL ID/ CCB

PART Requirement7.2.25 6.3.3.2.1.

1Display user ratings of tools and resources


7.2.25-2 Overall ratings link to a View Project Reviews page that allows users to view other user's reviews for the tool or resource

7.2.31 6.3.3.2.1.4

Display in matrix form system-collated features and standards

7.2.31-2 With project tree results provide a link "Display as a table" that results in a matrix display of result standards and features

7.2.37 6.3.3.2.1.9.1

Display descriptions of licenses and what they mean to users

7.2.40 6.3.3.2.1.3.1

Display user ratings on ease of installation



Gap ID/ FR ID

BRL ID/ CCB

PART Requirement431 For a topic tree selection, show all projects in the current topic and below

34 Display cousins in project tree navigation instead of breadcrumb format

508 In Matrix View, split attributes into separate columns for easier comparison

528 Allow users to view all the children of a particular topic at once

2.5 View Tool Summary

2.5.1 Description:A user (observer) views a summary page for the tool/resource that contains a tool description, assigned tool categories, and summary information about tool assets. This use Case describes changes in functionality from the basic GForge functionality, in order to:

Display aggregate review results, and

Link to tool license details.

Display the number of documents located in the tool's document manager

See project funding information below

See defined project relationships below

Display total download count

In addition, the following changes are a result of usability testing: The center column of the page displays an expandable/collapsible box containing

attributes the administrator tagged to the tool/resource The center column also displays an expandable/collapsible box containing associated

tools/resources and their relationships The center column also contains a project activity box for this tool/resource's recent

forums, files, history, screenshots, trackers, etc. A new "Participate" box is shown on the right column that offers users quick links to

submit various forms of information or join the team.


2.5.3 Preconditions:1. The user navigates to the summary page for a tool/resource

2.5.4 Flow of Events:1. In addition to the existing flow events:

a. The summary information includes aggregate rating scores (please see Special Requirements).

b. The summary information includes a link from project licenses to a detailed textc. Next to the Activity %, we display the total download countd. Description of the license (see the Edit Tool Tree Categories use case).

2. Show the number of documents that are contained in the tool's document manager



3. Show any funding information set by the project administrator (see Edit Public Information)4. Show any specified project relationships set by the project administrator (see Associate

Project with Another Tool/Resource)

2.5.5 Alternate Flow: If no data is available for the aggregate rating scores, an appropriate icon or message

portraying the lack of reviews is displayed.

2.5.6 Post Conditions: The user is able to see aggregate rating scores The user is able to see detailed text descriptions of tools’ licenses.

2.5.7 Special Requirements:The system will display the all aggregate rating scores for the project and the number of ratings with the tool/resource tree categories and in the same format as the tree categories. Please see Documentation/Web Page Content/ToolRatingQuestions.doc for the rating headings.

The following diagram summarizes the interface updates:


High-level changes include:

The summary page shows a "Specifications" DIV in the center column of the page The summary page shows a "Associations" DIV in the center column under the

"Specification"DIV Below the dynamic box sections, the summary page shows the "Project Activity" history

list A new information box containing “Participate” links is shown on the right Various page elements have been repositioned



Specific requirements: Specifications

1. The new dynamic “Specifications” box will show topic associations made by the tool/resource administrator

a. When the box is collapsed: All attributes under “Functionality” and “License” roots

b. When the box is expanded: All attributes associated with the tool/resource Associations

1. The new dynamic “Associations” box will show tools that are related to the current tool by subproject or other admin selected relationship

a. When the box is collapsed: Only association types “Is Part Of” and “Has Subpart” will be shown

b. When the box is expanded: All association types will be shown Project Activity

1. The new “Project Activity” box will show the ten latest updates to project data2. The “Project Activity” box can be filtered by a select list of NITRC modules

located on its' top right cornerDifferences from the graphic:

Subscribe to RSS feed: This will include the standard RSS icon next to the link The initial release of NITRC 2.0 covers: Files, News, Forums, Docs, Trackers, & Wiki changes.

The remaining project feeds: Tasks, Mailing List (creation), and Screenshots will be added at a later phase of NITRC 2.0 (Iteration 15 or 16).

Gap ID/ FR ID


7.2.25 6.3.3.2.1.1 Display user ratings of tools and resources


7.2.25-2 Overall ratings link to a View Project Reviews page that allows users to view other users’ reviews for the tool or resource

7.2.37 6.3.3.2.1.9.1 Display descriptions of licenses and what they mean to users

7.2.37-1 On the project summary page, next to a listed license, a help symbol leads to a full license description if available.

444 DocManager Summary on resource home page

25 Compare P5 Funding field for tool and resources

642 Browse/Site Navigation P2

Show the download count on tools’ summary pages

3427 Implement Tool/Resource Summary page

2.6 Edit Tool/Resource Tree Attributes

2.6.1 Description:The system administrator adds or edits attributes to the tool/resource tree (also called a “Trove tree” in GForge). This Use Case describes changes in functionality from the basic GForge functionality in order to:



Assign attributes to the NITRC front page tool or resource attribute trees (please see 2.24 Display Home Page)

2.6.2 Actors:System Administrator

2.6.3 Preconditions: The user has a valid system administrator account The user logs in as a system administrator The user navigates to the “browse attributes” page from the site administration page

2.6.4 Flow of Events: Two aligned columns will appear next to the list of attributes. The first column will be titled

“Used on front page tool tree”. The second will be titled “Used on front page resource tree”. If an attribute is on the respective front page tree, a green “Yes” link will appear If an attribute is not on the respective front page tree, a red “No” link will appear

If the system admin clicks on a “Yes” link, it will be replaced with “No”, and the attribute will not appear on the respective list. Similarly, clicking on a “No” will replace it with “Yes” and the attribute will then appear on the respective list. (Please note that assignments to the front page tree are in a single attribute by attribute basis. Selecting a parent attribute will not automatically select the child attribute nor vise versa.)

2.6.5 Post Conditions: Attributes will appear on the front-page attribute lists as assigned. The front-page tree will be

constructed through a depth-first search of the assigned attributes. Specifically, chosen attributes that have no chosen ancestors will appear on the top level of the tree.


IDBRL ID/ CCB

PART Requirement29 Browse/Site Nav. Implementation of Front Page Redesign

2.7 Create/Edit Tool Releases

2.7.1 Description:The project administrator (or user type given permission by the project administrator) uploads a file or external URL link as an official release for the project. This use Case describes changes in functionality from the basic GForge functionality in order to:

Make file releases links to external URLs.

Require change log for all tool releases

2.7.2 Actors:Project Administrator

A user type configured by the Project Administrator to have file release permissions

2.7.3 Preconditions: The user has a valid project administrator account, or an account designated by the project

administrator to have file release permissions The user logs in The user navigates to the create/edit tool release page



2.7.4 Flow of Events: In addition to the existing flow of events:

a. The user can specify a link to an external page instead of uploading a file

2.7.5 Alternate Flow: If neither a URL nor a file is uploaded, the system displays an error message stating that one

of the two is mandatory If no text is entered into the “change log text area, the system displays an error message

stating that some text must be supplied for the change log.

2.7.6 Post Conditions: If a URL is specified, the URL is stored into the database as the content of the file release.

2.7.7 Special Requirements:If the user associated an external URL to a file release, that URL is presented as the destination of the file release link (please see the “Download Tool Releases” use case).


IDBRL ID/ CCB

PART Requirement7.2.23 6.1.1.1 Provide tools and resources for download or pointers to tools and

resources

7.2.23-2 links to external downloads are displayed on the "Files" tab

834 Require change log with tool releases

2.8 Download Tool Releases

2.8.1 Description:A user downloads a release of a tool from a project. If the project administrator provided an external link as the release, the user is redirected to the destination of that URL. This use Case describes changes in functionality from the basic GForge functionality in order to:

Allow file releases to be links to external URLs.

Ensure human (non-search robot) downloading of resources through the use of a “captcha” to improve accuracy of download count.


2.8.3 Preconditions: The user has navigated to the “Files” tab or files section of the summary page for a project

2.8.4 Flow of Events: In addition to the existing flow of events

a. At the top of the file release page, provide a check box with the instructions to please check the box before clicking on the download links to ensure human intervention and to reduce false search robot download counts (note: the text could say that by checking the box they are agreeing to the software license terms).

b. In order to download any files from the page, the user must check the checkbox.c. If the project administrator has associated an external URL to a file release, the link

to the URL is provided as the destination of the file release link.d. If a user clicks on a release link and the link is associated with an external URL, the



user is directed to that URL.e. The “Release” column of the file packages table should show a tool tip with the text of

the release notes as well as provide a link to the actual notes

2.8.5 Alternate Flow: If a user clicks on a release link and the link is associated with an uploaded file, the user is

presented the file for download. If user did not check the human verification checkbox, they are returned to the file release

page with an appropriate error message.

2.8.6 Post Conditions: The user is redirected to the URL associated with the file release link.

2.8.7 Special Requirements: Permit the human verification checkbox data to be sent as a GET parameter so that

developers can use scripts to download the tools as well.


IDBRL ID/ CCB

PART Requirement7.2.23 6.1.1.1 Provide tools and resources for download or pointers to tools and

resources

7.2.23-2 links to external downloads are displayed on the "Files" tab

3019 Compare P4 Eliminate spybot/crawler counts from download statistics

2.9 Edit Project Public Information

2.9.1 Description:The project administrator associates NITRC functionality (forums, tracker, SCM, MediaWiki etc.) with a project. This Use Case describes changes in functionality from the basic GForge functionality in order to:

Allow project administrators to add custom tool menu items that link to external URLs.

Allow project administrators to display appropriate funding sources or grant numbers

2.9.2 Actors:Project administrator

2.9.3 Preconditions: The user has a valid project administrator account The user logs in The user navigates to the Project Admin / Edit Public Info page

2.9.4 Flow of Events: In addition to the existing flow of events

a. A form section “Custom Tool Menu Entries” is displayed. The section contains an array of rows that allow a user to add a new item to the tool menu. In each row there is a select box to suggest a menu item name, an edit box for a custom menu item name, an edit box for the destination URL, and a checkbox (“Display URL without NITRC Menu”) that controls if the destination URL is displayed with the NITRC menu.



i. The user enters the desired menu items and external URLs for the project.ii. The user may click the ‘graphic upload button and select a graphic of their choice

to be associated with the project. If a graphic is currently associated with the project, it will be displayed above the graphic upload button; otherwise a gray graphic with a note saying ‘currently no image is associated with this project’ will be displayed. The image upload will be limited to sizes of 500 KB and must be one of the following types: .jpg, .gif, .bmp, .tiff, .png. Image resolution recommendations are listed but not enforced.

iii. If the user does not wish to have the external links appear with the NITRC menu system, the user selects the checkbox stating, “Display URL without NITRC menu”.

iv. The user clicks submit.b. The page will also offer a text box that takes the funding sources and/or grant

numbers. This funding source will not be required for a valid tool/resource registration.

i. The user may provide a funding source in the appropriate text box.ii. The user clicks submit.

2.9.5 Alternate Flow: The user presses cancel

o The main project administration page is displayed

2.9.6 Post Conditions: The system stores entered custom tool menu entries and external links with the project.

2.9.7 Special Requirements:When a project administrator adds custom tool menu entries, they appear in the tool menu. Therefore the tool menu will have “Summary” at the top, “Advanced Search” second, “Admin” third (for Project or System Administrators), and the rest of the project menu entries in alphabetical order.

When a user selects the menu item associated with an external URL, the user is taken to the external link. If the external link has the “Display URL without NITRC menu” option selected, then the external link is displayed full-screen, otherwise the external link is presented in an IFRAME surrounded by the standard NITRC menus.

When a tool / resource admin creates custom menu items, the user must select from the available suggested names, or provide an altername name, but not both.

MediaWiki is automatically added to the default menu when a project is created. When a user clicks on MediaWiki, they are taken to a project entry page named after the project. Projects created prior to MediaWiki can enable this in under the manage tool menu screen.

Enhance editable text in the forums and wiki to support mathematical equation markup such as MathML.

Uploaded images will be displayed with the project on the right hand side of the project description area. If a project does not have a graphic associated with it, then the public view of the project will appear without a graphic.

The image upload limit will initially be set to 500 KB, but will be configurable if this needs to be increased or decreased in the future. Image resolution (pixel size) recommendations will be noted under the upload button. Adherence to these recommendations will be left up to file up loaders.




Gap ID/ FR ID


23 Project administrators can associate public project sections (such as forums, bug tracker, and wiki) with external links

52 Pull down menu options for standard external links346 Forum Math markup in forums

402 Project P1 Let the resources have a little graphic associated with them.

714 MediaWIki P1 Anything but PhpWiki (Part 1)

25 Compare P5 Funding field for tool and resources

2.10 View tool documents

2.10.1 Description:A user (observer) views tool / resource documents that are uncategorized by document group. Also, a tool / resource administrator adds documents to an uncategorized, default, top-level folder.

2.10.2 Actors:Any observer can view documents as well as tool / resource administrators to add/edit documents

2.10.3 Preconditions: The user navigates to the Docman utility The tool / resource administrator has added documents to the uncategorized top-level, default folder.

2.10.4 Flow of Events:1. The user is shown uncategorized documents that exist in a tool/resource top-level document

group.2. The user may download top-level documents without having to drill into document group

folder.3. Next to the document titles, the system will display the date/time the document was last

modified and the size of the document.

2.10.5 Alternate Flow (Uncategorized document):1. The tool / resource administrator (or other user with appropriate Docman permissions) desires to add a new document to the uncategorized document group.

a. The user clicks on the “submit new documentation” linkb. The user uploads a new document and selects “uncategorized” from the select list for

document group.

2.10.6 Post Conditions (Uncategorized document):1. The user is presented a list of documents that appear to be uncategorized that exist at the top

level of available document groups

2.10.7 Special Requirements If the user does not have permissions to delete a document, the system will place a trash can

next to the document with the pop-up text “Request Deletion of Document” (see Request Tool document.docx 10-May-23


Document Deletion) display “If you find an out-dated document, please send a request to the PROJECT’s administrator to delete the document.” (Where the bolded part is a link to the administrator’s email address.

2.10.8 Requirements/Feature Request ReferenceGap ID/ FR ID


450 Document tab default 'group'

2937

Browse/Site Navigation Part 11 Display Date/Time and Size with Project Docs

2.11 Request Tool Document Deletion

2.11.1 Description:A user requests that a tool document be deleted by having an email sent to the tool administrator.

2.11.2 Actors:Any observer viewing public documents but who does not have permission to delete the document.

2.11.3 Preconditions: The user navigates to the Docman utility Documents exist that can be viewed but not deleted by the user

2.11.4 Flow of Events:1 A user without document delete privileges wishes to request removal of a document2 When viewing the list of documents, when a user does not have delete privileges, a small

trash can is placed next to each document with the title (pop-up text) “Request deletion of document”.

a The user clicks on the “delete icon”b The system displays a dialog showing the user that they are requesting to delete a

document and is given a text box to explain why they wish the document to be deleted. The user is also presented submit buttons.

c The user enters the reasoning and presses submit

2.11.5 Alternate Flow (Cancel):1 The user presses cancel

a The user returns to the list of documents

2.11.6 Post Conditions:1 An email is sent to the tool administrator

2.11.7 Requirements/Feature Request Reference



Gap ID/ FR ID


463

Browse/Site Navigation Part 11 Ability to request deletion of a document

2.12 Search NITRC

2.12.1 Description:A single simple Boolean search will allow simultaneous searching of NITRC projects, ontology, internal NITRC web pages, and external web pages that are linked to NITRC project menus.

2.12.2 Actors:Observers.

2.12.3 Preconditions: The user has navigated to the NITRC website.

2.12.4 Flow of Events:1. The observer selects ‘Search NITRC’ from the search type drop-down list in the upper right-

hand corner. This is available on all pages.2. The observer enters search criteria and submits the request.3. The user is presented search results with three sections with search results:

a. Projectsb. Keywordsc. Web Pages

2.12.5 Alternate Flow:None

2.12.6 Post Conditions:1. The user is able to sort project results by name, average rating, activity percentile, and

download count2. The user is able to sort web page results by name, search relevance, project name, and

modulea. In the web page results the user will be able to select a project name and/or module

name and filter the results to that project and/or module.

2.12.7 Special Requirements: Initial implementation will include simple Boolean “and”. If possible “or” and “not” will be

added. “Search NITRC” is the default search option for site-wide related pages such as the

NITRC main page. A web crawler will be used to navigate NITRC and external web pages starting with

project (and community) menuso Every page will therefore be associated with a project and the module (menu

item) through which they are related to NITRC The look and feel of the page will match the prototype (see “NITRC Search UI.pdf” –

though note that “Relevance” bar should be part of the Web search)





143 Search News P2

612 Search Advanced search (PubMed as best practice): Boolean logic, etc

613 Search Search by developer

660 Search Basic description of top-level searches

867 Search P1 Update Google Search to include any external link from project menus - interoperates

2853 Search P1 Uber-Search

2.13 Edit Project Group Members

2.13.1 Description:Projects require at least one administrator. Constraints will be put in place to prevent projects that have a single administrator by preventing them from switching their role to a non-administrator role such as developer. Without this check, the project could be left without an administrator. Currently a NITRC site administrator must authorize the next project administrator.

2.13.2 Actors:Project Administrator

2.13.3 Preconditions: A project administrator navigates to the role management module.

2.13.4 Flow of Events:1. A project administrator selects a new role for themselves2. GForge runs a check to verifies that another administrator exists for the project3. The project administrator is redirected back to the “manage roles” page and notified that they

are the only existing administrator on the project and therefore can not change their role until another administrator is assigned to the project.

2.13.5 Alternate Flow:1. The project has more than one administrator and allows the roles to change.

2.13.6 Post Conditions:The project retains an administrator

2.13.7 Special Requirements:None



410 Project P1 Safeguard against administratorless projects

2.14 Request to join tool/resource

2.14.1 Description:



Registered users are able to request to join any existing tool/resource. This use case describes the differences between the default Gforge functionality and desired NITRC behavior.


2.14.3 Preconditions: A registered user access the project summary page

2.14.4 Flow of Events:1. A registered user navigates to a tool/resource's “request to join” request form. The user fills

out the request and submits the form.2. An email is generated by the system and sent to the project administrator. This email informs

the administrator that a join request has occurred and provides the name and email address of the user who has made the join request.

2.14.5 Alternate Flow:1. None.

2.14.6 Post Conditions:The tool/resource administrator has an email notifying them of the join request.

2.14.7 Special Requirements:None



82 Send an email to the project administrator when a user requests to join their tool/resource.

2.15 Download Complete Project Resources

2.15.1 Description:Projects administrators can download all of the data from their projects in a compressed archive via a single-click export.

2.15.2 Actors: Project administrator either directly or via a Web client. Projects with private information will require authentication/authorization.

2.15.3 Preconditions: A project administrator has enabled ‘nightly project resource back-up’ for their project and has logged in and navigated to the project admin page.

2.15.4 Flow of Events:1. The project administrator clicks the administrator back-up button on the project admin page.2. The user will be prompted with a save as file dialog box. The default file name will be the

project name and date (YYYY_MM_DD). All spaces will be converted to underscores. Ex. brain_scanner_2008_01_18.zip

3. The user will save the archive to a location of their choice.

2.15.5 Alternate Flow:



1. User cancels file save as dialog box.

2.15.6 Post Conditions:1. Back up of project is saved to the project administrator’s location of choice.

2.15.7 Special Requirements: Project will default to disabled exports. Project administrators will have the ability

to enable exports in an easy to find and understand section on the project configuration page. This section will allow exports to be configured for different operating systems such as Mac / UNIX (.tar.gz), and PC (.zip).

Project exports are a snapshot of the as is code and other resources from the previous evening. Snapshots are created nightly by the system to avoid overloading the system during peak usage times, approximately 8 – 6 Monday – Friday across the continental US (5 am - 6 pm Pacific time zone).

Web clients that can authenticate with web servers such as wget, can be configured to download the current project export from a project’s one-click export URL.



657 System P1 One-click backup of project information for administrators

2.16 Submit News

2.16.1 Description:All users can propose news items for NITRC site-wide and/or project publication. After submission, the appropriate administrator, project, or system will be notified of the submission, and must log in and navigate to the approval page for pending news submissions process.

In addition, news from a special private project “Funding Opportunities”, will be displayed on the NITRC front page.

2.16.2 Actors:A Registered User

2.16.3 Preconditions: None

2.16.4 Flow of Events:1. User selects the "Submit NITRC Community News" menu option under the NITRC

"Community" menu.2. The user submits the new news article form.3. The administrator is altered that a news story has been submitted.4. The administrator logs onto the system and accepts / rejects submitted news story by

navigating to the approve pending news submissions component.

2.16.5 Alternate Flow:1. A NITRC administrator rejects a news story.

2.16.6 Post Conditions:1. Story submitter is notified on the outcome of the submission.



2. Administrator logs on and navigates to approve pending news submissions.3. Accepted news stories are posted to news.

2.16.7 Special Requirements: Site Administrator options will expand to include a publish news form. This will

permit them to accept or reject submitted news stories. On the front page of NITRC, the latest number of news items (determined by

aesthetics) from the special “Funding Opportunities” project will be displayed in a box under Recently Registered Tools/Resources. If there are no news items in the project, then the box will not be displayed.


Gap ID/ FR ID


492 News P1 Regular users to 'propose' news to NITRC Community

619 News P2 Display Submit News for only those who can submit news

873 Supplemental funding box on front page

2.17 Search for Tool/Resource

2.17.1 Description:This Use Case is being removed and combined with the NITRC Search.



614 Search P2 Allow searching by ontology keywords (tool tree categories).

619 News P2 Display Submit News for only those that can submit news

2.18 Collaborate with MediaWiki Plug-in

2.18.1 Description:Users will collaborate using MediaWiki, the most popular wiki program in the world, instead of GForge default PHPWiki. The addition of MediaWiki will fulfill several feature requests out-of-the-box that PHPWiki does not offer.


2.18.3 Preconditions: User navigates to MediaWiki page

2.18.4 Flow of Events:1. Use of MediaWiki default features.

2.18.5 Alternate Flow:1. None

2.18.6 Post Conditions:1. None



2.18.7 Special Requirements: Single sign on: Users and groups are shared between NITRC and MediaWiki. MediaWiki will be wrapped in NITRC's theme and menus but will retain its well

know look and feel. Integrate MediaWiki into NITRC menus to the extent technically possible MediaWiki provides out-of-the-box calendar functionality (FR 418). MediaWiki provides out-of-the-box page views/access statistics (FR 603). MediaWiki provides out-of-the-box page community editable wiki pages (FR 615). Existing Wiki pages will be migrated from PHPWiki to MediaWiki.


Gap ID/ FR ID


418 MediaWIki P2 Calendaring functionality via PHP or media wiki to support training events (Part 2)

603 MediaWIki P2 Figure out how we can track hits to specific wikis, specific forums, etc. (Part 2)

615 MediaWIki P3 Allow NITRC users to edit the NITRC Community Wiki. (Part 3)

2.19 Email Users

2.19.1 Description:The mail component of NITRC allows project administrators to set up mailing lists of users interested in their tool/resource. Users have the ability to "subscribe" to available lists.


2.19.3 Preconditions: User submits request to a download or a document or view a documentation page.

2.19.4 Special Requirements: Enhance NITRC generated emails to include the option to CC email addresses. Send a user an email with a link to a file, resource, wiki, thread, etc... This

functionality will appears at the bottom of the resource as a link indicating ‘e-mail this story’ or similar.

Email users when a news story has been posted. If it is a tool specific story then all users belonging to that tool will be emailed. If the story is site wide then all NITRC users will receive an email. Users can set preferences during registration or under account maintenance for each to receive the emails or read them online.


Gap ID/ FR ID


389 Mail cc option on NITRC generated emails

526 Mail Ability to invite selected members to consider monitoring a wiki, thread, what ever

699 News P2 E-mail notification for news



2.20 Mail Members of a Project

2.20.1 Description:A Tool/Resource Administrator sends an email to all project members in a project.

2.20.2 Actors:A Tool/Recourse Administrator

2.20.3 Preconditions: The Tool/Resource Administrator is logged in and navigates to a project for which they

are an administrator

2.20.4 Flow of Events:1. The Tool/Resource Administrator clicks on the “Admin” project menu2. At the bottom of the “Group Members” box, the user is presented a “Email all Members” link that is a mailto: link of all of the members in the project.3. The Administrator clicks on the link4. The mailto: link executes the user’s mail program to construct an email and populates the TO: address from the mailto: link5. The flow continues following the mail program’s process to mail a letter

2.20.5 Special RequirementsIn the instructions, note that the mail is not stored like a mailing list.



2938 Tool Resource Admin P1

NITRC Community FR 2928: automatic generation of mailing list

2.21 Register New Tool or Resource

2.21.1 Description:Enhance the default tool or resource registration process to permit tools to create a unique license type if applicable. All existing registration fields will remain as is with the exception of the license section that is detailed below.


2.21.3 Preconditions: The Register Tool/Resource (http://www.nitrc.org/register/projectinfo.php) will change from a drop down of standard licenses to a dropdown with all licenses (standard and project defined) and a radio button with two options: ‘Existing License Type’ (default) or ‘Add New License Type’.

2.21.4 Flow of Events:1. The user selects the existing license type applicable to their project.

2.21.5 Alternate Flow:1. If a registrant’s tool does not fall under one of the existing categories they will select the ‘Add

New License Type’ radio button. This will enable the section to add a new license type. The radio button ensures only an existing license or a new license type is submitted.



2. The user enters a name and description and clicks submit.3. A new license type is created.

2.21.6 Post Conditions:1. The tool is automatically categorized with the created / selected license type new or existing.

2.21.7 Special Requirements: When a new license type is submitted, a new category titled with the license

name field will be auto created under the Other/Proprietary license type category. This category structure is automatically listed under the software map.

If project would like to switch to an existing license type, they can do so under the ‘Edit Tool Tree Categorization’ component. This might result in an extra unused license type and will need to be pruned by a NITRC administrator or possibly an automated process (nightly batch job or at time of change).

The license description associated with a project can be viewed on the project summary page by clicking the question mark link at the end of the license row. The license description is also accessible under the software map in the section listing all licenses.


Gap ID/ FR ID


641 Tool Resource Admin P1

Display license description for tools with "other/proprietary" licenses

2.22 Associate Project with Another Tool/Resource

2.22.1 Description:A Tool/Resource will have the option to associate with multiple existing Tools/Resources. Initial tool association types will be: plug-in, subproject, and dependency.

2.22.2 Actors:Project administrator

2.22.3 Preconditions: A tool administrator decides it would like to associate the tool with an existing Tool/Resource.

2.22.4 Flow of Events:1. The project administrator selects from the project admin menu the ‘Tool/Resource

Association’ link.2. The system presents a page with three sections:

a. Existing associations (a select list for association type and another select list for project) that have been made by the administrator from the current project to another (so that the associations may be modified)

b. New associations (select list for association type and another select list for project) from the current project to another

c. A list of associations made from other projects to the current one (so that the project administrator can choose which ones to display on the project home page)

3. The project administrator selects from the ‘Tool/Resource Association’ page the appropriate tool associations and which associations should be displayed on the project summary page.



2.22.5 Post Conditions:1. The associations that have been chosen to be made public are displayed upon the project

summary page2. For every new/modified association, an email notification is sent to the administrator of the

related project about the proposed relationship and instructions on having it appear on the project summary page.a. While proposed associations appear on the administration page of the destination project

for the opportunity to be displayed as well, new and modified associations default to not being displayed on the tool/resource summary page of the related project until that project’s administrator approves of the relationship.

2.22.6 Special Requirements: Tentative association type definitions:

Plug-in – add on to a hosting application. Subproject – this is a project developed in concert with and under the auspices of a

parent project. Dependency – this project requires another project to function.


Gap ID/ FR ID


69 Better support for subprojects

656 Community FR 637: new category for summary page: plugin for package

776 Compare P2 "Related projects" on summary page

2.23 Submit Comments / Suggestions to NITRC

2.23.1 Description:A registered user wants to submit a comment or suggestion about any page to the NITRC team.


2.23.3 Preconditions: The user has comments or suggestions about any page they are viewing.

2.23.4 Flow of Events:1. The user clicks a link in the NITRC banner which directs them to the comment/suggestion form.1. The user fills in a simplified tracker form.2. The user clicks submit.

2.23.5 Alternate Flow:1. The user clicks cancel.2. The user is returned to their previous page

2.23.6 Post Conditions:



If the user submitted a valid suggestion form, the information will be automatically added to the appropriate NITRC tracker (with the standard features of email monitoring and history tracking).


Gap ID/ FR ID


2936 Browse/Site Nav. P2

NITRC Community FR 2925: Consider a Feedback/Comments button on right hand side

2.24 Display Home Page

2.24.1 Description:Based upon usability testing, a number of user interface elements of the NITRC home page will be updated from the default gForge behavior. This includes:

The ability to select attributes (topics) from two lists (separated between tools and resources)

A clearly marked search box for tools and resources A highlighted tool/resource Reformatted latest news A list of recently active forums A list of recently updated files, and Reformatted list of recently registered tools

2.24.2 Actors: All registered users and observers.

2.24.3 Preconditions:

1 The user has navigated to NITRC home page.

2.24.4 Flow of Events: In addition to the normal flow of events, the following actions will occur:

When the user views the NITRC home page, a public tool or resource (chosen by the site administrator through the “Update Featured Tool/Resource” use case) will appear in the “Featured tool/resource” box (by title and screenshot if provided).

o Clicking on the tool/resource name will take the user to the tool/resource’s home page.

The attribute lists, from which users may browse tools or resources, are hierarchies (see 2.6 Edit Tool/Resource Tree Attributes for details on how the lists are formed). So if an attribute has children, there will be a visual sign, and hovering over the attribute will cause a pop-up to appear that displays the children of the attribute.

o The lists will be formed by a depth-first search of the whole attribute tree, looking for attributes that are assigned to the respective front-page list (see 2.6)

“Depth-first” means that if an attribute is assigned to the list, but no ancestors of that attribute is assigned to the list, it will appear as a top-level element in the list. Any of its children will be recursively added depth-first.



o Clicking on a attribute will take the user to the attribute tree at the location of that attribute and filtering upon that attribute

Entering a string in the central search box and clicking “Search” will take the user to the tool/resource search results using the given string for the search.

The recently active forums box will be populated by the three most recent public forum postings by forum name, number of posts, and last posting date

o Clicking on the forum name will take the user to the forumo A “more forums” icon will take the user to a paginated full-screen version of the

list of recently active forums. The recently updated files box will be populated by the three most recently updated

public files by project name, release name, and dateo Clicking on the project or release name will take the user to the project’s file

release system pageo A “more file updates” icon will take the user to a paginated full-screen version of

the list of recently updated files. A “more tools/resources” icon will take user to a paginated full-screen version of the list of

recently registered tools/resources.

2.24.5 Special RequirementsA graphical depiction of the front-page design is as follows:



Differences from graphic: The two attribute trees are “Browse software” and “Browse other resources” “Browse software” and “Browse other resources” will be clickable as well and lead to the attribute

tree


Gap ID/ FR ID


730 Browse/Site Nav. P2

"Hot topics" box on the front page

29 Browse/Site Nav.

Implementation of Front Page Redesign



2.25 View Tool Tracker List

2.25.1 Description:In addition to the regular GForge browse tracker functionality, we add the ability to display and sort on custom fields that have been added.

2.25.2 Actors: All registered users and observers.


1 There are custom fields in a tool’s tracker.

2.25.4 Flow of Events: 1 The user selects “Build Query” while browsing a tracker 2 In the “Build Query” pop-up, in addition to the standard fields a new multi-select field is

presented: “Displayed Fields”. It defaults to the standard non-custom fields that are normally displayed.

a The user selects which fields they wish to display in the report 3 In addition, the system displays custom fields in the “Order by:” select box

a The user selects which field where they wish to sort the data 4 The user clicks “Save Changes” 5 The user executes the Power Query

a The resulting report displays the selected fields (normal and custom) in the sort order selected

2.25.5 Special Requirements: The default set of displayed fields for the Quick Query and the Power Query is set to the fields chosen by the tool administrator (please see the Administer Tool Tracker use case). If no column set is chosen, then the default columns are left as the NITRC/gForge default behavior.For the Quick Query:

If “Assigned To” is not visible in the Quick Query, then the “Assignee” select box will not be displayed (and automatically set to “Any”).

If “State”, “Open Date”, and “Closed Date” are all not visible, then the “State” select box will not be displayed (and automatically set to “Any”).

The “Order by:” select list will contain exactly those columns that are displayed [Please note that custom fields are alpha-numeric, so they are sorted alpha-numerically as opposed to an underlying data type such as date]


Gap ID/ FR ID

BRL/CCB Part

Requirement715 Tool/Resource

Admin P1Sorting tracker items based on Custom Fields

829 Tool/Resource Admin P1

Suppress default tracker sort/display fields and display custom sort/display fields



2.26 View/Submit Forum Articles

2.26.1 Description:In addition to the regular GForge 4.5.11 forum functionality, we will incorporate the ability to save and view attachments to forum articles that is available in GForge 4.6


Gap ID/

FR ID

BRL/CCB Part


Admin P3Allow attachments in forums

2.27 Administer Tool Tracker

2.27.1 Description:In addition to the regular gForge tool tracker administration functionality, we add the ability to change the default columns in the “Quick Query” and “Power Query”.

2.27.2 Actors: Tool Administrator.


1 The tool administrator has a tracker defined for their tool.

2.27.4 Flow of Events: 1 The tool administrator navigates to a specific tracker and selects “Admin” from the tracker

menu (or selects a specific tracker from the generic tracker Admin menu)2 The user selects “Update Settings” from the specific tracker Admin menu 3 On the Update settings page, under the “Description:” will be a “Default Displayed Fields” with

a multi-select list of the fields of the tracker (standard and custom). By default, the columns dictated by standard gForge behavior will be selected.

4 The tool admin will select the fields desired (and set other settings for the tracker) and press “Submit”.

2.27.5 Postconditions:

1 The default displayed columns for the Quick Query and Power Query are changed.


Gap ID/ FR ID

BRL/CCB Part


Admin P1Suppress default tracker sort/display fields and display custom sort/display fields



2.28 Update Featured Tool/Resource

2.28.1 Description:The site administrator chooses a tool or resource to appear on the NITRC front-page as the “Featured Tool/Resource”.

2.28.2 Actors: Site Administrator.


1 None.

2.28.4 Flow of Events: 1 The site administrator navigates to the site admin page (by selecting “Site Administration” in

the NITRC menu)2 Under “Group Maintenance” the site administrator selects “Update Featured Tool/Resource” 3 The site administrator is presented a select list of all of the public tools/resources (defaulting

to the currently featured tool/resource)4 The site administrator selects from the list and clicks “Submit” 5 The site administrator returns to the “Site Administration” menu with a message stating that

the featured tool/resource has been updatedChange from updated flow of events:

Provide a list (12) of project select lists and “start date” edit boxes. The currently featured tool/resource will be the one whose start date is closest but before or on the current date.


1 The featured tool/resource displayed on the NITRC front-page reflects the one selected by the site-administrator.


Gap ID/ FR ID BRL/CCB Part Requirement29 Browse/Site

Nav.Implementation of Front Page Redesign

3. Specific UI EnhancementsThe following items are user interface (UI) enhancements to the Neuroimaging Informatics Tools and Resources Clearinghouse (NITRC) website. These enhancements will add to or replace components of the existing GForge UI. Similar to the use cases above, enhancements will be described as differences from the default GForge UI.

3.1 Describe Most Active Order

3.1.1 Description: The listings of "most active" projects have an odd and non-intuitive metric and sort order. An explanation of how these projects are being sorted will be provided. The explanation will include the NITRC community's decision how external resources are



accounted for in the calculation.


Gap ID/ FR ID


687 Compare Browse by Most Active Sort Order

3.2 Context help

3.2.1 Description: Context help pop-ups accessed by question mark icons will expand to areas in user rating and project statistic areas to explain how those numbers are calculated.

Statistics - The statistics module counts open and closed items that belong to various NITRC modules, as well as page views for those individual modules. In addition, statistics are aggregated for the entire site, as well as for each project. The statistics module also calculates aggregated counts/views over periods of time. Total page views and new tool additions are also shown graphically. Users who wish to understand the details on how these values are calculated will click on a question mark icon next to each numeric value. A context sensitive help page will open displaying a brief description and how the value was calculated. Each help page is context sensitive meaning that each of the following pages will link to a different corresponding page:

NITRC Test Environment StatisticsTop Tool/Resource DownloadsMost Active This WeekRecently Registered Tools/Resources

Rating System – Similar to statistics, the rating module ranks individual projects against other projects. Context help icons are displayed as info icons next to each rating section (Overall, Installation, Documentation, etc…) in both contribute and display sections of the reviews / ratings module. The help text provides detailed descriptions of the corresponding category to assist users in making and interpreting reviews.


Gap ID/ FR ID


516 Rating P1 Rating Help Text pop-ups

517 Browse/Site Nav.

Other Help Text Pop-ups

3.3 Link to FAQ

3.3.1 Description: Add a link to the NITRC FAQ under the Help menu. This will make the link more accessible to those who need it.




Gap ID/ FR ID


426 Themes P1 Add a link under help to the FAQ (Location and links to NITRC Community FAQs)

3.4 Dynamic Site Theme

3.4.1 Description:NITRC themes comprise the look and feel of the site. Visual elements such as the dynamic horizontal menu system, html styles (CSS), logos, and icons are all part of the theme.

To create the initial dynamic horizontal menu (NITRC's top-level menu), the menu hierarchy and pointers to the NITRC Community project were hard coded. It will facilitate changes to NITRC and sharing of the NITRC system (a concern of the NIH) to have the configuration of the menu structure and menu items separated out from the display code.


Gap ID/ FR ID


339 Themes P2 Refactor text and default group in menu system

3.5 Display News

3.5.1 Description:Enhance the display of news stories to differentiate between a snippet and a full new story.Projects can configure news stories from additional sources, RSS news feeds or similar, to be displayed alongside NITRC stories.


Gap ID/ FR ID


514 News P2 News feed to Community from linked-out news tabs

624 News P2 Indication of a shortened news item on front page news

3.6 Enhanced Bookmarking

3.6.1 Description:A registered NITRC user wishes to bookmark the current browser page. This use case presents differences from the default GForge behavior.

3.6.2 Post Conditions:1. The bookmarked page is reloaded1. A bookmark has been added the this user's “My Bookmarks” section on their “My Personal Page”

3.6.3 Special Requirements: The NITRC name added to all bookmark link names should be dropped.




Gap ID/ FR ID


2942 Browse/ Site Nav. P2

Improve bookmarking functionality

3.7 Link Uploaded Documents to a Default MediaWiki Discussion

3.7.1 Description:A user wishes to edit a MediaWiki page and add links to existing NITRC pages or documents.

3.7.2 Actors:Registered NITRC user

3.7.3 Preconditions: The user selects the MediaWiki project menu tab to navigate to a tool's MediaWiki home page.

The user selects the page to edit

3.7.4 Flow of Events:

The user enters special tags that MediaWiki knows how to format into a valid NITRC link. The special tags must be in the format:

1. <tracker group_id=”12” tracker_id=’2043”> [Tracker item link text]<tracker/>2. Additional meta/attribute tags may be necessary to specify other module data

3.7.5 Alternate Flow:1.The user cancels the MediaWiki edit.

3.7.6 Post Conditions:1. The MediaWiki page will be saved and the user link will be converted to a valid link pointing to the desired destination. 2. The links will be named by the text between the open and close tag

3.7.7 Special Requirements: MediaWiki needs to have custom links developed for each NITRC module. A Community MediaWiki Help Page will be needed to explain the construction of tags to the users.


Gap ID/ FR ID


2957 Browse/ Site Nav. P2

Wiki macro for linking docman documents (and other modules)

3.8 Biositemaps Downloaddocument.docx 10-May-23


A new system-to-system interface will provide a stream of XML data in the form of RDF files associated with each NITRC project. The details are contained in a PowerPoint document held in tracker item 3013: http://www.nitrc.org/tracker/?func=detail&group_id=11&aid=3103&atid=129 .

Gap ID/ FR ID


3013 Compare Biositemaps

3.9 Tool/Resource Search (or Narrow by Attribute redesign)

3.9.1 Description:A user wants to search for a tool/resource within NITRC. This can be accomplished through a combination of free text and attribute searches.


3.9.3 Screen Shots:


http://www.nitrc.org/tracker/?func=detail&group_id=11&aid=3103&atid=129


3.9.4 Preconditions:4. The user navigates to an initial search by either:

Selecting an attribute from the front page (initiating a single-term attribute search)o Note: A free text search is conducted on not just assigned attributes but the title

and description of a tool/resource. Selecting an attribute limits results to those tool/resources assigned to that particular attribute.

Selecting “Tools/Resources” from the menu (initiating an empty search) Entering text in a “Tool/Resource” Search in the header (initiating a free text search)

3.9.5 Flow of Events:8. As described in the preconditions, navigating to the tool/resource search page requires some

sort of search (initially a single-term attribute search, a free-text search, or an empty search). Given an arbitrary set of search terms (attribute and free-text), the tool/resource search page will display: The current search terms along the top (underneath the Tool/Resource Search Results

tab) with check boxes allowing the user to remove each term separately A list of attributes along the left, grouped by top level attribute (Functionality, Operating



System, etc.) with the number of hits for the attribute The attributes will be displayed in frequency of occurrence in the result set (i.e. most

frequently occurring first). In contrast, the NITRC front page is alphabetical since in all probability the user will be looking for a specific attribute, while here the list provides information about the result set.

A number of attributes (and possibly whole groups) will be hidden and will be expandable by the user. The groups of attributes, the order, the default state (open or closed), and the number of viewed attributes will be editable by the NITRC administrator

In addition two of the top level attribute groups are those groups defined to appear on the front page of NITRC

9. Attribute groups that have a match in the result set will be displayed: If the administrator configured the attribute group to default to closed, it will be closed Otherwise, attributes that have a hit will be listed. If the number of attributes in a group that hit are greater than the default to be displayed

(set by the NITRC administrator), a “See All” link will be displayed When clicked, the “See All” will be replaced with the full list of attributes in the group

Attribute groups that have more than one level will display the children in a pop-up just like the NITRC front page

10. The user may expand or contract the attribute groups and list at will11. The user may select an attribute, at which time the search will be reimplemented with the

current terms AND the new attribute (repeating this use case)12. The user may uncheck a box in the list of current search terms, at which time the search will

be reimplemented with that search term removed13. The user may reorder results based upon Name, Average Rating (default), Activity, Latest

File, or Downloads14. The user may page through the results15. The user may sort the results by a series of displayed values including: Title, Activity, Lastest

File Released, Downloads, Overall Rating16. The user may select the site-wide search tab (at which time the search terms will be

collapsed into a single search query)17. The user may select a tool, at which time the user is directed to the tool/resource page18. The use can resize the left column (by grabbing a widget between the left and right columns).

3.9.6 Alternate Flow: None


3.9.8 Special Requirements:The administrator has the ability to select which attribute groups are displayed, the order in which the attribute groups are displayed, and the number of displayed attributes within each group by default. Attribute groups are defined by the top level attribute in the hierarchy. In addition the two special groups defined for the NITRC front page are also able to be selected for use in the Search.

3.9.9 Requirement/Feature Request ReferenceFR ID Requirement



4517 Transform Narrow by Attribute design elements from Photoshop into HTML+CSS+JS

4520 NITRC 2.0 Narrow by Attribute Sort By pull-down options

3115 Narrow By Attribute redesign: 2nd browse and narrowing page after selecting topic from front page

3.10 Configure Attribute Groups for Tool/Resource Search

3.10.1 Description:A NITRC administrator wants to configure the attribute groups used (and their order) in the tool/resource search.

3.10.2 Actors:NITRC Administrator

3.10.3 Preconditions: The NITRC Administrator selects “Configure Attribute Groups for Tool/Resource Search”

from the admin menu

3.10.4 Flow of Events: An array is displayed containing:

A select list of the top-level attributes PLUS the two special groups defined for NITRC’s front page

If the attribute group defaults to open or closed If open, the number of attributes displayed by default for the group

When the administrator clicks “Submit” the order of the attribute groups is determined by the order in which the Administrator chose the attribute groups.

3.11 Set Custom SCM Instructions

3.11.1 Description:A Tool/Resource Administrator replaces the default SCM instructions with custom instructions.

3.11.2 Actors:A Tool/Resource Administrator

3.11.3 Preconditions: The Tool/Resource Administrator is logged in and navigates to a project for which they

are an administrator

3.11.4 Flow of Events:6. The Tool/Resource Administrator clicks on the “Source Code” project menu7. The Tool/Resource Administrator clicks “Admin” in the SCM sub-menu8. In addition to the existing permission checkboxes, the administrator is presented a textarea into which he or she can enter BBCode for SCM instructions

a. The contents of the text area defaults to the standard SCM instructions9. The Administrator fills out the instructions and presses “Update”



http://www.nitrc.org/tracker/index.php?func=detail&aid=3115&group_id=11&atid=129





On the project’s Source Code page, if the tool administrator provides instructions, these instructions are presented in place of the default instructions (beginning “Developer CVS Access via SSH” or “Documentation for Subversion …”).


FR ID Requirement4402 Custom text on SCM page

3.12 Compare Tools/Resources

3.12.1 Description:A user wants to conduct a side-by-side comparison of the attributes for a set of tools/resources within NITRC. This can be accomplished by selecting resources across a combination of free text and attribute searches.


3.12.3 Screen Shots:The following depicts the results of a search. Added to the results (from the Tool/Resource Search Use Case) are check boxes (for each tool/resource), a “Compare” button, and “Select All” and “Unselect All” links.




The following depicts what happens when a user has selected some tools/resources for comparison but then navigates to a new page of the results. The currently selected tools/resources are listed at the top at the top of the results, and the number of items selected for comparison appears in the “Comparison” tab.



The following depicts the comparison matrix for three items that were selected in the search results. Of note are the capability to sort by attributes and the ability to expand and collapse the main categories.

3.12.4 Preconditions:5. The user conducts a tool/resource search.

3.12.5 Flow of Events:19. With the tool/resource search results, the system displays a check box for every tool/resource

title. 20. The user selects a number of resources and then selects the “Compare” button (or the

“Compare” tab).21. The system displays a table with each column representing a selected tool/resource.

At the top of each column are the tool’s name and key statistics (latest file release, activity, downloads, and overall rating).

The rest of the rows of the table contain the assigned categories and other attributes for the compared tools/resources. The attributes are grouped by their top-level ancestor in the attribute tree (e.g. Category, License, Development Status, etc.)

22. The user may also sort the columns of the tree by average rating, latest file release, name, downloads and number of ratings

23. If the user clicks on a tool/resource name, they are taken to the tool/resource summary page24. Clicking on an attribute will add that attribute to the current tool/resource search (since a

search was conducted to bring the user to the comparison page).document.docx 10-May-23


3.12.6 Alternate Flow: If the user selects some tools/resources in a search for comparison, but then modifies the

current search or pages the current results, the system will remember what tools/resources were selected and display them in a list.


3.12.8 Special Requirements:1. None

3.12.9 Requirement/Feature Request ReferenceFR ID Requirement

3175 New compare display from narrowing search results

3658 Add filter capability in Tool/Resource Results page to filter categories


