Page History

Każda z tych stron jest zdefiniowana w pliku Each of those pages is defined in the pages.xml poprzez sekcję file by section <page>...</page> np., for example:

<page name="main" layout="home_layout" inherits="base-page">
...
</page>

<page name="publication" layout="home_layout" inherits="base-page">
...
</page>

<page name="contact" layout="home_layout" secure="true" inherits="base-page">
...
</page>

Znaczniki page posiadają 3 wyróżniające się pola:

name - identyfikator strony np.: main, publication, contact,

layout - nazwa layoutu (układu strony), na którym osadzone będą wszystkie komponenty dla danej strony,

 inherits - identyfikator strony(może być abstrakcyjny), z której definiowana strona będzie pobierać komponenty oprócz komponentów własnych (np.: Strona kontaktu jest zdefiniowana w sekcji contact. Zawiera komponent ContactComponent, ale pole inherits ma wartość base-page dlatego strona kontaktu będzie zawierać również wszystkie komponenty jakie zostały zdefiniowane dla sekcji base-page ).

Page tags have three different fields:

name – the identifier of a page, for example: “main”, “publication”, or “contact”;

layout – the name of a layout (a graphic layout of a page) in which all components of a page will be set; and

 inherits – the identifier of a page (it can be abstract) from which the page which is being defined will take components (apart from its own components); for example: the “contact” page is defined in the “contact” section and contains the ContactComponent component, but the “inherits” field has the “base-page” value, so the contact page will also contain all the components defined for the “base-page” section;

Components – correspond to particular elements of a page; for example, the section with recently added objects on the home page is a separate component; components can be displayed in various places on a page; the components to be displayed on a page ought to be specified in the descriptor of the page, in the pages.xml file; the method of defining a component is presented below:The “component” tag is characterized with the use of the following attributesKomponenty - odpowiadają poszczególnym elementom strony np. sekcja z ostatnio dodanymi obiektami na stronie głównej to odrębny komponent. Komponenty mogą być wyświetlane w różnych miejscach w obrębie strony. To jakie komponenty są wyświetlane na stronie należy wyspecifikować w deskryptorze danej strony w pliku pages.xml. Sposób definiowania komponentu pokazano poniżej:

<component name="...">
	<place>...</place>
	<position>...</position>
</component>

Znacznik component charakteryzujemy poprzez następujące atrybuty:

name - pełna nazwa klasy komponentu;

place - nazwa umiejscowienia w layoucie;

position - pozycja, na której ma być umieszczony komponent w zadanym miejscu(place), musi mieć wartość unikalną, jeśli inny komponent umiejscowiono w tym samym miejscu.

The “component” tag is characterized with the use of the following attributes:

name – the full name of a component;

place – the name of the position of a component in a layout; and

position – the position in which the component should be put in a place; if there is another component in the same place, the position must have a unique value.

One example of a component is the component on the contact page. That page is defined in the page contact element. It uses the home_layout layout. It has a component which is defined in the following manner:

<components>
	<component name="pl.psnc.dlibra.web.comp.pages.components.ContactComponent">
		<place>main</place>
			<position>1</position>
	</component>
</components>

To oznacza, że zawartość komponentu ContactComponent umiejscowionego w pliku It means that the content of the ContactComponent component in the  /WEB-INF/components/templates/ContactComponent.vm jest renderowana w szablonie rozmieszczeń file is rendered in the /WEB-INF/layouts/templates/home_layout.vm w pętli distribution template, in a loop:

#foreach( $comp in $main)
	$!{comp.RenderedTemplate}
#end

Każdy komponent składa się z trzech elementów:

Every component consists of three elements:

• a Java class (for example, klasy Javowej (np. pl.psnc.dlibra.web.comp.pages.components.IndexSearchComponent),
• pliku szablonu(plik szablonu nazywa się tak samo jak klasa Javowa np. IndexSearchComponent.vm),
• .components.IndexSearchComponent),
• a template file, which is named the same as the Java class, for example, IndexSearchComponent.vm ; and
• files with various language versions, for example, plików z różnymi wersjami językowymi (np. IndexSearchComponent_xx.xml).

W wersji 6 wszystkie komponenty znajdują się w archiwum in version 6, all components are located in the dcore-webapp-components-6.x.x.jar (znajduję się on : archive, in the /WEB-INF/lib). Klasa Javowa znajduję sie w katalogu odpowiadającym jej nazwie pakietowej (w tym wypadku directory. The Java class is in the directory which corresponds to its package name (in this case, /pl/psnc/dlibra/web/comp/pages/components/) natomiast pozostałe pliki komponentu - w głównym katalogu tego archiwum., and the remaining files of the component – in the root directory of that archive.

The default files from the JAR archive Istnieje możliwość "przykrycia" domyślnych plików z archiwum JAR (dcore-webapp-components-6.x.x.jar) własnymi zmienionymi plikami. W tym celu najlepiej wypakować pliki szablonów, które mają być zmienione do odpowiedniego katalogu. W przypadku plików *.vm jest to katalog can be “covered” with the user’s own, changed files. For that purpose, it is best to unpack the template files which are to be changed, to an appropriate directory. In the case of  .vm files, it is the  /WEB-INF/components/templates, natomiast dla plików językowych directory, and in the case of *.xml jest to katalog language files, it is the /WEB-INF/components/resources.

Tak wypakowane pliki można zmieniać i zmiany w nich "nadpiszą" oryginalną zawartość plików pozostawionych w archiwum jar. Zmiany w plikach *.vm będą widoczne natychmiastowo po ich zapisaniu. Zmiany w plikach *.xml będą uwzględniane również natychmiastowo, pod warunkiem, że pliki te były już wypakowane przy starcie serwera Tomcat. W przeciwynym razie należy zrestartować Tomcat.

directory.

Files unpacked in that way can be changed, and the original content of the files left in the JAR archive will be overwritten with the new data. The changes in the *.vm files will be visible immediately after they have been saved. The changes in the *.xml files will also be taken into account immediately if they were already unpacked when the Tomcat server was being started up. Otherwise, the Tomcat server should be restarted.

Moreover, in some component templates, macros defined in the components_library.vm or layout_library.vm file are used. File componentsjibrary.vm  is in the Dodatkowo w niektórych szablonach komponentów używane są makra, zdefiniowane w pliku components_library.vm lub layout_library.vm. Plik components_library.vm znajduje się w archiwum dcore-web-components-6.x.x.jar. Własne makra oraz zmodyfikowane makra powinny zostać umieszczone adekwatnie w plikach archive. The user’s own macros and modified macros should be placed, appropriately, in files /WEB-INF/components/templates/custom_library.vmlub or /WEB-INF/layout/custom_templates/custom_layout_library.vm). Zmiany w tych plikach również powinny być uwzględniane zaraz po ich zapisaniu pod warunkiem, że edytowane przez nas makro było już dostępne przy starcie serwera Tomcat.

Opis plików konfiguracyjnych aplikacji czytelnika systemu dLibra 6.0

Poniżej znajduję się opis najważniejszych plików konfiguracyjnych aplikacji czytelnika systemu dLibra. Zmiany dokonywane w niektórych plikach wymagają restartu aplikacji czytelnika, pliki te zostały oznaczone (bezpośrednio po nazwie umieszczono (R)). Pliki nie ujęte w poniższym zestawieniu nie powinny być modyfikowane bez uprzedniej konsultacji z twórcami oprogramowania dLibra.

• actions.xml - W pliku tym znajdują się dodatkowe parametry konfiguracyjne dla akcji. Można tu określić między innymi:
  • adres email na jaki mają być wysyłane wiadomości wysyłane przez użytkowników z formularza kontatkowego oraz format tej wiadomośći (plain/text czy html),
  • konfiguracja zabezpieczeń mechanizmu proponowania słów kluczowych przez użytkowników (tylko dla wdrożeń, które mają dedykowane rozwiązania w tym zakresie) :
    • czy propozycje mają być domyślnie odrzucane czy akceptowane,
    • maksymalną i minimalną długość propozycji słów kluczowych,
    • maksymalną liczbę propozycji, które może wprowadzić użytkownik w ciągu zadanego czasu (domyślnie maksymalnie 5 propozycji w ciągu 30min).
  • maksymalną i minimalną długość loginu który wprowadzają użytkownicy w czasie rejestracji.
  • pola metadanych, po których użytkownik ma mieć możliwośc sortowania wyników wyszukiwania.

The changes in those files will also be takes into account immediately after they have been saved if the macro edited by the user was available when the Tomcat server was being started up.

A Description of the Configuration Files of the Reader Application of the 6.0 Version of the dLibra System

Below, there is a description of the most important configuration files for the reader application of the dLibra system. Changes made in some files require a restart of the reader application. Those files are marked with (R) directly after their names. Files not included in the breakdown below should not be modified without prior consultation with the creators of the dLibra system.

• actions.xml – that file contains additional configuration parameters for actions, including:
  • the addressee email address for messages sent by users through the contact form and the format of those messages (plain text or HTML);
  • the configuration of the protections of the mechanism which allows users to propose key words (only for implementations with dedicated solutions for that):
    • whether the proposals are to be rejected or accepted by default,
    • the maximum and minimum length of the proposals of key words, and
    • the maximum number of proposals which can be entered by a user in a given period of time (by default, the maximum is five proposals during 30 minutes);
  • the maximum and minimum length of the login entered by a user during registration; and
  • the metadata fields which the user will be able to use for sorting search results.
• components.xml – additional configuration parameters for particular components; in that file, the following elements should be changed:
  • the collection identifier and “Recommended”,
  • for the index component – the list of tokens which, as prefixes of value indexes, will not be taken into account during sorting;
  • the maximum length of the search query;
  • the possibility of displaying a form with the question about access to a protected publication;
  • the possibility of filtering by collections, group publications, and accessibility in the search results;
  • the names of the attributes which should not be searchable;
  • the number of elements displayed on the home page for the recommended, recently added, and most popular publications and news;
  • identifiers of collections which are not to be displayed in the collection structure and whether the collection structure is to be a complete tree;
  • the names of the attributes which are to be displayed in the index component;
  • the email address of the person responsible for the administration of the OAI repository; and
  • the basic attributes in the digital object information view; the possibility of identifier an OAI identifier;
  components.xml - Dodatkowe parametry konfiguracyjne dla poszczególnych komponentów. W tym pliku zmieniamy:
  • Identyfikator kolekcji oraz "Polecane".
  • Dla komponentu indeksów listę tokenów, które jako prefiksy wartości indeksów nie będą uwzględniane w sortowaniu.
  • Maksymalną długość zapytania wyszukiwawczego.
  • Możliwość wyświetlania formularza z zapytaniem o dostęp do publikacji chronionej.
  • Możliwość filtrowania po kolekcjach, publikacjach grupowych oraz dostępności w wynikach wyszukiwania.
  • Nazwy atrybutów, po których nie ma być możliwości przeszukiwania.
  • Liczbę elementów wyświetlanych na stronie głównej dla: polecanych, ostatnio dodanych i najpopularniejszych publikacji oraz wiadomości.
  • Identyfikatory kolekcji, których nie chcemy wyświetlać w strukturze kolekcji oraz to czy struktura kolekcji ma być pełnym drzewem.
    

  • Nazwy atrybutów, które chcemy wyświetlać w komponencie indeksów.

  • Adres email osoby odpowiedzialnej za administrację repozytorium OAI.

  • Podstawowe atrybuty w widoku informacji o obiekcie cyfrowym, możliwość wyświetlania identyfikatora OAI
• ignored_ips.txt i ignored_agents.txt (R) - Pliki te związane są zliczaniem statystyk odwiedzin. W pierwszym podajemy adresy IP, które nie mają być zliczane (np. komputery na których pracują redaktorzy). Każdy wpis jest traktowany jako wyrażenie regularne można więc podawać również całe zakresy adresów IP. W pliku znajduję się przykładowy wpis dla 127.0.0.1. Przed dodaniem nowego wyrażenia regularnego warto sprawdzić jego poprawność używając bezpłatnych narzędzi dostępnych online np. – those files are related to computing the visit statistics; in the first file, the IP addresses to be counted (for example, the computers on which editors work) should be entered; every entery is treated as a regular expression, so complete ranges of IP addresses can be entered; the file contains a sample entry for 127.0.0.1; before adding a new regular expression, it is worth checking if it is correct, with the use of free tools available online, for example, http://regexpal.com/.

Na podobnej zasadzie działa plik The ignored_agents.txt , należy umieścić tutaj wyrażenia regularne dla wartości pola user-agents. Pole to jest częścią nagłówka żądania HTTP, jest to łańcuch znaków identyfikujący program za pomocą którego przeglądana jest strona np. przeglądarka internetowa, robot wyszukiwarki. Jeżeli wartość łańcucha zostanie dopasowane do podanego wzorca to identyfikujące się za niego pomocą programy nie bedą zliczane do statystyk odwiedzin i wyświetleń treści publikacji. W pliku znajduję się przykład dla googlebot'a. Listę identyfikatorów user agents można znaleźć w sieci.functions in a similar manner: regular expressions for the “user-agents” field should be placed here. The field is a part of the heading of a HTTP request. It is a sequence of characters which identify the program used for browsing a page (for example, an Internet browser or a browser bot). If the value of the sequence is adapted to the given model, the programs identifying with the use of that sequence will not be counted for the statistics of visits and impressions of publication content. The file contains a sample entry for Googlebot. The list of “user agents” identifiers can be found online.

• pages.xml – that file contains the definition of the pages displayed by the reader application of the dLibra system; it must be modified when:
  
  • the order of the components displayed on a given page is changed;
  • a new component is being added to a page; or

  • a new page is being created in the reader application; the issues related to modifying that file are discussed in detail in the “Adjusting the Look of the Reader Application” and the “Frequently Asked Questions” chapters;

  pages.xml - Plik zawiera defnicję stron wyświetlanych przez aplikację czytelnika systemu dLibra. Modyfikacja tego pliku jest konieczna w przypadku:
  • zmiany kolejności komponentów wyświetlanych na danej stronie,
  • dodawania nowego komponentu do konkretnej strony,
  • tworzenia nowej strony w ramach aplikacji czytelnika.
    Zagadnienia związane z wykonywaniem zmian w tym pliku zostaną szczegółowo omowione w rozdziałach : "Dostosowywanie wyglądu aplikacji Czytelnika" oraz
    "Najczęściej zadawane pytania".

• pages_titles.xml (R) - W pliku tym określamy tytuły i pod tytuły poszczególnych stron. – in that file, the titles and subtitles of particular pages are determined;
• templates.properties (R) - Zawiera parametry konfiguracyjne dostępne z poziomu wszystkich szablonów. – contains the configuration parameters available from the level of all templates;
• periodic.xml (R) - Plik ten zawiera definicje zadań okresowych wykonywanych przez aplikacje czytelnika. Konfigurujemy w nim:
  • czas wykonywania kopii zapasowej JCR, ścieżkę w której ma być przechowywana kopia zapasowa JCR oraz liczbę przechowywanych uprzednio stworzonych kopii,
  • mechanizmu importu wiadomości z zewnętrznego kanału RSS,
  • czas generowania i zapisu a także generowania widoków prezentacyjnych statystyk, identyfikatory atrybutów na podstawie których generowane są statystyki wartości atrybutów
    
  • czas wysyłania biuletynów z ostatnio dodanymi publikacjami,
  • położenie katalogu do którego zapisywane są informacje o zapytaniach wyszukiwawczych wydawanych przez użytkowników aplikacji czytelnika,
  • czas i mechanizm tworzenia mapy strony.
  – that file contains definitions of periodic tasks performed by the reader application; the following elements are configured in it:
  
  • the time of creating a backup of JCR, the path in which the backup is to be stored, and the number of stored previously created backups;
  • the mechanism of importing news from an external RSS;
  • the time of generating and saving, and of generating statistics presentation views; identifiers of the attributes on the basis of which attribute value statistics are created;
    
  • the time of sending newsletters with recently added publications;
  • the location of the directory in which information about reader application users’ search queries are saved; and
  • the time and mechanism of creating the site map.;

• files pliki dlibra-webapp\WEB-INF\components\resources\WEBAPP_xx.xml - Gdzie xx oznacza wersję jezykową (np. pl) w pliku tym znajdują sie najczęściej modyfikowane etykiety tekstowe dla każdej z zainstalowanych wersji językowych.xml – where xx means the language version (for example, .pl); that file contains the most frequently modified text labels for every installed language version;
• dlibra-webapp\WEB-INF\components\templates\custom_library.vm - Zawiera dodatkowe makra języka VTL stworzone przez administratorów danej biblioteki dla komponentów. Informacje o tworzeniu makr jęzka VTL można znaleźć na stronach projektu Velocity.vm – contains additional VTL language macros for components, created by the administrators of the given library; information about creating VTL language macros can be found on the web pages of the Velocity project;
• dlibra-webapp\WEB-INF\layout\custom_templates\custom_layout_library.vm - Zawiera dodatkowe makra języka VTL stworzone przez administratorów danej biblioteki dla szablonów rozmieszczeń. Informacje o tworzeniu makr jęzka VTL można znaleźć na stronach projektu Velocity.vmvm – contains additional VTL language macros for distribution templates, created by the administrators of the given library; information about creating VTL language macros can be found on the web pages of the Velocity project;
• files Pliki dlibra-webapp\WEB-INF\layout\resources\layout_xx.xml - Gdzie xx oznacza wersję jezykową (np. pl) w pliku tym znajdują się etykiety
  tekstowe używane w szablonach rozmieszczeń. – where xx means the language version (for example, .pl); that file contains text labels ued in distribution templates;

• Katalog dlibra-webapp\WEB-INF\formats - zawiera konfiguracje wszystkich rozszerzeń związanych z prezentacją treści publikacji. Szczegółowy jej opis znajduję się w rozdziale "Konfiguracja prezentacja treści w aplikacji czytelnika".

• directory – contains the configurations of all extensions related to presenting publication content; for more information, see section 03. The Extensions of the Reader Application.

The Configuration Files in the dlibra-webapp/WEB-INF/conf

Directory

The reader application uses its local database which is completely unrelated to the database used by the dLibra server. The configuration of that base consists of, apart from the two files discussed below, jcr-init.properties

and jcr-repository.xml

files. However, they should never be modified.

• jcr-init-desc.xml (R) - specyfikacja podstawowej zawartości (wartości domyślne), która jest umieszczna w bazie danych podczas pierwszego startu aplikacji czytelnikadesc.xml (R) – the specification of the basic content (default values) put in the database during the first start-up of the reader application.
• jcr.properties (R) - konfiguracja podstawowych parametrów dostępowych do bazy danych aplikacji czytelnika. W przypadku gdy katalog roboczy aplikacji czytelnika zostanie przeniesiony należy uaktualnić ścieżkę do bazy danych, która znajduję się w tym pliku– configuration of the basic access parameters for the database of the reader application. The working directory of the reader application contains a path to the database; that path should be updated when the directory is moved.
• services.properties (R) - parametry połączeniowe do serwera dLibry. W przypadku gdy serwer dLibry zostanie przeniesiony na inną maszynę należy uaktualnić znajdujący się w tym pliki adres serwer– the parameters for connecting to the dLibra server. The dLibra server contains the server address; that address should be updated when the server is moved to another machine.
• smtp.properties (R) - parametry dostępowe do serwera SMTP. Parametry te wykorzystywane są przez aplikacje czytelnika do wysyłania wiadomości email– access parameters for the SMTP server. Those parameters are used by the reader application for sending emails.
• cache.properties (R) - zawiera ustawienia pamięci podręcznej (cache) aplikacji czytelnika. Użycie cache znacznie przyspiesza działanie aplikacji czytelnika wykorzystanie pamięci podręcznej jest niezbędne w przypadku bibliotek posiadającej powyżej 1000 publikacji.
• exlibris.xml - treść tego pliku zawiera konfigurację mechanizmu exlibris. Więcej na temat konfiguracji exlibris
  można dowiedzieć się w sekcji konfiguracji Aplikacji Czytelnika.
• pubcreator.properties - plik podstawowych parametrów konfiguracji mechanizmu Self-Archiving. Więcej na temat konfiguracji Self-Archiving można znaleźć w sekcji konfiguracji Aplikacji Czytelnika. Dotyczy dedykowanych wdrożeń z włączoną funkcją Self-Archiving.
• pubc-metadata.xml - zawiera konfigurację formularza atrybutów dla funkcjonalności Self-Archiving. Więcej na ten temat można znaleźć w sekcji konfiguracji Aplikacji Czytelnika. Dotyczy dedykowanych wdrożeń z włączoną funkcją Self-Archiving.

Opis struktury pod dlibra-webapp\style

W katalogu dlibra-webapp\style znajduję się większość grafik i arkuszy stylów css używanych w aplikacji czytelnika.

Dodatkowe elementy

• – contains the cache settings of the reader application. When cache is used, the functioning of the reader application is significantly accelerated. Cache must be used in the case of libraries containing more than 1000 publications.
• exlibris.xml – the content of that file contains the configuration of the bookplate mechanism. The bookplate configuration is discussed in detail in the “Configuring the Reader Application” section.
• pubcreator.properties – that file contains the basic parameters of the self-archiving mechanism. The self-archiving configuration is discussed in detail in the “Configuring the Reader Application” section. It applies to dedicated implementations with the “self-archiving” function switched on.
• pubc-metadata.xml – contains the configuration of the attribute form for the “self-archiving” functionality. That topic is discussed in detail in the “Configuring the Reader Application” section. It applies to dedicated implementations with the “self-archiving” function switched on.

A Description of the Structures at dlibra-webapp\style

Most graphics files and CSSs used in the reader application are in the dlibra-webapp\style directory.

Additional Elements

Apart from standard references to pages defined in the reader application, there are also resources available from the main level:

• http://demo.dl.psnc.pl/Content - odpowiedzialny za dostęp do treści publikacji. – responsible for access to publication content;
  • calling
  • Wywołanie /Content/2952/ powoduje przejście do treści głównego pliku wydania o identyfikatorze 2952.will cause a transition to the content of the main file of the edition with the 2952 identifier;
  • calling Wywołanie /Content/2952/directory.djvu powoduje pobranie pliku directory.djvu z wydania o identyfikatorze 2952.will cause a download of the.djvu file from the edtition with the 2952 number;
• http://demo.dl.psnc.pl/zipContent - odpowiedzialny za dostęp do treści publikacji w postaci
  archiwów ZIP. Wywołanie – responsible for access to publication content in the form of ZIP archives; calling /zipContent/2952/ powoduje pobranie treści całego wydanie o identyfikatorze 2952 jako pliku zip.will cause a download of the content of the whole edition with the 2952 number, as a ZIP file;

• http://demo.dl.psnc.pl/image - odpowiedzialny za dostęp do miniaturek wydań.Wywołanie – responsible for access to edition thumbnails; calling /image?id=2940 powoduje pobraniu miniaturki wydania o identyfikatorze 2940.will cause a download of the thumbnail of the edition with the 2940 number;
• http://demo.dl.psnc.pl/ka - odpowiedzialny za szyfrowanie publikacji zabezpieczonych, – responsible for encrypting protected publications;
• http://demo.dl.psnc.pl/dlibra/dlibra-app.jnlp - wpisując ten adres do przeglądarki uruchamiamy Aplikację Redaktora/Admnistratora. – entering that address to a browser will start up the Editor and Administrator Application;
• http://demo.dl.psnc.pl/dlibra/publication/81/content - odnośnik do treści publikacji o identyfikatorze 81, jeżeli publikacja posiada więcej niż jedno wydanie wyświetlona zostanie lista wydań danej publikacji. W przypadku publikacji grupowej wyświetlona zostanie struktura publikacji grupowej.psnc.pl/dlibra/publication/81/content – a reference to the content of the publication with the 81 identifier; if the publication has more than one edition, a list of the editions of that publication will be displayed; in the case of a group publication, the structure of the group publication will be displayed;
• http://demo.dl.psnc.pl/dlibra/publication/81/ - odnośnik do opisu publikacji o identyfikatorze 81, jeżeli publikacja posiada więcej niż jedno wydanie wyświetlona zostanie lista wydań danej publikacji. – a reference to the description of the publication with the 81 identifier; if the publication has more than one edition, a list of the editions of that publication will be displayed;