...
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 ImportAplikacja czytelnika pozwala na publikowanie na stronie głównej różnego rodzaju wiadomości. Wiadomości te można dodawać za pośrednictwem panelu administracyjnego aplikacji czytelnika bądź wykorzystując mechanizm importu wiadomości z kanału RSS. Poniżej omówiona został sposób w jaki import taki można przeprowadzić.The 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”. Exlibrisy w aplikacji czytelnika systemu dLibra reprezentowane są jako obrazki z odnośnikiem do wybranej strony (biblioteki, instytucji itp.), które pojawiają się na stronie opisu publikacji (publication, docmetadata). Exlibrisy są dodawane wg wartości konkretnych atrybutów umieszczonych w metadanych. Np. exlibris może zostać wyświetlony w zależności od wartości atrybutu Prawa - dla wartości "Instytucja Biblioteczna X" będzie wyświetlony obrazek identyfikujący daną instytucję oraz odnośnik do strony głównej tej instytucji "www.instytucjabibliotecznax.com". Procedura dołączania exlibrisu wygląda następująco: A bookplate is added in the following manner:
Każdy z elementów: attribute, attribute-value i exlibris może być definiowany wielokrotnie, co pozwala na dodanie wielu exlibrisów w ramach każdej określonej wartości atrybutu metadanych.
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 examplePrzykładowo:
W przypadku takiej konfiguracji, dla atrybutu Praw, exlibris Biblioteki Uniwersyteckiej w Poznaniu pojawi się zarówno, gdy w atrybucie podana będzie wartość "Biblioteka Uniwersytecka w Poznaniu" jak i "BUP". Dodatkowo jeśli w tym samym atrybucie Praw pojawi się wartość "Uniwersytet im. 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 Poznańska", wówczas wyświetlą się dwa exlibrisy (dwa obrazki z odnośnikami) odpowiednio dla UAM i PP. Konfiguracja exlibris.xml zacznie działać dopiero po restarcie środowiska serwletów aplikacji czytelnika (Apache Tomcat). Nieprawidłowe ustawienia mogą w efekcie prowadzić do wyświetlania wyjątków i błędów w logach systemu. Konfiguracja systemu kopii zapasowych JCRAby zmienić domyślne ustawienia systemu tworzenia kopii zapasowych JCR 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ącoPoznanska” 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, for example, np.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:
where:
In the example presented above, the parameter set for the example thumbnail is: 200, 200,1.0, false oraz, and image/png. Każda część oznacza kolejno:The subsequent parts mean:
The first two values determine the dimensions of the output graphics file of the thumbnail for the reader application regardless of the dimensions of the input graphics file entered in the Editor Application. Thus, if the graphics file in the Editor Application has been entered in dimensions: width = 500 pixels, height = 200 pixels, then the image will be appropriately scaled in the reader application, to the dimensions configured in the “thumbnails.settings” parameter. That can be useful when the thumbnail files entered by editors are very detailed, and that degree of detail is not necessary when they are displayed in the reader application; moreover,when the dimensions are decreased, the memory volume needed for sending them is lowered, which may accelerate the speed of the data transfer. The next parameter is related to the last one, and it is only taken into account when the thumbnail has the “image/jpeg” format of the output graphics file. It makes it possible to further decrease the sent file, thanks to the lossy compression of the JPEG format. The optimal compression is set with the use of a floating-point number, in the (0,1) range, for example,
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'. . The next parameter determines the way in which the input image is to be adjusted to the dimensions of the thumbnail entered in the “thumbnails.settings” parameter. When the flag is set to “true”, the original graphics file will be decreased proportionally and cropped to the area defined by the first two parameters. When the flag is set to “false”, the original graphics file will be adjusted to fit in the area defined by the “thumbnails.settings” thumbnail parameters. The last parameter determines the type of the output graphics file format of the thumbnail. The two most popular formats, JPEG and PNG, are supported. When the JPEG format is chosen, the parameter of the degree of compression (described above) is also significant. The formats are identified by MIME types. For PNG, it is “imagne/png” and for JPEG – “image/jpeg”. A change of thumbnail display parameters requires a restart of the container (for example, Apache Tomcat), of the reader applicationZmiana parametrów wyświetlanej miniatury wymaga restartu kontenera (np. Apache Tomcat) Aplikacji Czytelnika.
Konfiguracja komponentu "Polecane"
Configuring the “Recommended” ComponentThe basic configuration of the “Recommended” component is in the Podstawowa konfiguracja komponentu "Polecane" znajduje się w pliku /WEB-INF/components.xml Aplikacji Czytelnika.Przykładowy wpis konfiguracyjny komponentu przedstawia się następująco file of the reader application. Here is a sample configuration entry of the component:
The configuration has two basic parameters:
When it has its default values, the first parameter puts in the value of the recommendedld entity which is declared at the beginning of the document, in linePierwszy 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 konfiguracyjnymThe default value of the entity is “3”, and it points to the ID of the collection which is automatically created during installation. From that collection, the publications which are to be displayed in the component are randomly selected, and only those of the randomly selected publications are displayed to which a thumbnail is assigned. When the collection does not contain any publications which fulfill the abovementioned conditions, the component will not be displayed.
Both the value assigned to the entity and the parameter values can be changed so as to indicate collections chosen by the administrator. The next parameter, RecommendedCount, is responsible for the number of publications to be selected randomly and presented in the component. If the component does not find an appropriate number of publications with thumbnails in the collection, it will display those it has been able to find. Adding a Component to a Page The next step of the configuration of the component is adding it to a selected page. Pages are defined in the /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.W deklaracji tej, między znacznikami <components></components> należy umieścić wpis (domyślnie powinien on już być obecny w komentarzu w pliku configuration file of the reader application. In order to add the component to the home page, the user should find the declaration of the page (the <page> tag) named “main” in the pages.xml document. The following entry should be made in that declaration, between the <components></components> tags (the entry should be already in the file by default):
Wprowadzanie zmian i konfiguracja zarówno w obszarze pliku The configuration and changes in the components.xml jak i and pages.xml nie wymaga zrestartowania kontenera Aplikacji Czytelnika. Konfiguracja funkcjonalnościfiles do not require a restart of the container of the reader application. Configuring the Self-Archiving(tylko dla dedykowanych wdrożeń z włączoną funkcjąFunctionality (Only for Dedicated Implementations with the Self-Archiving)Function Switched On)This section is about the configuration of the self-archiving mechanism, pubcreator.properties, in the reader application. Niniejsza sekcja przedstawia konfigurację mechanizmu Self-Archiving w Aplikacji Czytelnika. pubcreator.properties Pierwszym plikiem konfiguracyjnym jestThe first configuration file is /WEB-INF/conf/pubcreator.properties , w którym zawarte są następujące parametry; it contains the following parameters:
The class.name orazand main.files.suggesters nie podlegają zmianomparameters are not subject to changes. ParametrThe 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 jestparameter allows administrators to introduce limits of the size of the content files of created publications. The file size is given in bytes. In this case, value “0” means that the size is not limited. One important parameter is 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.. In that parameter, the administrator determines the path to the temporary file directory. Publication content files are also stored in that directory until they are sent to the server. When the process of creating a publication has finished, the files are automatically removed from the directory. If a user does not complete the process of creating a publication in his or her session, the temporary files sent by that user to the reader application will be removed by the appropriate periodic task. The setting of that parameter is important for the correct functioning of the self-archiving mechanism. Reszta parametrów, tj.The remaining parameters, that is, main.files.suggesters.use, main.files.suggesters oraz, and 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. Parametryare for configuring the suggestion options of the main content file. In the current version of the dLibra system, there is a suggestion mechanism based on file names. default.main.files.lookup.filter.regexp(x), parameters, gdzie x stanowią kolejne liczby ze zbioruwhere x are the subsequent numbers from set N={0,1,...n}, określają wyrażenia regularne rozpoznające potencjalne pliki główne treści publikacji.determine the regular expressions which recognize the potential main content files of a publication. Configuring the Attribute Form – Konfiguracja formularza atrybutów -pubc-metadata.xml PlikFile /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ącois for configuring the attribute form which appears in the second step of the publication creator. That file determines, among other things, the number, type, and order of metadata attributes. The basic form of the file looks as follows:
The main element of the XML structure is pubc-metadata , który zawiera elementy attribute reprezentujące pola w formularzu.which contains attribute elements which represent fields in the form. Every attribute element has its own set of elements and attributes. The attribute elements are:
The subordinate elements of the attribute element are:
The “name” attribute of the “attribute” element must be unique for every defined field. The administrator can use that attribute in correlation with the “alias” attribute set to the “true” value because by default the name of a field is taken directly from the name of the dLibra metadata attribute indicated with the “rdf-name” element (see above); in this case, however, the user can set his or her own name for the filed in the label files of the “Pub licationUploadComponent” file. Such a label begins with the “PublicationUploadComponent” prefix and ends with the name determined in the attribute, for example, “PublicationUploadComponent.title”. For more information about labels, see here. The “required” attribute determines whether the field must be filled in in order for the publication to be accepted. When the user does not enter any value in that field, an appropriate message will be displayed in the creator. The “pname” attribute determines whether the data taken from the field will play the role of the name of the publication; a field marked in this way with the attribute should be a required field. If there is no field with the “pname” attribute set to the “true” value, the name of the created publication will be taken from the first required field.
The first important subordinate element of the “attribute” element is “rdf-name”. It combines the indicated field of the form with an attribute in the metadata schema of the digital library. All values entered in the field are associated with a specific metadata attribute through the RDF name of the attribute. Sample RDF names are: “Title”, “Creator”, “Abstract”.
The “position” subordinate element determines the position of the field on the list of form fields. The two additional subordinate elements, “multiple” and “input-type”, are not required. The first one determines if many values can be added to the field (the default value of that element is “true”), and the second one determines the type of the field. There are three types to choose from: TEXT (standard text field), TEXTAREA (big text field), and DATE (date checkbox); they are entered in the “name” attribute of the element. By default, the TEXT type is selected for every field. For example 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:
If a DATE-type field is defined, the following subordinate elements can be placed between the <input-type ...></input-type> umieścić podrzędne elementytags:
Here is a sample configuration of the date fieldPrzykł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 The last issue worth noting is the management of controlled metadata attributes. The fields which refer to controlled attributes in the RDF name are presented as expandable lists from which the user can choose one of the proposed items. Attributes are set as controlled in the Administrator Application. For more information about that subject, see here
Configuring the Rules Before adding a publication, every user must accept the Rules, the content of which can be adjusted to the needs of the digital library. The content of the “Rules” is located on the “regulations” help page and can be changed in the administration panel of the reader application. The Rules can also be completely disabled in the publication creator, by adding an entry concerning the “PublicationUploadComponent” in the “components.xml” file.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)A change of the “components.xml” does not require a restart of the container of the reader application. Other Configuration Stages In order for the self-archiving functionality to operate correctly, there must be appropriate settings in the dLibra server. The configuration of the self-archiving functionality can be checked here. Configuring the Mechanism of Adding Public Tags (Only for Dedicated Implementations with the Public Tag Function Switched On)The basic parameters of the action of adding public tags are configurable. To configure them, the user should open the action configuration file, 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. It contains the following entry:
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.Aby rozpocząć modyfikację parametrów zabezpieczania plików PDF należy wyświetlić do edycji plik settings.xml z katalogu In the public tag moderation process, they are kept for a period of time in which the moderator can set their status to the “accepted” or “unaccepted” value. Only accepted public tags are added to the “Tag” attribute of the selected publication. The “accept.all.tags” parameter determines whether the sent proposal of a public tag is to be automatically set as “accepted”, which status can be changed by the moderator. By default, the “accept.all.tags” parameter has the “false” value, which means that the added public tags are “unaccepted” by default. The two following parameters determine the minimum (“min.tag.length”) and maximum (“max.tag.length”) number of characters for a public tag. If a tag is not within the limit, it is not added to the proposal of key words. Setting the value of any of those parameters to “0” will cause the parameter to not be taken into account when checking the number of tag characters.Configuration of the Display of Protected PDF FilesThe described configuration allows the user to determine the protection in the PDF document displayed by the reader application with greater precision. In order to begin modifying the parameters for protecting PDF files, the user should display the “settings.xml” file from the /WEB-INF/formats/pdf for edition. Plik ten powinien zawierać wpisyThe file should contain the following entries:
Podstawowymi parametrami są The basic parameters are “owner.pass oraz ” and “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ć. As regards the remaining parameters, there are (with the omission of the general parameters of the configuration of the display mechanism):
Wszystkie wymienione w liście parametry przyjmują wartości typu boolean (true|false).
All the parameters from the list have boolean-type values (“true” or “false”)
A change of those parameters requires a restart of the container (Zmiana parametrów wymaga restartu kontenera Aplikacji Czytelnika (tj. Apache Tomcat) . Konfiguracja kolekcji głównej dla Aplikacji Czytelnikaof the reader application. Configuring the Main Collection for the Reader ApplicationSince version 5.0 of the dLibra system, administrators can indicating any collection from the collections in the digital library to be the main collection, and they can connect many reader applications to one dLibra server. In order to configure the main collection for a reader application, the /WEB-iNF/web.xmi file must be opened for edition. It contains the following entry (by default, in the XML commentOd 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 The entry should be “uncommented”, and the “[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” should be replaced with the numerical ID of the collection (the unique ID set in the collection database). In the end, the servlet environment (for example, Tomcat) should be restarted. Changes in the “Contact” FormIn order to change the default contact values in the form, the user should open the “WEBAPP_en.xml” (for English) and “WEBAPP_ pl.xml” (for Polish) from the “/WEB-INF/components/ resources. W plikach tych można znaleźć wpisy w postaciresources” directory for edition. The files may contain the following entries:
Ł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. Particular values for the XML elements correspond to the values from the form. The changes in those files do not require a restart of the servlet container. As regards the contact form, one should also remember about the email address to which the messages entered by the user are sent. That address can be configured in the “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:xml” file, by changing the value for the declared “SendMailActiorr” action.
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 plikuAny number of semicolon- or comma-separated email addresses can be placed between the “value” tags. The Settings of the Management of Watermarks (Only for Dedicated Implementations with the Public Tag Function Switched On)Watermarks are displayed for protected JPG presentations (a special publication tag in the dLibra system, which is created by indicating the directory with JPG files as the main file). It is done with the use of a special Java applet. A watermark is an image which is put over the content of a presentation, with the effect of opacity. We recommend the use of a graphics file in the PNG format which makes it possible to save an image with a transparent background. Such an image is also enlarged to take as much space as possible. However, it is centered and not spread to the proportions of the main image. One can also obtain the effect of a watermark smaller than the main image, by adding a transparent border of selected width in the watermark graphic. Apart from an image, the name of the logged in user can also be automatically put in a watermark. Watermark configuration is located in the “WEB-INF/web.xml , w sekcji poświęconej servletowi watermarkServlet. Można tam zdefiniować następujące parametry:file”, in the section about the “watermarkServlet” servlet. The following parameters can be defined there:
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ń:
Making the Site Map Available to Indexing BotsThe site map is a protocol which makes it easier for indexing bots to collect information about the most important pages in the reader application. Within the framework of the “SitemapGeneratingTask” periodic task, the reader application generates absolute URLs to those pages and saves them in accordance with the following assumptions:
In order to change the default page map generation 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:
W zadaniu można ustawić wartości następujących parametrów: In the task, you can set the values of the following parameters:
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
Managing Linking PublicationsLinking publications make it possible to enter, in a digital library, the information about an object which is made available by another website. In the default configuration, when the user wants to see the content of such a publication, the user will first see a notice the information about the external content and the target link which has to be called. If we want the user to be redirected to the target address without having the notice displayed, we should add the configuration presented below to the “
|
...