Obsługa działań

org.eclipse.help.base.activitySupport

3.1

Ten punkt rozszerzenia jest używany przez moduły dodatkowe produktu do konfigurowania zachowania systemu pomocy podczas używania działań. Udostępnia możliwość konfigurowania następujących aspektów:

Ten punkt rozszerzenia jest traktowany jako eksperymentalny i najprawdopodobniej ulegnie zmianom w kolejnych wersjach w miarę rozwoju mechanizmu obsługi działań.

<!ELEMENT extension (support+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT support (localScopeCheckbox , documentMessage , showAllMessage)>

<!ATTLIST support

productId CDATA #REQUIRED>


<!ELEMENT showAllMessage (#PCDATA)>

Zwykły komunikat tekstowy, który zostanie wyświetlony w oknie dialogowym po wyłączeniu filtrowania działań. Celem komunikatu jest ostrzeżenie, że bez włączonego filtrowania niektóre dokumenty mogą odwoływać się do niewidocznych elementów interfejsu użytkownika.



<!ELEMENT localScopeCheckbox (#PCDATA)>

Etykieta pola wyboru na stronie preferencji lokalnego zasięgu wyszukiwania. Zaznaczenie tego pola wyboru powoduje dołączenie wyników wyszukiwania w dokumentach należących do wyłączonych działań.



<!ELEMENT documentMessage EMPTY>

<!ATTLIST documentMessage

class    CDATA #IMPLIED

pluginId CDATA #REQUIRED>

Fragment kodu HTML, który zostanie wyświetlony u góry tematu pomocy należącego do wyłączonego działania. Celem komunikatu jest powiadomienie użytkownika, że temat może zawierać odwołania do niewidocznych elementów interfejsu użytkownika. Ponieważ tekst komunikatu znajduje się wewnątrz pliku XML, należy dodać znaczniki HTML przy użyciu standardowych encji XML dla znaków specjalnych.

Komunikat może zawierać odsyłacz hipertekstowy, który udostępnia użytkownikowi dostęp do edytora działań umożliwiającego zmianę stanu aktywności działania. W tym przypadku musi zostać użyty atrybut class.



Poniżej przedstawiono przykład zastosowania punktu rozszerzenia obsługi działania:

 

<extension point=

"org.eclipse.help.base.activitySupport"

>

<support productId=

"com.example.xyzProduct"

>

<showAllMessage>

Ta akcja spowoduje wyświetlenie wszystkich tematów w spisie treści.

</showAllMessage>

<documentMessage class=

"com.example.xyz.OpenRolePreference"

>

Ten temat należy do roli, która jest aktualnie wyłączona. &lt;p&gt; Aby włączyć rolę, należy otworzyć &lt;a href="ACTIVITY_EDITOR"&gt;Stronę preferencji roli&lt;/a&gt;.

</documentMessage>

</support>

</extension>

Atrybut class elementu documentMessage musi implementować interfejs org.eclipse.help.ILiveHelpAction.

Pakiet Eclipse SDK udostępnia domyślny mechanizm obsługi działań, który używa określenia "możliwość" i pozwala otwierać stronę preferencji Możliwości za pomocą odsyłacza hipertekstowego w tematach dotyczących wyłączonych możliwości. W przypadku przesłaniania należy upewnić się, że dokonane zmiany i używana terminologia są zgodne z używanymi na platformie interfejsu użytkownika.