jeromedl tutorial

47
DERI Galway IDA Business Park Lower Dangan Galway IRELAND http://www.deri.ie DERI – DIGITAL ENTERPRISE RESEARCH INSTITUTE J EROME DL 2.0.1 U SER G UIDE Sebastian Ryszard Kruk, Mariusz Cygan, Ewelina Kruk, Slawomir Grzonkowski, Tomasz Woroniecki DERI ELITE PROJECT DELIVERABLE 1.1.02 MARCH 2, 2007 DERI – DIGITAL ENTERPRISE RESEARCH INSTITUTE

Transcript of jeromedl tutorial

Page 1: jeromedl tutorial

DERI GalwayIDA Business Park

Lower DanganGalway

IRELANDhttp://www.deri.ie

DERI – DIGITAL ENTERPRISE RESEARCH INSTITUTE

JEROMEDL 2.0.1 USER GUIDE

Sebastian Ryszard Kruk, Mariusz Cygan,Ewelina Kruk, Sławomir Grzonkowski, Tomasz Woroniecki

DERI ELITE PROJECT DELIVERABLE 1.1.02

MARCH 2, 2007

DERI – DIGITAL ENTERPRISE RESEARCH INSTITUTE

Page 2: jeromedl tutorial
Page 3: jeromedl tutorial

DERI ELITE DELIVERABLE

DERI ELITE PROJECT DELIVERABLE 1.1.02, MARCH 2, 2007

JEROMEDL 2.0.1 USER GUIDE

Sebastian Ryszard Kruk, Mariusz Cygan, Ewelina Kruk,Sławomir Grzonkowski, Tomasz Woroniecki1,

Introduction. JeromeDL is a Social Semantic Digital Library. As a digital library, it allows institu-tions to easily publish documents on the Web. It supports a variety of document formats; it allowsto store and query a rich bibliographic description of each document.To find relevant documents in JeromeDL users can use searching and browsing features. Wholedocuments content can be searched through, as well as single fields of the documents description,like author or publish year. Users can also find documents by browsing content of subject categoriesand keywordsWith JeromeDL’s social and semantic services every library user can bookmark interesting books,articles or other materials in semantically annotated directories. Users can allow others to see theirbookmarks and annotations and share their knowledge within a social network. JeromeDL can alsotreat a single library resource as a blog post. Users can comment the content of the resource andreply to others’ comments and this way create new knowledge.This document will guide the user through the installation process and all administration tasks forlibrarians. It will also present the most important features for the end users.

Keywords: digital library, semantic web, user guide

1Digital Enterprise Research Institute Galway, National University of Ireland GalwayIDA Business Park, Lower Dangan, Galway, Ireland E-mail: [email protected]

Acknowledgements: This work was supported by Enterprise Ireland under Grant No. *ILP/05/203*. Theauthors would like to acknowledge Stefan Decker, Bill McDaniel, Corrib Group, the DERI Galway for fruitfuldiscussions.

Copyright c© 2007 by the authors

Page 4: jeromedl tutorial

DERI ELITE PROJECT D1.1.02 I

Contents1 JeromeDL: The Semantic Digital Library - Installation 1

1.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11.2 Altering Look and Feel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.3 SMTP Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.4 Aggregation Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.5 HyperCuP Lightweight Implementation in JeromeDL - User Guide . . . . . . . . . . . . . . . . . . . 3

1.5.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.5.2 HyperCuP Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.6 RDF Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61.7 Paths, URL, etc. - Advanced Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61.8 Running JeromeDL on Different Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81.9 Building JeromeDL from Source Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81.10 JeromeDL Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91.11 Guide for upgrading JeromeDL 2.0 to version 2.0.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

2 JeromeDL: The Semantic Digital Library - User Guide 102.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102.2 Registering to the System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112.3 Searching for Resources in JeromeDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132.4 Browsing Digital Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152.5 Reading Resources in JeromeDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162.6 Sharing Knowledge with Community Bookmarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222.7 Access to Meta-data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292.8 JeromeDL Internationalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

3 JeromeDL: The Semantic Digital Library - Librarians Guide 323.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323.2 Becoming Admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323.3 Uploading Resources to JeromeDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333.4 Approving publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403.5 Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Page 5: jeromedl tutorial

DERI ELITE PROJECT D1.1.02 1

1 JeromeDL: The Semantic Digital Library - Installation

1.1 Introduction

Unless you are going to start using JeromeDL in production stage, which will make us all happy, youprobably do not need to read any of these configuration details.

Good news - JeromeDL runs out of the box. You do not have to make any configuration changes if youjust want to play with it. Here are some express installation tips.

Prerequisites

• Have JDK 5.01 installed on your system (remember to have the JAVA_HOME variable set up on thepath to JDK5.0)

• Download JeromeDL installer2 and run it, or ...• Download JeromeDL+Tomcat package3 and unpack it to any writable device (can be a USB stick)

Running JeromeDL on Windows

1. go to the directory where JeromeDL package has been unpacked

2. execute

startup.bat

3. check your web browser with address http://localhost:8080/jeromedl/

4. if nothing unexpected has happened - congratulations - you have a JeromeDL instance running

Running JeromeDL on Linux

1. Open the console

2. go to the directory where the JeromeDL package has been unpacked:

cd PATH_TO_WHERE_JEROMEDL_IS_UNPACKED

3. execute

startup.sh

4. check your web browser with address http://localhost:8080/jeromedl/

5. if nothing unexpected has happened - congratulations - you have a JeromeDL instance running

However, once you are happy with it, and ready to use it as your semantic digital library, this configura-tion tutorial will come in very handy. There are some things you might want to change to accommodate theinstallation to your environment, or to use any of the advanced features like aggregation mode (see Sec. 1.4)or distributed searching (See Sec. 1.5.

1http://java.sun.com/javase/downloads/index_jdk5.jsp2http://www.jeromedl.org/guide/bin/JeromeDL-2.0.1.jar3http://www.jeromedl.org/guide/bin/JeromeDL-2.0.1.tar.gz

Page 6: jeromedl tutorial

2 DERI ELITE PROJECT D1.1.02

1.2 Altering Look and Feel

Once you have your JeromeDL up and running - you will need to tweak the way it looks. There are twoplaces where you should look at for things to be changed:

• JeromeDL/image/ folder where some of the images can be replaced with your own logos. Youcan start by looking at the images in sub-folders with locale names, such as, en or de.

• JeromeDL/WEB-INF/src/org/jeromedl/i18n/ orJeromeDL/WEB-INF/classes/org/jeromedl/i18n/ (depending on wheather you installed

JeromeDL from sources or not) - please take some time to update the following properties:

a9_contact_person = [email protected]

dc_creator = Jon Doe jon[dot]doe[at]no[dot]comdc_publisher = Jon Doe Publishingdc_subject = Easy publishingdc_title = Jon’s Digital Library

title = Jon’s Digital Library

1.3 SMTP Settings

Many places where JeromeDL was installed in its early days required special SMTP settings for e-maildelivery. Although those settings are used only when a user registers him/herself to the system, they need tobe set up if your ISP requires any special configuration.

In order to change email settings, go to JeromeDL/WEB-INF/jeromedl.properties and alterthe following properties:

• jeromedl.foafmatic.adminEmail - the email of the person allowed to send emails

• jeromedl.foafmatic.fromEmail - the email that appears as the sender of the registration emails sentby JeromeDL

• jeromedl.foafmatic.smtpServer - the address of the SMTP server

• jeromedl.foafmatic.mail.auth - use SMTP authentication (true|false)?

• jeromedl.foafmatic.mail.username - username used for SMTP authentication

• jeromedl.foafmatic.mail.password - password used for SMTP authentication

Here is an example configuration:

jeromedl.foafmatic.adminEmail = [email protected] = [email protected] = smtp.no.comjeromedl.foafmatic.mail.auth = falsejeromedl.foafmatic.mail.username = falsejeromedl.foafmatic.mail.password = false

Page 7: jeromedl tutorial

DERI ELITE PROJECT D1.1.02 3

1.4 Aggregation Services

One of the advanced features of JeromeDL is to establish a hierarchical federation of digital libraries. Thecontent of the libraries at one level of hierarchy is aggregated by those set up on the level above them.

In order to enable this feature go to JeromeDL/WEB-INF/jeromedl.properties and alter theproperty jeromedl.scrapping.servers.

Here is an example:

jeromedl.scrapping.servers = http://localhost:7080, http://localhost:8080

1.5 HyperCuP Lightweight Implementation in JeromeDL - User Guide

1.5.1 Introduction

HyperCuP Lightweight Implementation4 is an open source library that provides a communication backendfor developing distributed applications with a very efficient broadcast algorithm.

The aim of this manual is to provide general information about configuring HyperCuP within JeromeDL.Moreover, the manual shows how to configure a single JeromeDL installation to make it able to co-operatewith other instances.

1.5.2 HyperCuP Configuration

Using Properties File (recommended) The easiest and recommended way to configure the HyperCuP isto prepare a properties file: JeromeDL/WEB-INF/hypercup.properties. An example propertiesfile looks like the following:

services.amount = 2services.name.1 = elpservices.name.2 = dfoafservice.elp.localquery = org.jeromedl.service.elp.LocalQueryImplservice.elp.url = http://another.library.net/services/HyperCuPServiceservice.elp.integrationchampion = http://another.library.net/

services/HyperCuPServiceservice.dfoaf.localquery = org.foafrealm.hypercup.LocalQueryImplservice.dfoaf.url = http://another.library.net/services/HyperCuP4DFOAFservice.dfoaf.integrationchampion = http://another.library.net/

services/HyperCuP4DFOAF

From an administrator’s perspective, only four lines are important, which are responsible for setting upthe addresses. The administrator should adjust them to the library needs:

• service.elp.url=http://another.library.net/services/HyperCuPService - This entry contains a properaddress of the ELP service (distributed searching protocol in JeromeDL) . Usually, it is required tochange the ”another.library.net” to a correct library address. Each library has a uniqueaddress.

4http://www.hypercup.org/

Page 8: jeromedl tutorial

4 DERI ELITE PROJECT D1.1.02

Figure 1: Starting connections

• service.elp.integrationchampion=http://library.deri.org/services/HyperCuPService - This line in-forms the system about the other library elp service address which the system will connect after press-ing the start button. The administrator must replace the ’library.deri.org’ part with a correct service’saddress. The address can be same for many libraries who participate in the federated network.

• service.dfoaf.url=http://another.library.net/services/HyperCuP4DFOAF - The line’s meaning issimilar to the service.elp.url; it contains a proper address of the dfoaf service. Usually, it is required tochange the ’library.deri.ie’ to a correct library address. The address is individual for various libraries.

• service.dfoaf.integrationchampion=http://another.library.net/services/HyperCuP4DFOAF - Theline meaning is similar to the service.elp.integrationchampion; it informs the system about the otherdfoaf service address provided by other library which the system will connect after pressing the startbutton. The administrator must replace the ’library.deri.org’ part with a correct service’s address. Theaddress can be same for many libraries who participate in the federated network. When the propertiesfile is completed, the administrator must click on the start button (See Fig. 1) in the HyperCuP panel.

Using WWW Panel It is possible to configure HyperCuP using the web panel. HyperCuP’s panel isdepicted in the (See Fig. 2) (See Tab. 1.5.2) for an explanation of the fields.

Configured libraries are able to co-operate with each other. If two librarians decide to connect theirlibraries, one of them must join to the other. In order to perform this task, an administrator must fill in theform (6) with the other libraryâAZs service address and press the join (7) button.

JeromeDL uses two services: dfoaf and elp; they require separate configuration.The HyperCuP protocol [2] connects libraries using specific algorithms as a result libraries have con-

nections which are known as virtual; they are needed for maintenance reasons; such connections are listedin the ’The peers for this service’ area (8). It is strongly recommended to use a properties file in orderto configure libraries!

Configuration Test In order to check if the provided addresses are correct, the administrator should try toenter the parameters given in the service.elp.url and service.elp.integrationchampion to a web browser. Forinstance, entering http://library.deri.ie/services/HyperCuPService orhttp://library.deri.org/services/HyperCuPService should result in a web page (see

Fig. 3).

Page 9: jeromedl tutorial

DERI ELITE PROJECT D1.1.02 5

Figure 2: HyperCuP’s control panel

Figure 3: Correct elp service configuration

Page 10: jeromedl tutorial

6 DERI ELITE PROJECT D1.1.02

Figure 4: Correct dfoaf service configuration

So as to check the dfoaf service, we proceed similarly. Entering service.dfoaf.url or service.dfoaf.integrationchampionparameters in a web-browser should results in showing a screen (See Fig. 4).

Additionally, the successful configuration process is noticeable from the HyperCuP administration panel.Clicking on the link 4 (See Fig. 1) results in showing the current configuration; a sample configuration hasbeen shown in (See Fig. 5). Only connections which are configured by means of the properties are shownon this page. Moreover, the connections have different status.

The status is explained below.

• Not initialized – the service still needs some steps to complete the configuration process,

• Initialized but not connected – the service is initialized. However, it is not connected to any otherservice,

• Initialized and connected and – informs that the service is both configured and connected with otherservice or services,

• Unknown – some unexpected problems arose.

1.6 RDF Storage

JeromeDL uses Sesame as the RDF storage. The default JeromeDL installation comes with Sesame usingnative RDF storage. However, you can change it by altering to JeromeDL/WEB-INF/sesame.conffile.

For further reference please refer to Sesame user manual5.

1.7 Paths, URL, etc. - Advanced Settings

There are a number of additional settings in JeromeDL/WEB-INF/jeromedl.properties that canhelp you tweak JeromeDL behaviour towards your needs.

• jeromedl.defaultLanguage - default language that JeromeDL will greet its visitors. Your can se-lect any locale from English, Polish, German, Korean, Ukrainian, Russian, Spanish, Portuguese-Brazilian, French, Dutch, Bulgarian and Gaelic. But be aware that JeromeDL v2.0.1 fully supportsonly the first 7 of them.

5http://www.openrdf.org/doc/sesame/users/ch03.html

Page 11: jeromedl tutorial

DERI ELITE PROJECT D1.1.02 7

Figure 5: Predefined connections preview

• jeromedl.indexPath - relative or absolute path to where the fulltext index of documents should bestored

• jeromedl.storagePath - relative or absolute path to where the binary resources should be stored

• jeromedl.resourceMaxSize - maximal allowed size for uploaded resources

• jeromedl.indexOptimizationPeriod - how often should the fulltext index be optimized

• jeromedl.search.default.distributed - indicates whether the searching should be distributed by de-fault

• jeromedl.search.default.isConjunction - indicates whether the searching should be in conjunctivemode by default

• jeromedl.mms.targetEndPoint - JeromeDL uses MarcOnt Mediation Services (MMS6) to deliverbibliographic descriptions in different formats. If you decide to use JeromeDL in production mode -please set up your own MMS and change this entry.

Here is an example configuration:

jeromedl.defaultLanguage = en

jeromedl.indexPath = WEB-INF/lucene/index/jeromedl.storagePath = WEB-INF/storage/

jeromedl.resourceMaxSize = 2000000000jeromedl.indexOptimizationPeriod = 1

6MMS: http://mms.marcont.org

Page 12: jeromedl tutorial

8 DERI ELITE PROJECT D1.1.02

# default options for searchjeromedl.search.default.distributed = falsejeromedl.search.default.isConjunction = true

# marcont meditation servicesjeromedl.mms.targetEndPoint = http://mms.marcont.org/services/MMSService

1.8 Running JeromeDL on Different Port

One of the problems you might have when running JeromeDL is that another application is already runningon port 8080, used by the Tomcat server in you installation of JeromeDL. To overcome the problemyou need to change the default port to some other (called in this section NEWPORT).

• open webapp/WEB-ING/jeromedl.properties file and change two properties:

jeromedl.resource.URI = http://localhost:NEWPORT/jeromedl/resource/%sjeromedl.sesame.serviceURL = http://localhost:NEWPORT/sesame/

• open apache-tomcat/conf/server.xml and change

<Service name="Catalina">...<Connector port="8080" maxHttpHeaderSize="8192" >...</Connector>...

</Service>

to

<Service name="Catalina">...<Connector port="NEWPORT" maxHttpHeaderSize="8192" >...</Connector>...

</Service>

1.9 Building JeromeDL from Source Code

Here is a step-by-step information on how to build JeromeDL from source code.

Page 13: jeromedl tutorial

DERI ELITE PROJECT D1.1.02 9

Prerequisites

• JeromeDL source code7

Download the latest source code by executing:svn co https://jeromedl.svn.sourceforge.net/svnroot/jeromedl/trunk jeromedl

• Apache Tomcat servlet container8 (version 5.5.17 or later)• Apache Ant 9

Installation and running JeromeDL

• JeromeDL comes with some standard configuration. You can change it by changing properties fileslocated in base module in src directory

• Install Apache Tomcat• Install libraries in Tomcat by copying or symbolic linking:

– all jar files from webapp/WEB-INF/lib/tomcat/client/lib/ toCATALINA_HOME/client/lib/

– all jar files from webapp/WEB-INF/lib/tomcat/server/lib/ toCATALINA_HOME/server/lib/

– file webapp/WEB-INF/lib/tomcat/cont/Catalina/localhost/jeromedl.xmlto CATALINA\_HOME/conf/Catalina/localhost/. docBase attribute in this file shouldbe pointing to the webapp module path

• Modify webapp/WEB-INF/build.xml to contain proper paths• Build the project by executing:

antin webapp/WEB-INF directory

• Start Tomcat

1.10 JeromeDL Logging

You can also change the way that JeromeDL logs messages. JeromeDL uses the default Java logging so-lution. To tweak it please change entries in JeromeDL/WEB-INF/src/logging.properties orJeromeDL/WEB-INF/classes/logging.properties (depending wheather you are setting up

JeromeDL from source code [first path] or not [latter path]).Here is an example configuration:

handlers = java.util.logging.ConsoleHandler

org.jeromedl.level = ALL

java.util.logging.ConsoleHandler.level = CONFIGjava.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter

7http://jeromedl.svn.sourceforge.net/viewvc/jeromedl/trunk/8http://tomcat.apache.org/download-55.cgi9http://ant.apache.org/bindownload.cgi

Page 14: jeromedl tutorial

10 DERI ELITE PROJECT D1.1.02

1.11 Guide for upgrading JeromeDL 2.0 to version 2.0.1

To upgrade to version 2.0.1 you should perform the following steps:

1. Download JeromeDL-2.0.1.tar.gz fromhttp://sourceforge.net/project/showfiles.php?group_id=129949

2. Unpack the downloaded file to a new directory:

mkdir JeromeDL-2.0.1cd JeromeDL-2.0.1tar xzvf JeromeDL-2.0.1.tar.gz

3. Copy the resources and configs from your library to the new installation:

cd previous_jeromedl_installation_directorycp -a webapp/WEB-INF/lucene ../JeromeDL-2.0.1/JeromeDL/webapp/WEB-INFcp -a webapp/WEB-INF/storage ../JeromeDL-2.0.1/JeromeDL/webapp/WEB-INFcp -a webapp/WEB-INF/dwn ../JeromeDL-2.0.1/JeromeDL/webapp/WEB-INFcp -a webapp/WEB-INF/*.properties ../JeromeDL-2.0.1/JeromeDL/webapp/WEB-INF

4. Merge any other files which you have hand edited (for exampleapache-tomcat/conf/server.xml)

5. Run the new installation:

cd JeromeDL-2.0.1/JeromeDL./startup.sh

6. Test the new installation by pointing your web browser tohttp://localhost:8080/jeromedl or whatever address you configured JeromeDL to berunning at.

7. If everything is ok and you can browse and download all of you resources, you can delete the oldinstallation. To make things safe, make a backup of the old version installation before you delete it.

2 JeromeDL: The Semantic Digital Library - User Guide

2.1 Introduction

Welcome to JeromeDL Users Guide. Here, we will introduce you to the most important features of thesystem - from browsing the library to accessing metadata.

To begin, please look at preview at the video presenting an overview of JeromeDL.(See Fig. 6

Page 15: jeromedl tutorial

DERI ELITE PROJECT D1.1.02 11

Figure 6: Overview of JeromeDL – screenshot from video

2.2 Registering to the System

Although, you can browse and search JeromeDL resources without registering, similar to a real-life library,you gain more access as a registered user.

JeromeDL uses FOAFRealm10 identity management system to maintain registered users (and creatorsof publications as well). The are 4 generic types of users recognized by the system:

• Not registered, users without a profile in the system. They can still browse and search the digitallibrary. But they cannot use certain features like bookmarking11.

• Registered users, users with an account in one of the FOAFRealm systems can make use of thebookmarking and collaborative filtering sub-system12.

• Community members, are users that registered themselves and are linked by some other users asfriends in their FOAF profile. These users are allowed to upload resources13 to the system.

• Administrators, users that are the most trusted friends (the trust value in the profile is set to 1.0 )of [email protected] user. They have full control over the system, including: approvingresources for publishing14, reindexing and refreshing database15, configuring P2P network16.

Before you will register to the system you need to create new account

1. Click the register link on the shorthand in the right-hand side of the page (see Fig. 7)

2. Provide a name , valid e-mail address and a new password (twice)10http://www.foafrealm.org/11http://www.jeromedl.org/guide/userguide_bookmarking.html12http://www.jeromedl.org/guide/userguide_bookmarking.html13http://www.jeromedl.org/guide/adminguide_uploading.html14http://www.jeromedl.org/guide/adminguide_approving.html15http://www.jeromedl.org/guide/adminguide_maintenance.html16http://www.jeromedl.org/guide/configuration_p2p.html

Page 16: jeromedl tutorial

12 DERI ELITE PROJECT D1.1.02

Figure 7: Registering and logging in to JeromeDL

3. Click submit

4. Check you email inbox for new email from the system

5. Click on the link provided to complete the installation

6. Please note that in order to gain administrative rights on the new account you need to login as admin-istrator and set your new email as a friend of administrator with trust level = 1.0

Here is another video - a step by step registration process (See Fig. 8)

1. REGISTER

2. fill in the empty fields:

• name, email address and password (twice) are obligatory

3. click register

4. check your email inbox and open the mail with the linkto complete the registration process

5. you can login now

• provide login (your email address) and password

6. in "My profile":

• you can add your picture

• you can change information about yourself

• you can add / remove friends

Page 17: jeromedl tutorial

DERI ELITE PROJECT D1.1.02 13

Figure 8: A step by step registration process – screenshot from video

• click this button to accept uploaded information

• you cannot upload resources

7. logout

8. login as admin ([email protected])

9. you should add your email as a friend of admin(default trust level = \textbf{0.5}) - this will give youmore access to JeromeDL

10. log-out

11. login with your own email again

12. you have more privileges now- e.g. you can start uploading resources

2.3 Searching for Resources in JeromeDL

JeromeDL presents 4 ways to search for resources:

• A simple keyword-based search (with semantic query expansion based on your profile) (See Fig. 9)

• An advanced search based on schemata types (Dublin Core, MARC21, BibTeX) (See Fig. 10)

• A semantic search - where you can either provide an RDF query directly or use one of a couple of natu-ral language templates (like: Show me all resources written by a friends of mine)(See Fig. 11)

• A distributed search, including searching through A9.com17 interface17http://a9.com/

Page 18: jeromedl tutorial

14 DERI ELITE PROJECT D1.1.02

Figure 9: Simple, keyword search

Figure 10: Advanced search

Video presenting the search features in JeromeDL (See Fig. 2.3)

Simple search

1. click SIMPLE SEARCH in the menu

2. provide some keywords (e.g. WEB)

3. click SEARCH button

Advanced search

1. click ADVANCED SEARCH in the menu

2. provide some keywords (e.g.: digime)

3. provide name of the author (e.g. Kruk)

Page 19: jeromedl tutorial

DERI ELITE PROJECT D1.1.02 15

Figure 11: Semantic query interface

4. provide search term e.g. author’s name

5. select one of the properties presented

6. click "More Parameters" if you want to specify more query parameters

7. you can also remove some of existing query parameters

8. click SEARCH button

Video presenting the search in JeromeDL using the A9.com interface (See Fig. 2.3)

1. change URI

2. select Add / Remove options to select JeromeDL search engine

3. look up JeromeDL search engine(s)

4. click more info

5. type in your search query

6. go to the [email protected]

7. choose simple search

8. type in the same search query

9. you can compare the search results

2.4 Browsing Digital Library

The browsing component in JeromeDL is something that we are currently improving. At the followingmoment you can browse resources by filtering them with:

• Type of publication (article, in-proceedings, etc.) (See Fig. 14 and Fig. 15)

• Author of the publication (See Fig. 16)

Page 20: jeromedl tutorial

16 DERI ELITE PROJECT D1.1.02

Figure 12: Another short video presenting the search features in JeromeDL – screenshot from video

• Keywords describing the publication (See Fig. 17)

• Categories/topics describing publication (See Fig. 18)

Here is a short video presenting some of the browsing features in JeromeDL (See Fig. 19)

1. select the type of resources to display (e.g. articles)

2. display different types of view (table, jeromedl, google-like)

3. display different languages

4. display different types of sorting (title, authors, dates)

5. display number of resources and number of pages

6. click on a resource and it displays differentkinds of versions (html, pdf, rtf)

7. click on an author’s name

2.5 Reading Resources in JeromeDL

Once you find the resource that you were looking for, you can open it by clicking on the arrow next toresource’s title (individual link to the resource - see Fig. 20).

You will be presented with information (see Fig. 21) on the resource, which can consist of:

• cover page

• abstract

• number of chapters

• number of attachments

Page 21: jeromedl tutorial

DERI ELITE PROJECT D1.1.02 17

Figure 13: ... and searching through the A9.com interface – screenshot from video

Figure 14: Start browsing by types of publications

• keywords

• categories/topic

• additional arbitrary properties, like e.g., related conference, publication place

Reading RTF/HTML resources (See Fig. 22)

1. select the type of resources to show(e.g. publications)

2. click this resource

3. click here to show cover page

4. the cover page

5. click here to see the chapter in the HTML version

6. you can see the resource in the HTML version

Page 22: jeromedl tutorial

18 DERI ELITE PROJECT D1.1.02

Figure 15: JeromeDL presenting resources of type Master’s Thesis

7. click here to see the chapter in the PDF version

8. you can see the resource in the PDF version

9. you can change pages

10. click here to see the chapter in the RTF version

11. you can view the RTF version in your word processor

12. click here to view this resource (protected from printing)in HTML version

13. the HTML version of the resource protected from printingis rendered with the Java Applet

14. you can select chapters with this interface as well

Reading PDF resources (See Fig. 23)

1. select the type of resources to show (e.g. articles)

2. click this resource

3. click here to see the chapter in the PDF version

4. you can see the resource in the PDF version

5. you can change pages

Page 23: jeromedl tutorial

DERI ELITE PROJECT D1.1.02 19

Figure 16: JeromeDL presenting publications of Sebastian Ryszard Kruk

Figure 17: JeromeDL presenting publications annotated with keyword ’network’

Page 24: jeromedl tutorial

20 DERI ELITE PROJECT D1.1.02

Figure 18: JeromeDL presenting publications classified under category ’Directories’

Figure 19: Video presenting some of the browsing features in JeromeDL – screenshot from video

Reading external resources (See Fig. 24)

1. select the type of resources to show (e.g. miscellaneous)

2. click this resource

3. open this resource

4. you can see the resource in the HTML version

Reading SWF resources (See Fig. 25)

1. select the type of resources to show (e.g. manuals)

2. click this resource

3. click here to see multimedia part in Macromedia Flash

4. you can see the resource in Macromedia Flash format

Page 25: jeromedl tutorial

DERI ELITE PROJECT D1.1.02 21

Figure 20: Individual link to the resource

Figure 21: Information about the resource

Page 26: jeromedl tutorial

22 DERI ELITE PROJECT D1.1.02

Figure 22: Reading RTF/HTML resources – screenshot from video

5. you can change pages

6. click here to see the multimedia inMacromedia Flash (smaller version)

7. change the type of the resource

8. you can see the resourcein Macromedia Flash again

Reading scanned resources – screenshot from video (See Fig. 26)

1. select the type of resources to show(e.g. antique books)

2. open this resource

3. click here to see the collection of scanned pagesfor this antique book

4. you can see the collection of scanned pagesfor this antique book

5. you can change size of this resource

6. you can change pages

2.6 Sharing Knowledge with Community Bookmarks

JeromeDL features a unique collaborative filtering system based on social networking and enriched semanticinformation, called social semantic collaborative filtering18 It allows users to easily bookmark, annotateresources, share them and (if required) protect their knowledge.

To bookmark/annotate a resource - first click on the "individual link" (see Fig. 27) to the resource18http://library.deri.ie/resource/5e68d6a6

Page 27: jeromedl tutorial

DERI ELITE PROJECT D1.1.02 23

Figure 23: Reading PDF resources – screenshot from video

If you wish you can create a new directory - providing label, description, categories and keywords (seeFig. 28):

1. Select the ‘box next to the directory where you what to put your resource

2. Social Semantic Collaborative Filtering is a pure AJAX application - so no need to submit a page :)

You can take a look on how the bookmarking system in JeromeDL works (See Fig. 29)

1. Log as user A.

2. Select one of types of resources - e.g. Publications

3. Click on this resource

4. Open individual resource view

5. Click Your Bookmarks

6. Create new directory

(a) Give name and description(b) Select WordNet value(c) Select some Taxonomies(d) Click SAVE

7. Create new bookmark in the newly created directory.

8. Add this resource to selected directory

9. You can see results of your action

10. You can choose a second resource

11. Add the second resource to the same directory.

Page 28: jeromedl tutorial

24 DERI ELITE PROJECT D1.1.02

Figure 24: Reading external resources – screenshot from video

Figure 25: Reading SWF resources – screenshot from video

Page 29: jeromedl tutorial

DERI ELITE PROJECT D1.1.02 25

Figure 26: Reading scanned resources

Figure 27: Individual link to the resource

Page 30: jeromedl tutorial

26 DERI ELITE PROJECT D1.1.02

Figure 28: Annotating resources to JeromeDL

Page 31: jeromedl tutorial

DERI ELITE PROJECT D1.1.02 27

Figure 29: Adding resources to bookmark – screenshot from video

12. Go to the bookmarks page.

13. View your bookmark and bookmarks of your friends.

14. Copy one of the friend’s bookmark and paste into your directory.

15. Cut this directory and paste into another one.

16. See more information about directory.

17. See the directory policies.

18. Empty clipboard

19. Log as user B

20. Set policy to the directory.

21. Log as user A

22. Open bookmarks of user B, and see that directorywith policy set is hidden.

You can also access and manage your bookmarks with your mobile device (See Fig. 30)

1. Log into FOAFRealm (as [email protected])

2. Select Friends list

3. Explore friends’ list

4. Select one friend

(a) Show information about a friend(b) View friend’s bookmarks(c) Explore friend’s bookmarks

5. Add new friend

Page 32: jeromedl tutorial

28 DERI ELITE PROJECT D1.1.02

Figure 30: Manage your bookmarks with your mobile device – screenshot from video

Page 33: jeromedl tutorial

DERI ELITE PROJECT D1.1.02 29

6. See new friend’s details

7. Remove friend

8. Send e-mail to a friend

9. Back to main menu

10. Open Bookmarks

11. Explore bookmarks

12. View details about a bookmark

13. Add new bookmark

14. Remove added bookmark

15. Explore next directory

16. Back to main menu

17. Select Profile

18. Explore and edit profile

19. Check profile changes

20. Log as different user ([email protected])

21. View bookmarks

22. Set rights to one of the directories

23. Log one more time as first user ([email protected])

24. View friends list

25. View [email protected] bookmarks

26. See that Damyan has no rights to one of the directories

27. End application

2.7 Access to Meta-data

JeromeDL delivers access not only to the resources but also to the meta-data. There are couple of meta-datastandards supported by JeromeDL:

1. A user stays notified on the new publications uploaded to JeromeDL library by subscribing to an RSSchannel either with one of the channels listed in the shorthand (see Fig. 31) or with an embedded linkto the RSS channel (recognized by many web browsers, e.g. Mozilla)

2. Almost every page presented to the user by JeromeDL is rendered out of the RDF information, whichthe user can get access to (see Fig. 32)

3. To support different meta-data standards, JeromeDL utilized MarcOnt Mediation Services19, whichcan be invoked by selecting the RDF icon next to the publication (see Fig. 33).

19MarcOnt Mediation Services: http://mms.marcont.org/

Page 34: jeromedl tutorial

30 DERI ELITE PROJECT D1.1.02

Figure 31: RSS channels in JeromeDL

Figure 32: Links to RDF sources of the presented information

Figure 33: MarcOnt Mediation Services invoked from JeromeDL

Page 35: jeromedl tutorial

DERI ELITE PROJECT D1.1.02 31

Figure 34: Access RSS channels in JeromeDL – screenshot from video

4. Since there are many ways to express semantically rich information, JeromeDL aims to support moreand more of them. Currently, users can facilitate from the information being embedded in HTML webpages in20:

• eRDF21

• microformats22

5. Semantic information managed by JeromeDL is also detectable by Semantic Radar23

Take a look a the video showing how to access RSS channels in JeromeDL (See Fig. 34)

1. you can see different types of RSS feeds

2. add Live Bookmark

3. show Bookmarks Toolbar

4. you can select from bookmarks a resourcewhich you are interested in

2.8 JeromeDL Internationalization

One of the aims of the JeromeDL project is to make it as user-friendly as possible. That is why it is soimportant for us to make it communicate in your language. If it cannot at the moment - maybe you can helpus24.?Here is a video on how to change the default language in JeromeDL (See Fig. 35)

20http://www.jeromedl.org/guide/images/showimage12.jpg21http://research.talis.com/2005/erdf/xtech2006.html22http://microformats.org/23http://www.jeromedl.org/guide/userguide_access.html24http://www.jeromedl.org/index.php?option=com_content&task=view&id=23&Itemid=51

Page 36: jeromedl tutorial

32 DERI ELITE PROJECT D1.1.02

Figure 35: Languages in JeromeDL – screenshot from video

3 JeromeDL: The Semantic Digital Library - Librarians Guide

3.1 Introduction

JeromeDL delivers a number of features accessible only to administrators, librarians or advanced users -among them uploading resources, approving for publication or reindexing the database.Here is some video presenting an overview of administrative features (See Fig. 36)

1. present general overview of the system

2. click Administration panel

3. show introductory documentation

4. move over most common features

3.2 Becoming Admin

To be granted administrative rights you need to login as the admin (see below) or become a trusted friend ofthe admin.

1. Click login link on the shorthand in the right-hand side of the page

2. provide login [email protected]

3. provide password changeit!!

4. click submit and you should be registered with administrative rights

Please note that admin’s password should be changed as soon as possible after installation.

Page 37: jeromedl tutorial

DERI ELITE PROJECT D1.1.02 33

Figure 36: Video presenting overview of administrative features – screenshot from video

Figure 37: Accessing Uploading Interface

3.3 Uploading Resources to JeromeDL

To upload resources to JeromeDL you do not have to be an admin. However, since this feature is restrictedto members of the community25 we have decided to include it here.

• link to the interface is located on the shorthand in the right-hand side of the page (see Fig. 37)

• first select the type of the resources you want to upload:

1. PDF – resource with a couple of chapters, each consisting of one PDF file2. RTF – resource with a couple of chapters, each consisting of one RTF file (this resources can be

later rendered also as HTML or PDF)3. SWF – resource with a couple of multimedia parts, each consisting of one or two (if a smaller

version of the presentation is also provided) Macromedia Flash presentations25http://www.jeromedl.org/guide/userguide_registering.html

Page 38: jeromedl tutorial

34 DERI ELITE PROJECT D1.1.02

Figure 38: Providing Basic Information

4. SCAN – resource with a couple of chapters, each consisting of many JPG or PNG images(pages)

5. URI – resource that is not stored in the JeromeDL database, but somewhere else

• fill some basic information about the publication (see Fig. 38):

1. Provide the title of the resource2. Select authors/editors etc. by providing parts of their names and drag-and-dropping them to an

appropriate category3. Provide an abstract of the resource4. Select a cover page of the resource

• Now you can add the new content - chapters/parts of the publication (see Fig. 39)

1. Start adding new chapters2. Fill in starting and ending pages3. Select digital resources (PDF, RTF, images) to upload in each chapter

• Later, you can annotate the publication with keywords and categories or topics (see Fig. 40)

1. Select entries in taxonomies to describe this resource2. Select keywords from WordNet or provide your own

• Finally, you can attach some other binary resources (see Fig. 41), and provide additional annotationsusing (see Fig. 42):

Page 39: jeromedl tutorial

DERI ELITE PROJECT D1.1.02 35

Figure 39: Adding chapters

Figure 40: Annotating publication with keywords and categories/topics

Page 40: jeromedl tutorial

36 DERI ELITE PROJECT D1.1.02

Figure 41: Uploading attachments

Figure 42: Additional descriptions

– properties from MarcOnt ontology– any properties referenced by URI– new properties using short name (they will become suggestions for the next versions of the

MarcOnt ontology)

Following video present uploading publications step-by-step

1. choose digital type of resource to upload- e.g. pdf, scans, swf etc.

2. choose type of the resource- e.g. article, book, old book etc.

3. fill in the title

4. copy the abstract

5. paste the abstract

6. fill in the uri (if digital type is an uri)

7. fill in the abstract

8. choose cover page

9. choose whether resource is pre-print version

10. choose protection type - e.g. protected from copying,available after paying

11. fill in a part of the author’s name

12. click SEARCH

Page 41: jeromedl tutorial

DERI ELITE PROJECT D1.1.02 37

13. select creator(s), publishers and contributorsthrough AJAX component

14. after finding person(s) use drag & drop to place themin appropriate boxes

15. you can add many chapters

16. add many media parts (the same steps as for chapter)

17. add many pages within the chapters (multifile upload appletas a convenient way to add and send many files at once)

18. fill in empty fields for each chapter:name, title, pages from, pages to

19. choose files and upload - e.g. content,smaller content, pages

20. add attachments (through multifile upload applet)

21. choose domains related to the resource being uploaded.One can choose a value from many different classifications(e.g. PKT, DDC, DMOZ). Another AJAX component is used for this purpose.

22. choose WordNet keywords describing the resource. Again AJAX componentis used for it. After searching for particular word, one can view adetailed description of results and drag & drop desired keywordsto the prepared box. Keywords not from WordNet can also be added.

23. (the progress bar will indicate the progressin uploading files to the server) in the mean while you cancontinue describing resource

24. fill in some additional information

25. click SEND to finish the upload

Different upload forms for different type of resource (See Fig. 43)

1. fill in empty fields

2. forms are created dynamically dependingon the type of resource to add

Support for many languages (i18n) (See Fig. 44)

1. translations of uploader form

2. you can change the language

Page 42: jeromedl tutorial

38 DERI ELITE PROJECT D1.1.02

Figure 43: Different upload forms for different type of resource – screenshot from video

Figure 44: Support for many languages (i18n) – screenshot from video

Page 43: jeromedl tutorial

DERI ELITE PROJECT D1.1.02 39

Figure 45: Uploading pdf file (book) – screenshot from video

Figure 46: Uploading scans (old book) – screenshot from video

Page 44: jeromedl tutorial

40 DERI ELITE PROJECT D1.1.02

Figure 47: Uploading presentation (swf) – screenshot from video

Uploading pdf file (book) (See Fig. 45)

1. form for uploading pdf

2. adding many chapters

3. adding content for each of the chapters

Uploading scans (old book) (See Fig. 46

1. form for uploading scans

2. adding many chapters

3. adding and uploading many scannedpages within each of the chapters

Uploading presentation (swf) (See Fig. 47

1. form for uploading swf (presentations)

2. adding media part

3. adding content and smaller content (with lower resolution)

3.4 Approving publications

JeromeDL allows each community member to upload resources to the database. However, in order to controlthe quality of the resources published in the library, each resource has to be approved by an administratorafter uploading (or after each time the resource has been changed).

A video showing how to approve publications in JeromeDL (See Fig. 48)

1. log-out if logged

2. login as administrator ([email protected])

Page 45: jeromedl tutorial

DERI ELITE PROJECT D1.1.02 41

Figure 48: Approve publications in JeromeDL – screenshot from video

3. admin’s account gives you full access to JeromeDL

4. login as you again and now you have full access

5. click APPROVE PUBLICATIONS

6. select resources you want to publish

7. click PUBLISH

8. check if the resources you selected are published

3.5 Maintenance

There are a couple of features restricted to the administrator, that are allowed to maintain the digital libraryservice. All of them can be accessed from the shorthand panel at the right-hand side on JeromeDL webpage.

• Re-indexing database (fulltext index)

• Refreshing database, e.g., removing unreferenced binary resources

• HyperCuP configuration 26

• Checking current configuration

A short video showing how to re-index database (See Fig. 49)

1. click on REINDEX in the shorthand

2. wait till the page will load

26http://www.jeromedl.org/guide/configuration_p2p.html

Page 46: jeromedl tutorial

42 DERI ELITE PROJECT D1.1.02

Figure 49: How to re-index database – screenshot from video

Page 47: jeromedl tutorial

DERI ELITE PROJECT D1.1.02 43

numberon the name descriptionFig.

1 version id for information only. in order to connect different libraries into one network,all libraries must have the same hypercup version.

2 keep-aliveinterval

a control value which enables to check states of the connected libraries. thedefault value is 20000 milliseconds; it means that the library checks the avail-ability of other connected libraries every 20 seconds. if an accident occursor a connection is unsuccessful, the automatic repair of the connection is per-formed.

3 restore pre-defined con-nections

it allows an administrator to start a set of predefined connections. the propertiescan be viewed by clicking on a highlighted link (4). figure 5 in section 4 showsan example window which appears after clicking on the link. the button startexecutes the prepared configuration file.

4 propertieslink

the location of the properties file. click on it to preview.

5 start a newservice

this area allows creating new services. working with JeromeDL, an admin-istrator probably will never use this feature. Here is a sample configuration:

1. enter service address (D-FOAF):http://library.deri.ie/jeromedl/services/hypercup4dfoaf

2. enter service alias: dfoaf

3. localquery implementation:org.foafrealm.hypercup.localqueryimpl

4. enter service address (ELP):http://library.deri.ie/jeromedl/services/hypercupservice

5. enter service alias: dfoaf

6. localquery implementation:org.jeromedl.service.elp.localqueryimpl

The service addresses differ depending on the real installation address. Afterfilling in the forms, the button initialize (10) must be pressed; if everythingwent correctly a new service will appear in the available services (9) area.

6 address enter the address of the library you are going to connect7 join press it when you configure the service and are going to join.8 peers the list of the peers who are connected to a given service9 available

servicesthis area shows a detailed overview of all configured services. Here is themeaning of all fields:alias the service’s name,

address the service’s address,

query status if the localquery is registered correctly, the status is ”ok”.

Table 1: Fields descriptions