The Manner in which the Extension Operates
This extension makes it possible to generate a HTML file with a list of publications belonging to a selected group publication. The list does not contain other group publications, but it takes into account possible publications grouped in other publications (as well as multiple embedded publications).
Once the “New group object” option has been selected from the “Tools” menu in the Administrator Application, there appears a dialog box (see the image below) where the identifier of the group publication should be entered. In the next window, the user should indicate the file in which the generated list is to be saved. If the operation is carried out correctly, there will appear a message saying that the list has been saved
Sposób działania rozszerzenia
To rozszerzenie pozwala na wygenerowanie pliku html zawierającego listę publikacji należących do wybranej publikacji grupowej. Lista ta nie zawiera innych publikacji grupowych, ale uwzględnia ewentualne publikacje zgrupowane w innych publikacjach (również publikacje zagnieżdżone wielokrotnie).
Po wybraniu polecenia z menu Narzędzia w aplikacji administratora, pojawia się okno dialogowe (zobacz rysunek poniżej), w które należy wpisać identyfikator publikacji grupowej. W kolejnym oknie należy wskazać plik, do którego ma zostać zapisana wygenerowana lista. Jeśli operacja zostanie przeprowadzona poprawnie, pojawi się komunikat o zapisaniu listy.
| Anchor | ||||
|---|---|---|---|---|
|
| labelImg | ||||
|---|---|---|---|---|
| ||||
Konfiguracja rozszerzenia
W celu zmiany ustawień wtyczki, należy w aplikacji redaktora wybrać z menu Program pozycję Konfiguracja, po czym w zakładce Konfiguracja rozszerzeń wybrać wtyczkę (Lista publikacji w publikacji grupowej) i kliknąć przycisk Konfiguruj. Pojawi się standardowe okno konfiguracji rozszerzenia, w którym można wprowadzić katalog na dysku lub adres www, skąd ma być pobrany plik konfiguracyjny. Jak zwykle, należy pamiętać o zaznaczeniu opcji Używaj konfiguracji z podanego źródła.
|
Configuring the Extension
In order to change the settings of the plugin, the user should select the “Configuration” item from the “Program” menu, select the plugin (“Publication list in a group publication”), and click the “Configure” button. There will appear a standard configuration window, in the user can enter the directory on the drive or the website address from which the configuration file is to be loaded for the extension. As usual, option “Use the configuration from the given source” should be marked.
The name of the file required by the generator of a publication list is index.vm; it is the template of the HTML file to be generated. The template is saved in the Apache Velocity format. For more information about that technology, see here. The structure of the template used in the default setting is presented belowPlik wymagany przez generator listy publikacji ma nazwę index.vm i jest to szablon pliku HTML, który ma zostać wygenerowany. Szablon jest zapisany w formacie Apache Velocity. Więcej informacji na temat tej technologii znajduje się tutaj. Poniżej przedstawiono budowę szablonu wykorzystywanego w domyślnym ustawieniu.
| Code Block |
|---|
## define $library_url below appropriately to your digital library url. #set($library_url = "dlibra.psnc.pl") <html> <head> <meta HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8"> </head> <body> <TABLE border="1"> <tr> <th>Tytuł publikacji</th> <th>Link do publikacji</th> <th>Identyfikator OAI</th> </tr> #foreach( $pub in $pubs ) <tr> <td>$pub.getLabel()</td> <td><a href="http:/$library_url/publication/$pub.getId()">http://$library_url/publication/$pub.getId()</a> <td>oai:$library_url:$pub.getId()</td> #end </body> </html> |
Jak pokazuje przykład, w szablonie można korzystać ze zmiennej $pubs, która jest listą obiektów opisujących publikacje należące do wybranej publikacji grupowej. Obiekty te udostępniają następujące metodyAs shown in the template, variable $pubs can be used in it. The variable is a list of objects which describe the publications in the selected group publication. The following methods are made available by the objects:
getId()zwraca identyfikator publikacji– returns the publication identifier;getLabel()zwraca nazwę publikacji (widoczną w aplikacji redaktora, niezwiązaną bezpośrednio z wartościami widocznymi dla czytelnika) – returns the name of the publication (visible in the Editor Application, not directly related to the values visible to the reader).