...
Table of Content Zone | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Configuring the Reader ApplicationIn this chapter, there are instructions on the configuration of some mechanisms related to the reader application. Configuring the CAS ServiceThe dLibra system makes it possible to use a central login system created with the use of the CAS server and the LDAP service. CAS is available as another identity provider in file dlibra-webapp/WEB-INF/conf/user-providers.xml. The following fragment should be uncommented:
Next, the user should:
Next, the content of file dlibra-webapp/WEB-INF/conf/ldap.properties should be completed. The file contains parameters which make it possible to use the LDAP service. Configuring News ImportThe reader application makes it possible to publish various types of messages on the home page. Those news can be added with the use of the administration panel of the reader application or by means of the mechanism of RSS news import. A sample import process is discussed below. In order to import news from an RSS available online, the user should uncomment the “periodic-task” tag containing the configuration of the NewsImportTask in the periodic.xml file
The configuration of that task consists of the following parameters:
by default, that task is carried out once a day; whenever the reader application detects that a new news item has appeared in the RSS channel, it will import it within the framework of the nearest performance of that task. Adding BookplatesIn the reader application of the dLibra system, bookplates are represented as images with a link to the selected page (library, institution, etc.) which appear on the page with the description of a publication (publication, docmetadata). Bookplates are added on the basis of the values of particular attributes in metadata. For example, a bookplate may be displayed depending on the value of the “Permissions” attribute – for the “Library Institution X” value, an image which identifies that institution will be displayed, together with a link to the home page of that institution, “www.instytucjabibliotecznax.com”. A bookplate is added in the following manner:
The “attribute, “attribute-value”, and “exlibris” elements can be defined many times, so many bookplates can be added for every determined value of a metadata attribute, For example:
In that configuration, the “Biblioteka Uniwersytecka w Poznaniu” bookplate will appear for the “Permissions” attribute both when it has the “Biblioteka Uniwersytecka w Poznaniu” value and when it has the “BUP” value. Moreover, if the same “Permissions” attribute has the “Uniwersytet A. Mickiewicza i Politechnika Poznanska” value, two bookplates (images with links) will be displayed, for the Adam Mickiewicz University and for the Poznan University of Technology. The exlibris.xml configuration will only begin to apply after the servlet environment of the reader application (Apache Tomcat) has been restarted. Incorrect settings may cause exceptions and system log errors to appear. Configuring the JCR Backup SystemIn order to change the default JCR backup creation settings in the system, the user should edit the periodic.xml file in the /WEB-INF directory of the reader application. The entry concerning the appropriate periodic task is looks as follows:
Two parameters can be changed in the task: jcr.backup.dir orazand copies.amount. Pierwszym parametrem administrator wskazuje katalog, do którego mają być umieszczane pliki kopii zapasowych. Każda pojedyncza kopia zapasowa to plik w formacie .xml, o nazwie By means of the first parameter, the administrator indicates the directory in which backups are to be placed. Every single backup copy is an XML file named jcr-backup_[ data utworzenia kopiithe date of the creation of the copy].xml, np.for example, jcr-backup_2010.12.25.08.00.00.xml. Drugi parametr określa maksymalną liczbę kopii zapasowych. Zadanie okresowe wykonuje się cyklicznie, domyślnie co 24 godz., i stąd po utworzeniu przez nie maksymalnej ilości plików kopii, każdy kolejno utworzony nadpisuje najstarszy plik kopii z katalogu The second parameter determines the maximum number of backup copies. The periodic task is carried out periodically – by default, every 24 hours. Thus, when the maximum number of copy files has been created, each subsequent file overwrites the oldest file from the jcr.backup.dir directory.Możliwe wartości parametru The copies.amount can have the following values:
A change of parameters in periodic tasks requires a restart of the container (for example, Apache Tomcat), of the reader application.
Odzyskiwanie danych z kopii zapasowych JCR Aby odzyskać dane z utworzonego pliku .xml kopii zapasowej należy umieścić go w odpowiednim katalogu. Katalog ten jest konfigurowany w pliku
Restoring Data from JCR Backup Copies In order to recover data from a backup copy XML file, it should be placed in an appropriate directory. That directory is configured in the /WEB-INF/conf/jcr.properties Aplikacji Czytelnika pod parametremfile of the reader application, at parameter jcr.restore.dir. Kopia zapasowa jest automatycznie odzyskiwana podczas ponownego uruchomienia kontenera (np. Apache Tomcat) Aplikacji Czytelnika.Uwaga! Plik kopii zapasowej, po odzyskaniu z niego danych, jest automatycznie usuwany. A backup copy is automatically restored at a restart of the container (for example, Apache Tomcat) of the reader application. Caution! When the data from a backup copy file have been recovered, the file is automatically removed. Configuring ThumbnailsThe “context-param” parameter from the Konfiguracja miniaturZa konfigurację miniatur wyświetlanych w Aplikacji Czytelnika odpowiedzialny jest parametr (context-param) z pliku
Wartości parametru wstawia się między znacznikami The parameter values are entered between the <param-value></param-value>. Parametr składa sie z par tags. The parameter consists of id_miniatury:zestaw_parametrów_miniatury. Zestaw parametrów jest czteroczęściowy i poszczególne jego części oddzielone są od siebie znakiem ';'. Istnieje zatem możliwość zdefiniowania różnych profili miniatur np.: recomended, col_home_recommended, collection_description itd. Dzięki temu możemy sobie wybrać jakie wymiary ma mieć nasz obrazek w zależności od potrzeb. Schemat dostępu do miniatury przedstawia poniższy url pairs The parameter set consists of four parts which are separated with the semicolon (;) character, so various thumbnail profiles can be defined, for example: “recomended”, “col_home_recommended”, or “collection_description”, and we can choose a suitable size of the image. The URL below illustrates the schema of the access to a thumbnail:
gdzie:
W przedstawionym wyżej przykładzie zestaw parametrów dla miniatury example wynosi: 200, 200, 1.0, false oraz image/png. Każda część oznacza kolejno:
Pierwsze dwie wartości określają jakie wymiary będzie miał wyjściowy plik graficzny miniatury dla Aplikacji Czytelnika, bez względu na wymiary pierwotnego pliku graficznego - wprowadzonego w Aplikacji Redaktora. Jeśli więc przykładowo plik graficzny w Aplikacji Redaktora został wprowadzony w wymiarach szerokość = 500 pikseli i wysokość = 200 pikseli, to w Aplikacji Czytelnika będzie on odpowiednio przeskalowany do wymiarów skonfigurowanych w parametrze thumbnails.settings. Może to być przydatne w przypadku, gdy wprowadzane przez redaktorów pliki miniatur są dużej szczegółowości, niepotrzebnej przy wyświetlaniu w Aplikacji Czytelnika; zmniejszenie ich wymiarów zmniejsza zarazem ilość pamięci potrzebnej do ich przesyłu, co może dodatnio wpłynąć na szybkość transferu danych. Kolejny parametr jest powiązany z ostatnim i jest brany pod uwagę jedynie w przypadku, gdy miniatura ma ustawiony format wyjściowego pliku graficznego na 'image/jpeg'. Dzięki temu dodatkowo można zmniejszyć przesyłany plik stosując zalety kompresji stratnej formatu JPEG. Sensowną kompresje ustala się za pomocą liczby zmiennopozycyjnej w przedziale (0,1), Następny parametr określa sposób w jaki pierwotny obraz graficzny ma być dostosowany do wymiarów miniatury wprowadzonych w parametrze thumbnails.settings. Ustawienie flagi na 'true' spowoduje, że pierwotny plik graficzny zostanie proporcjonalnie zmniejszony i następnie obcięty do obszaru zdefiniowanego przez pierwsze dwa parametry. Ustawienie flagi na 'false' (domyślne) spowoduje, że pierwotny plik graficzny zostanie wpisany w obszar zdefiniowany przez parametry miniatury thumbnails.settings. Ostatni z parametrów określa typ wynikowego formatu graficznego miniatury. Wspierane są dwa najpopularniejsze formaty: JPEG oraz PNG. W przypadku wybrania formatu JPEG znaczenie ma również parametr stopnia kompresji (opisany wyżej). Poszczególne formaty identyfikowane są przez typy MIME, tj. dla PNG - 'image/png' oraz dla JPEG - 'image/jpeg'. Zmiana parametrów wyświetlanej miniatury wymaga restartu kontenera (np. Apache Tomcat) Aplikacji Czytelnika.
Konfiguracja komponentu "Polecane"Podstawowa konfiguracja komponentu "Polecane" znajduje się w pliku /WEB-INF/components.xml Aplikacji Czytelnika. Przykładowy wpis konfiguracyjny komponentu przedstawia się następująco:
Konfiguracja posiada dwa podstawowe parametry:
Pierwszy parametr w swoich domyślnych wartościach wstrzykuje wartość encji recommendedId, która jest deklarowana
Domyślnie wartością encji jest '3', która wskazuje na ID automatycznie utworzonej, przy instalacji, kolekcji.
Zarówno wartość przypisana encji jak i wartości parametrów mogą zostać zmienione, tak aby wskazywać na kolekcje wybrane przez administratora. Kolejny parametr RecommendedCount odpowiada za liczbę publikacji, które mają być wylosowane i prezentowane w komponencie. Jeśli komponent nie odnajdzie we wskazanej kolekcji odpowiedniej liczby publikacji z miniaturami, wyświetli te, które udało mu się odnaleźć. Dodanie komponentu na stronę Kolejnym krokiem konfiguracji komponentu jest dodanie go na wybraną stronę. Strony definiuje się w pliku konfiguracyjnym /WEB-INF/pages.xml Aplikacji Czytelnika. Aby dodać komponent na stronę główną, należy w dokumencie pages.xml znaleźć deklarację strony (znacznik <page>) o nazwie main.
Wprowadzanie zmian i konfiguracja zarówno w obszarze pliku components.xml jak i pages.xml nie wymaga zrestartowania kontenera Aplikacji Czytelnika. Konfiguracja funkcjonalności Self-Archiving (tylko dla dedykowanych wdrożeń z włączoną funkcją Self-Archiving)Niniejsza sekcja przedstawia konfigurację mechanizmu Self-Archiving w Aplikacji Czytelnika. pubcreator.properties Pierwszym plikiem konfiguracyjnym jest /WEB-INF/conf/pubcreator.properties, w którym zawarte są następujące parametry:
Parametry class.name oraz main.files.suggesters nie podlegają zmianom. Parametr max.file.size umożliwia administratorom wprowadzenie limitów na wielkość pliku treści tworzonych publikacji. Wielkość pliku podaje się w bajtach. Wartość 0 w tym wypadku oznacza brak limitu na wielkość. Istotnym parametrem jest upload.temp.dir, w którym administrator ustala ścieżkę do katalogu plików tymczasowych. W katalogu tym przechowywane są pliki z treścią publikacji do momentu przesłania ich do serwera. Po zakończeniu procesu tworzenia publikacji, pliki te są automatycznie usuwane z katalogu. Jeśli użytkownik w ramach swojej sesji nie dokończy procesu tworzenia publikacji, wówczas pliki tymczasowe, przesłane przez niego do Aplikacji Czytelnika, usunie zadanie okresowe. Ustawienie tego parametru jest istotne do prawidłowego działania mechanizmu Self-Archiving. Reszta parametrów, tj. main.files.suggesters.use, main.files.suggesters oraz default.main.files.lookup.filter.regexp(x) służy do konfiguracji opcji podpowiadania pliku głównego treści. W obecnej wersji dLibry opracowany został mechanizm podpowiadania działający w oparciu o nazwę plików. Parametry default.main.files.lookup.filter.regexp(x), gdzie x stanowią kolejne liczby ze zbioru N={0,1,...n}, określają wyrażenia regularne rozpoznające potencjalne pliki główne treści publikacji. Konfiguracja formularza atrybutów - pubc-metadata.xml Plik /WEB-INF/conf/pubc-metadata.xml służy do konfiguracji formularza atrybutów, który pojawia się w 2-gim kroku kreatora publikacji. W pliku tym określa się m.in. liczbę, rodzaj oraz kolejność wyświetlania atrybutów metadanych. W podstawowej formie plik przedstawia się następująco:
Głównym elementem struktury XML jest pubc-metadata, który zawiera elementy attribute reprezentujące pola w formularzu. Każdy element attribute posiada własny zestaw elementów oraz atrybutów. Atrybuty elementu attribute :
Elementy podrzędne elementu attribute:
Atrybut nazwy name elementu attribute musi być unikalny dla każdego zdefiniowanego pola. Administrator może go wykorzystać w korelacji z atrybutem alias ustawionym na 'true', domyślnie bowiem nazwa dla pola jest pobierana bezpośrednio od nazwy atrybutu metadanych dLibra, wskazanego elementem rdf-name (patrz wyżej), w tym wypadku można jednakże ustawić własną nazwę dla pola w plikach etykiet komponentu PublicationUploadComponent. Etykieta taka rozpoczyna się od prefiksu "PublicationUploadComponent" a kończy nazwą określoną w atrybucie name, np. "PublicationUploadComponent.title". Atrybut required określa czy wypełnienie pola jest wymagane do zaakceptowania tworzonej publikacji.
Pierwszym istotnym elementem podrzędnym elementu attribute jest rdf-name, który łączy wskazane pole formularza z atrybutem w schemacie metadanych biblioteki cyfrowej. Wszystkie wpisywane w pole wartości są kojarzone z konkretnym atrybutem metadanych poprzez nazwę RDF atrybutu. Przykładowymi nazwami RDF są: Title, Cretor, Abstract itp.
Element podrzędny position określa pozycję pola na liście pól formularza. Dwa dodatkowe podrzędne elementy, tj. multiple oraz input-type nie są wymagane. Pierwszy określa czy do danego pola można dodać wiele wartości (domyślnie 'true'), drugi określa jakiego typu jest pole formularza. Można wybrać spośród trzech typów: TEXT (standardowe pole tekstowe), TEXTAREA (duże pole tekstowe) oraz DATE (pole wyboru daty), które wpisuje się w atrybucie name elementu. Domyślnie dla każdego pola wybierany jest element typu TEXT. Przykładowo:
Jeśli zdefiniowane pole jest typu DATE wówczas można między znacznikami <input-type ...></input-type> umieścić podrzędne elementy:
Przykład konfiguracji pola daty:
Ostatnią kwestią wartą zaznaczenia jest obsługa kontrolowanych atrybutów metadanych. Pola, które w nazwie RDF odwołują się do atrybutów kontrolowanych prezentują się jako listy rozwijalne, w których użytkownik może wybrać jedną z proponowanych pozycji. Atrybuty ustawia się jako kontrolowane w Aplikacji Administratora. Więcej na ten temat można znaleźć tutaj.
Konfiguracja regulaminu Przed przystąpieniem do dodawania publikacji każdy użytkownik jest zobowiązany do zaakceptowania regulaminu, którego treść można zmienić na potrzeby własnej biblioteki cyfrowej. Treść regulaminu znajduje się na stronie pomocy regulations i może ona zostać zmieniona w panelu administracyjnym Aplikacji Czytelnika.
Wprowadzenie zmiany w pliku components.xml nie powinno wymagać restartu kontenera Aplikacji Czytelnika. Inne etapy konfiguracji Do prawidłowego działania funkcjonalności Self-Archiving potrzebne są jeszcze ustawienia w serwerze dLibra. Konfiguracja mechanizmu dodawania tagów publicznych (tylko dla dedykowanych wdrożeń z włączoną funkcją tagów publicznych)Istnieje możliwość konfigurowania podstawowych parametrów akcji dodawania tagów publicznych. Aby to zrobić należy otworzyć plik /WEB-INF/actions.xml konfiguracji akcji. W pliku tym można odnaleźć wpis:
W procesie moderacji tagów publicznych są one przetrzymywane pewien okres czasu, w którym moderator może ustawić ich stan na "zaakceptowany" bądź "niezaakceptowany". Tylko zaakceptowane tagi publiczne są dodawane do atrybutu "Tagi" wybranej publikacji. Parametr accept.all.tags ustala czy przesyłana propozycja tagu publicznego ma być automatycznie ustawiana na stan "zaakceptowany", który może zostać ewentualnie zmieniony przed moderatora. Standardowo parametr accept.all.tags ustawiony jest na false co oznacza, iż dodawane tagi publiczne są domyślnie w stanie "niezaakceptowane". Dwa kolejne parametry określają minimalną (min.tag.length) oraz maksymalną (max.tag.length) liczbę znaków przeznaczonych na tag publiczny. W przypadku, gdy tag nie spełnia wyznaczonego limitu, nie zostanie on dodany do propozycji słów kluczowych. Ustawienie któregokolwiek z tych parametrów na wartość 0 spowoduje, iż nie będzie on brany pod uwagę przy sprawdzaniu liczby znaków tagu. Konfiguracja wyświetlania zabezpieczonych plików PDFOmawiana konfiguracja umożliwia precyzyjniejsze określenie zabezpieczenia w wyświetlanym przez Aplikację Czytelnika dokumencie PDF.
Podstawowymi parametrami są owner.pass oraz user.pass, które określają kolejno: hasło właściciela dokumentu PDF oraz hasło użytkownika dokumentu PDF, które będzie zobowiązany wprowadzić, jeśli dokument można w jakiś sposób modyfikować.
Wszystkie wymienione w liście parametry przyjmują wartości typu boolean (true|false).
Zmiana parametrów wymaga restartu kontenera Aplikacji Czytelnika (tj. Apache Tomcat). Konfiguracja kolekcji głównej dla Aplikacji CzytelnikaOd wersji 5.0 administratorzy mają możliwość wskazania dowolnej kolekcji, spośród istniejących w bibliotece cyfrowej, która będzie spełniała rolę kolekcji głównej. Opcja ta idzie w parze z możliwością podłączenia wielu Aplikacji Czytelnika pod pojedynczy Serwer dLibra. Aby skonfigurować dla danej Aplikacji Czytelnika jej kolekcję główną wystarczy otworzyć do edycji plik /WEB-INF/web.xml, w którym znajduje się następujący wpis (domyślnie w komentarzu XML):
Wpis należy "odkomentować" zaś w miejsce [id of collection] należy wrzucić numeryczne ID kolekcji (unikalne ID ustawiane w bazie danych kolekcji). Po wszystkim należy zrestartować środowisko serwletów (np. Tomcat). Zmiany w formularzu "Kontakt"Aby zmienić domyślne wartości kontaktowe w formularzu należy otworzyć do edycji pliki WEBAPP_en.xml (dla języka angielskiego) oraz WEBAPP_pl.xml (dla języka polskiego), z katalogu /WEB-INF/components/resources. W plikach tych można znaleźć wpisy w postaci:
Łatwo zauważyć, iż poszczególne wartości dla elementów XML odpowiadają wartościom z formularza. Zmiany w tych plikach nie wymagają ponownego uruchomienia kontenera serwletów. Inną rzeczą, o której warto pamiętać w kontekście formularza kontaktu, jest adres mail, na który wysyłane są wpisane przez użytkownika wiadomości. Adres ten można skonfigurować w pliku /WEB-INF/actions.xml, zmieniając wartość dla deklarowanej akcji SendMailAction:
Między znacznikami value można umieścić dowolną liczbę adresów mail oddzielonych średnikami lub przecinkami. Ustawienia obsługi znaków wodnych (tylko dla dedykowanych wdrożeń z włączoną funkcją tagów publicznych)Znaki wodne wyświetlane są dla zabezpieczonych prezentacji JPG (specjalny typ publikacji w dLibrze, który tworzy się poprzez wskazanie jako plik główny katalogu zawierającego pliki JPG). Odbywa się to za pomocą specjalnego appletu Java. Znak wodny to obrazek, który jest nakładany na wyświetlaną treść prezentacji z efektem przezroczystości. Zalecamy wykorzystać grafikę w formacie PNG, który pozwala zapisać obraz z przezroczystym tłem. Obrazek ten jest zawsze powiększany tak, aby zajmował maksymalną powierzchnię. Nie jest jednak rozciągany do proporcji głównego obrazu, tylko wyśrodkowany. Można jednak uzyskać efekt znaku wodnego mniejszego niż główny obraz, poprzez dodanie przezroczystego obramowania o wybranej szerokości w grafice znaku wodnego. Oprócz obrazka, w znaku wodnym może być automatycznie wstawiona nazwa zalogowanego użytkownika. Konfiguracja znaków wodnych znajduje się w pliku WEB-INF/web.xml, w sekcji poświęconej servletowi watermarkServlet. Można tam zdefiniować następujące parametry:
Udostępnianie Mapy Strony robotom indeksującymMapa Strony(Sitemap) jest protokołem umożliwiającym robotom indeksującym łatwiejsze zgromadzenie informacji o najważniejszych stronach w Aplikacji Czytelnika. Aplikacja Czytelnika w ramach zadania okresowego SitemapGeneratingTask generuje bezwzględne adresy url do nich i zapisuje je według poniższych założeń:
Aby zmienić domyślne ustawienia generowania mapy strony należy wyedytować plik periodic.xml znajdujący się w katalogu /WEB-INF Aplikacji Czytelnika. Wpis dotyczący odpowiedniego zadania okresowego przedstawia się następująco:
W zadaniu można ustawić wartości następujących parametrów:
Obsługa publikacji linkującychPublikacje linkujące pozwalają na umieszczenie w bibliotece cyfrowej informacji o obiekcie, który jest udostępniany przez jakiś inny serwis internetowy. W domyślnej konfiguracji, gdy użytkownik chce zobaczyć treść takiej publikacji, najpierw zobaczy planszę z informacją o zewnętrznej treści oraz docelowym linkiem, który musi wywołać. Jeśli nie chcemy, aby ta plansza była wyświetlana, tylko żeby użytkownik od razu został przekierowany na docelowy adres, należy dodać poniższą konfigurację w
|
...