...
Po ponownym uruchomieniu Aplikacji Redaktora wtyczki powinny być widoczne (można to sprawdzić w menu Pomoc -> O programie). Proces uaktualnienia w panelu administracyjnym musi zostać uruchomiony po każdej zmianie plików jar
.
Konfiguracja rozszerzeń
Aby rozszerzenie było poprawnie widoczne w Aplikacji Redaktora i Administratora, odpowiednia konfiguracja musi znajdować się w pliku src/etc/plugin.xml
. Budowa tego pliku wynika z wymagań biblioteki Java Plugin Framework. Poniżej znajduje się przykładowa zawartość tego pliku:
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" ?>
<!DOCTYPE plugin PUBLIC "-//JPF//Java Plug-in Manifest 0.7" "http://jpf.sourceforge.net/plugin_0_7.dtd">
<plugin id="pl.psnc.dlibra.app.extension.op.test" version="${pom.currentVersion}">
<requires>
<import plugin-id="pl.psnc.dlibra.app.extension"/>
</requires>
<runtime>
#foreach($dep in ${pom.dependencies})
#if(${dep.type} == "jar" && !${dep.getProperty('dist.skip').equals("true")})
<library id="${dep.artifact}" path="lib/${dep.artifact}" type="code" />
#end
#end
<library id="pluginCode" path="${jarName}" type="code" />
</runtime>
<extension plugin-id="pl.psnc.dlibra.app.extension"
point-id="objectPanel" id="op-test">
<doc>
<doc-text>Polish interface language is provided by Poznan Supercomputing and Networking Center.</doc-text>
</doc>
<parameter id="class"
value="pl.psnc.dlibra.app.extension.optest.DummyObjectPanel"/>
</extension>
</plugin> |
W znacziku <runtime>
znajduje się makro Velocity, które automatycznie dołączy do dystrybucji wtyczki niezbędne pliki jar
(wszystkie te, które są wymienione jako zależności w pliku project.xml
i nie mają dopisanej właściwości <dist.skip>true</dist.skip>
).
Znacznik <extension>
definiuje konkretne rozszerzenie. Atrybut pluginId
musi mieć wartość "pl.psnc.dlibra.app.extension"
. Atrybut point-id
musi zawierać identyfikator punktu rozszerzeń, do którego ma być włączona wtyczka (zgodny z nazwami wymienionymi w dokumentacji), natomiast atrybut id
musi być unikalnym identyfikatorem rozszerzenia. Wewnątrz znacznika <extension>
można umieścić opcjonalny znacznik doc
z tekstem, który ma być wyświetlony w oknie informacyjnym Aplikacji (Menu Pomoc -> O programie...), oraz znaczniki <parameter>
definiujące parametry wymienione w opisie danego punktu rozszerzeń.
Uwaga: w przykładowych rozszerzeniach każda wtyczka korzysta z tylko jednego punktu rozszerzeń, ale nic nie stoi na przeszkodzie, aby jedna wtyczka była włączona do wielu punktów. W tym celu należy umieścić w pliku konfiguracyjnym więcej znaczników <extension>
.
Lista przykładowych rozszerzeń
Rozszerzenia zostały wymienione i opisane w podrozdziałach:
...