GUI Design Template

User Guide
KRSTE.my Release 3.1
11 December 2009
Prepared by
Copyright
2009 MOSTI
All Rights Reserved
Document Id
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Revision History
Date
11 Dec 2009
Author
Comment
Version
RM Ruzila
Final Submission
1.0.0
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 2 of 35
Copyright
2009 MOSTI
All Rights Reserved
TABLE OF CONTENTS
1
INTRODUCTION .............................................................................................................. 6
2
OVERVIEW ....................................................................................................................... 6
3
SIGN IN / SIGN OUT ........................................................................................................ 8
4
HOME ............................................................................................................................. 13
5
KNOWLEDGE DOMAIN ................................................................................................. 13
6
CREATE CONTENT ....................................................................................................... 16
7
DASHBOARD ................................................................................................................. 19
8
SEARCH ......................................................................................................................... 20
9
8.2
W ORDNET® ............................................................................................................. 21
8.3
SEARCH OPTIONS..................................................................................................... 22
8.4
DOCUMENTS ............................................................................................................ 24
8.5
PROJECTS................................................................................................................ 25
8.6
PATENTS.................................................................................................................. 26
8.7
PEOPLE ................................................................................................................... 27
8.8
ORGANISATIONS ....................................................................................................... 29
BASIC NAVIGATION ..................................................................................................... 31
9.1
PAGINATION ............................................................................................................. 31
9.2
LINKED TEXT ............................................................................................................ 31
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 3 of 35
Copyright
2009 MOSTI
All Rights Reserved
TABLE OF FIGURES
FIGURE 1 KRSTE.MY R3 LAYOUT ................................................................................................ 7
FIGURE 2 KRSTE.MY R3 LANDING PAGE...................................................................................... 9
FIGURE 3 LOGIN ........................................................................................................................ 10
FIGURE 4 HOMEPAGE................................................................................................................. 11
FIGURE 5 LOGOUT ..................................................................................................................... 12
FIGURE 6 APPLICATION BAR ....................................................................................................... 13
FIGURE 7 KNOWLEDGE DOMAIN.................................................................................................. 13
FIGURE 8 SELECT KNOWLEDGE DOMAIN ..................................................................................... 14
FIGURE 9 NAVIGATION MENU...................................................................................................... 14
FIGURE 10 SEARCH RESULTS..................................................................................................... 15
FIGURE 11 TRAVERSE THE MRDCS ........................................................................................... 15
FIGURE 12 CREATE CONTENT .................................................................................................... 16
FIGURE 13 TERMS AND CONDITION ............................................................................................. 17
FIGURE 14 CREATE DOCUMENT FORM ........................................................................................ 18
FIGURE 15 CREATE CONTENT STATUS........................................................................................ 19
FIGURE 16 SEARCH PAGE .......................................................................................................... 20
FIGURE 17 SEARCH RESULTS..................................................................................................... 21
FIGURE 18 SEARCH OPTIONS ..................................................................................................... 22
FIGURE 19 OTHER RELATED SEARCH ......................................................................................... 23
FIGURE 20 DOCUMENTS ............................................................................................................. 24
FIGURE 21 PROJECTS ................................................................................................................ 25
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 4 of 35
Copyright
2009 MOSTI
All Rights Reserved
FIGURE 22 PATENTS .................................................................................................................. 26
FIGURE 23 PEOPLE .................................................................................................................... 27
FIGURE 24 EXPAND PEOPLE....................................................................................................... 28
FIGURE 25 ORGANISATIONS ....................................................................................................... 29
FIGURE 26 EXPAND ORGANISATION INFO .................................................................................... 30
FIGURE 27 PAGINATION NAVIGATION .......................................................................................... 31
FIGURE 28 LINKED TEXT NAVIGATION ......................................................................................... 32
FIGURE 29 PROJECT DETAIL VIEW .............................................................................................. 33
FIGURE 30 PROJECT LEADER DETAIL VIEW ................................................................................. 34
FIGURE 31 ORGANIZATION DETAIL VIEW ..................................................................................... 35
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 5 of 35
Copyright
2009 MOSTI
All Rights Reserved
1 Introduction
This document contains the user guide to KRSTE.my R3.1.
2 Overview
KRSTE.my (Knowledge Resource for Science and Technology Excellence,
Malaysia) is an initiative by MOSTI and spearheaded by MASTIC to address
science and technology issues and challenges faced by the community, the
ministry and the country.
KRSTE.my is designed to be a Single Point Access Facilities (SPAF)
providing intelligent collaborative knowledge management and learning
services platform on Science and Technology and Innovation.
KRSTE.my enables:
-
Knowledge exchange in secure environment.
-
Context based search using semantic technology.
-
Content enrichment with content sources from local and international
institution.
-
Informative decision making through state of the art of dashboard
facilities.
-
Visual display of content by showing the relationships and big picture
view of experts in various field of research
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 6 of 35
Copyright
2009 MOSTI
All Rights Reserved
Figure 1 KRSTE.my R3 Layout
Header
Top Navigation Menu
Application Bar
Application Area
Footer
The 3.1 is divided into six parts:
A. Header
Shows KRSTE.my logo
B. Top Navigation Menu
Display current user and provides links to Sign Out.
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 7 of 35
Copyright
2009 MOSTI
All Rights Reserved
C. Application Bar
Provides links to application in KRSTE.my.Search Area
D. Application Area
Shows the results of the search and applications invoked by the
user.
E. Footer
Shows MOSTI logo and disclaimer, links to About, Contact Us,
FAQ, Security, Privacy, and Terms.
3 Sign In / Sign Out
This is the landing page for KRSTE.my R3.1, where the user can logs in.
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 8 of 35
Copyright
2009 MOSTI
All Rights Reserved
Figure 2 KRSTE.my R3 Landing Page
3.1.1 User will see welcome banner about KRSTE.
3.1.2 User will see latest news and events.
3.1.3 To login, user click on the Log In link at the top of the page as show in
Figure 3.
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 9 of 35
Copyright
2009 MOSTI
All Rights Reserved
Figure 3 Login
3.1.4 User enters the username and password at the drop down box.
3.1.5 For this 3.1 release, only English language is available.
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 10 of 35
Copyright
2009 MOSTI
All Rights Reserved
Figure 4 Homepage
3.1.6 Upon successful login, the user will get the homepage.
3.1.7 In the Application Bar, user will be able to access all applications that
are authorized to user.
3.1.8 User will get the KRSTE.my statistics on knowledge base, latest
content added, the most viewed resources and latest news and events
updates.
3.1.9 In the Top Navigation Menu, there is a link for user to Sign Out.
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 11 of 35
Copyright
2009 MOSTI
All Rights Reserved
Figure 5 Logout
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 12 of 35
Copyright
2009 MOSTI
All Rights Reserved
4 Home
Figure 6 Application Bar
4.1.1 To go back to the KRSTE Homepage, user can click on the Home icon
5 Knowledge Domain
Figure 7 Knowledge Domain
5.1.1 To browser contents in KRSTE.my, user can click on the Knowledge
Domain icon.
5.1.2 System displays a list of available Knowledge Domain.
5.1.3 User can click on the Knowledge Domain name to view the contents
available in KRSTE.my
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 13 of 35
Copyright
2009 MOSTI
All Rights Reserved
Figure 8 Select Knowledge Domain
5.1.4 User will see two columns: First column (left column) shows the
classification of the contents based on MRDCS. This column serves as
the navigation menu for the second column (right column).
Figure 9 Navigation Menu
5.1.5 The first line in the navigation menu (after the Knowledge Domain –
Agriculture header) serves as the breadcrumb or the current selection.
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 14 of 35
Copyright
2009 MOSTI
All Rights Reserved
Figure 10 Search Results
5.1.6 The second column shows the contents related to the current selection.
Figure 11 Traverse the MRDCS
5.1.7 User can select any items listed in the Navigation Menu, and system
refreshes the Search Results.
5.1.8 User can also navigate using the breadcrumb.
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 15 of 35
Copyright
2009 MOSTI
All Rights Reserved
6 Create Content
Figure 12 Create Content
6.1.1 User can view status of contents that have been uploaded by the user
into KRSTE.my.
6.1.2 All contents uploaded must be approved by the System Administrator
before it can be shared with other KRSTE.my users.
6.1.3 User can add Document or Resource. A document is a formal piece of
writing that provides information or acts as a record of events or
arrangements, for instance an article, book, journal, seminar paper
or research paper. Whereas, a resource could be URL, plain
writings or media files.
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 16 of 35
Copyright
2009 MOSTI
All Rights Reserved
6.1.4 Regardless of what types, user is required to read and accept (or
decline) the stated Terms and Condition.
Figure 13 Terms and Condition
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 17 of 35
Copyright
2009 MOSTI
All Rights Reserved
Figure 14 Create Document Form
6.1.5 Mandatory fields are required to be entered before the forms can be
submitted.
6.1.6 Once user presses save, the document information will be created and
user can view the status of the created document. Similar process
applies to resource
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 18 of 35
Copyright
2009 MOSTI
All Rights Reserved
Figure 15 Create Content Status
6.1.7 User can edit the content information or withdraw before the
administrator approves the submitted document information.
7 Dashboard
Dashboard is only accessible to authorized users. To request access, please
contact KRSTE.my Administrator.
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 19 of 35
Copyright
2009 MOSTI
All Rights Reserved
8 Search
User can click on the Search icon to go to the search page.
Figure 16 Search Page
8.1.1 Whenever the user submits a search request, system returns multiple
sets of search results as shown in the following figure:
WordNet®
Search Options
Documents
Projects
People
Patents
Organizations
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 20 of 35
Copyright
2009 MOSTI
All Rights Reserved
Figure 17 Search Results
8.2 WordNet®
8.2.1 WordNet®, is a list of synonym for the entered keyword based on the
WordNet® database. It is a large lexical database of English words. It
is available from Princeton University.
8.2.2 In R3.1, the Word Net is used as alternative keyword that the user can
choose to better match the return results.
8.2.3 When user selects the any of the synonym listed in the Word Net,
system will treat that as the new search keyword.
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 21 of 35
Copyright
2009 MOSTI
All Rights Reserved
8.2.4 User can expand the list of synonym by clicking on the MORE button.
8.2.5 User can reduce the list of visible synonym by clicking on the LESS
button.
8.3 Search Options
Figure 18 Search Options
8.3.1 Search Options, is a list of related search that the system proposes
based on the keyword entered.
8.3.2 The default search uses the string entered by user as keyword to
match with contents available in KRSTE.my.
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 22 of 35
Copyright
2009 MOSTI
All Rights Reserved
8.3.3 The system also performs context search by using the string entered
by the user and find the meaning of the string by matching the MRDCS
context and display any match as Other related search.
8.3.4 If this default option is not what the user wants, the user can select
search options from other related search where system will then
retrieves the results that matched the user’s selection.
8.3.5 User can click on MORE button to expand the Search Options or click
on LESS button to return to the initial display.
Figure 19 Other Related Search
TAKE NOTE: Even though the system proposes the search options, it does
not necessarily mean that there are contents available for the proposed
options.
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 23 of 35
Copyright
2009 MOSTI
All Rights Reserved
8.4 Documents
Figure 20 Documents
8.4.1 Documents, list of documents metadata that have been extracted from
local and international sources and stored in knowledge base.
8.4.2 Note that, KRSTE.my does not store the actual document unless
directly uploaded by the user into the system.
8.4.3 In R3.1, documents include theses, research paper, journal articles,
etc. In R3.1, classified documents and Government files are not kept in
the system.
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 24 of 35
Copyright
2009 MOSTI
All Rights Reserved
8.5 Projects
Figure 21 Projects
8.5.1 Projects, list of projects metadata that have been extracted from local
and international sources and stored in knowledge base.
8.5.2 These projects could be funded by Malaysian Government through its
Malaysian Development Programs, or could be funded by own
organization’s fund.
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 25 of 35
Copyright
2009 MOSTI
All Rights Reserved
8.6 Patents
Figure 22 Patents
8.6.1 Patents, list of patents metadata that have been extracted from local
and international sources and stored in knowledge base.
8.6.2 Similar to document, the actual patent document is not kept in the
system unless directly uploaded by the user.
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 26 of 35
Copyright
2009 MOSTI
All Rights Reserved
8.7 People
Figure 23 People
8.7.1 Persons, list of researchers’ information extracted from local and
international sources which include organization own websites, MOHE,
and MASTIC databases among others.
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 27 of 35
Copyright
2009 MOSTI
All Rights Reserved
Figure 24 Expand People
8.7.2 User can click on EXPAND INFO to expand the displayed information
which will list the number of projects, documents and patents that have
been extracted and available in KRSTE.my knowledge base.
8.7.3 User can click on COLLAPSE INFO to collapse the displayed
information to the initial display.
TAKE NOTE: This does not give an accurate number of projects,
documents and patents that the person actually has in reality. It merely
states that in the KRSTE.my knowledge base, there are projects,
documents and patents that have been linked to the identified person.
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 28 of 35
Copyright
2009 MOSTI
All Rights Reserved
8.8 Organisations
Figure 25 Organisations
8.8.1 Organizations, list of organizations’ information extracted from own
organization websites, and MASTIC databases among others.
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 29 of 35
Copyright
2009 MOSTI
All Rights Reserved
Figure 26 Expand Organisation Info
8.8.2 User can click on EXPAND INFO to expand the displayed information
which will list the number of projects, documents and patents that have
been extracted and available in KRSTE.my knowledge base.
8.8.3 User can click on COLLAPSE INFO to collapse the displayed
information to the initial display.
TAKE NOTE: This does not give an accurate number of projects,
documents and patents that the person actually has in reality. It merely
states that in the KRSTE.my knowledge base, there are projects,
documents and patents that have been linked to the identified person.
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 30 of 35
Copyright
2009 MOSTI
All Rights Reserved
9 Basic Navigation
9.1 Pagination
Figure 27 Pagination Navigation
9.1.1 In R3.1, if there are more than ten records returned, the results will be
formatted into multiple pages. User can navigate by clicking on the
page number, or NEXT, or PREVIOUS button.
9.2 Linked Text
9.2.1 User can click on any of the linked text to view the detail content.
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 31 of 35
Copyright
2009 MOSTI
All Rights Reserved
Figure 28 Linked Text Navigation
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 32 of 35
Copyright
2009 MOSTI
All Rights Reserved
Figure 29 Project Detail View
9.2.2 In this example, system pops up a new window that shows detail of the
project
information
including
project
leader
and
organization
information that are currently linked to this organization in KRSTE.my
knowledge base, if available.
9.2.3 User can click on the Project Leader link and system displays detail
information about the Project Leader.
9.2.4 User can also click on the Organization link and system displays detail
information about the Organization.
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 33 of 35
Copyright
2009 MOSTI
All Rights Reserved
Figure 30 Project Leader Detail View
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 34 of 35
Copyright
2009 MOSTI
All Rights Reserved
Figure 31 Organization Detail View
KRSTE.myR3-SPP-TPL-USER_GUIDE-ver.1.0.0
Page 35 of 35
Copyright
2009 MOSTI
All Rights Reserved