You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Wprowadzenie

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>

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

Uwaga

Interfejsy programistyczne wyszczególnione w poniższych opisach znajdują się w bibliotece programistycznej dlibra-app-extension-api

.

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.

Rozszerzenie przyjmuje dwa parametry:

  • class - jest to nazwa klasy, która implementuje odpowiedni interfejs programistyczny tego rozszerzenia
  • name - nazwa rozszerzenia

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

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

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

Rozszerzenie fileParser

Rozszerzenie to odnajduje dla określonego pliku powiązane z nim inne pliki. W aplikacji redaktora i administratora po wybraniu pliku głównego (np. w kreatorze publikacji) następuje automatyczne sprawdzenie jakie inne pliki są a nim powiązane. W tym celu wykorzystywane są rozszerzenia fileParser. Domyślnie w aplikacji zainstalowane są rozszerzenia HTML oraz DjVu. Jeśli dla wybranego pliku nie ma zdefiniowanego rozszerzenia to redaktor musi sam zdecydować o tym, jakie pliki będą stanowić zawartość publikacji.

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

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

Rozszerzenie interfaceLanguage

Rozszerzenie to pozwala na dodawanie tłumaczeń interfejsu użytkownika aplikacji redaktora i administratora. Domyślnie w aplikacji zainstalowane są rozszerzenia dla języka polskiego, angielskiego i ukraińskiego. Poprzez to rozszerzenie można dodać tłumaczenie interfejsu w innych językach. Aby otrzymać listę fraz/słów do tłumaczenia prosimy o kontakt.

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

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

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

Rozszerzenie graphicProvider

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.

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

Rozszerzenie sourceLocator

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.

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

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

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.

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

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

  • Import grup wartości z plików MARC - pozwala na odczyt plików w formacie MARC-21 (dlibra-app-extension-dictcopy). 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 (dlibra-app-extension-dictcopy).

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

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

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

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

  • 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 (dlibra-app-extension-fh-jpg).

Rozszerzenie tool

Opis ogólny

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:

  • 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 określenie 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 (dlibra-app-extension-tl-leafslist).
  • 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.
Przykładowe rozszerzenie tool
Instalacja

Narzędzie ilustrujące  możliwości rozszerzeń typu tool zostało przygotowane przez zespół rozwijający system dLibra i jest dostępne do pobrania tutaj.

Aby zainstalować wtyczkę w systemie dLibra należy skopiować plik .jar wtyczki do katalogu /WEB-INF/jnlp-jars aplikacji czytelnika i uruchomić w panelu administracyjnym proces uaktualnienia aplikacji redaktora/administratora. Więcej na temat panelu administracyjnego aplikacji czytelnika można dowiedzieć się tutaj.

Funkcjonalność

Rozszerzenie realizuje następujące funkcje:

  • odczytuje zaznaczone obiekty cyfrowe w ramach listy elementów aplikacji redaktora i wyświetla je na panelu rozszerzenia (panel „Tabela wyników selekcji” – patrz rysunek poniżej)
  • umożliwia wybieranie obiektów na liście elementów aplikacji redaktora, poprzez wskazanie obiektu do zaznaczenia na panelu rozszerzenia (panel „Tabela selekcji” – patrz rysunek poniżej).

 

Okno rozszerzenia zawiera dwie tabele:

  1. Aktualnie zaznaczone publikacje na liście elementów AR
  2. Publikacje zaznaczone na liście elementów AR przy uruchomieniu narzędzia

Pierwsza tabela wyświetla podstawowe informacje na temat aktualnie zaznaczonych publikacji na liście elementów aplikacji redaktora. Zmiana zaznaczonych publikacji na liście elementów aplikacji redaktora powoduje zmianę wyświetlanych informacji w tej tabeli.

Tabela druga wyświetla podstawowe informacje na temat publikacji zaznaczonych w momencie uruchamiania rozszerzenia. Oznacza to, że zmiana zaznaczenia po uruchomieniu rozszerzenia nie wpływa na listę wyświetlonych publikacji w ramach tej tabeli. Tabela druga ma dodatkową właściwość, mianowicie zaznaczenie na niej publikacji przekłada się na zaznaczenie tej publikacji na liście elementów aplikacji redaktora. Jeśli przed uruchomieniem rozszerzenia z menu „Narzędzia” nie był zaznaczony żaden element na liście elementów aplikacji redaktora, wówczas druga tabela będzie pusta. Warto zaznaczyć, iż zmiana zaznaczenia na tabeli drugiej w sposób pośredni zmienia listę publikacji umieszczonych w tabeli pierwszej. To dlatego, iż zaznaczenia w tabeli drugiej wpływają na zaznaczenia na liście elementów aplikacji redaktora. Z kolei zaznaczenia na liście elementów aplikacji redaktora odzwierciedlane są na bieżąco w tabeli pierwszej.

Kod źródłowy wtyczki oraz jego pełną dokumentację techniczną można znaleźć tutaj.

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

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 (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
  • No labels