Page tree
Skip to end of metadata
Go to start of metadata

Frequently Asked Questions

How to change the library logo?

See 04. Adjusting the Look of the Reader Application

How to change the text displayed on the pages?

Any text label used in the component template can be “covered” by entering the new value in “dlibra-webapp/WEB-INF/components/resources/WEBAPP_xx.xml” files. It will be immediately applied.

For example, in the component responsible for the “News” section (“NewsComponent”), the “NewsComponent.News” label is used, with the “News” value. [*] In order to change that value for Polish, the “NewsComponent.News” key should be added to the “dlibra-webapp/WEBINF/components//resources/WEBAPP_pl.xml” file, and a new value for that label – for example, “News” – should be entered there.

How to add a link in the “Information” section of the home page?

There are three types of links which can be used in the “Information” section:

  1. to an existing help page,
  2. to resources in the reader application, for example, to a specific publication, and
  3. to an external website, for example, to the website of an institution which creates the library.

Follow these instructions:

  1. Log into the administration panel of the reader application.
  2. Go to the “Information > Content” section.
  3. Select the “Add a new item” option.
    1. In the case of help pages, select the page and click the “Add” button.
  4. Fill in the form.
  5. A link to resources in the reader application should look as follows: $homeURL/dlibra/contact. The “$homeURL” tag will be replaced with the address of the reader application.
  6. Confirm the form.

Where can the information about the address and the institutions which create the library be added?

Address data are changed in “webapp/WEB-INF/components/resources/WEBAPP_xx.xml” files, at the “ContactComponent.Address” key. Information about the institutions which create the lbrary are changed in “webapp/WEB-INF/layout/resources/layout_xx.xml ” files, at the “Home.Copyright.” key. 

How can a new help page be added?

Help pages are stored in the database of the reader application. In order to add a new help page, the user should log into the administration panel of the reader application and follow the instructions given below.

The instructions are:

  1. Open the administration panel of the reader application.
  2. Go to the help page section.
  3. Select the “Add” option.
  4. Enter appropriate values (identifier/title/content/language) in the form.
  5. Confirm; a page in the selected language will be created. In order to create a version in another language, create another help page, with the same identifier but a different language.

How can a graphics file displayed on the pages of the reader application be replaced?

For information about the methods of changing graphics files, see chapter 04. Adjusting the Look of the Reader Application. Changing the Existing Images (Logo).

How can the title of a page displayed by the reader application be changed?

TThe titles of pages of the reader application are defined in the “webapp/WEB-INF/pages-titles.xml” file. A sample entry for the home page is presented below:

<page name="main">
	<title></title>
 	<subTitle></subTitle>
</page>

In the case of the home page, both the tag title and subtitle are empty. Any constant value or value from the “velocity” variable can be entered there, for example:

pate_titles.xml
<title><![CDATA[Moja Biblioteka Cyfrowa]]></title>
lub
<title><![${res.getProperty('base.library.full')}]]></title>

At the level of reader application templates, the values of the expressions in the “title” and “subtitle” tags are available through the “pageTitle” and “pageSubtitle” tags.i  A fragment of the “webapp/WEB-INF/layout/templates/parts/meta-header.vm.” file is presented below as an illustration of the process of creating a page title in the reader application.

#if ($pageTitle)
	#set($metaTitle = "${escapeUtil.parseHtmlToText($pageTitle)} - ${res.getProperty('base.library.full')}")
#else
	#set($metaTitle = "${res.getProperty('base.library.full')}")
#end

A page title is created:

  1. by combining the title from the declaration in the “pages_titles.xml” file with an entry from language resources – if the title has been declared in the “pages_titles.xml” file for the given page; or
  2. from an entry from language resources if the title has not been declared in the “pages_titles.xml” file for the given page.

Ostrzeżenie

When changing the content of the “pages-titles.xml” file, it should be remembered that:

  1. the content of the “title” and “subtitle” tags must not include the new line characters because that would cause errors in the output HTML code of the website;
  2. the initial “<![CDATA” tag and the final “]]>” tag should not be removed; and
  3. the file has UTF-8 encoding.

Changes in the “pages-titles.xml” file are visible immediately – the reader application does not have to be restarted.

How can the content of the meta tags in the headings of the web pages of the reader application be changed?

Meta tags in headings are changed in the “webapp/WEB-INF/layout/templates/parts/meta-header.vm” file. The user’s own, new tags can also be added. Such variables as “$pageTitle(title)”, “$pageSubTitle(description)” or “$pageTitledImage(thumbnail)” are set in the “webapp/WEB-INF/pages-titles.xml” file. Their values differ depending on page identifiers, for example, “publication” or “latest”. For instance, in the case of the home page, the title will be the name of the library, and in the case of a digital object, it will probably be the title of that object.

How can the library logo be made dependent on the interface language selected by the user?

For information about how to change a logo depending on the language, see chapter 04. Adjusting the Look of the Reader Application. Changing the Existing Images (Logo).

Where is the main file with VTL macros in the reader application in the 5.0 version of the dLibra system?

Files with macros are located in the “/WEB-INF/lib/dlibra-web-components-x.x.x.jar” archive. They are “component_library.vm” and “layout_library.vm” files. Macros can be overwritten, by being defined again in files “ /WEB-INF/components/templates/custom_library.vm” and “/WEB-INF/layouts/templates/layout_library.vm”.

What can be done when the reader application is very slow?

By default, the cache of the reader application is disabled in the dLibra system. If the reader application begins to run slowly, it is worth enabling the cache. That is done by changing the value of the “use.cache” flag in the “ /WEB-INF/conf/cache.properties” file to “true”. Next, Tomcat should be restarted. At the start-up of the reader application, the necessary data will be downloaded. For that reason, the start-up can take longer than before the enabling of the cache. When all the information has been downloaded and the application has been started up correctly, the application should run significantly faster.

Problems with the certificate when accessing the contact page

When the “Contact” item is clicked, the browser displays an error message saying that “The certificate is not trusted because it is self-signed” or that “The certificate is no longer valid (date here). (Error code: sec_error_expired_issuer_certificate)”.

The instruction for generating a new certificate for Tomcat is very simple – to run the following command:

$JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA

and enter all data of the institution. The command should be run be the user who runs Tomcat. The changes will apply after Tomcat has been restarted.

Generating a new certificate will solve the problem of an exceeded expiry date. Modern browsers, however, will still warn against such a certificate because it has not been issued by an authorized institution. In order to remedy that problem, the user should request such an institution to issue a certificate.

lt, the cache of the reader application is disabled in the dLibra system. If the reader application begins to run slowly, it is worth enabling the cache. That is done by changing the value of the “use.cache” flag in the “/WEB-INF/conf/cache.properties” file to “true”.

What exactly are cookies used for in the dLibra system? What must I do as the administrator of the dLibra system to ensure compliance with article 173 of the Telecommunication Law?

 Since March 22, 2013, the revised Telecommunication Law ((http://www.dziennikustaw.gov.pl/DU/2012/1445) is binding in Poland. Article 173 of that law says:

Art. 173.

1. Przechowywanie informacji lub uzyskiwanie dostępu do informacji już przechowywanej w telekomunikacyjnym urządzeniu końcowym abonenta lub użytkownika końcowego jest dozwolone, pod warunkiem że:

  1. abonent lub użytkownik końcowy zostanie uprzednio bezpośrednio poinformowany w sposób jednoznaczny, łatwy i zrozumiały, o:
    1. celu przechowywania i uzyskiwania dostępu do tej informacji,
    2. możliwości określenia przez niego warunków przechowywania lub uzyskiwania dostępu do tej informacji za pomocą ustawień oprogramowania zainstalowanego w wykorzystywanym przez niego telekomunikacyjnym urządzeniu końcowym lub konfiguracji usługi;
  2. abonent lub użytkownik końcowy, po otrzymaniu informacji, o których mowa w pkt 1, wyrazi na to zgodę;
  3. przechowywana informacja lub uzyskiwanie do niej dostępu nie powoduje zmian konfiguracyjnych w telekomunikacyjnym urządzeniu końcowym abonenta lub użytkownika końcowego i oprogramowaniu zainstalowanym w tym urządzeniu.

2. Abonent lub użytkownik końcowy może wyrazić zgodę, o której mowa w ust. 1 pkt 2, za pomocą ustawień oprogramowania zainstalowanego w wykorzystywanym przez niego telekomunikacyjnym urządzeniu końcowym lub konfiguracji usługi.
3. Warunków, o których mowa w ust. 1, nie stosuje się, jeżeli przechowywanie lub uzyskanie dostępu do informacji, o której mowa w ust. 1, jest konieczne do:

  1. wykonania transmisji komunikatu za pośrednictwem publicznej sieci telekomunikacyjnej;
  2. dostarczania usługi telekomunikacyjnej lub usługi świadczonej drogą elektroniczną, żądanej przez abonenta lub użytkownika końcowego.

4. Podmioty świadczące usługi telekomunikacyjne lub usługi drogą elektroniczną mogą instalować oprogramowanie w telekomunikacyjnym urządzeniu końcowym abonenta lub użytkownika końcowego przeznaczonym do korzystania z tych usług lub korzystać z tego oprogramowania, pod warunkiem że abonent lub użytkownik końcowy:

  1. przed instalacją oprogramowania zostanie poinformowany bezpośrednio, w sposób jednoznaczny, łatwy i zrozumiały, o celu, w jakim zostanie zainstalowane oprogramowanie, oraz sposobach korzystania przez podmiot świadczący usługi z tego oprogramowania;
  2. zostanie poinformowany bezpośrednio, w sposób jednoznaczny, łatwy i zrozumiały, o sposobie usunięcia oprogramowania z telekomunikacyjnego urządzenia końcowego użytkownika lub abonenta;
  3. przed instalacją oprogramowania wyrazi zgodę na jego instalację i używanie.

The cookies used in the reader application of the dLibra system are related to two basic aspects of the functioning of the system:

  • maintaining the current user session and remembering, for example, a recent search query and its results or the user’s identity (after logging in) in the session; and
  • preserving the preferences determined by the user, for example, the default way of displaying the DjVu publication or the disabling of information pages about publication formats (in older versions of the dLibra system).

Both aspects fall under paragraph 3, article 173 of the Telecommunication Law because they are necessary for ensuring the functionality of the application which the user wants to use. It means that in the default configuration of the dLibra system, it is not necessary to display special messages about cookies and their acceptance to the user.

NOTE: When the reader application is extended, for the purposes of the digital library, by adding new components, such as banners of automatic advertising systems or traffic tracking with the use of the Google Analytics service, it will become necessary to add an additional message or information component to pages included in such an additional functionality. In such a case, we recommend becoming acquainted with the privacy policy of the relevant providers of additional services (for example, for Google Analytics: http://www.google.com/intl/pl /analytics/privacyoverview.html).

How can several reader applications be run on one dLibra server?

  1. The configuration of the connection in the dLibra server: in the server database, in the “sys_services” table, add a row for the new reader application. The row will be very similar to the existing entry, in which ser_type=ps. The only changes to be made are: changing “ser_id” to the next free value and changing “ser_password” and “ser_port” to any other values (“ser_port” needs to be an actual port that the app can listen on). Any auxiliary description can be entered in the “ser_description” column because the description does not have an influence on the operation of the system.
  2. Creating a new instance of the reader application: the installer can be used for installing another user application in a new place or for copying the existing application. In the latter case, one should remember to copy the “webapp-works” directory and replace all the configuration files in which it is mentioned (it is best to search for the path in all files in the “WEB-INF” directory).
  3. The configuration of the connection to the dLibra server: in the “WEB-INF/conf/services.properties” file, the port in the “my.url” entry and the password in the “my.password” entry should be should be set in to the values added in the “sys_services” table.
  4. The configuration of the main collection in the new application: in accordance with that entry. It should be remembered that the collection will continue to be visible in the main reader application. If the contents presented by two reader applications are to be separated, both applications should have their main collections set in such a way that none of those collection is a subcollection of the other.
  5. Tomcata configuration: if Tomcat is configured in accordance with the recommendations, that is, through the “ROOT.xml” file in the “tomcat/conf /Catalina/localhost” directory, the easiest solution will be to copy that file with a new name, for example, “podstrona.xml” (in the same directory). In that way, if, for example, the original page was available at http://bilioteka.pl/dlibra, the new page will be available at http://biblioteka.pl/podstrona/dlibra. Off course, the copied XML file should be modified so that it contains the path to the directory containing the new instance of the reader application. Also, please make sure that the address at which the new application will be available is entered correctly in “WEB-INF/templates.properties”.



  • No labels