This chapter shows the basic operations of a XooNIps database site.
Note: as a feature of XooNIps, screen designs can be easily changed by using XOOPS templates (themes). Therefore, the site (screen) design shown in this chapter is an example; it may not be applied to the site you have built or are going to access.
This section shows the operations that the guest users are entitled to perform on XooNIps.
The guest users are permitted to search and browse the registered items in the public area.
A list will be displayed by clicking on an item type (ex. "Binders", "model" as described) at the "Index Tree".
"XooNIps Search" is for searching items by item type or metadata.
On a "Listing item" screen, the order of the listed items can be changed by the pulldown menu at "Order by". The conditions vary with the item types.
On a "Detail" screen, [Download] button will appear only if the item is permitted to be downloaded by guest users.
Downloading will be permitted only if the user agrees with the license condition.
Each item can be searched by detailed conditions.
Click on the link [Advanced].
On a "Search Items" screen, check an item type (ex. "Title", "Presentation Type", etc.) to open entry fields will appear. Fill in the fields and click on the [Search] button to start searching.
Item types can be chosen more than one.
"XooNIps Ranking" lists the titles of most accessed items. Click on a link to go to its detailed information.
"XooNIps Ranking" will not be shown if it is not permitted for guest users to view.
Outline of new user registrations.
To use the XooNIps functions, the user has to be approved by a moderator to become a registered user.
It may automatically be approved, depending on the condition set on the site policy (XOOPS).
Click on the link [Register now!]
The location of the link on the screen varies with the site designs.
Fill in the entry fields at "User Registration".
The fields indicated "*" are essentials designed by the site policy. Click on the [Submit].
After submitting the registration, it may require a moderator's approval according to the site policy.
This section shows the operations that the registered users are entitled to perform on XooNIps.
Enter the user name and password to login.
Login field is not always located as shown in this manual due to the variety of site designs.
Click on the [logout] (a link or button).
[Logout] is not always located as shown in this manual due to the variety of site designs.
How to organize and manage the items in a private area:
Click on the link [Edit Private Tree] at "XooNIps User Menu".
How to register a new keyword:
Enter a new keyword in the field "New Index Keyword", and click on the [register] button.
A new index keyword will be registered underneath the private tree
How to change keywords:
Registered keywords can be modified.
Check the keyword to be modified and enter a new keyword in the field "Rename to", then click on the [rename] button.
The keyword "tool" has been changed to "model".
How to delete a keyword:
Check the checkbox of the keyword to be deleted and click on the [delete] button.
Change the order of keywords:
How to change the order of Keywords:
Indicate a number from 1 to 10 from the dropdown list at "up/down".
Shift keywords
How to shift keywords:
Choose one from the dropdown list next to the [move to] button and click on it.
To show the result, click on the [open all] button at the "Index Tree".
The keyword [tool] has been shifted underneath [model].
How to register new items:
Click on the link [Add New Item] at "XooNIps User Menu".
Choose an item type from the dropdown list.
After choosing an item type, a "Register" screen appears.
Check at least one checkbox of a keyword at "Private" index to which the item belongs.
The items with "*" are required.
For the "ID" field, always enter the same value. If the ID is duplicated, it will be regarded as an error.
"Download Limitation":
Decide whom to be permitted to download the items (ex. login users only or all the users including guests).
"Download Notification":
An option available only if login users are set to be permitted to download the items.
It depends on the system configuration of the site.
"Readme":
Click on the link [Edit], and a window will open. Indicate a file and click on the [upload] button; or, directly edit in the textbox and click on the [OK] button.
"Rights":
To set the Creative Commons license. Or, edit an original license, click on the link [edit] to open an edit window.
Rights edit window:
Click on the link [Edit] to open an edit window. Indicate a file and click on the [upload] button. Or edit an original text in the textbox and click on the [upload] button.
"Related to":
To indicate other related items.
Identify related items by item IDs. The item IDs are the values automatically numbered, which are not the same as the other "ID" entered on the "Register" screen.
Click on the [Search items (new window)] button to open another window.
"Listing item" window:
Click on the [Search] button to open another window for searching items.
To inquire the item ID of related items by using "Index Tree" or "XooNIps Search".
This screen allows only to inquire item IDs. For registering item IDs, return to the "Register" screen.
Click on the [Next] button on the "Register" screen to open a confirmation screen. Click on the [update] button to confirm the registration.
Go to the "Detail" screen of the intended item. Use "Index Tree" or "XooNIps Search" to search for it.
Click on [Modify] button, and a "Modify" screen will appear. Make modifications as necessary and click on [Next] button.
On the "Detail" screen, modification history will be shown.
Delete items
Go to the "Detail" screen of the item to be deleted. Use "Index Tree" or "XooNIps Search" for search the intended item.
Click on the [Delete] button to open a dialog box and choose [OK].
"Binder" is an item type, by which items can be collectively managed.
To identify the items to be registered in a Binder, use either of the following 3 commands on the "Register" screen.
[Item list]
Choose items from the item list.
[Index keyword]
Choose the item to be registered in a Binder by using Index Tree.
[Search]
Choose the item to be registered in a Binder by using detail search.
How to choose by [Item list]
Click on [Item list]. Choose items from the list showing the applicable items (registered in the Public Index and the user's private index.)
Check the checkbox of the item to be registered and click on the [Select] button to confirm.
How to choose by an index keyword:
Click on an intended keyword at "Private" index.
Check the checkbox of the item to be registered in a Binder and click on the [Select] button to confirm the registration.
How to choose by [Search]
Click on [Search], and a "Detail" search screen will appear. Search the item to be registered in a Binder in the same manner as normal search.
Check the checkbox of the intended item and click on the [Select] button.
Click on the [Next] button to confirm the registration.
On the "Register" screen for Paper items (XooNIps User Menu>>Add New Item; pulldown menu "Paper" at "Select item type"), there is "PubMedID" field. If a PubMedID is given, enter the ID and click on the [Complete] button, then the other following related information will be automatically filled out.
On the "Register" screen for Book item, there is ISBN code field. If the code is identified, enter it (10 or 13 digits) and click on the "Complete" button, then the other related information will be automatically filled out. In this case, the URL field will be filled with the detailed information provided by Amazon.
To register an item in the public area, it may require to be reviewed by the moderator for approval according to the site policy.
Go to the "Detail" screen of the item to be published in the Public area, by using "Index Tree" or "XooNIps Search".
Choose an index keyword of the Public area from the "Add to public index" dropdown list at the bottom and click on the [Submit].
Item publishing may be controlled by the site policy. Therefore, it may require a review to be approved by the moderator.
XooNIps allows to make a group among the registered users.
The group will be given a specific area where information can be shared with the members.
Search a group registered on XooNIps.
Contact the group administrator via email or private message to ask for group admission.
The group administrator or moderator will perform the operations for adding members to the group.
When a user joins a group, a group tab will be added in the Index Tree.
How to register items in a user's private area to a group area:
Click on the index keyword to be registered at the intended group tab.
A "Listing Item" screen will appear. Search the intended item.
Check the checkbox of the item to be registered to the group index.
The other group members can not view the registered item until the group administrator or moderator completes the review and approval.
Basically, an item's edit authority is given only to the user who originally registered/requested to register the item.
When the user resigns from the membership, he/she can transfer their items to another user.
How to transfer an item:
Click on the link [Request Item Transfer] on XooNIps user menu.
Identify the item to be transferred. Use either of [Item List], [Index keyword], [Search] at "Add items from" for searching it.
Choose the user who transfers his/her authority (transferee) by the dropdown list and click on the [Next] button.
A confirmation screen will appear. Click on the [execute transfer] button.
How to transfer a user's editing authority to another user:
Click on the link of "Accept Item Transfer".
Choose an index tree keyword to register the transferred item and click on the [Accept] button.
This section shows the operations that the group administrators are entitled to perform an XooNIps.
Click on the link [Edit Group Tree] on the XooNIps Group Admin menu.
The link is not always located as shown due to the variety of site designs.
How to add/delete a group member: click on the group name. If you are an administrator managing more than one group, choose the intended group name and click on it.
How to add a member: choose a user listed at "Non-members" and click on the [Add] button.
How to review and certify an item requested to register in a group area:
Click on the [Certify Group Items] at the "XooNIps Group Admin menu".
The item can also be reviewed and certified on its "Detail" screen/ Use "Index Tree" or "XooNIps Search" to get to the screen.
Check the "Index" field on the "Certify item" screen. Click on either of [Accept] or [Reject] button to decide whether or not to publish the item in the group area.
How to withdraw a registered item:
Go to the "Detail" screen of the intended item. Use the "Index Tree" or "XooNIps Search" to search for the item.
Click on the [Withdraw] button at the "Index" field, and a confirmation dialog box will appear, then click on [OK].
Keywords at a group index can be added, deleted and edited in the same manner as Private.
Click on the [Edit Group Tree] on the "XooNIps Group Admin Menu".
How to edit group indexes: (If you are an administrator managing more than one group, choose an intended group index tab.)
Click on the group index tab.
Click on a keyword to be edited.
Continue to edit the group index.
The items registered in a group index can be collectively transferred to the public index by each keyword:
Group administrator
Click on the [Edit Group Tree] at "XooNIps Group Admin menu".
At the "Publication group item" check the checkboxes of the keywords to be published.
By the dropdown list, choose a public index keyword to which the checked index keywords are to be added. Click on the [Submit] button.
Moderator
Click on the link [Certify Public Group Items] at the "XooNIps Moderator menu".
Check the checkbox either of [Approve] or [Reject].
Decide whether or not to publish the item by clicking on [Accept] or [Reject].
Moderators are permitted to transfer group administrators' authority. Contact the site's moderator if necessary.
Moderators are permitted to cancel groups. Contact the site's moderator if necessary.
This section shows the operations that the moderators are entitled to perform on XooNIps.
Edit index trees in the public area.
Click on the link [Edit Public Tree] at the "XooNIps Moderator menu".
The layout varies with the site designs.
The basic operations are same as the private area.
To entitle non-registered users (new users/guests) to use the XooNIps functions, the moderator may have to perform the following procedure. Refer back to the Table 4.2. (Chapter 4) "User Registration Policies". If your site's site policy has been set as "Certify automatically", the moderator can skip the following procedure.
Click on the link [Certify Users] at "XooNIps Moderator menu".
The following functions will be active by clicking on the following links: Email, detail, certify.
A mailer comes out with the email address of the user.
Detail
Show the "Detail" screen of the user's items.
Certify
Decide whether or not to certify non-registered users. (Users can not use the XooNIps functions without being certified.)
How to review and decide whether or not to certify the item as a publishing item for the public area:
Click on the link [Certify Public Items] at the "XooNIps Moderator menu".
Click on either of [Accept] or [Reject] button.
How to withdraw the items in public area:
Go to the "Detail" screen of the intended item. Use "Index Tree" or "XooNIps Search" to search for it.
Click on the [Withdraw] button at the "Index" field, and a dialog box will appear. Click on [OK].
How to create/delete a group:
Click on the link [Edit Groups] at the "XooNIps Moderator menu".
Create a new group: enter the required information in each field and click on [Submit] button.
Delete a group: click on the link [Delete], and a dialog box will appear. Click on [OK].
"Group Name"
Enter the group's name.
"Group Description"
Edit the group's description.
"Group Administrators"
Choose a user as a group administrator (Multiple choice is acceptable).
"Maximum number of items"
Enter the maximum number of the item to be registered in the group area.
"Maximum number of indexes"
Enter the maximum number of the keywords for the group index.
"Maximum size of items [MB]"
Enter the maximum value of data for the group area.
How to download event logs on XooNIps in a CSV formatted file or transform the data into a graphic chart:
Click on the link [Event Log] at the "XooNIps Moderator's menu".
Download event logs
How to download event logs:
Indicate a period for the intended event logs. The data will be downloaded in CSV formatted file.
By the event
Indicate a specific period. Choose "Download" or "Graph" for each category: "Access to top page", "Access to item", "Download of item" and "New users and items".
"Registered Information"
List the status of registered users and items.
This section shows the operations that the system administrators are entitled to perform on XooNIps.
Go to "Change Panel Home" (upper right on XOOPS Administration screen).
Refer to the following sections in this manual: "3.6. Installation of XooNIps", "4.1. Site policy", "4.2. Maintenance".
Basically on XooNIps, the items can be modified only by the user who has originally registered them.
However, system administrators are exclusively entitled to change/modify all the items.
Click on the link [Switch User Account] at "XooNIps User Menu".
Choose a user from the dropdown list and enter the password.
After completing the procedure, click on the link [End Switch User (user name)] at the XooNIps User Menu.
How to export the items and index tree structures on XooNIps to other sites:
If the "enabled" field at "Import/Export" (ref. 4.1.6.) has been set as "Yes", the registered users can also import/export items.
Export objects:
Items
More than one items can be exported simultaneously if they are registered in the same index keyword.
It depends on the site policy (ref. 4.1.6. "Import/Export") whether attached files will be exported.
Index Tree keyword
Export index structures.
The following shows the procedure.
How to export Index Tree keywords:
Index keywords containing no items belonging to can not be exported.
Click on the intended index keyword to show the item list.
Click on the keyword to be exported and click on [Export] button.
Check the [Export indexes]. If it should be exported recursively, choose "Yes" at the field "Export indexes recursive".
The information to be exported will be displayed. Check the information, and if it is ok, click on the [Download] button.
Export items
Go to the "Detail" screen of the item to be exported and click on the [Export] button.
Define whether or not to export attached files.
The choices ("Yes" / "No") will not appear if "No" has been chosen at the export field of the site policy.
Read through the license agreement, check the checkbox "Agree" if you agree, and click on the [download] button. It will start downloading.
How to load the items and index keywords imported from other XooNIps sites:
Click on the [Import] button at the XooNIps User menu.
Table 5.1. Import functions
Description | |
---|---|
"File to import" |
Select the file to be imported. |
"To certify items automatically" |
If the item is to be imported to the public area, it will be automatically certified publishing. |
"Don't import (Error check only)" |
Perform error check but do not import. |
"Logging" |
Show the importing logs. (default) |
Check the checkbox of the index keyword to which an intended file will be imported. Choose the file to be imported and click on the [Next] button.
If "logging" is checked and any errors occur, error descriptions will be displayed. Return to the previous screen and modify them.
If there is no error, click on the import button.
Refrain from unwanted overwriting:
It is subject to confirm whether or not to overwrite the file if it is found to include duplicated keywords or items.
Harvesting metadata requires manual operations.
Please refer to 4.2.7. "OAI-PMH".
Go to the "User Management" ("Administration Menu" at "XooNIps User Menu; "XOOPS>>XooNIps>>Maintenance>>User Management). Click on the pen-icon of the intended user to go to the "Modify User Information". Choose "moderator" at the "User's Groups" field.
Note: the pulldown menu derives from the "Moderator Group" ("XOOPS>>XooNIps>>System Configuration>>Basic Configurations>>Moderator Group).