Page History

...

Rozszerzenia aplikacji redaktora i administratora bazują na Java Plugin Framework (JPF). Podstawowym elementem w tym mechanizmie jest plik opisujący plugin JPF:

...

<?xml version="1.0" ?>
<!DOCTYPE plugin PUBLIC "-//JPF//Java Plug-in Manifest 0.4" "http://jpf.sourceforge.net/plugin_0_7.dtd">
<plugin id="pl.psnc.dlibra.app.extension" version="${pom.currentVersion}">
	<extension-point id="metadata">
		<parameter-def id="class"/>
		<parameter-def id="name"/>
		<parameter-def id="icon" multiplicity="none-or-one"/>
	</extension-point>
	<extension-point id="fileParser">
		<parameter-def id="class"/>
	</extension-point>
	<extension-point id="interfaceLanguage">
		<parameter-def id="class"/>
	</extension-point>
	<extension-point id="graphicProvider">
		<parameter-def id="class"/>
	</extension-point>
	<extension-point id="sourceLocator">
		<parameter-def id="class"/>
	</extension-point>
	<extension-point id="dictionaryManager">
		<parameter-def id="class"/>
	</extension-point>
	<extension-point id="filesHandler">
		<parameter-def id="class"/>
	</extension-point>
    	<extension-point id="tool">
        	<parameter-def id="class"/>
 	</extension-point>
 	<extension-point id="miniatureProvider">
        	<parameter-def id="class"/>
 	</extension-point>
</plugin>

Poniżej opisane są wszystkie możliwe rozszerzenia (punkty rozszerzeń) zdefiniowane dla aplikacji redaktora i administratora dLibra.

Jak widać plugin ten definiuje dziewięć możliwych rozszerzeń (punktów rozszerzeń) aplikacji redaktora i administratora opisanych w kolejnych sekcjach.

Rozszerzenie metadata

Rozszerzenie metadata służy do poszerzania możliwości importujących i eksportujących metadane w aplikacji. Poprzez to rozszerzenie możemy dodać funkcję importowania lub/i eksportowania metadanych z/do zewnętrznego formatu.

...

Interfejs programistyczny (język Java) dla tego rozszerzenia to dljdocos1dlibra-app-extension-api2pl.psnc.dlibra.app.extension.metadata.MetadataFinderos. Szczegółowe informacje związane z tym interfejsem znajdują się w komentarzach metod i samego interfejsu (JavaDocs).

...

• Import metadanych z formatu MARC (dlprojos1dlibra-app-extension-mf-marcos).
• Import metadanych z formatu XML (dlprojos1dlibradcore-app-extension-mf-xmlos).
• Import metadanych z formatu BibTeX (dlprojos1dlibra-app-extension-mf-bibtexos).
• Eksport w formacie RDF - to rozszerzenie jest zintegrowane z aplikacją redaktora i administratora - nie jest zdefiniowane w odrębnym projekcie.

...

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 dljdocos1dlibra-app-extension-api2pl.psnc.dlibra.app.extension.fileparser.FileParseros. Szczegółowe informacje związane z tym interfejsem znajdują się w komentarzach metod i samego interfejsu (JavaDocs).

...

• Format DjVu - rozszerzenie odnajduje pliki powiązane z danym plikiem w formacie DjVu (dlprojos1dlibradcore-app-extension-fp-djvuos).
• Format HTML - rozszerzenie odnajduje pliki powiązane z danym plikiem w formacie HTML (dlprojos1dlibradcore-app-extension-fp-htmlos).

Rozszerzenie interfaceLanguage

...

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 dljdocos1dlibra-app-extension-api2pl.psnc.dlibra.app.extension.language.InterfaceLanguageos. Szczegółowe informacje związane z tym interfejsem znajdują się w komentarzach metod i samego interfejsu (JavaDocs).

...

• Polski - rozszerzenie udostępnia wszystkie słowa/frazy interfejsu użytkownika w języku polskim (dlprojos1dlibra-app-extension-il-plos).
• Angielski - rozszerzenie udostępnia wszystkie słowa/frazy interfejsu użytkownika w języku angielskim (dlprojos1dlibra-app-extension-il-enos).Ukraiński - rozszerzenie udostępnia wszystkie słowa/frazy interfejsu użytkownika w języku ukraińskim (dlprojos1dlibra-app-extension-il-ukos).

Rozszerzenie graphicProvider

...

W aplikacji domyślnie zainstalowana jest wtyczka zapewniająca domyślny wygląd (dlprojos1dlibra-app-extension-gpos).

Rozszerzenie sourceLocator

...

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 dljdocos1dlibra-app-extension-api2pl.psnc.dlibra.app.extension.sourcelocator.SourceLocatoros. Szczegółowe informacje związane z tym interfejsem znajdują się w komentarzach metod i samego interfejsu (JavaDocs).

...

• Z39.50 - pozwala na lokalizowanie plików metadanych przy użyciu serwerów Z39.50 (dlprojos1dlibra-app-extension-sl-z3950os).

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

...

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 dljdocos1dlibra-app-extension-api2pl.psnc.dlibra.app.extension.dictionarymanager.DictionaryManageros. Szczegółowe informacje związane z tym interfejsem znajdują się w komentarzach metod i samego interfejsu (JavaDocs).

...

• Import grup wartości z plików MARC - pozwala na odczyt plików w formacie MARC-21 (dlprojos1dlibra-app-extension-dictcopyos-dl-marc). Zapis do plików nie jest wspierany.
• 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 (dlprojos1dlibradcore-app-extension-dm-dictcopyos).

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

...

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 dljdocos1dlibra-app-extension-api2pl.psnc.dlibra.app.extension.fileshandler.FilesHandleros. Szczegółowe informacje związane z tym interfejsem znajdują się w komentarzach metod i samego interfejsu (JavaDocs).

...

• 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 (dlprojos1dlibradcore-app-extension-fh-jpgos).

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 jeden parametr dwa parametry:

• 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:

• Lista publikacji w publikacji grupowej - zapisuje publikacje należące do wybranej publikacji grupowej w pliku html (dlprojos1dlibradcore-app-extension-tl-leafslistosleaflist).
• 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

...

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 dljdocos1dlibra-app-extension-api2pl.psnc.dlibra.app.extension.miniatureprovider.MiniatureProvideros. Szczegółowe informacje związane z tym interfejsem znajdują się w komentarzach metod i samego interfejsu (JavaDocs).

...

• 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.

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:

• 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 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.

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 (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).

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 (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.