Page History

...

The configuration of particular extensions is presented here.

The fileParser Extension

The fileParser Extension finds files related to a particular file. After the main file has been selected in the Editor and Administrator Application (for example, in the publication creator), the system automatically checks which files are related to that file – by default, with the use of fileParser extensions. By default, HTML and DjVu extensions are installed in the application. If no extension is defined for the selected file, the editor must decide what kind of files will be the content of the publication.

...

• Polish – for making all user interface words/phrases available in Polish (dlibra-app-extension-il-pl), and
• English – for making all user interface words/phrases available in English (dlibra-app-extension-il-en).

...

The graphicProvider Extension

Rozszerzenie to pozwala na zmianę wyglądu elementów graficznych w aplikacji redaktora i administratora. Poprzez dodanie rozszerzenia tego typu można poprawić ikonki i obrazki widoczne w aplikacji tak, by lepiej pasowały do kontekstu (kulturowego lub technicznego), w którym będzie wykorzystywany system dLibra. Zalecane jest, aby w aplikacji zainstalowana była co najwyżej jedna wtyczka tego typu, ponieważ nie jest dostępny mechanizm wyboru kontekstu graficznego, analogiczny do wyboru języków.

That extension makes it possible to change the look of graphic elements in the Editor and Administrator Application. When an extension of that type is added, the look of icons and images in the application can be changed so that they match the (cultural or technical) context better. It is recommended that only one plugin of that type be installed the application because the application does not have a mechanism for selecting a graphic context (in analogy to the language selection).

By default, the application is offered with a pre-installed plugin which ensures the default look W aplikacji domyślnie zainstalowana jest wtyczka zapewniająca domyślny wygląd (dlibra-app-extension-gp).

...

The sourceLocator Extension

Rozszerzenie to pozwala na lokalizację plików z metadanymi, które później będą importowane. Korzystając z tego rozszerzenia możliwe jest wprowadzenie nowej funkcji lokalizacji pliku metadanych.

That extension makes it possible to locate files with metadata for later import. It allows the introduction of a new function for locating metadata files.

The extension has one parameter, class, which specifies the name of the class which implements the programming interface of the extension. The programming interface (Java language) for that extension is Rozszerzenie to przyjmuje jeden parametr class, który specyfikuje nazwę klasy implementującej interfejs programistyczny rozszerzenia. Interfejs programistyczny (język Java) dla tego rozszerzenia to pl.psnc.dlibra.app.extension.sourcelocator.SourceLocator. Szczegółowe informacje związane z tym interfejsem znajdują się w komentarzach metod i samego interfejsu SourceLocator. For more information about that interface, see the comments on the methods and the interface (JavaDocs).

Lista domyślnie zainstalowanych rozszerzeń tego typu jest następującaThe following extensions of that type are installed by default:

• Z39.50 - pozwala na lokalizowanie plików metadanych przy użyciu serwerów – makes it possible to locate metadata files with the use of Z39.50 servers (dlibra-app-extension-sl-z3950).

Opis konfiguracji poszczególnych rozszerzeń można znaleźć tutaj.

Rozszerzenie dictionaryManager

Rozszerzenie to pozwala na importowanie i eksportowanie grup wartości atrybutów z i do zewnętrznych plików.

The configuration of particular extensions is presented here.

The dictionaryManager Extension

That extension makes it possible to import and export attribute value groups from and to internal files.

The extension has one parameter, class, which specifies the name of the class which implements the programming interface of the extension. The programming interface (Java language) for that extension is Rozszerzenie to przyjmuje jeden parametr class, który specyfikuje nazwę klasy implementującej interfejs programistyczny rozszerzenia. Interfejs programistyczny (język Java) dla tego rozszerzenia to pl.psnc.dlibra.app.extension.dictionarymanager.DictionaryManager. Szczegółowe informacje związane z tym interfejsem znajdują się w komentarzach metod i samego interfejsu For more information about that interface, see the comments on the methods and the interface (JavaDocs).

Lista domyślnie zainstalowanych rozszerzeń tego typu jest następująca:

The following extensions of that type are installed by default:

• import of value groups from files in the MARC format – it makes it possible to read files in the MARC-21 format Import grup wartości z plików MARC - pozwala na odczyt plików w formacie MARC-21 (dlibra-app-extension-dl-marc). Zapis do plików nie jest wspierany.; saving to files is not supported; and
• import/export of value groups from/to files in the XML format – it makes it possible to save and read files in the XML format. It can be used for copying attribute values between libraries Import/export grup wartości z/do plików XML - pozwala na zapis i odczyt plików w postaci XML. Można je wykorzystać do kopiowania wartości atrybutów pomiędzy bibliotekami (dcore-app-extension-dm-dictcopy).

Opis konfiguracji poszczególnych rozszerzeń można znaleźć tutajThe configuration of particular extensions is presented here.

...

The filesHandler

...

To rozszerzenie pozwala zdefiniować procedury, które będą realizowane po wybraniu pliku głównego w kreatorze nowej publikacji. Procedury te mogą obejmować przetwarzanie plików na dysku, wyświetlanie okien dialogowych i inne. Skutkiem działania procedury może być zmiana wybranego pliku głównego oraz pozostałych plików dodanych do wydania. Jeśli w aplikacji zainstalowanych jest więcej niż jedna wtyczka do tego rozszerzenia, są one odpytywane po kolei, aż do pierwszej wtyczki, która przetworzy pliki poprawnie (nie wyrzuci wyjątku).

Extension

That extension makes it possible to define procedures to be carried out after the main file has been selected in the new publication creator. Those procedures may include file processing on a drive, displaying dialog boxes, etc. A procedure defined by such an extension can result in a change of the selected main file and of the remaining files added to a release. If there is more than one plugin for that extension in the application, the plugins are called one by one, until one of them processes the files correctly (does not throw an exception).

The extension has one parameter, class, which specifies the name of the class which implements the programming interface of the extension. The programming interface (Java language) for that extension is Rozszerzenie to przyjmuje jeden parametr class, który specyfikuje nazwę klasy implementującej interfejs programistyczny rozszerzenia. Interfejs programistyczny (język Java) dla tego rozszerzenia to pl.psnc.dlibra.app.extension.fileshandler.FilesHandler. Szczegółowe informacje związane z tym interfejsem znajdują się w komentarzach metod i samego interfejsu The filesHandler Extension For more information about that interface, see the comments on the methods and the interface (JavaDocs).

Lista domyślnie zainstalowanych rozszerzeń tego typu jest następująca:

The following extensions of that type are installed by default:

• JPG presentations – if a file containing files in the JPG format has been selected, that plugin makes it possible to define the order of images and to assign a description to every image; the information is saved in file Presentation Data.xml which is marked as the main file Prezentacje JPG - jeśli wybrano folder zawierający pliki .jpg, ta wtyczka pozwala na zdefiniowanie kolejności obrazków i przypisanie opisu do każdego obrazka. Informacje te są zapisywane w pliku PresentationData.xml, który jest oznaczany jako plik główny (dcore-app-extension-fh-jpg).

Rozszerzenie tool

To rozszerzenie pozwala dodać nowe elementy do menu Narzędzia w aplikacji administratora lub redaktora, jak pokazano na poniższym rysunku.

Rozszerzenie to przyjmuje dwa parametry:

The Tool Extension

That extension makes it possible to add new elements to the “Tools” menu in the Administrator or Editor Application (see the figure below). The extension has two parameters:

• class, which specifies the name of the class which implements the programming interface of the extension; the programming interface (Java language) for that extension is class, który specyfikuje nazwę klasy implementującej interfejs programistyczny rozszerzenia. Interfejs programistyczny (język Java) dla tego rozszerzenia to pl.psnc.dlibra.app.extension.tool.Tool. Szczegółowe informacje związane z tym interfejsem znajdują się w komentarzach metod i samego interfejsu (JavaDocs).
• type, który określa przeznaczenie narzędzia, tj. czy jest to narzędzie aplikacji administratora czy aplikacji redaktora. W związku z tym parametr ten może przyjąć tylko dwie wartości: ADMIN (określający aplikację administratora) oraz EDITOR (określający aplikację redaktora). W efekcie ustawienie parametru sprawi, że narzędzie będzie wyświetlane w menu „Narzędzia” w aplikacji administratora, bądź aplikacji redaktora.

Lista domyślnie zainstalowanych rozszerzeń tego typu jest następująca:

• ; for more information about that interface, see the comments on the methods and the interface (JavaDocs), and
• type, which determines the use of the tool, that is, if the tool belongs to the Administrator Application or to the Editor Application; so the parameter can only have one of the two values: ADMIN (for the Administrator Application) or EDITOR (for the Editor Application); when the parameter is set, the tool will be displayed in the “Tools” menu in the Administrator Application or in the Editor Application.

The following extensions of that type are installed by default:

• a publication list in a group publication – for saving publications which belong to a selected group publication, in a file in the HTML format Lista publikacji w publikacji grupowej - zapisuje publikacje należące do wybranej publikacji grupowej w pliku html (dcore-app-extension-tl-leaflist).
• Narzędzie do czyszczenia słownika atrybutu - pozwala usunąć ze słownika wartości, które nie są przypisane do żadnej publikacji. To rozszerzenie jest zintegrowane bezpośrednio z aplikacją administratora - nie jest zdefiniowane w odrębnym projekcie.

Oprócz powyższych rozszerzeń, zespół rozwijający system dLibra przygotował dla programistów zainteresowanych tworzeniem własnych rozszerzeń narzędzie przykładowe, ilustrujące możliwości rozszerzeń typu tool.

Rozszerzenie miniatureProvider

To rozszerzenie pozwala na automatyczne generowanie miniatur dla dodawanych publikacji na podstawie plików wybranych do wydania. Możliwe jest wygenerowanie kilku miniatur dla publikacji, z których redaktor będzie mógł wybrać jedną.

• ; and
• an attribute-dictionary clearing tool – for removing those values which are not assigned to any publication; that extension is directly integrated with the Administrator Application; it is not defined in a separate project.

Apart from the extensions mentioned above, the team which develops the dLibra system has prepared sample tools – which illustrate the possibilities of tool-type extensions – for programmers interested in developing their own extensions.

The miniatureProvider Extension

That extension makes it possible to automatically generate thumbnails for added publications, on the basis of files selected for releases. Several thumbnails can be generated for one publication, and the editor can choose one of them.

The extension has one parameter, class, which specifies the name of the class which implements the programming interface of the extension. The programming interface (Java language) for that extension is Rozszerzenie to przyjmuje jeden parametr class, który specyfikuje nazwę klasy implementującej interfejs programistyczny rozszerzenia. Interfejs programistyczny (język Java) dla tego rozszerzenia to pl.psnc.dlibra.app.extension.miniatureprovider.MiniatureProvider. Szczegółowe informacje związane z tym interfejsem znajdują się w komentarzach metod i samego interfejsu For more information about that interface, see the comments on the methods and the interface (JavaDocs).

Domyślnie zainstalowaną wtyczką, która implementuje to rozszerzenie, jest wtyczka tworząca prezentacje na podstawie plików jpg (zobacz opis rozszerenia filesHandler). Poza tym, w aplikacji redaktora zintegrowano wtyczki pozwalające na generowanie miniatur z następujących plików:

• najpopularniejsze formaty graficzne (jpg, png, gif)
• pliki djVu
• pliki pdf

Rozszerzenie eventListener

Rozszerzenie typu eventListener pozwala reagować na zdarzenia zachodzące w aplikacji redaktora i administratora.

The plugin installed by default to implement that extension is a plugin which creates presentations on the basis of files in the JPG format (see the description of the filesHandler extension). Besides, in the Editor Application, there are integrated plugins for generating thumbnails from the following files:

• the most popular graphic file formats (JPG, PNG, GIF),
• files in the DjVu format, and
• files in the PDF format.

The eventListener Extension

An extension of the eventListener type makes it possible to react to events in the Editor and Administrator system.

That extension is represented in the dLibra software as a Java-language programming interface Rozszerzenie to reprezentowane jest w oprogramowaniu dLibra jako interfejs programistyczny języka Java pl.psnc.dlibra.app.extension.eventListener.EventListener.

Interfejs ten posiada jedną metodę o nazwie eventPushed przyjmującą następujące parametry:

.

The interface has one method – called eventPushed – with the following parameters:

• event – representing an event which took place in the Editor and Administrator Application; that parameter is an implementation of interface event - reprezentuje zdarzenie, które miało miejsce w aplikacji redaktora i administratora. Parametr ten jest impementacją interfejsu pl.psnc.dlibra.app.extension.eventlistener.AppEvent, który umożliwia określenie identyfikatora obiektu jakiego zdarzenie dotyczy oraz typu zdarzenia, który może być jedną z wartości określonych w typie wyliczeniowym and it makes it possible to determine the identifier of the object to which the event partains and to identify the event type, which can be one of the values determined in calculation pl.psnc.dlibra.app.extension.eventlistener.AppEventType.
• serverInterface - reprezentuje interfejs dostępowy do serwera dLibry, za pośrednictwem którego można odwołać się do usług umożliwiających pobranie danych dotyczących obiektów w dLibrze.

W domyślnej konfiguracji aplikacji redaktora i administratora nie ma rozszerzeń tego typu. Rozszerzenie to zaprojektowane zostało z myślą o narzędziach wykonujących specyficzne działania w zewnętrznych systemach, które z oczywistych względów nie są wspierane przez aplikację redaktora i administratora. Dla programistów chcących stworzyć narzędzie tego typu, powstało przykładowe rozszerzenie.

Rozszerzenie objectPanel

Rozszerzenia tego typu pozwalają na dodanie dodatkowej zakładki w aplikacji redaktora, widocznej w dolnej części ekranu po zaznaczeniu obiektu określonego typu. Wtyczka taka ma pełną swobodę w przygotowaniu zawartości zakładki i może w tym celu korzystać z dostępu do funkcji serwera. Rozszerzenie to może posłużyć do wyświetlania dodatkowych informacji związanych z wybranym obiektem, np. pobranych z zewnętrznych systemów.

• ; and
• serverlnterface – representing the dLibra server access interface, which can be used for referring to services which make it possible to retrieve data pertaining to objects in the dLibra system.

In the default configuration of the Editor and Administrator Application, there are no extensions of that type. The extension has been designed for tools which carry out specific activities in external systems and which, for obvious reasons, are not supported by the Editor and Administrator Application. A sample extension was created for programmers who want to create such a tool.

The objectPanel Extension

Extensions of that type make it possible to add an additional tab in the Editor Application, which will be visible in the lower part of the screen after an object of a particular type has been selected. A plugin of that kind can freely prepare the content of such a tab, and it can make use of access to server functions for that purpose. The extension can also be used for displaying additional information related to a selected object – for example, information retrieved from external systems.

The extension has one parameter, class, which specifies the name of the class which implements the programming interface of the extension. The programming interface (Java language) for that extension is Rozszerzenie to przyjmuje jeden parametr class, który specyfikuje nazwę klasy implementującej interfejs programistyczny rozszerzenia. Interfejs programistyczny (język Java) dla tego rozszerzenia to pl.psnc.dlibra.app.extension.objectpanel.ObjectPanel. Szczegółowe informacje związane z tym interfejsem znajdują się w komentarzach metod i samego interfejsu For more information about that interface, see the comments on the methods and the interface (JavaDocs).

Domyślnie w aplikacji redaktora nie jest zainstalowane żadne rozszerzenie tego typu, ale można pobrać przykładową implementację, która demonstruje możliwości rozszerzenia.

Rozszerzenie dataSource

Ten typ rozszerzeń umożliwia dodanie nowych sposobów definiowania treści publikacji. W kreatorze nowej publikacji (a także dodawania plików do publikacji, oraz podmiany plików w publikacji), na stornie wyboru plików, użytkownik może wybrać jedno z zainstalowanych rozszerzeń dataSource, dzięki czemu zamiast standardowego panelu wyboru plików pojawi się panel przygotowany przez to rozszerzenie. Kiedy użytkownik wybierze pliki do publikacji w tym panelu, rozszerzenie przekazuje tę informację do aplikacji redaktora i użytkownik może przejść do następnych kroków kreatora. Przy pomocy tego rozszerzenia można wskazać nie tylko pliki na dysku lokalnym, ale też zasoby dostępne w Internecie - w takim przypadku serwer dLibry pobierze je i zapisze w swoim repozytorium (pobieranie może się również odbyć za pośrednictwem komputera redaktora).

By default, no extension of that type is installed in the Editor Application, but a sample implementation – which demonstrates the capabilities of the extension – can be downloaded.

The dataSource Extension

That extension type makes it possible to add new ways of defining publication content. In the creator for adding a new publication (as well as adding files to a publication and for replacing files in a publication), on the file selection page, the user can choose one of the installed dataSource extensions. Then, instead of the standard file selection panel, the panel prepared by that extension will be displayed. When the user has selected files for publication in that panel, the extension passes that information on to the Editor Application, and the user can go to next steps of the creator. The extension makes it possible to indicate not only files on the local drive but also resources on the Internet, which will be downloaded by the dLibra server and saved in its repository (the files can also be downloaded with the use of the editor’s computer).

The extension has one parameter, class, which specifies the name of the class which implements the programming interface of the extension. The programming interface (Java language) for that extension is Rozszerzenie to przyjmuje jeden parametr class, który specyfikuje nazwę klasy implementującej interfejs programistyczny rozszerzenia. Interfejs programistyczny (język Java) dla tego rozszerzenia to pl.psnc.dlibra.app.extension.datasource.DataSource. Szczegółowe informacje związane z tym interfejsem znajdują się w komentarzach metod i samego interfejsu For more information about that interface, see the comments on the methods and the interface (JavaDocs).

Domyślnie w aplikacji redaktora nie jest zainstalowane żadne rozszerzenie tego typu, ale można pobrać przykładową implementację, która demonstruje możliwości rozszerzeniaBy default, no extension of that type is installed in the Editor Application, but a sample implementation – which demonstrates the capabilities of the extension – can be downloaded.