Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

  • 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

Opis ogólny

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

...

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

Image Removed

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.

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 eventListener

...

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

...

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 nie są z oczywistych względów nie są wspierane przez aplikację redaktora i administratora.

Przykładowe rozszerzenie typu eventListener
Instalacja

Narzędzie pokazujące sposób korzystania z punktu rozszerzeń eventListener zostało stworzone przez zespół rozwijający system dLibra i jest dostępne do pobrania tutaj.

Aby zainstalować wtyczkę w systemie dLibra należy skopiować plik dcore-app-extension-el-test-x.x.x.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 to reaguje na zdarzenia zachodzące w aplikacji redaktora i administratora i dla każdego z nich wyświetla okienko dialogowe informujące o typie zdarzenia oraz podające informacje pobrane z serwera dLibry dotyczące obiektu, dla którego zdarzenie miało miejsce. Przykładowy efekt działania tej wtyczki dla zdarzenia dotyczącego zmiany właściwości wydania widoczny jest na obrazku poniżej.

Image Removed

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

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. Implementacja wyświetla dodatkową zakładkę dla wszystkich typów obiektów, z wyjątkiem publikacji grupowych. Na zakładce wyświetlany jest typ obiektu, jego nazwa oraz identyfikator. Znajduje się tam też przycisk symulujący wprowadzenie zmian, które użytkownik może zatwierdzić lub anulować. Przykładowe rozszerzenie dostępne jest tutaj.

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. Implementacja zawiera prosty formularz, w którym można wpisać odnośniki URL do polików. Przykładowe rozszerzenie dostępne jest tutaj.